Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[url_launcher] When not fully loaded, clicking close causes the callback to not be triggered correctly. #8582

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
+27 −3
Open

[url_launcher] When not fully loaded, clicking close causes the callback to not be triggered correctly. #8582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
3403990
fix(url_launcher): When not fully loaded, clicking close causes the c…
StanleyCocos Feb 7, 2025
6082e8c
fix: change log
StanleyCocos Feb 7, 2025
13e3058
fix: format
StanleyCocos Feb 7, 2025
87a4a3a
fix: chenge log
StanleyCocos Feb 7, 2025
940b311
fix: test
StanleyCocos Feb 7, 2025
4f733e5
fix: type
StanleyCocos Feb 8, 2025
2c0d46b
fix: test
StanleyCocos Feb 10, 2025
4c258ab
Merge branch 'main' into fix/url_launcher_ios
StanleyCocos Feb 10, 2025
2a095f2
fix: changelog
StanleyCocos Feb 13, 2025
39ef600
Merge branch 'main' into fix/url_launcher_ios
StanleyCocos Feb 13, 2025
99359e7
fix: comment
StanleyCocos Feb 18, 2025
a2c8559
fix: comment
StanleyCocos Feb 21, 2025
1b53da5
Merge branch 'main' into fix/url_launcher_ios
StanleyCocos Feb 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/url_launcher/url_launcher_ios/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
## NEXT
## 6.3.3

* Updates minimum supported SDK version to Flutter 3.22/Dart 3.4.
* Ensures the completion callback is invoked if the user dismisses the Safari view before the initial URL load completes.

## 6.3.2

Expand Down
18 changes: 18 additions & 0 deletions packages/url_launcher/url_launcher_ios/example/ios/RunnerTests/URLLauncherTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,24 @@ final class URLLauncherTests: XCTestCase {
XCTAssertEqual(launcher.passedOptions?[.universalLinksOnly] as? Bool, true)
}

func testLaunchSafariViewControllerWithClose() {
let launcher = FakeLauncher()
let plugin = createPlugin(launcher: launcher)

let expectation = XCTestExpectation(description: "completion called")
plugin.openUrlInSafariViewController(url: "https://flutter.dev") { result in
switch result {
case .success(let details):
XCTAssertEqual(details, .failedToLoad)
case .failure(let error):
XCTFail("Unexpected error: \(error)")
}
expectation.fulfill()
}
plugin.closeSafariViewController()
wait(for: [expectation], timeout: 30)
}

}

final private class FakeLauncher: NSObject, Launcher {
Expand Down
5 changes: 5 additions & 0 deletions ...her/url_launcher_ios/ios/url_launcher_ios/Sources/url_launcher_ios/URLLaunchSession.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ final class URLLaunchSession: NSObject, SFSafariViewControllerDelegate {

private let completion: OpenInSafariCompletionHandler
private let url: URL
private var isLoadCompleted: Bool = false

/// The Safari view controller used for displaying the URL.
let safariViewController: SFSafariViewController
Expand Down Expand Up @@ -46,12 +47,16 @@ final class URLLaunchSession: NSObject, SFSafariViewControllerDelegate {
} else {
completion(.success(.failedToLoad))
}
isLoadCompleted = true
}

/// Called when the user finishes using the Safari view controller.
///
/// - Parameter controller: The Safari view controller.
func safariViewControllerDidFinish(_ controller: SFSafariViewController) {
if !isLoadCompleted {
completion(.success(.failedToLoad))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is .failedToLoad the correct result here? Or we should add a new InAppLoadResult.dismissed result?

If this is the correct result, should we update this comment to indicate this case can happen if the user dismisses the Safari view before the initial load completes?

packages/packages/url_launcher/url_launcher_ios/pigeons/messages.dart

Lines 30 to 31 in fd53793

/// The URL did not load successfully.
failedToLoad,

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At first, I did consider adding a new InAppLoadResult to describe the close action, but it seems it could lead to confusion among developers. This is because, currently, after a successful load, clicking the close button does not trigger any callback.

Additionally, when the user clicks close before the loading is complete, triggering the failedToLoad callback seems reasonable in a broader sense, as the interruption of the loading process can be considered a loading failure.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is the correct result, should we update this comment to indicate this case can happen if the user dismisses the Safari view before the initial load completes?

Do you think it’s possible to modify the comment like this:

// The URL did not load successfully (or close the SFSafariViewController earlier)

}
controller.dismiss(animated: true, completion: nil)
didFinish?()
}
Expand Down
2 changes: 1 addition & 1 deletion packages/url_launcher/url_launcher_ios/pigeons/messages.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ enum InAppLoadResult {
/// The URL was successfully loaded.
success,

/// The URL did not load successfully.
/// The URL did not load successfully (or the user closed the view controller before it loaded).
failedToLoad,

/// The URL could not be launched because it is invalid.
Expand Down
2 changes: 1 addition & 1 deletion packages/url_launcher/url_launcher_ios/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: url_launcher_ios
description: iOS implementation of the url_launcher plugin.
repository: https://github.com/flutter/packages/tree/main/packages/url_launcher/url_launcher_ios
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+url_launcher%22
version: 6.3.2
version: 6.3.3

environment:
sdk: ^3.4.0
Expand Down