feat(auth): Update ActionCodeSettings to support LinkDomain and deprecate DynamicLinkDomain (#703)

* [chore] Release 4.12.0 (#561)

- Release 4.12.0

* Revert "[chore] Release 4.12.0 (#561)" (#565)

This reverts commit 32af2b8.

* Add LinkDomain to ActionCodeSettings

* Handle INVALID_HOSTING_LINK_DOMAIN

* Mark DynamicLinkDomain as deprecated

* Better error message for INVALID_HOSTING_LINK_DOMAIN

---------

Co-authored-by: Google Open Source Bot <[email protected]>
Co-authored-by: Lahiru Maramba <[email protected]>
Co-authored-by: Google Open Source Bot <[email protected]>

Author: 3 people

auth/email_action_links.go

@@ -31,7 +31,9 @@ type ActionCodeSettings struct {
 	AndroidPackageName    string `json:"androidPackageName,omitempty"`
 	AndroidMinimumVersion string `json:"androidMinimumVersion,omitempty"`
 	AndroidInstallApp     bool   `json:"androidInstallApp,omitempty"`
-	DynamicLinkDomain     string `json:"dynamicLinkDomain,omitempty"`
+	LinkDomain            string `json:"linkDomain,omitempty"`
+	// Deprecated: Use LinkDomain instead.
+	DynamicLinkDomain string `json:"dynamicLinkDomain,omitempty"`
 }
 
 func (settings *ActionCodeSettings) toMap() (map[string]interface{}, error) {

auth/email_action_links_test.go

@@ -35,6 +35,7 @@ var testActionLinkResponse = []byte(fmt.Sprintf(testActionLinkFormat, testAction
 var testActionCodeSettings = &ActionCodeSettings{
 	URL:                   "https://example.dynamic.link",
 	HandleCodeInApp:       true,
+	LinkDomain:            "hosted.page.link",
 	DynamicLinkDomain:     "custom.page.link",
 	IOSBundleID:           "com.example.ios",
 	AndroidPackageName:    "com.example.android",
@@ -44,6 +45,7 @@ var testActionCodeSettings = &ActionCodeSettings{
 var testActionCodeSettingsMap = map[string]interface{}{
 	"continueUrl":           "https://example.dynamic.link",
 	"canHandleCodeInApp":    true,
+	"linkDomain":            "hosted.page.link",
 	"dynamicLinkDomain":     "custom.page.link",
 	"iOSBundleId":           "com.example.ios",
 	"androidPackageName":    "com.example.android",
@@ -293,6 +295,7 @@ func TestEmailVerificationLinkError(t *testing.T) {
 	cases := map[string]func(error) bool{
 		"UNAUTHORIZED_DOMAIN":         IsUnauthorizedContinueURI,
 		"INVALID_DYNAMIC_LINK_DOMAIN": IsInvalidDynamicLinkDomain,
+		"INVALID_HOSTING_LINK_DOMAIN": IsInvalidHostingLinkDomain,
 	}
 	s := echoServer(testActionLinkResponse, t)
 	defer s.Close()

auth/user_mgt.go

@@ -522,6 +522,7 @@ const (
 	emailAlreadyExists       = "EMAIL_ALREADY_EXISTS"
 	emailNotFound            = "EMAIL_NOT_FOUND"
 	invalidDynamicLinkDomain = "INVALID_DYNAMIC_LINK_DOMAIN"
+	invalidHostingLinkDomain = "INVALID_HOSTING_LINK_DOMAIN"
 	phoneNumberAlreadyExists = "PHONE_NUMBER_ALREADY_EXISTS"
 	tenantNotFound           = "TENANT_NOT_FOUND"
 	uidAlreadyExists         = "UID_ALREADY_EXISTS"
@@ -556,6 +557,11 @@ func IsInvalidDynamicLinkDomain(err error) bool {
 	return hasAuthErrorCode(err, invalidDynamicLinkDomain)
 }
 
+// IsInvalidHostingLinkDomain checks if the given error was due to an invalid hosting link domain.
+func IsInvalidHostingLinkDomain(err error) bool {
+	return hasAuthErrorCode(err, invalidHostingLinkDomain)
+}
+
 // IsInvalidEmail checks if the given error was due to an invalid email.
 //
 // Deprecated: Always returns false.
@@ -1447,6 +1453,11 @@ var serverError = map[string]*authError{
 		message:  "the provided dynamic link domain is not configured or authorized for the current project",
 		authCode: invalidDynamicLinkDomain,
 	},
+	"INVALID_HOSTING_LINK_DOMAIN": {
+		code:     internal.InvalidArgument,
+		message:  "the provided hosting link domain is not configured in Firebase Hosting or is not owned by the current project",
+		authCode: invalidHostingLinkDomain,
+	},
 	"PHONE_NUMBER_EXISTS": {
 		code:     internal.AlreadyExists,
 		message:  "user with the provided phone number already exists",

auth/user_mgt_test.go

@@ -2151,6 +2151,11 @@ func TestHTTPErrorWithCode(t *testing.T) {
 			errorutils.IsInvalidArgument,
 			"the provided dynamic link domain is not configured or authorized for the current project",
 		},
+		"INVALID_HOSTING_LINK_DOMAIN": {
+			IsInvalidHostingLinkDomain,
+			errorutils.IsInvalidArgument,
+			"the provided hosting link domain is not configured in Firebase Hosting or is not owned by the current project",
+		},
 		"PHONE_NUMBER_EXISTS": {
 			IsPhoneNumberAlreadyExists,
 			errorutils.IsAlreadyExists,