[With interface workaround] Auth Web OTP Retrieval #7496

Evanition · 2023-07-25T18:30:46Z

This branch contained all the changes related to webOTP Autofill.
Includes changes in

confirmWithWebOTP
overloaded verifyPhoneNumber/_verifyPhoneNumber
overloaded signInWithPhoneNumber
interfaces for webOTP typescript support
unit tests

changeset-bot · 2023-07-25T18:31:11Z

⚠️ No Changeset found

Latest commit: e510234

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

google-oss-bot · 2023-07-25T18:52:08Z

Size Report ¹

Affected Products

`@firebase/auth`

Type	Base (`43e402f`)	Merge (`03c6862`)	Diff
browser	177 kB	179 kB	+2.17 kB (+1.2%)
cordova	206 kB	206 kB	+108 B (+0.1%)
esm5	231 kB	233 kB	+2.77 kB (+1.2%)
main	175 kB	175 kB	+108 B (+0.1%)
module	177 kB	179 kB	+2.17 kB (+1.2%)
react-native	189 kB	192 kB	+2.81 kB (+1.5%)

@firebase/auth/cordova
Type Base (43e402f) Merge (03c6862) Diff
browser 206 kB 206 kB +108 B (+0.1%)
module 206 kB 206 kB +108 B (+0.1%)
@firebase/auth/internal
Type Base (43e402f) Merge (03c6862) Diff
browser 188 kB 190 kB +2.17 kB (+1.2%)
esm5 244 kB 247 kB +2.77 kB (+1.1%)
main 211 kB 211 kB +108 B (+0.1%)
module 188 kB 190 kB +2.17 kB (+1.2%)
bundle
Type Base (43e402f) Merge (03c6862) Diff
auth (Phone) 82.9 kB 84.0 kB +1.16 kB (+1.4%)

`firebase`

Type	Base (`43e402f`)	Merge (`03c6862`)	Diff
firebase-auth-compat.js	136 kB	137 kB	+1.19 kB (+0.9%)
firebase-auth-cordova.js	174 kB	174 kB	+107 B (+0.1%)
firebase-auth.js	147 kB	148 kB	+1.49 kB (+1.0%)
firebase-compat.js	778 kB	779 kB	+1.20 kB (+0.2%)

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/5GRON47p23.html

google-oss-bot · 2023-07-25T19:09:17Z

Size Analysis Report ¹

Affected Products

`@firebase/auth`

AuthErrorCodes
Size
Type Base (43e402f) Merge (03c6862) Diff
size 41.7 kB 41.7 kB +51 B (+0.1%)
size-with-ext-deps 62.4 kB 62.5 kB +51 B (+0.1%)

`PhoneAuthProvider`

Size

Type	Base (`43e402f`)	Merge (`03c6862`)	Diff
size	40.4 kB	43.1 kB	+2.70 kB (+6.7%)
size-with-ext-deps	61.2 kB	63.9 kB	+2.70 kB (+4.4%)

Dependency

Type Base (43e402f) Merge (03c6862) Diff

functions

59 dependencies

_addTidIfNecessary
_assert
_castAuth
_createError
_emulatorUrl
_errorWithCustomMessage
_fail
_getBrowserName
_getClientVersion
_getCurrentScheme
_getFinalTarget
_getInstance
_getPasswordPolicy
_getUserLanguage
_initializeAuthInstance
_isAndroid
_isBlackBerry
_isChromeIOS
_isFirefox
_isHttpOrHttps
_isIEMobile
_isOnline
_isSafari
_isWebOS
_logError
_logWarn
_logoutIfInvalidated
_makeTaggedError
_parseToken
_performApiRequest
_performFetchWithErrorHandling
_performSignInRequest
_persistenceKeyName
_prodErrorMap
_reloadWithoutSaving
_tokenExpiresIn
_verifyPhoneNumber
assertStringOrUndefined
createErrorInternal
debugAssert
debugFail
deleteAccount
extractProviderData
getAccountInfo
getIdTokenResult
getVersionForPlatform
isUserInvalidated
linkWithPhoneNumber$1
mergeProviderData
registerAuth
reload
requestStsToken
secondsStringToMilliseconds
sendPhoneVerificationCode
signInWithPhoneNumber$1
startEnrollPhoneMfa
startSignInPhoneMfa
utcTimestampToDateString
verifyPhoneNumberForExisting

63 dependencies

_addTidIfNecessary
_assert
_castAuth
_createError
_emulatorUrl
_errorWithCustomMessage
_fail
_getBrowserName
_getClientVersion
_getCurrentScheme
_getFinalTarget
_getInstance
_getPasswordPolicy
_getUserLanguage
_initializeAuthInstance
_isAndroid
_isBlackBerry
_isChromeIOS
_isFirefox
_isHttpOrHttps
_isIEMobile
_isOnline
_isSafari
_isWebOS
_logError
_logWarn
_logoutIfInvalidated
_makeTaggedError
_parseToken
_performApiRequest
_performFetchWithErrorHandling
_performSignInRequest
_persistenceKeyName
_processCredentialSavingMfaContextIfNecessary
_prodErrorMap
_reloadWithoutSaving
_signInWithCredential
_tokenExpiresIn
_verifyPhoneNumber
assertStringOrUndefined
createErrorInternal
debugAssert
debugFail
deleteAccount
extractProviderData
getAccountInfo
getIdTokenResult
getVersionForPlatform
isUserInvalidated
linkWithPhoneNumber$1
mergeProviderData
providerIdForResponse
registerAuth
reload
requestStsToken
secondsStringToMilliseconds
sendPhoneVerificationCode
signInWithCredential
signInWithPhoneNumber$1
startEnrollPhoneMfa
startSignInPhoneMfa
utcTimestampToDateString
verifyPhoneNumberForExisting

+ _processCredentialSavingMfaContextIfNecessary
+ _signInWithCredential
+ providerIdForResponse
+ signInWithCredential

classes

17 dependencies

AuthCredential
AuthImpl
AuthInterop
AuthMiddlewareQueue
Delay
FetchProvider
InMemoryPersistence
NetworkTimeout
PasswordPolicyImpl
PersistenceUserManager
PhoneAuthCredential
PhoneAuthProvider
ProactiveRefresh
StsTokenManager
Subscription
UserImpl
UserMetadata

20 dependencies

AuthCredential
AuthImpl
AuthInterop
AuthMiddlewareQueue
ConfirmationResultImpl
Delay
FetchProvider
InMemoryPersistence
MultiFactorError
NetworkTimeout
PasswordPolicyImpl
PersistenceUserManager
PhoneAuthCredential
PhoneAuthProvider
ProactiveRefresh
StsTokenManager
Subscription
UserCredentialImpl
UserImpl
UserMetadata

+ ConfirmationResultImpl
+ MultiFactorError
+ UserCredentialImpl

debugErrorMap
Size
Type Base (43e402f) Merge (03c6862) Diff
size 48.8 kB 48.8 kB +55 B (+0.1%)
size-with-ext-deps 69.6 kB 69.6 kB +55 B (+0.1%)

`linkWithPhoneNumber`

Size

Type	Base (`43e402f`)	Merge (`03c6862`)	Diff
size	41.2 kB	43.0 kB	+1.88 kB (+4.6%)
size-with-ext-deps	62.0 kB	63.8 kB	+1.89 kB (+3.0%)

Dependency

Type Base (43e402f) Merge (03c6862) Diff

functions

65 dependencies

_addTidIfNecessary
_assert
_assertLinkedStatus
_castAuth
_createError
_emulatorUrl
_errorWithCustomMessage
_fail
_getBrowserName
_getClientVersion
_getCurrentScheme
_getFinalTarget
_getInstance
_getPasswordPolicy
_getUserLanguage
_initializeAuthInstance
_isAndroid
_isBlackBerry
_isChromeIOS
_isFirefox
_isHttpOrHttps
_isIEMobile
_isOnline
_isSafari
_isWebOS
_link$1
_logError
_logWarn
_logoutIfInvalidated
_makeTaggedError
_parseToken
_performApiRequest
_performFetchWithErrorHandling
_performSignInRequest
_persistenceKeyName
_prodErrorMap
_reloadWithoutSaving
_tokenExpiresIn
_verifyPhoneNumber
assertStringOrUndefined
createErrorInternal
debugAssert
debugFail
deleteAccount
extractProviderData
getAccountInfo
getIdTokenResult
getVersionForPlatform
isUserInvalidated
linkWithCredential
linkWithPhoneNumber
linkWithPhoneNumber$1
mergeProviderData
providerDataAsNames
providerIdForResponse
registerAuth
reload
requestStsToken
secondsStringToMilliseconds
sendPhoneVerificationCode
signInWithPhoneNumber$1
startEnrollPhoneMfa
startSignInPhoneMfa
utcTimestampToDateString
verifyPhoneNumberForExisting

68 dependencies

_addTidIfNecessary
_assert
_assertLinkedStatus
_castAuth
_createError
_emulatorUrl
_errorWithCustomMessage
_fail
_getBrowserName
_getClientVersion
_getCurrentScheme
_getFinalTarget
_getInstance
_getPasswordPolicy
_getUserLanguage
_initializeAuthInstance
_isAndroid
_isBlackBerry
_isChromeIOS
_isFirefox
_isHttpOrHttps
_isIEMobile
_isOnline
_isSafari
_isWebOS
_link$1
_logError
_logWarn
_logoutIfInvalidated
_makeTaggedError
_parseToken
_performApiRequest
_performFetchWithErrorHandling
_performSignInRequest
_persistenceKeyName
_processCredentialSavingMfaContextIfNecessary
_prodErrorMap
_reloadWithoutSaving
_signInWithCredential
_tokenExpiresIn
_verifyPhoneNumber
assertStringOrUndefined
createErrorInternal
debugAssert
debugFail
deleteAccount
extractProviderData
getAccountInfo
getIdTokenResult
getVersionForPlatform
isUserInvalidated
linkWithCredential
linkWithPhoneNumber
linkWithPhoneNumber$1
mergeProviderData
providerDataAsNames
providerIdForResponse
registerAuth
reload
requestStsToken
secondsStringToMilliseconds
sendPhoneVerificationCode
signInWithCredential
signInWithPhoneNumber$1
startEnrollPhoneMfa
startSignInPhoneMfa
utcTimestampToDateString
verifyPhoneNumberForExisting

+ _processCredentialSavingMfaContextIfNecessary
+ _signInWithCredential
+ signInWithCredential

classes

18 dependencies

AuthCredential
AuthImpl
AuthInterop
AuthMiddlewareQueue
ConfirmationResultImpl
Delay
FetchProvider
InMemoryPersistence
NetworkTimeout
PasswordPolicyImpl
PersistenceUserManager
PhoneAuthCredential
ProactiveRefresh
StsTokenManager
Subscription
UserCredentialImpl
UserImpl
UserMetadata

19 dependencies

AuthCredential
AuthImpl
AuthInterop
AuthMiddlewareQueue
ConfirmationResultImpl
Delay
FetchProvider
InMemoryPersistence
MultiFactorError
NetworkTimeout
PasswordPolicyImpl
PersistenceUserManager
PhoneAuthCredential
ProactiveRefresh
StsTokenManager
Subscription
UserCredentialImpl
UserImpl
UserMetadata

+ MultiFactorError

`reauthenticateWithPhoneNumber`

Size

Type	Base (`43e402f`)	Merge (`03c6862`)	Diff
size	41.7 kB	43.0 kB	+1.29 kB (+3.1%)
size-with-ext-deps	62.5 kB	63.8 kB	+1.30 kB (+2.1%)

Dependency

Type Base (43e402f) Merge (03c6862) Diff

functions

64 dependencies

_addTidIfNecessary
_assert
_castAuth
_createError
_emulatorUrl
_errorWithCustomMessage
_fail
_getBrowserName
_getClientVersion
_getCurrentScheme
_getFinalTarget
_getInstance
_getPasswordPolicy
_getUserLanguage
_initializeAuthInstance
_isAndroid
_isBlackBerry
_isChromeIOS
_isFirefox
_isHttpOrHttps
_isIEMobile
_isOnline
_isSafari
_isWebOS
_logError
_logWarn
_logoutIfInvalidated
_makeTaggedError
_parseToken
_performApiRequest
_performFetchWithErrorHandling
_performSignInRequest
_persistenceKeyName
_processCredentialSavingMfaContextIfNecessary
_prodErrorMap
_reauthenticate
_reloadWithoutSaving
_tokenExpiresIn
_verifyPhoneNumber
assertStringOrUndefined
createErrorInternal
debugAssert
debugFail
deleteAccount
extractProviderData
getAccountInfo
getIdTokenResult
getVersionForPlatform
isUserInvalidated
linkWithPhoneNumber$1
mergeProviderData
providerIdForResponse
reauthenticateWithCredential
reauthenticateWithPhoneNumber
registerAuth
reload
requestStsToken
secondsStringToMilliseconds
sendPhoneVerificationCode
signInWithPhoneNumber$1
startEnrollPhoneMfa
startSignInPhoneMfa
utcTimestampToDateString
verifyPhoneNumberForExisting

66 dependencies

_addTidIfNecessary
_assert
_castAuth
_createError
_emulatorUrl
_errorWithCustomMessage
_fail
_getBrowserName
_getClientVersion
_getCurrentScheme
_getFinalTarget
_getInstance
_getPasswordPolicy
_getUserLanguage
_initializeAuthInstance
_isAndroid
_isBlackBerry
_isChromeIOS
_isFirefox
_isHttpOrHttps
_isIEMobile
_isOnline
_isSafari
_isWebOS
_logError
_logWarn
_logoutIfInvalidated
_makeTaggedError
_parseToken
_performApiRequest
_performFetchWithErrorHandling
_performSignInRequest
_persistenceKeyName
_processCredentialSavingMfaContextIfNecessary
_prodErrorMap
_reauthenticate
_reloadWithoutSaving
_signInWithCredential
_tokenExpiresIn
_verifyPhoneNumber
assertStringOrUndefined
createErrorInternal
debugAssert
debugFail
deleteAccount
extractProviderData
getAccountInfo
getIdTokenResult
getVersionForPlatform
isUserInvalidated
linkWithPhoneNumber$1
mergeProviderData
providerIdForResponse
reauthenticateWithCredential
reauthenticateWithPhoneNumber
registerAuth
reload
requestStsToken
secondsStringToMilliseconds
sendPhoneVerificationCode
signInWithCredential
signInWithPhoneNumber$1
startEnrollPhoneMfa
startSignInPhoneMfa
utcTimestampToDateString
verifyPhoneNumberForExisting

+ _signInWithCredential
+ signInWithCredential

signInWithPhoneNumber
Size
Type Base (43e402f) Merge (03c6862) Diff
size 41.5 kB 42.6 kB +1.16 kB (+2.8%)
size-with-ext-deps 62.3 kB 63.4 kB +1.16 kB (+1.9%)

Test Logs

https://storage.googleapis.com/firebase-sdk-metric-reports/sEmvwA3dAF.html

packages/auth/src/core/errors.ts

packages/auth/src/model/public_types.ts

packages/auth/src/platform_browser/providers/phone.ts

prameshj

Thanks for working on this!

packages/auth/src/platform_browser/providers/phone.ts

prameshj · 2023-08-05T00:02:55Z

packages/auth/src/platform_browser/providers/phone.ts

+    phoneOptions: PhoneInfoOptions | string,
+    applicationVerifier: ApplicationVerifier,
+    webOTPTimeout?: number
+  ): Promise<unknown> {


nit: can we explore if "Promise<UserCredential| string>" will work?

Yes. This would also work :) I like that it is more specific than using "unknown" - even though this will not be public for developers to see. I have replaced "unknown" in the return types. Please feel free to comment if you believe "unknown" is preferred.

prameshj · 2023-08-05T00:03:24Z

packages/auth/src/platform_browser/strategies/phone.test.ts

 use(chaiAsPromised);
 use(sinonChai);

+//interfaces added to provide typescript support for webopt autofill


Is this needed in the test fil?

Yes, I believe this is needed for us to use OTPCredential in the unit tests. It can be removed once typescript support is added for the WebOTP API.

packages/auth/src/platform_browser/strategies/phone.ts

packages/auth/test/integration/flows/totp.test.ts

packages/auth/src/platform_browser/strategies/phone.ts

packages/auth/demo/database.rules.json

packages/auth/demo/public/404.html

packages/auth/demo/yarn.lock

packages/auth/demo/yes/index.html

packages/auth/src/api/index.ts

packages/auth/src/platform_browser/strategies/phone.ts

packages/auth/test/integration/webdriver/static/rollup.config.js

packages/auth/test/integration/flows/totp.test.ts

common/api-review/auth.api.md

renkelvin

Great, thanks!

Implementing ConfirmWithWebOTP Method

2ed35fe

Evanition requested review from a team, lisajian, prameshj, renkelvin and sam-gc as code owners July 25, 2023 18:30

Update API reports

060c42a

github-actions bot requested review from dwyfrequency and hsubox76 as code owners July 25, 2023 18:51

changed firebase error to custom error messages

bfbc747

AngelAngelXie and others added 14 commits July 25, 2023 19:23

Update API reports

3508d6e

Implementing verifyPhoneNumber method

2f3416c

Update API reports

dc6df46

added overloaded signInWithPhoneNumber

b6af0af

overloading verifyPhoneNumber

73185ec

Update API reports

58fdc57

adding changes to demo app

bc82fe5

adding webOTPError Type

7004408

added unit tests & fixed documentations

a24db79

Update API reports

341dd90

formatted code

456fa58

removed unnecessary imports

00ee945

fixed demo app & modified errors

137e657

added documentation & fixed the fallback code

41eec76

AngelAngelXie requested review from egilmorez, kevinthecheung and markarndt as code owners July 28, 2023 17:08

AngelAngelXie changed the title ~~Implementing ConfirmWithWebOTP Method[Complete Changes]~~ [Complete Changes]Implementing ConfirmWithWebOTP Method Aug 2, 2023

AngelAngelXie added 2 commits August 2, 2023 18:29

removed test changes

0d69efa

modifying rollup to resolve sourcemap warning

3845e1e

AngelAngelXie added the Status: In Progress label Aug 2, 2023

kevinthecheung approved these changes Aug 2, 2023

View reviewed changes

packages/auth/src/core/errors.ts Outdated Show resolved Hide resolved

packages/auth/src/model/public_types.ts Show resolved Hide resolved

packages/auth/src/platform_browser/providers/phone.ts Show resolved Hide resolved

prameshj reviewed Aug 5, 2023

View reviewed changes

AngelAngelXie added 6 commits August 7, 2023 03:14

changed webOTPTimeoutname

1e8e2c8

cleaning up code

cec3a97

Reverted irrelevant changes

ff232d0

cleaning up code

82d6bfe

cleaning up code

c17f2db

reverting un-needed changes

a5a5d65

renkelvin reviewed Aug 7, 2023

View reviewed changes

common/api-review/auth.api.md Show resolved Hide resolved

AngelAngelXie changed the base branch from master to WebOTP August 8, 2023 17:25

removing unecessary elements

196c8dc

Evanition force-pushed the DewayneTest3 branch from bb8d57e to 196c8dc Compare August 9, 2023 16:57

AngelAngelXie and others added 8 commits August 10, 2023 22:51

Merge branch 'WebOTP' into DewayneTest3

4869aa7

Linting and formatting

abe3ea2

modified unit tests

4c4eda6

fixing unit test

de47f1d

added unit tests

d73e42b

removed unneeded imports

1088ecf

fixing unit tests

34ce322

fixed format

e510234

AngelAngelXie changed the title ~~[Complete Changes]Implementing ConfirmWithWebOTP Method~~ [With interface workaround] Auth Web OTP Retrieval Aug 11, 2023

renkelvin approved these changes Aug 11, 2023

View reviewed changes

renkelvin merged commit cb2aa98 into WebOTP Aug 11, 2023

renkelvin deleted the DewayneTest3 branch August 11, 2023 19:09

firebase locked and limited conversation to collaborators Sep 11, 2023

[With interface workaround] Auth Web OTP Retrieval #7496

[With interface workaround] Auth Web OTP Retrieval #7496

Uh oh!

Conversation

Evanition commented Jul 25, 2023 • edited by AngelAngelXie Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Jul 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

google-oss-bot commented Jul 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Report 1

Affected Products

@firebase/auth

@firebase/auth/cordova

@firebase/auth/internal

bundle

firebase

Test Logs

Uh oh!

google-oss-bot commented Jul 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Analysis Report 1

Affected Products

@firebase/auth

AuthErrorCodes

PhoneAuthProvider

debugErrorMap

linkWithPhoneNumber

reauthenticateWithPhoneNumber

signInWithPhoneNumber

Test Logs

Uh oh!

Uh oh!

Uh oh!

Uh oh!

prameshj left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

prameshj Aug 5, 2023

Choose a reason for hiding this comment

Uh oh!

AngelAngelXie Aug 7, 2023

Choose a reason for hiding this comment

Uh oh!

prameshj Aug 5, 2023

Choose a reason for hiding this comment

Uh oh!

AngelAngelXie Aug 7, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

renkelvin left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Evanition commented Jul 25, 2023 •

edited by AngelAngelXie

Loading

changeset-bot bot commented Jul 25, 2023 •

edited

Loading

google-oss-bot commented Jul 25, 2023 •

edited

Loading

Size Report ¹

`@firebase/auth`

`@firebase/auth/cordova`

`@firebase/auth/internal`

`bundle`

`firebase`

google-oss-bot commented Jul 25, 2023 •

edited

Loading

Size Analysis Report ¹

`@firebase/auth`

`AuthErrorCodes`

`PhoneAuthProvider`

`debugErrorMap`

`linkWithPhoneNumber`

`reauthenticateWithPhoneNumber`

`signInWithPhoneNumber`