aboutyou#162: Ensure Chrome Custom Tab does not disappear when switching away and back from the app during Sign in with Apple

tp · tp · commit ec2c3d1790ad · 2022-12-21T17:26:23.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -91,3 +91,5 @@ ios/vendor
 android/vendor
 
 **/coverage/lcov.info
+
+.fvm/
diff --git a/packages.code-workspace b/packages.code-workspace
@@ -0,0 +1,37 @@
+{
+  "folders": [
+    {
+      "path": "packages/pending_operations"
+    },
+    {
+      "path": "packages/sign_in_with_apple/sign_in_with_apple_platform_interface"
+    },
+    {
+      "path": "packages/sign_in_with_apple/sign_in_with_apple"
+    },
+    {
+      "path": "packages/sign_in_with_apple/sign_in_with_apple_web"
+    },
+    {
+      "path": "packages/state_queue"
+    },
+    {
+      "path": "packages/state_queue_test"
+    },
+    {
+      "path": "packages/with_bloc"
+    },
+    {
+      "path": ".github"
+    }
+  ],
+  "settings": {
+    "dart.lineLength": 80,
+    "search.exclude": {
+      "**/.fvm": true,
+    },
+    "files.exclude": {
+      "**/.fvm": true
+    }
+  }
+}
diff --git a/packages/sign_in_with_apple/sign_in_with_apple/CHANGELOG.md b/packages/sign_in_with_apple/sign_in_with_apple/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 4.3.0
+
+- Android: Fixes an issue where the Chrome Custom Tab would disappear when the user "left" the app (e.g. using the app switcher) ([#162](https://github.com/aboutyou/dart_packages/issues/162))
+  - Beware that your app's `launchMode` affects the specific behavior of the Chrome Custom Tab. For more information see the README.
+
 ## 4.2.0
 
 - Remove `jcenter` repository for the Android package
diff --git a/packages/sign_in_with_apple/sign_in_with_apple/README.md b/packages/sign_in_with_apple/sign_in_with_apple/README.md
@@ -138,6 +138,13 @@ You can find out if you are already using the new embedding by looking into your
 
 In case you are not yet using Android V2 Embedding, please first upgrade your app using the following guide: https://github.com/flutter/flutter/wiki/Upgrading-pre-1.12-Android-projects
 
+#### `launchMode`
+
+To ensure that deep links from the login web page (shown in a Chrome Custom Tab) back to the app still work, your app must use `launchMode` `singleTask` or `singleTop`
+  - When using `singleTask` the Chrome Custom Tab persists across app switches from within Android's app switcher, but will be dismissed when the app is launched anew from the home screen icon / app gallery
+  - With launch mode `singleTop` the Chrome Custom Tab stays present both after using the app switcher or launching the app anew via its icon
+  - If you change your app's `launchMode` be sure to test any other third-party integrations that might be affected by this (e.g. deep links)
+
 ### Web
 
 For web support you need to add the follow script import to your `index.html`'s `<head>` tag:
diff --git a/packages/sign_in_with_apple/sign_in_with_apple/android/src/main/kotlin/com/aboutyou/dart_packages/sign_in_with_apple/SignInWithApplePlugin.kt b/packages/sign_in_with_apple/sign_in_with_apple/android/src/main/kotlin/com/aboutyou/dart_packages/sign_in_with_apple/SignInWithApplePlugin.kt
@@ -91,7 +91,6 @@ public class SignInWithApplePlugin: FlutterPlugin, MethodCallHandler, ActivityAw
 
         val builder = CustomTabsIntent.Builder();
         val customTabsIntent = builder.build();
-        customTabsIntent.intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
         customTabsIntent.intent.data = Uri.parse(url)
 
         _activity.startActivityForResult(
diff --git a/packages/sign_in_with_apple/sign_in_with_apple/example/README.md b/packages/sign_in_with_apple/sign_in_with_apple/example/README.md
@@ -13,3 +13,25 @@ flutter config --enable-macos-desktop
 # cd macos && bundle exec pod install && cd -
 flutter run -d macOS
 ```
+
+## Test Android deep links
+
+### Simulate a callback from the SiwA process
+
+This mimicks the `intent://` link the success redirect would use
+
+```
+adb shell am start -a android.intent.action.VIEW \
+    -c android.intent.category.BROWSABLE \
+    -d "signinwithapple://callback?code=abc123" com.aboutyou.dart_packages.sign_in_with_apple.example
+```
+
+### Simulate a deep link into the app
+
+```
+adb shell am start -a android.intent.action.VIEW \
+    -c android.intent.category.BROWSABLE \
+    -d "siwa-example://siwa.example.com/foo" com.aboutyou.dart_packages.sign_in_with_apple.example
+```
+
+This will close the Chrome Custom Tab if a SiwA login flow is active, and then show the deep link inside the app (just a `print` in the example)
diff --git a/packages/sign_in_with_apple/sign_in_with_apple/example/android/app/src/main/AndroidManifest.xml b/packages/sign_in_with_apple/sign_in_with_apple/example/android/app/src/main/AndroidManifest.xml
@@ -20,10 +20,19 @@
               android:name="io.flutter.embedding.android.NormalTheme"
               android:resource="@style/NormalTheme"
               />
+            <meta-data android:name="flutter_deeplinking_enabled" android:value="true" />
+
             <intent-filter>
                 <action android:name="android.intent.action.MAIN"/>
                 <category android:name="android.intent.category.LAUNCHER"/>
             </intent-filter>
+            <intent-filter>
+                <action android:name="android.intent.action.VIEW" />
+                <category android:name="android.intent.category.DEFAULT" />
+                <category android:name="android.intent.category.BROWSABLE" />
+                
+                <data android:scheme="siwa-example" android:host="siwa.example.com" />
+            </intent-filter>
         </activity>
 
         <!-- Set up the Sign in with Apple activity, such that it's callable from the browser-redirect -->
diff --git a/packages/sign_in_with_apple/sign_in_with_apple/example/lib/main.dart b/packages/sign_in_with_apple/sign_in_with_apple/example/lib/main.dart
@@ -24,6 +24,14 @@ class _MyAppState extends State<MyApp> {
   @override
   Widget build(BuildContext context) {
     return MaterialApp(
+      onGenerateRoute: ((settings) {
+        // This is also invoked for incoming deep links
+
+        // ignore: avoid_print
+        print('onGenerateRoute: $settings');
+
+        return null;
+      }),
       home: Scaffold(
         appBar: AppBar(
           title: const Text('Example app: Sign in with Apple'),
diff --git a/packages/sign_in_with_apple/sign_in_with_apple/example/pubspec.lock b/packages/sign_in_with_apple/sign_in_with_apple/example/pubspec.lock
@@ -7,7 +7,7 @@ packages:
       name: async
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.8.2"
+    version: "2.9.0"
   boolean_selector:
     dependency: transitive
     description:
@@ -21,7 +21,7 @@ packages:
       name: characters
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.2.0"
+    version: "1.2.1"
   charcode:
     dependency: transitive
     description:
@@ -35,21 +35,21 @@ packages:
       name: clock
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.1.0"
+    version: "1.1.1"
   collection:
     dependency: transitive
     description:
       name: collection
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.15.0"
+    version: "1.16.0"
   fake_async:
     dependency: transitive
     description:
       name: fake_async
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.2.0"
+    version: "1.3.1"
   flutter:
     dependency: "direct main"
     description: flutter
@@ -92,7 +92,7 @@ packages:
       name: js
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.6.3"
+    version: "0.6.4"
   lints:
     dependency: transitive
     description:
@@ -106,28 +106,28 @@ packages:
       name: matcher
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.12.11"
+    version: "0.12.12"
   material_color_utilities:
     dependency: transitive
     description:
       name: material_color_utilities
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.1.3"
+    version: "0.1.5"
   meta:
     dependency: transitive
     description:
       name: meta
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.7.0"
+    version: "1.8.0"
   path:
     dependency: transitive
     description:
       name: path
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.8.0"
+    version: "1.8.2"
   pedantic:
     dependency: transitive
     description:
@@ -148,7 +148,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "4.0.0"
+    version: "4.2.0"
   sign_in_with_apple_platform_interface:
     dependency: "direct overridden"
     description:
@@ -174,7 +174,7 @@ packages:
       name: source_span
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.8.1"
+    version: "1.9.0"
   stack_trace:
     dependency: transitive
     description:
@@ -195,21 +195,21 @@ packages:
       name: string_scanner
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.1.0"
+    version: "1.1.1"
   term_glyph:
     dependency: transitive
     description:
       name: term_glyph
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.2.0"
+    version: "1.2.1"
   test_api:
     dependency: transitive
     description:
       name: test_api
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.4.8"
+    version: "0.4.12"
   typed_data:
     dependency: transitive
     description:
@@ -223,7 +223,7 @@ packages:
       name: vector_math
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.1.1"
+    version: "2.1.2"
 sdks:
-  dart: ">=2.14.0 <3.0.0"
+  dart: ">=2.17.0-0 <3.0.0"
   flutter: ">=2.8.0"
diff --git a/packages/sign_in_with_apple/sign_in_with_apple/pubspec.yaml b/packages/sign_in_with_apple/sign_in_with_apple/pubspec.yaml
@@ -1,6 +1,6 @@
 name: sign_in_with_apple
 description: Flutter bridge to initiate Sign in with Apple (on iOS, macOS, and Android). Includes support for keychain entries as well as signing in with an Apple ID.
-version: 4.2.0
+version: 4.3.0
 homepage: https://github.com/aboutyou/dart_packages/tree/master/packages/sign_in_with_apple
 repository: https://github.com/aboutyou/dart_packages
 
