fix(tests): Only mock event channel when using AppLinks >=6.0.0

Author: bruiken

packages/supabase_flutter/test/supabase_flutter_test.dart

@@ -1,3 +1,4 @@
+import 'package:app_links/app_links.dart';
 import 'package:flutter/services.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:supabase_flutter/supabase_flutter.dart';
@@ -95,11 +96,32 @@ void main() {
   group('Deep Link with PKCE code', () {
     late final PkceHttpClient pkceHttpClient;
     late final EventChannel appLinksEventChannel;
+    late final bool mockEventChannel;
+
+    /// Check if the current version of AppLinks uses an explicit call to get
+    /// the initial link. This is only the case before version 6.0.0, where we
+    /// can find the getInitialAppLink function.
+    bool appLinksExposesInitialLinkInStream() {
+      try {
+        // before app_links 6.0.0
+        (AppLinks() as dynamic).getInitialAppLink;
+        return false;
+      } on NoSuchMethodError catch (_) {
+        return true;
+      }
+    }
+
     setUp(() async {
       pkceHttpClient = PkceHttpClient();
 
-      // Add initial deep link with a `code` parameter
+      // Add initial deep link with a `code` parameter, use method channel if
+      // we are in a version of AppLinks that use the explcit method for
+      // getting the initial link. Otherwise we want to mock the event channel
+      // and put the initial link there.
+      mockEventChannel = appLinksExposesInitialLinkInStream();
       appLinksEventChannel = mockAppLink(
+        mockMethodChannel: !mockEventChannel,
+        mockEventChannel: mockEventChannel,
         initialLink: 'com.supabase://callback/?code=my-code-verifier',
       );
       await Supabase.initialize(
@@ -121,8 +143,10 @@ void main() {
         'Having `code` as the query parameter triggers `getSessionFromUrl` call on initialize',
         () async {
       // Wait for the initial app link to be handled, as this is an async process
-      final stream = appLinksEventChannel.receiveBroadcastStream();
-      await stream.first;
+      if (mockEventChannel) {
+        final stream = appLinksEventChannel.receiveBroadcastStream();
+        await stream.first;
+      }
       expect(pkceHttpClient.requestCount, 1);
       expect(pkceHttpClient.lastRequestBody['auth_code'], 'my-code-verifier');
     });

packages/supabase_flutter/test/widget_test_stubs.dart

@@ -97,26 +97,35 @@ class MockEmptyLocalStorage extends LocalStorage {
 /// Registers the mock handler for app_links
 ///
 /// Returns the [EventChannel] used to mock the incoming links.
-EventChannel mockAppLink({String? initialLink}) {
+EventChannel mockAppLink({
+  bool mockMethodChannel = false,
+  bool mockEventChannel = false,
+  String? initialLink,
+}) {
   const channel = MethodChannel('com.llfbandit.app_links/messages');
   const eventChannel = EventChannel('com.llfbandit.app_links/events');
 
   TestWidgetsFlutterBinding.ensureInitialized();
 
   // ignore: invalid_null_aware_operator
   TestDefaultBinaryMessengerBinding.instance?.defaultBinaryMessenger
-      .setMockMethodCallHandler(channel, (call) async => initialLink);
-
-  // ignore: invalid_null_aware_operator
-  TestDefaultBinaryMessengerBinding.instance?.defaultBinaryMessenger
-      .setMockStreamHandler(
-    eventChannel,
-    MockStreamHandler.inline(
-      onListen: (arguments, events) {
-        events.success(initialLink);
-      },
-    ),
-  );
+      .setMockMethodCallHandler(
+          channel, (call) async => mockMethodChannel ? initialLink : null);
+
+  if (mockEventChannel) {
+    // ignore: invalid_null_aware_operator
+    TestDefaultBinaryMessengerBinding.instance?.defaultBinaryMessenger
+        .setMockStreamHandler(
+      eventChannel,
+      MockStreamHandler.inline(
+        onListen: (arguments, events) {
+          if (mockEventChannel) {
+            events.success(initialLink);
+          }
+        },
+      ),
+    );
+  }
 
   return eventChannel;
 }