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

graeme-verticalscope · 2025-07-02T13:58:30Z

Discussion

Add the LinkDomain field to the ActionCodeSettings struct, this new field enables migrating off of firebase dynamic links, which is deprecated and will be unsupported soon.

See #681, I was asked to create a second PR targeting master branch. Original PR is #682

- Release 4.12.0

This reverts commit 32af2b8.

Xiaoshouzi-gh

Thanks for putting this together!

lahirumaramba · 2025-07-08T16:33:09Z

Thanks for the contribution! The base branch for PRs should be pointed to dev (I just changed it here), please update the feature branch and let me know if you run into any issues.

graeme-verticalscope · 2025-07-08T16:48:32Z

I guess you'll want to close either this PR or #682. I had originally created a PR targeting dev, but was recently asked to make one targeting master

Xiaoshouzi-gh · 2025-07-08T17:08:33Z

I guess you'll want to close either this PR or #682. I had originally created a PR targeting dev, but was recently asked to make one targeting master

Approved #682 too.

jonathanedey

Hi @graeme-verticalscope, thanks for getting started on this.

Can you add some error logic similar for what we have for dynamicLinkDomain:

firebase-admin-go/auth/user_mgt.go

Line 524 in d515faf

invalidDynamicLinkDomain = "INVALID_DYNAMIC_LINK_DOMAIN"

For invalidHostingLinkDomain the backend error should be "INVALID_HOSTING_LINK_DOMAIN"

firebase-admin-go/auth/user_mgt.go

Lines 554 to 557 in d515faf

    
           // IsInvalidDynamicLinkDomain checks if the given error was due to an invalid dynamic link domain. 
        
           func IsInvalidDynamicLinkDomain(err error) bool { 
        
           	return hasAuthErrorCode(err, invalidDynamicLinkDomain) 
        
           }

firebase-admin-go/auth/user_mgt.go

Lines 1445 to 1449 in d515faf

    
           "INVALID_DYNAMIC_LINK_DOMAIN": { 
        
           	code:     internal.InvalidArgument, 
        
           	message:  "the provided dynamic link domain is not configured or authorized for the current project", 
        
           	authCode: invalidDynamicLinkDomain, 
        
           },

Also ensure these are included in our tests:

firebase-admin-go/auth/user_mgt_test.go

Lines 2149 to 2153 in d515faf

    
           "INVALID_DYNAMIC_LINK_DOMAIN": { 
        
           	IsInvalidDynamicLinkDomain, 
        
           	errorutils.IsInvalidArgument, 
        
           	"the provided dynamic link domain is not configured or authorized for the current project", 
        
           },

firebase-admin-go/auth/email_action_links_test.go

Lines 293 to 296 in d515faf

    
           cases := map[string]func(error) bool{ 
        
           	"UNAUTHORIZED_DOMAIN":         IsUnauthorizedContinueURI, 
        
           	"INVALID_DYNAMIC_LINK_DOMAIN": IsInvalidDynamicLinkDomain, 
        
           }

Thanks!

auth/email_action_links.go

graeme-verticalscope · 2025-07-22T20:34:56Z

@jonathanedey, thanks I added the error code you mentioned!

You may want to check that the code and message are correct here:

	"INVALID_HOSTING_LINK_DOMAIN": {
		code:     internal.InvalidArgument,
		message:  "the provided hosting link domain is not configured or authorized for the current project",
		authCode: invalidHostingLinkDomain,
	},

I used the same code and a similar message to the existing dynamic link error mapping.

jonathanedey

LGTM with one change, thanks!

jonathanedey · 2025-07-23T14:25:38Z

auth/user_mgt.go

@@ -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 or authorized for the current project",


Good call out, lets go with the following to match the node sdk:

the provided hosting link domain is not configured in Firebase Hosting or is not owned by the current project

Great! I updated the error message.

egilmorez

LG with possible nit, thanks!

auth/user_mgt.go

graeme-verticalscope · 2025-07-23T17:43:00Z

Let me know if there's anything else I need to do, otherwise I'm assuming this can be approved and merged by a repository maintainer :)

jonathanedey · 2025-07-23T18:15:38Z

That's everything, thanks again @graeme-verticalscope for putting this together!

google-oss-bot and others added 28 commits May 21, 2020 11:49

Merge dev into master

54b8114

Merge dev into master

cef91ac

Merge dev into master

77177c7

Merge dev into master

a957589

Merge dev into master

eb0d2a0

Merge dev into master

05378ef

Merge dev into master

4121c50

Merge dev into master

928b104

Merge dev into master

02cde4f

Merge dev into master

6b40682

Merge dev into master

e60757f

Merge dev into master

bb055ed

Merge dev into master

23a1f17

Merge dev into master

1d24577

Merge dev into master

61c6c04

[chore] Release 4.12.0 (firebase#561)

32af2b8

- Release 4.12.0

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

02300a8

This reverts commit 32af2b8.

Merge dev into master

74c9bd5

Merge dev into master

37c7936

Merge dev into master

b04387e

Merge dev into master

87b867c

Merge dev into master

6a28190

Merge dev into master

c3be6f2

Merge dev into master

afeaa15

Merge dev into master

570427a

Merge dev into master

fe866a0

Merge dev into master

db240e4

Add LinkDomain to ActionCodeSettings

5236150

graeme-verticalscope mentioned this pull request Jul 2, 2025

Add ActionCodeSettings.linkDomain #681

Open

Xiaoshouzi-gh approved these changes Jul 7, 2025

View reviewed changes

lahirumaramba self-assigned this Jul 8, 2025

lahirumaramba changed the title ~~Add LinkDomain to ActionCodeSettings~~ feat(auth): Add LinkDomain to ActionCodeSettings Jul 8, 2025

lahirumaramba added the release-note label Jul 8, 2025

lahirumaramba changed the base branch from master to dev July 8, 2025 16:31

Merge branch 'dev' into actioncodesettings-linkdomain-master

0b7fc2c

jonathanedey self-requested a review July 17, 2025 17:59

jonathanedey requested changes Jul 18, 2025

View reviewed changes

jonathanedey reviewed Jul 18, 2025

View reviewed changes

auth/email_action_links.go Outdated Show resolved Hide resolved

graeme-verticalscope added 2 commits July 22, 2025 16:23

Handle INVALID_HOSTING_LINK_DOMAIN

a7de246

Mark DynamicLinkDomain as deprecated

e384662

graeme-verticalscope mentioned this pull request Jul 22, 2025

Add LinkDomain to ActionCodeSettings #682

Closed

jonathanedey requested review from OrlandriaH-G and egilmorez and removed request for OrlandriaH-G July 23, 2025 14:27

jonathanedey approved these changes Jul 23, 2025

View reviewed changes

egilmorez approved these changes Jul 23, 2025

View reviewed changes

auth/user_mgt.go Show resolved Hide resolved

graeme-verticalscope and others added 2 commits July 23, 2025 13:36

Better error message for INVALID_HOSTING_LINK_DOMAIN

c0bc26f

Merge branch 'dev' into actioncodesettings-linkdomain-master

cf4bee1

jonathanedey changed the title ~~feat(auth): Add LinkDomain to ActionCodeSettings~~ feat(auth): Update ActionCodeSettings to support LinkDomain and deprecate DynamicLinkDomain Jul 23, 2025

jonathanedey changed the title ~~feat(auth): Update ActionCodeSettings to support LinkDomain and deprecate DynamicLinkDomain~~ feat(auth): Update ActionCodeSettings to support LinkDomain and deprecate DynamicLinkDomain Jul 23, 2025

jonathanedey merged commit 056a0c1 into firebase:dev Jul 23, 2025
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

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

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

Uh oh!

graeme-verticalscope commented Jul 2, 2025

Uh oh!

Xiaoshouzi-gh left a comment

Uh oh!

lahirumaramba commented Jul 8, 2025

Uh oh!

graeme-verticalscope commented Jul 8, 2025

Uh oh!

Xiaoshouzi-gh commented Jul 8, 2025

Uh oh!

jonathanedey left a comment

Uh oh!

Uh oh!

graeme-verticalscope commented Jul 22, 2025

Uh oh!

jonathanedey left a comment •

edited

Loading

Uh oh!

jonathanedey Jul 23, 2025

Uh oh!

graeme-verticalscope Jul 23, 2025

Uh oh!

egilmorez left a comment

Uh oh!

Uh oh!

graeme-verticalscope commented Jul 23, 2025

Uh oh!

jonathanedey commented Jul 23, 2025

Uh oh!

Uh oh!

Uh oh!

	// IsInvalidDynamicLinkDomain checks if the given error was due to an invalid dynamic link domain.
	func IsInvalidDynamicLinkDomain(err error) bool {
	return hasAuthErrorCode(err, invalidDynamicLinkDomain)
	}

	"INVALID_DYNAMIC_LINK_DOMAIN": {
	code: internal.InvalidArgument,
	message: "the provided dynamic link domain is not configured or authorized for the current project",
	authCode: invalidDynamicLinkDomain,
	},

	"INVALID_DYNAMIC_LINK_DOMAIN": {
	IsInvalidDynamicLinkDomain,
	errorutils.IsInvalidArgument,
	"the provided dynamic link domain is not configured or authorized for the current project",
	},

	cases := map[string]func(error) bool{
	"UNAUTHORIZED_DOMAIN": IsUnauthorizedContinueURI,
	"INVALID_DYNAMIC_LINK_DOMAIN": IsInvalidDynamicLinkDomain,
	}

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

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

Uh oh!

Conversation

graeme-verticalscope commented Jul 2, 2025

Discussion

Uh oh!

Xiaoshouzi-gh left a comment

Choose a reason for hiding this comment

Uh oh!

lahirumaramba commented Jul 8, 2025

Uh oh!

graeme-verticalscope commented Jul 8, 2025

Uh oh!

Xiaoshouzi-gh commented Jul 8, 2025

Uh oh!

jonathanedey left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

graeme-verticalscope commented Jul 22, 2025

Uh oh!

jonathanedey left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jonathanedey Jul 23, 2025

Choose a reason for hiding this comment

Uh oh!

graeme-verticalscope Jul 23, 2025

Choose a reason for hiding this comment

Uh oh!

egilmorez left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

graeme-verticalscope commented Jul 23, 2025

Uh oh!

jonathanedey commented Jul 23, 2025

Uh oh!

Uh oh!

Uh oh!

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

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

jonathanedey left a comment •

edited

Loading