Switch Dynamic Links C++/Unity to use Domain URI Prefix rather than Dynamic Links Domain, which is now marked as deprecated. This allows custom domains to be used.

Includes docs changes pointing users at how to set up a DDL custom domain.

Tested via custom domain set up on this project: http://firebase/u/0/project/fdl-cd-test-1

PiperOrigin-RevId: 252880145

Author: jonsimantov

dynamic_links/src/dynamic_links_android.cc

@@ -15,16 +15,15 @@
 #include <assert.h>
 #include <jni.h>
 
-#include "dynamic_links/src/common.h"
-#include "dynamic_links/src/include/firebase/dynamic_links.h"
-#include "dynamic_links/src/include/firebase/dynamic_links/components.h"
-
 #include "app/src/assert.h"
 #include "app/src/include/firebase/app.h"
 #include "app/src/include/firebase/version.h"
 #include "app/src/reference_counted_future_impl.h"
 #include "app/src/util.h"
 #include "app/src/util_android.h"
+#include "dynamic_links/src/common.h"
+#include "dynamic_links/src/include/firebase/dynamic_links.h"
+#include "dynamic_links/src/include/firebase/dynamic_links/components.h"
 
 namespace firebase {
 namespace dynamic_links {
@@ -72,7 +71,7 @@ METHOD_LOOKUP_DEFINITION(dlink,
   X(SetLink, "setLink",                                                     \
     "(Landroid/net/Uri;)"                                                   \
     "Lcom/google/firebase/dynamiclinks/DynamicLink$Builder;"),              \
-  X(SetDynamicLinkDomain, "setDynamicLinkDomain",                           \
+  X(SetDomainUriPrefix, "setDomainUriPrefix",                               \
     "(Ljava/lang/String;)"                                                  \
     "Lcom/google/firebase/dynamiclinks/DynamicLink$Builder;"),              \
   X(SetAndroidParameters, "setAndroidParameters",                           \
@@ -679,10 +678,12 @@ static jobject PopulateLinkBuilder(JNIEnv* jni_env,
     *error_out = "Link is missing.";
     return nullptr;
   }
-  if (!components.dynamic_link_domain || !*components.dynamic_link_domain) {
+  if ((!components.dynamic_link_domain || !*components.dynamic_link_domain) &&
+      (!components.domain_uri_prefix || !*components.domain_uri_prefix)) {
     *error_out =
-        "DynamicLinkComponents.dynamic_link_domain "
-        " is required and cannot be empty.";
+        "DynamicLinkComponents.domain_uri_prefix is required and cannot be "
+        "empty (unless you set DynamicLinkComponents.dynamic_link_domain, "
+        "which is deprecated).";
     return nullptr;
   }
 
@@ -699,11 +700,16 @@ static jobject PopulateLinkBuilder(JNIEnv* jni_env,
     return nullptr;
   }
 
+  static const char kHttpsPrefix[] = "https://";
+  std::string domain =
+      components.domain_uri_prefix != nullptr
+          ? components.domain_uri_prefix
+          : std::string(kHttpsPrefix) + components.dynamic_link_domain;
   link_builder = SetBuilderString(
-      jni_env, link_builder, components.dynamic_link_domain,
-      dlink_builder::GetMethodId(dlink_builder::kSetDynamicLinkDomain));
+      jni_env, link_builder, domain.c_str(),
+      dlink_builder::GetMethodId(dlink_builder::kSetDomainUriPrefix));
   if (util::GetExceptionMessage(jni_env, error_out)) {
-    // setDynamicLinkDomain() threw an exception.
+    // setDomainUriPrefix() threw an exception.
     jni_env->DeleteLocalRef(link_builder);
     return nullptr;
   }

dynamic_links/src/dynamic_links_ios.mm

@@ -112,25 +112,23 @@ static void AddUrlEncodingWarning(
     generated_link->error = std::string("Link ") + kMissingFieldPostfix;
     return nil;
   }
-  if (!components.dynamic_link_domain) {
-    generated_link->error = std::string("Domain ") + kMissingFieldPostfix;
+  if ((!components.dynamic_link_domain || !*components.dynamic_link_domain) &&
+      (!components.domain_uri_prefix || !*components.domain_uri_prefix)) {
+    generated_link->error =
+        std::string("Domain URI Prefix or Dynamic Links Domain ") + kMissingFieldPostfix;
     return nil;
   }
   NSURL *link_url = EncodeUrlFromString(components.link);
   if (!link_url) {
     generated_link->error = kUrlEncodingError;
     return nil;
   }
-  // If components.dynamic_link_domain doesn't start with "https://", add it.
   static const char kHttpsPrefix[] = "https://";
-  static const size_t kHttpsPrefixLength = sizeof(kHttpsPrefix) - 1;
-  std::string dynamic_link_domain =
-      strncmp(components.dynamic_link_domain, kHttpsPrefix, kHttpsPrefixLength) == 0
-          ? components.dynamic_link_domain
-          : std::string(kHttpsPrefix) + components.dynamic_link_domain;
+  std::string domain = components.domain_uri_prefix != nullptr ? components.domain_uri_prefix
+                       : std::string(kHttpsPrefix) + components.dynamic_link_domain;
   FIRDynamicLinkComponents* fir_components =
       [FIRDynamicLinkComponents componentsWithLink:link_url
-                                   domainURIPrefix:@(dynamic_link_domain.c_str())];
+                                   domainURIPrefix:@(domain.c_str())];
   {
     auto* cpp_params = components.google_analytics_parameters;
     if (cpp_params) {

dynamic_links/src/include/firebase/dynamic_links/components.h

@@ -15,6 +15,7 @@
 #ifndef FIREBASE_DYNAMIC_LINKS_CLIENT_CPP_SRC_INCLUDE_FIREBASE_DYNAMIC_LINKS_COMPONENTS_H_
 #define FIREBASE_DYNAMIC_LINKS_CLIENT_CPP_SRC_INCLUDE_FIREBASE_DYNAMIC_LINKS_COMPONENTS_H_
 
+#include <cstring>
 #include <string>
 #include <vector>
 
@@ -230,12 +231,23 @@ struct DynamicLinkComponents {
   /// URL, be properly URL-encoded, and use the HTTP or HTTPS scheme.
   /// Note, this field is required.
   const char* link;
-  /// The domain (of the form "xyz.app.goo.gl") to use for this Dynamic Link.
+  /// Deprecated: The domain (of the form "xyz.app.goo.gl") to use for this
+  /// Dynamic Link.
   ///
-  /// You can find this value in the Dynamic Links section of the Firebase
+  /// @deprecated The dynamic_link_domain field is deprecated. Use
+  /// domain_uri_prefix instead, which also supports custom domains.
+  FIREBASE_DEPRECATED const char* dynamic_link_domain;
+  /// The domain (of the form "https://xyz.app.goo.gl") to use for this Dynamic
+  /// Link. You can find this value in the Dynamic Links section of the Firebase
   /// console.
+  ///
+  /// If you have set up custom domains on your project, set this to your
+  /// project's custom domain as listed in the Firebase console.
+  ///
+  /// Only https:// links are supported.
+  ///
   /// Note, this field is required.
-  const char* dynamic_link_domain;
+  const char* domain_uri_prefix;
   /// The Google Analytics parameters.
   GoogleAnalyticsParameters* google_analytics_parameters;
   /// The iOS parameters.
@@ -251,6 +263,7 @@ struct DynamicLinkComponents {
   DynamicLinkComponents()
       : link(nullptr),
         dynamic_link_domain(nullptr),
+        domain_uri_prefix(nullptr),
         google_analytics_parameters(nullptr),
         ios_parameters(nullptr),
         itunes_connect_analytics_parameters(nullptr),
@@ -260,17 +273,37 @@ struct DynamicLinkComponents {
   /// Constructor that initializes with the given link and domain.
   ///
   /// @param link_ The link your app will open.
-  /// @param dynamic_link_domain_ The domain (of the form "xyz.app.goo.gl") to
-  /// use for this Dynamic Link. You can find this value in the Dynamic Links
-  /// section of the Firebase console.
-  DynamicLinkComponents(const char* link_, const char* dynamic_link_domain_)
+  /// @param domain_uri_prefix_ The domain (of the form
+  /// "https://xyz.app.goo.gl") to use for this Dynamic Link. You can find this
+  /// value in the Dynamic Links section of the Firebase console. If you have
+  /// set up custom domains on your project, set this to your project's custom
+  /// domain as listed in the Firebase console. Note: If you do not specify
+  /// "https://" as the URI scheme, it will be added.
+  DynamicLinkComponents(const char* link_, const char* domain_uri_prefix_)
       : link(link_),
-        dynamic_link_domain(dynamic_link_domain_),
+        dynamic_link_domain(nullptr),
+        domain_uri_prefix(domain_uri_prefix_),
         google_analytics_parameters(nullptr),
         ios_parameters(nullptr),
         itunes_connect_analytics_parameters(nullptr),
         android_parameters(nullptr),
-        social_meta_tag_parameters(nullptr) {}
+        social_meta_tag_parameters(nullptr) {
+    // For backwards compatibility with dynamic_link_domain, if
+    // domain_uri_prefix doesn't start with "https://", add it.
+    static const char kHttpsPrefix[] = "https://";
+    static const size_t kHttpsPrefixLength = sizeof(kHttpsPrefix) - 1;
+    if (strncmp(domain_uri_prefix, kHttpsPrefix, kHttpsPrefixLength) != 0) {
+      domain_uri_prefix_with_scheme =
+          std::string(kHttpsPrefix) + domain_uri_prefix;
+      domain_uri_prefix = domain_uri_prefix_with_scheme.c_str();
+    }
+  }
+
+#ifndef INTERNAL_EXPERIMENTAL
+
+ private:
+#endif  // INTERNAL_EXPERIMENTAL
+  std::string domain_uri_prefix_with_scheme;
 };
 
 /// Creates a long Dynamic Link from the given parameters.