Add ActionCodeSettings.linkDomain and deprecate ActionCodeSettings.dynamicLinkDomain #8738
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Add linkDomain field to ActionCodeSettings * Update API reports * Update error message for ERROR_INVALID_HOSTING_LINK_DOMAIN to include that default hosting domains cannot be used. * Use constants for test values --------- Co-authored-by: NhienLam <[email protected]>
* Implement Integration test for passwordless email sign-in via firebase-hosting links. * Add license to new test file created' did not match any files * Remove unwanted _
NhienLam
requested review from
a team,
lisajian,
Xiaoshouzi-gh,
sam-gc,
pashanka and
mansisampat
as code owners
🦋 Changeset detectedLatest commit: cb98346 The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Changeset File Check ✅
|
rachelsaunders
requested changes
Jan 28, 2025
| @@ -46,6 +47,11 @@ android?: { | |||
|
|
|||
| ## ActionCodeSettings.dynamicLinkDomain | |||
|
|
|||
| > Warning: This API is now obsolete. | |||
There was a problem hiding this comment.
"obsolete" isn't a word that we use to describe launch cycle stages. Do you maybe mean "deprecated"?
There was a problem hiding this comment.
This is actually autogenerated when I tagged the property with @deprecated. Should I manually change it to Warning: This API is now deprecated?
| @@ -46,6 +47,11 @@ android?: { | |||
|
|
|||
| ## ActionCodeSettings.dynamicLinkDomain | |||
|
|
|||
| > Warning: This API is now obsolete. | |||
| > | |||
| > Firebase Dynamic Links is deprecated. Migrate to use Firebase Hosting link and use `linkDomain` to set a custom domain instead. | |||
There was a problem hiding this comment.
Seems like something is missing from this part of the sentence:
"... Firebase Hosting link..."
There was a problem hiding this comment.
I'm not sure what it's missing, could you elaborate? We're telling developers to migrate from Firebase Dynamic Links to Firebase Hosting link; and use the new linkDomain field instead of the old dynamicLinkDomain field to set a custom domain. Do you have any suggestions to improve the sentence?
| @@ -513,8 +513,18 @@ export interface ActionCodeSettings { | |||
| * | |||
| * | |||
| * @defaultValue The first domain is automatically selected. | |||
| * | |||
| * @deprecated Firebase Dynamic Links is deprecated. Migrate to use Firebase Hosting link and use | |||
There was a problem hiding this comment.
here too... looks like something is missing in this description
Size Report 1Affected Products
Test Logs |
Size Analysis Report 1Affected Products
Test Logs |
DellaBitta
requested changes
Jan 29, 2025
| @@ -0,0 +1,106 @@ | |||
| /** | |||
| * @license | |||
| * Copyright 2023 Google LLC | |||
Xiaoshouzi-gh
approved these changes
Jan 29, 2025
NhienLam
commented
Jan 30, 2025
| @@ -513,8 +513,18 @@ export interface ActionCodeSettings { | |||
| * | |||
| * | |||
| * @defaultValue The first domain is automatically selected. | |||
| * | |||
| * @deprecated Firebase Dynamic Links is deprecated. Migrate to use Firebase Hosting link and use | |||
There was a problem hiding this comment.
@hsubox76 @DellaBitta Is this the correct way to mark an API as deprecated?
Using @deprecated generates "Warning: This API is now obsolete" in the refdocs, as shown in this example. But,I agree with @rachelsaunders's comment that "obsolete" isn't the right word.
On the other hand, simply put "Deprecated." (no @ tag) will not make it stand out in the refdocs, as shown in this example, and developers probably won't see the deprecated warning during build time when using this API.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Firebase Auth relies on Firebase Dynamic Links (FDL) for mobile out-of-band email action flows. As FDL is deprecated, we're introducing a new solution, Firebase Hosting links, to replace FDL usage in Firebase Auth.
Add a new
ActionCodeSettings.linkDomainproperty to customize the Firebase Hosting link domain that is used in out-of-band email action flows.Deprecate
ActionCodeSettings.dynamicLinkDomain. Migrate to use Firebase Hosting link and useActionCodeSettings.linkDomainto set a custom domain instead.Migration guide and public documentations will be available after the SDK release.