feat(dynamic_links): add additional longDynamicLink parameter for creating a short Dynamic Link enabling additional parameters to be appended such as "ofl". (#7796)

russellwheatley · web-flow · commit 433a08eaacfa · 2022-03-10T09:58:03.000Z
diff --git a/packages/firebase_dynamic_links/firebase_dynamic_links/android/src/main/java/io/flutter/plugins/firebase/dynamiclinks/FlutterFirebaseDynamicLinksPlugin.java b/packages/firebase_dynamic_links/firebase_dynamic_links/android/src/main/java/io/flutter/plugins/firebase/dynamiclinks/FlutterFirebaseDynamicLinksPlugin.java
@@ -133,8 +133,7 @@ public void onMethodCall(MethodCall call, @NonNull final MethodChannel.Result re
         result.success(url);
         return;
       case "FirebaseDynamicLinks#buildShortLink":
-        DynamicLink.Builder urlBuilder = setupParameters(call.arguments());
-        methodCallTask = buildShortLink(urlBuilder, call.arguments());
+        methodCallTask = buildShortLink(call.arguments());
         break;
       case "FirebaseDynamicLinks#getDynamicLink":
       case "FirebaseDynamicLinks#getInitialLink":
@@ -165,11 +164,17 @@ private String buildLink(Map<String, Object> arguments) {
     return urlBuilder.buildDynamicLink().getUri().toString();
   }
 
-  private Task<Map<String, Object>> buildShortLink(
-      DynamicLink.Builder urlBuilder, @Nullable Map<String, Object> arguments) {
+  private Task<Map<String, Object>> buildShortLink(@Nullable Map<String, Object> arguments) {
     return Tasks.call(
         cachedThreadPool,
         () -> {
+          DynamicLink.Builder urlBuilder = setupParameters(arguments);
+          String longDynamicLink = (String) arguments.get("longDynamicLink");
+
+          if (longDynamicLink != null) {
+            urlBuilder.setLongLink(Uri.parse(longDynamicLink));
+          }
+
           Integer suffix = 1;
           Integer shortDynamicLinkPathLength = (Integer) arguments.get("shortLinkType");
           if (shortDynamicLinkPathLength != null) {
@@ -187,11 +192,8 @@ private Task<Map<String, Object>> buildShortLink(
 
           Map<String, Object> result = new HashMap<>();
           ShortDynamicLink shortLink;
-          if (suffix != null) {
-            shortLink = Tasks.await(urlBuilder.buildShortDynamicLink(suffix));
-          } else {
-            shortLink = Tasks.await(urlBuilder.buildShortDynamicLink());
-          }
+
+          shortLink = Tasks.await(urlBuilder.buildShortDynamicLink(suffix));
 
           List<String> warnings = new ArrayList<>();
 
diff --git a/packages/firebase_dynamic_links/firebase_dynamic_links/example/lib/main.dart b/packages/firebase_dynamic_links/firebase_dynamic_links/example/lib/main.dart
@@ -77,6 +77,9 @@ class _MainScreenState extends State<_MainScreen> {
 
     final DynamicLinkParameters parameters = DynamicLinkParameters(
       uriPrefix: 'https://reactnativefirebase.page.link',
+      longDynamicLink: Uri.parse(
+        'https://reactnativefirebase.page.link/?efr=0&ibi=io.invertase.testing&apn=io.flutter.plugins.firebase.dynamiclinksexample&imv=0&amv=0&link=https%3A%2F%2Ftest-app%2Fhelloworld&ofl=https://ofl-example.com',
+      ),
       link: Uri.parse(DynamicLink),
       androidParameters: const AndroidParameters(
         packageName: 'io.flutter.plugins.firebase.dynamiclinksexample',
diff --git a/packages/firebase_dynamic_links/firebase_dynamic_links/ios/Classes/FLTFirebaseDynamicLinksPlugin.m b/packages/firebase_dynamic_links/firebase_dynamic_links/ios/Classes/FLTFirebaseDynamicLinksPlugin.m
@@ -158,24 +158,49 @@ - (void)buildLink:(id)arguments withMethodCallResult:(FLTFirebaseMethodCallResul
 }
 
 - (void)buildShortLink:(id)arguments withMethodCallResult:(FLTFirebaseMethodCallResult *)result {
-  FIRDynamicLinkComponents *components = [self setupParameters:arguments];
-
-  [components
-      shortenWithCompletion:^(NSURL *_Nullable shortURL, NSArray<NSString *> *_Nullable warnings,
-                              NSError *_Nullable error) {
-        if (error != nil) {
-          result.error(nil, nil, nil, error);
-        } else {
-          if (warnings == nil) {
-            warnings = [NSMutableArray array];
+  FIRDynamicLinkComponentsOptions *options = [self setupOptions:arguments];
+  NSString *longDynamicLink = arguments[@"longDynamicLink"];
+
+  if (longDynamicLink != nil) {
+    NSURL *url = [NSURL URLWithString:longDynamicLink];
+    [FIRDynamicLinkComponents
+        shortenURL:url
+           options:options
+        completion:^(NSURL *_Nullable shortURL, NSArray<NSString *> *_Nullable warnings,
+                     NSError *_Nullable error) {
+          if (error != nil) {
+            result.error(nil, nil, nil, error);
+          } else {
+            if (warnings == nil) {
+              warnings = [NSMutableArray array];
+            }
+
+            result.success(@{
+              kUrl : [shortURL absoluteString],
+              @"warnings" : warnings,
+            });
           }
-
-          result.success(@{
-            kUrl : [shortURL absoluteString],
-            @"warnings" : warnings,
-          });
-        }
-      }];
+        }];
+  } else {
+    FIRDynamicLinkComponents *components = [self setupParameters:arguments];
+    components.options = options;
+    [components
+        shortenWithCompletion:^(NSURL *_Nullable shortURL, NSArray<NSString *> *_Nullable warnings,
+                                NSError *_Nullable error) {
+          if (error != nil) {
+            result.error(nil, nil, nil, error);
+          } else {
+            if (warnings == nil) {
+              warnings = [NSMutableArray array];
+            }
+
+            result.success(@{
+              kUrl : [shortURL absoluteString],
+              @"warnings" : warnings,
+            });
+          }
+        }];
+  }
 }
 
 - (void)getInitialLink:(FLTFirebaseMethodCallResult *)result {
diff --git a/packages/firebase_dynamic_links/firebase_dynamic_links_platform_interface/lib/src/dynamic_link_parameters.dart b/packages/firebase_dynamic_links/firebase_dynamic_links_platform_interface/lib/src/dynamic_link_parameters.dart
@@ -10,6 +10,7 @@ class DynamicLinkParameters {
   DynamicLinkParameters({
     required this.link,
     required this.uriPrefix,
+    this.longDynamicLink,
     this.androidParameters,
     this.iosParameters,
     this.googleAnalyticsParameters,
@@ -52,11 +53,17 @@ class DynamicLinkParameters {
   /// Social Meta Tag parameters for a generated Dynamic Link URL.
   final SocialMetaTagParameters? socialMetaTagParameters;
 
+  /// Set the long Dynamic Link when building a short link (i.e. using `buildShortLink()` API). This allows the user to append
+  /// additional query strings that would otherwise not be possible (e.g. "ofl" parameter). This will not work if using buildLink() API.
+  final Uri? longDynamicLink;
+
   /// Returns the current instance as a [Map].
   Map<String, dynamic> asMap() {
     return <String, dynamic>{
       'uriPrefix': uriPrefix,
       'link': link.toString(),
+      if (longDynamicLink != null)
+        'longDynamicLink': longDynamicLink.toString(),
       if (androidParameters != null)
         'androidParameters': androidParameters?.asMap(),
       if (googleAnalyticsParameters != null)
@@ -74,6 +81,6 @@ class DynamicLinkParameters {
 
   @override
   String toString() {
-    return '$DynamicLinkParameters($asMap)';
+    return '$DynamicLinkParameters(${asMap()})';
   }
 }
diff --git a/packages/firebase_dynamic_links/firebase_dynamic_links_platform_interface/test/dynamic_link_parameters_test.dart b/packages/firebase_dynamic_links/firebase_dynamic_links_platform_interface/test/dynamic_link_parameters_test.dart
@@ -48,10 +48,16 @@ void main() {
 
   String uriPrefix = 'https://';
 
+  const String oflLink = 'https://ofl-link.com';
+  final longDynamicLink = Uri.parse(
+    'https://reactnativefirebase.page.link?amv=0&apn=io.flutter.plugins.firebase.dynamiclinksexample&ibi=io.invertase.testing&imv=0&link=https%3A%2F%2Ftest-app%2Fhelloworld&ofl=$oflLink',
+  );
+
   group('$DynamicLinkParameters', () {
     DynamicLinkParameters dynamicLinkParams = DynamicLinkParameters(
       uriPrefix: uriPrefix,
       link: link,
+      longDynamicLink: longDynamicLink,
       androidParameters: androidParams,
       googleAnalyticsParameters: googleParams,
       iosParameters: iosParams,
@@ -73,112 +79,116 @@ void main() {
         );
         expect(dynamicLinkParams.navigationInfoParameters, navigation);
         expect(dynamicLinkParams.socialMetaTagParameters, social);
+        expect(dynamicLinkParams.longDynamicLink, longDynamicLink);
       });
+    });
+    group('asMap', () {
+      test('returns the current instance as a [Map]', () {
+        final result = dynamicLinkParams.asMap();
 
-      group('asMap', () {
-        test('returns the current instance as a [Map]', () {
-          final result = dynamicLinkParams.asMap();
-
-          expect(result, isA<Map<String, dynamic>>());
-          expect(
-            result['androidParameters']['fallbackUrl'],
-            dynamicLinkParams.androidParameters?.fallbackUrl.toString(),
-          );
-          expect(
-            result['androidParameters']['minimumVersion'],
-            dynamicLinkParams.androidParameters?.minimumVersion,
-          );
-          expect(
-            result['androidParameters']['packageName'],
-            dynamicLinkParams.androidParameters?.packageName,
-          );
-          expect(result['uriPrefix'], dynamicLinkParams.uriPrefix);
-          expect(
-            result['googleAnalyticsParameters']['campaign'],
-            dynamicLinkParams.googleAnalyticsParameters?.campaign,
-          );
-          expect(
-            result['googleAnalyticsParameters']['content'],
-            dynamicLinkParams.googleAnalyticsParameters?.content,
-          );
-          expect(
-            result['googleAnalyticsParameters']['medium'],
-            dynamicLinkParams.googleAnalyticsParameters?.medium,
-          );
-          expect(
-            result['googleAnalyticsParameters']['source'],
-            dynamicLinkParams.googleAnalyticsParameters?.source,
-          );
-          expect(
-            result['googleAnalyticsParameters']['term'],
-            dynamicLinkParams.googleAnalyticsParameters?.term,
-          );
-          expect(
-            result['iosParameters']['appStoreId'],
-            dynamicLinkParams.iosParameters?.appStoreId,
-          );
-          expect(
-            result['iosParameters']['bundleId'],
-            dynamicLinkParams.iosParameters?.bundleId,
-          );
-          expect(
-            result['iosParameters']['customScheme'],
-            dynamicLinkParams.iosParameters?.customScheme,
-          );
-          expect(
-            result['iosParameters']['fallbackUrl'],
-            dynamicLinkParams.iosParameters?.fallbackUrl.toString(),
-          );
-          expect(
-            result['iosParameters']['ipadBundleId'],
-            dynamicLinkParams.iosParameters?.ipadBundleId,
-          );
-          expect(
-            result['iosParameters']['ipadFallbackUrl'],
-            dynamicLinkParams.iosParameters?.ipadFallbackUrl.toString(),
-          );
-          expect(
-            result['iosParameters']['minimumVersion'],
-            dynamicLinkParams.iosParameters?.minimumVersion,
-          );
-          expect(
-            result['itunesConnectAnalyticsParameters']['affiliateToken'],
-            dynamicLinkParams.itunesConnectAnalyticsParameters?.affiliateToken,
-          );
-          expect(
-            result['itunesConnectAnalyticsParameters']['providerToken'],
-            dynamicLinkParams.itunesConnectAnalyticsParameters?.providerToken,
-          );
-          expect(
-            result['itunesConnectAnalyticsParameters']['campaignToken'],
-            dynamicLinkParams.itunesConnectAnalyticsParameters?.campaignToken,
-          );
-          expect(result['link'], dynamicLinkParams.link.toString());
-          expect(
-            result['navigationInfoParameters']['forcedRedirectEnabled'],
-            dynamicLinkParams.navigationInfoParameters?.forcedRedirectEnabled,
-          );
-          expect(
-            result['socialMetaTagParameters']['description'],
-            dynamicLinkParams.socialMetaTagParameters?.description,
-          );
-          expect(
-            result['socialMetaTagParameters']['imageUrl'],
-            dynamicLinkParams.socialMetaTagParameters?.imageUrl.toString(),
-          );
-          expect(
-            result['socialMetaTagParameters']['title'],
-            dynamicLinkParams.socialMetaTagParameters?.title,
-          );
-        });
-      });
-
-      test('toString', () {
+        expect(result, isA<Map<String, dynamic>>());
+        expect(
+          result['androidParameters']['fallbackUrl'],
+          dynamicLinkParams.androidParameters?.fallbackUrl.toString(),
+        );
+        expect(
+          result['androidParameters']['minimumVersion'],
+          dynamicLinkParams.androidParameters?.minimumVersion,
+        );
+        expect(
+          result['androidParameters']['packageName'],
+          dynamicLinkParams.androidParameters?.packageName,
+        );
+        expect(result['uriPrefix'], dynamicLinkParams.uriPrefix);
+        expect(
+          result['longDynamicLink'],
+          dynamicLinkParams.longDynamicLink.toString(),
+        );
+        expect(
+          result['googleAnalyticsParameters']['campaign'],
+          dynamicLinkParams.googleAnalyticsParameters?.campaign,
+        );
+        expect(
+          result['googleAnalyticsParameters']['content'],
+          dynamicLinkParams.googleAnalyticsParameters?.content,
+        );
+        expect(
+          result['googleAnalyticsParameters']['medium'],
+          dynamicLinkParams.googleAnalyticsParameters?.medium,
+        );
+        expect(
+          result['googleAnalyticsParameters']['source'],
+          dynamicLinkParams.googleAnalyticsParameters?.source,
+        );
+        expect(
+          result['googleAnalyticsParameters']['term'],
+          dynamicLinkParams.googleAnalyticsParameters?.term,
+        );
+        expect(
+          result['iosParameters']['appStoreId'],
+          dynamicLinkParams.iosParameters?.appStoreId,
+        );
         expect(
-          dynamicLinkParams.toString(),
-          equals('$DynamicLinkParameters(${dynamicLinkParams.asMap})'),
+          result['iosParameters']['bundleId'],
+          dynamicLinkParams.iosParameters?.bundleId,
+        );
+        expect(
+          result['iosParameters']['customScheme'],
+          dynamicLinkParams.iosParameters?.customScheme,
+        );
+        expect(
+          result['iosParameters']['fallbackUrl'],
+          dynamicLinkParams.iosParameters?.fallbackUrl.toString(),
+        );
+        expect(
+          result['iosParameters']['ipadBundleId'],
+          dynamicLinkParams.iosParameters?.ipadBundleId,
+        );
+        expect(
+          result['iosParameters']['ipadFallbackUrl'],
+          dynamicLinkParams.iosParameters?.ipadFallbackUrl.toString(),
+        );
+        expect(
+          result['iosParameters']['minimumVersion'],
+          dynamicLinkParams.iosParameters?.minimumVersion,
+        );
+        expect(
+          result['itunesConnectAnalyticsParameters']['affiliateToken'],
+          dynamicLinkParams.itunesConnectAnalyticsParameters?.affiliateToken,
+        );
+        expect(
+          result['itunesConnectAnalyticsParameters']['providerToken'],
+          dynamicLinkParams.itunesConnectAnalyticsParameters?.providerToken,
+        );
+        expect(
+          result['itunesConnectAnalyticsParameters']['campaignToken'],
+          dynamicLinkParams.itunesConnectAnalyticsParameters?.campaignToken,
+        );
+        expect(result['link'], dynamicLinkParams.link.toString());
+        expect(
+          result['navigationInfoParameters']['forcedRedirectEnabled'],
+          dynamicLinkParams.navigationInfoParameters?.forcedRedirectEnabled,
+        );
+        expect(
+          result['socialMetaTagParameters']['description'],
+          dynamicLinkParams.socialMetaTagParameters?.description,
+        );
+        expect(
+          result['socialMetaTagParameters']['imageUrl'],
+          dynamicLinkParams.socialMetaTagParameters?.imageUrl.toString(),
+        );
+        expect(
+          result['socialMetaTagParameters']['title'],
+          dynamicLinkParams.socialMetaTagParameters?.title,
         );
       });
     });
+
+    test('toString', () {
+      expect(
+        dynamicLinkParams.toString(),
+        equals('$DynamicLinkParameters(${dynamicLinkParams.asMap()})'),
+      );
+    });
   });
 }
diff --git a/packages/firebase_dynamic_links/firebase_dynamic_links_platform_interface/test/method_channel_tests/method_channel_firebase_dynamic_links_test.dart b/packages/firebase_dynamic_links/firebase_dynamic_links_platform_interface/test/method_channel_tests/method_channel_firebase_dynamic_links_test.dart
diff --git a/tests/test_driver/firebase_dynamic_links/firebase_dynamic_links_e2e.dart b/tests/test_driver/firebase_dynamic_links/firebase_dynamic_links_e2e.dart
