Replace uni_links package with built-in deep link support (#206)

Author: daohoangson

README.md

@@ -23,6 +23,7 @@ upload the apps to GCS (automatically deleted after 30 days).
 - Push notification via [firebase_messaging](https://pub.dev/packages/firebase_messaging)
 - Dark mode: on / off / auto
 - Developer hidden menu (tap "Version" thrice)
+- Android, iOS domain association with [built-in deep link support](https://docs.flutter.dev/ui/navigation/deep-linking)
 
 ## FAQ
 

android/app/src/main/AndroidManifest.xml

@@ -22,7 +22,7 @@
             android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
             android:exported="true"
             android:hardwareAccelerated="true"
-            android:launchMode="singleTop"
+            android:launchMode="singleInstance"
             android:theme="@style/LaunchTheme"
             android:windowSoftInputMode="adjustResize">
             <!-- Specifies an Android theme to apply to this Activity as soon as
@@ -33,6 +33,11 @@
                 android:name="io.flutter.embedding.android.NormalTheme"
                 android:resource="@style/NormalTheme" />
 
+            <!-- https://docs.flutter.dev/cookbook/navigation/set-up-app-links -->
+            <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" />

ios/Podfile.lock

@@ -140,8 +140,6 @@ PODS:
   - sqflite (0.0.3):
     - Flutter
     - FMDB (>= 2.7.5)
-  - uni_links (0.0.1):
-    - Flutter
   - url_launcher_ios (0.0.1):
     - Flutter
   - video_player_avfoundation (0.0.1):
@@ -168,7 +166,6 @@ DEPENDENCIES:
   - shared_preferences_foundation (from `.symlinks/plugins/shared_preferences_foundation/darwin`)
   - sign_in_with_apple (from `.symlinks/plugins/sign_in_with_apple/ios`)
   - sqflite (from `.symlinks/plugins/sqflite/ios`)
-  - uni_links (from `.symlinks/plugins/uni_links/ios`)
   - url_launcher_ios (from `.symlinks/plugins/url_launcher_ios/ios`)
   - video_player_avfoundation (from `.symlinks/plugins/video_player_avfoundation/ios`)
   - wakelock_plus (from `.symlinks/plugins/wakelock_plus/ios`)
@@ -232,8 +229,6 @@ EXTERNAL SOURCES:
     :path: ".symlinks/plugins/sign_in_with_apple/ios"
   sqflite:
     :path: ".symlinks/plugins/sqflite/ios"
-  uni_links:
-    :path: ".symlinks/plugins/uni_links/ios"
   url_launcher_ios:
     :path: ".symlinks/plugins/url_launcher_ios/ios"
   video_player_avfoundation:
@@ -282,7 +277,6 @@ SPEC CHECKSUMS:
   shared_preferences_foundation: 5b919d13b803cadd15ed2dc053125c68730e5126
   sign_in_with_apple: f3bf75217ea4c2c8b91823f225d70230119b8440
   sqflite: 31f7eba61e3074736dff8807a9b41581e4f7f15a
-  uni_links: d97da20c7701486ba192624d99bffaaffcfc298a
   url_launcher_ios: 08a3dfac5fb39e8759aeb0abbd5d9480f30fc8b4
   video_player_avfoundation: 81e49bb3d9fb63dccf9fa0f6d877dc3ddbeac126
   wakelock_plus: 8b09852c8876491e4b6d179e17dfe2a0b5f60d47

ios/Runner/Info.plist

@@ -47,6 +47,8 @@
 	<string>bee1edd35d32695d76209b09c46c60dc</string>
 	<key>FacebookDisplayName</key>
 	<string>com.daohoangson.flutter_ttdemo</string>
+	<key>FlutterDeepLinkingEnabled</key>
+	<true/>
 	<key>ITSAppUsesNonExemptEncryption</key>
 	<false/>
 	<key>LSApplicationQueriesSchemes</key>

lib/main.dart

@@ -15,7 +15,6 @@ import 'package:the_app/src/widgets/menu/dark_theme.dart';
 import 'package:the_app/src/widgets/dismiss_keyboard.dart';
 import 'package:the_app/src/api.dart';
 import 'package:the_app/src/push_notification.dart' as push_notification;
-import 'package:the_app/src/uni_links.dart' as uni_links;
 import 'package:the_app/src/widgets/menu/dev_tools.dart';
 import 'package:timeago/timeago.dart' as timeago;
 
@@ -25,42 +24,35 @@ void main() async {
   DarkTheme? darkTheme;
   DevTools? devTools;
   FontScale? fontScale;
-  String? initialLink;
   String? initialPath;
   WidgetsFlutterBinding.ensureInitialized();
   await Future.wait([
     DarkTheme.create().then((value) => darkTheme = value),
     FontScale.create().then((value) => fontScale = value),
     DevTools.create().then((value) => devTools = value),
     facebook_log_in.configureFacebookLogin(),
-    uni_links.getInitialLink().then((value) => initialLink = value),
     firebase.initializeApp().then((value) async {
       error_reporting.configureErrorReporting();
       push_notification.configurePushNotification();
       initialPath = await push_notification.getInitialPath();
     }),
   ]);
 
-  Widget? defaultWidget;
-  String? fallbackLink;
+  Widget home;
   if (initialPath != null) {
-    defaultWidget = const NotificationListScreen();
-  } else if (initialLink != null) {
-    initialPath = buildToolsParseLinkPath(initialLink!);
-    fallbackLink = initialLink;
+    home = InitialPathScreen(
+      initialPath!,
+      defaultWidget: const NotificationListScreen(),
+    );
+  } else {
+    home = HomeScreen();
   }
 
   runApp(MyApp(
     darkTheme: darkTheme!,
     devTools: devTools!,
     fontScale: fontScale!,
-    home: initialPath != null
-        ? InitialPathScreen(
-            initialPath!,
-            defaultWidget: defaultWidget,
-            fallbackLink: fallbackLink,
-          )
-        : HomeScreen(),
+    home: home,
   ));
 }
 
@@ -95,7 +87,6 @@ class MyApp extends StatelessWidget {
 
     Widget app = MaterialApp(
       darkTheme: _theme(_themeDark),
-      home: home,
       localizationsDelegates: const [
         L10nDelegate(),
         GlobalCupertinoLocalizations.delegate,
@@ -105,6 +96,39 @@ class MyApp extends StatelessWidget {
       navigatorKey: push_notification.primaryNavKey,
       navigatorObservers: [FontControlWidget.routeObserver],
       onGenerateTitle: (context) => l(context).appTitle,
+      onGenerateInitialRoutes: (initialRoute) {
+        if (initialRoute == '/') {
+          // user (1) launches Android/iOS app
+          // or (4a) opens link when iOS app is killed
+          // (the actual route will trigger onGenerateRoute after a few ms)
+          return [MaterialPageRoute(builder: (_) => home)];
+        } else {
+          // (3) user opens link when Android app is killed
+          return [
+            MaterialPageRoute(
+              builder: (_) => InitialPathScreen(
+                buildToolsParseLinkPath(initialRoute),
+                defaultWidget: home,
+              ),
+            ),
+          ];
+        }
+      },
+      onGenerateRoute: (settings) {
+        // user opens link when: (2) Android/iOS app is in background
+        // or (4b) iOS app is killed
+        final name = settings.name;
+        if (name == null) {
+          debugPrint('onGenerateRoute -> $settings without name');
+          return null;
+        }
+
+        parsePath(
+          buildToolsParseLinkPath(name),
+          rootNavigator: push_notification.primaryNavKey.currentState,
+        );
+        return null;
+      },
       showPerformanceOverlay: showPerformanceOverlay,
       supportedLocales: const [
         Locale('en', ''),
@@ -114,7 +138,6 @@ class MyApp extends StatelessWidget {
     );
 
     app = DismissKeyboard(app);
-    app = uni_links.UniLinksApp(child: app);
     app = push_notification.PushNotificationApp(child: app);
     app = ApiApp(child: app);
 

lib/src/abstracts/uni_links.dart

@@ -11,9 +11,13 @@ import 'package:the_app/src/link.dart';
 const _kUnreadIconSize = 30.0;
 const _kUnreadIconBoxSize = 50.0;
 
-final primaryNavKey = GlobalKey<NavigatorState>();
+final primaryNavKey = GlobalKey<NavigatorState>(
+  debugLabel: 'push_notification.primaryNavKey',
+);
 
-final _key = GlobalKey<_PushNotificationAppState>();
+final _key = GlobalKey<_PushNotificationAppState>(
+  debugLabel: 'push_notification._key',
+);
 final StreamController<int> _notifController = StreamController.broadcast();
 
 void configurePushNotification() {

lib/src/push_notification.dart

@@ -8,7 +8,6 @@ import 'package:the_app/src/intl.dart';
 import 'availability/error_reporting.dart';
 import 'availability/firebase.dart';
 import 'availability/push_notification.dart';
-import 'availability/uni_links.dart';
 
 class DevTools extends ChangeNotifier {
   bool? _isDeveloper;
@@ -54,8 +53,8 @@ class DeveloperMenu extends StatelessWidget {
         builder: (_, developer, __) => developer.isDeveloper
             ? ListTile(
                 title: Text(l(context).menuDeveloper),
-                onTap: () => Navigator.of(context).push(
-                    MaterialPageRoute(builder: (_) => const DeveloperMenuScreen())),
+                onTap: () => Navigator.of(context).push(MaterialPageRoute(
+                    builder: (_) => const DeveloperMenuScreen())),
               )
             : const SizedBox.shrink(),
       );
@@ -74,7 +73,6 @@ class DeveloperMenuScreen extends StatelessWidget {
             const ErrorReportingWidget(),
             const FirebaseWidget(),
             const PushNotificationWidget(),
-            const UniLinksWidget(),
             _ShowPerformanceOverlayWidget(),
             _CrashTestWidget(),
           ],