From 0322c1bda93b2885b995e3df2b63b48314546961 Mon Sep 17 00:00:00 2001 From: Sam Stern Date: Wed, 14 Oct 2020 08:49:28 -0400 Subject: [PATCH 001/624] Implement useEmulator for Functions (#3906) --- .changeset/silver-books-reply.md | 8 +++++++ packages-exp/functions-exp/src/api.ts | 14 +++++++------ .../functions-exp/src/service.test.ts | 6 +++--- packages-exp/functions-exp/src/service.ts | 14 +++++++------ packages-exp/functions-exp/test/utils.ts | 5 +++-- packages/firebase/index.d.ts | 14 ++++++++++++- packages/functions-types/index.d.ts | 11 ++++++++++ packages/functions/src/api/service.ts | 13 ++++++++++++ packages/functions/test/service.test.ts | 21 +++++++++++++++++-- 9 files changed, 86 insertions(+), 20 deletions(-) create mode 100644 .changeset/silver-books-reply.md diff --git a/.changeset/silver-books-reply.md b/.changeset/silver-books-reply.md new file mode 100644 index 00000000000..7035ae9bcb6 --- /dev/null +++ b/.changeset/silver-books-reply.md @@ -0,0 +1,8 @@ +--- +'firebase': minor +'@firebase/functions-exp': minor +'@firebase/functions': minor +'@firebase/functions-types': minor +--- + +Add a useEmulator(host, port) method to Cloud Functions diff --git a/packages-exp/functions-exp/src/api.ts b/packages-exp/functions-exp/src/api.ts index 3d7ff92f740..c6dc36073b4 100644 --- a/packages-exp/functions-exp/src/api.ts +++ b/packages-exp/functions-exp/src/api.ts @@ -56,18 +56,20 @@ export function getFunctions( } /** - * Changes this instance to point to a Cloud Functions emulator running - * locally. See https://firebase.google.com/docs/functions/local-emulator + * Modify this instance to communicate with the Cloud Functions emulator. * - * @param origin - The origin of the local emulator, such as - * "http://localhost:5005". + * Note: this must be called before this instance has been used to do any operations. + * + * @param host The emulator host (ex: localhost) + * @param port The emulator port (ex: 5001) * @public */ export function useFunctionsEmulator( functionsInstance: Functions, - origin: string + host: string, + port: number ): void { - _useFunctionsEmulator(functionsInstance as FunctionsService, origin); + _useFunctionsEmulator(functionsInstance as FunctionsService, host, port); } /** diff --git a/packages-exp/functions-exp/src/service.test.ts b/packages-exp/functions-exp/src/service.test.ts index 9f518d29284..764e323ed03 100644 --- a/packages-exp/functions-exp/src/service.test.ts +++ b/packages-exp/functions-exp/src/service.test.ts @@ -41,7 +41,7 @@ describe('Firebase Functions > Service', () => { it('can use emulator', () => { service = createTestService(app); - useFunctionsEmulator(service, 'http://localhost:5005'); + useFunctionsEmulator(service, 'localhost', 5005); assert.equal( service._url('foo'), 'http://localhost:5005/my-project/us-central1/foo' @@ -58,7 +58,7 @@ describe('Firebase Functions > Service', () => { it('correctly sets region with emulator', () => { service = createTestService(app, 'my-region'); - useFunctionsEmulator(service, 'http://localhost:5005'); + useFunctionsEmulator(service, 'localhost', 5005); assert.equal( service._url('foo'), 'http://localhost:5005/my-project/my-region/foo' @@ -72,7 +72,7 @@ describe('Firebase Functions > Service', () => { it('prefers emulator to custom domain', () => { const service = createTestService(app, 'https://mydomain.com'); - useFunctionsEmulator(service, 'http://localhost:5005'); + useFunctionsEmulator(service, 'localhost', 5005); assert.equal( service._url('foo'), 'http://localhost:5005/my-project/us-central1/foo' diff --git a/packages-exp/functions-exp/src/service.ts b/packages-exp/functions-exp/src/service.ts index 30c557761a5..53cc07ade4d 100644 --- a/packages-exp/functions-exp/src/service.ts +++ b/packages-exp/functions-exp/src/service.ts @@ -133,18 +133,20 @@ export class FunctionsService implements _FirebaseService { } /** - * Changes this instance to point to a Cloud Functions emulator running - * locally. See https://firebase.google.com/docs/functions/local-emulator + * Modify this instance to communicate with the Cloud Functions emulator. * - * @param origin - The origin of the local emulator, such as - * "http://localhost:5005". + * Note: this must be called before this instance has been used to do any operations. + * + * @param host The emulator host (ex: localhost) + * @param port The emulator port (ex: 5001) * @public */ export function useFunctionsEmulator( functionsInstance: FunctionsService, - origin: string + host: string, + port: number ): void { - functionsInstance.emulatorOrigin = origin; + functionsInstance.emulatorOrigin = `http://${host}:${port}`; } /** diff --git a/packages-exp/functions-exp/test/utils.ts b/packages-exp/functions-exp/test/utils.ts index 659016c01df..f299c37f63b 100644 --- a/packages-exp/functions-exp/test/utils.ts +++ b/packages-exp/functions-exp/test/utils.ts @@ -64,10 +64,11 @@ export function createTestService( ); const useEmulator = !!process.env.FIREBASE_FUNCTIONS_EMULATOR_ORIGIN; if (useEmulator) { + const url = new URL(process.env.FIREBASE_FUNCTIONS_EMULATOR_ORIGIN!); useFunctionsEmulator( functions, - process.env.FIREBASE_FUNCTIONS_EMULATOR_ORIGIN! - ); + url.hostname, + Number.parseInt(url.port, 10)); } return functions; } diff --git a/packages/firebase/index.d.ts b/packages/firebase/index.d.ts index 97fa10dcc04..01e76372722 100644 --- a/packages/firebase/index.d.ts +++ b/packages/firebase/index.d.ts @@ -1799,10 +1799,22 @@ declare namespace firebase.functions { */ export class Functions { private constructor(); + + /** + * Modify this instance to communicate with the Cloud Functions emulator. + * + * Note: this must be called before this instance has been used to do any operations. + * + * @param host The emulator host (ex: localhost) + * @param port The emulator port (ex: 5001) + */ + useEmulator(host: string, port: number): void; + /** * Changes this instance to point to a Cloud Functions emulator running * locally. See https://firebase.google.com/docs/functions/local-emulator - * + * + * @deprecated Prefer the useEmulator(host, port) method. * @param origin The origin of the local emulator, such as * "http://localhost:5005". */ diff --git a/packages/functions-types/index.d.ts b/packages/functions-types/index.d.ts index 79152b8bc99..073821f8d52 100644 --- a/packages/functions-types/index.d.ts +++ b/packages/functions-types/index.d.ts @@ -53,10 +53,21 @@ export class FirebaseFunctions { */ httpsCallable(name: string, options?: HttpsCallableOptions): HttpsCallable; + /** + * Modify this instance to communicate with the Cloud Functions emulator. + * + * Note: this must be called before this instance has been used to do any operations. + * + * @param host The emulator host (ex: localhost) + * @param port The emulator port (ex: 5001) + */ + useEmulator(host: string, port: number): void; + /** * Changes this instance to point to a Cloud Functions emulator running * locally. See https://firebase.google.com/docs/functions/local-emulator * + * @deprecated Prefer the useEmulator(host, port) method. * @param origin The origin of the local emulator, such as * "http://localhost:5005". */ diff --git a/packages/functions/src/api/service.ts b/packages/functions/src/api/service.ts index 44b6a0cce30..9c386e604a9 100644 --- a/packages/functions/src/api/service.ts +++ b/packages/functions/src/api/service.ts @@ -150,10 +150,23 @@ export class Service implements FirebaseFunctions, FirebaseService { return `https://${this.region}-${projectId}.cloudfunctions.net/${name}`; } + /** + * Modify this instance to communicate with the Cloud Functions emulator. + * + * Note: this must be called before this instance has been used to do any operations. + * + * @param host The emulator host (ex: localhost) + * @param port The emulator port (ex: 5001) + */ + useEmulator(host: string, port: number): void { + this.emulatorOrigin = `http://${host}:${port}`; + } + /** * Changes this instance to point to a Cloud Functions emulator running * locally. See https://firebase.google.com/docs/functions/local-emulator * + * @deprecated Prefer the useEmulator(host, port) method. * @param origin The origin of the local emulator, such as * "http://localhost:5005". */ diff --git a/packages/functions/test/service.test.ts b/packages/functions/test/service.test.ts index d91d1b683b8..6704e34726d 100644 --- a/packages/functions/test/service.test.ts +++ b/packages/functions/test/service.test.ts @@ -33,13 +33,21 @@ describe('Firebase Functions > Service', () => { ); }); - it('can use emulator', () => { + it('can use emulator (deprecated)', () => { service.useFunctionsEmulator('http://localhost:5005'); assert.equal( service._url('foo'), 'http://localhost:5005/my-project/us-central1/foo' ); }); + + it('can use emulator', () => { + service.useEmulator('localhost', 5005); + assert.equal( + service._url('foo'), + 'http://localhost:5005/my-project/us-central1/foo' + ); + }); }); describe('custom region/domain constructor', () => { @@ -62,7 +70,7 @@ describe('Firebase Functions > Service', () => { assert.equal(service._url('foo'), 'https://mydomain.com/foo'); }); - it('prefers emulator to custom domain', () => { + it('prefers emulator to custom domain (deprecated)', () => { const service = createTestService(app, 'https://mydomain.com'); service.useFunctionsEmulator('http://localhost:5005'); assert.equal( @@ -70,5 +78,14 @@ describe('Firebase Functions > Service', () => { 'http://localhost:5005/my-project/us-central1/foo' ); }); + + it('prefers emulator to custom domain', () => { + const service = createTestService(app, 'https://mydomain.com'); + service.useEmulator('localhost', 5005); + assert.equal( + service._url('foo'), + 'http://localhost:5005/my-project/us-central1/foo' + ); + }); }); }); From 8f9e55992da312d249670901b9e267343ad496db Mon Sep 17 00:00:00 2001 From: Sam Horlbeck Olsen Date: Wed, 14 Oct 2020 13:14:42 -0700 Subject: [PATCH 002/624] Add assertion for emulator url scheme in auth (#3942) * Add assertion for emulator scheme * Formatting * PR feedback --- .../auth-exp/src/core/auth/auth_impl.test.ts | 16 ++++++++++++++++ packages-exp/auth-exp/src/core/auth/auth_impl.ts | 4 ++++ packages-exp/auth-exp/src/core/errors.ts | 3 +++ 3 files changed, 23 insertions(+) diff --git a/packages-exp/auth-exp/src/core/auth/auth_impl.test.ts b/packages-exp/auth-exp/src/core/auth/auth_impl.test.ts index b880e69a53e..6abacb74e54 100644 --- a/packages-exp/auth-exp/src/core/auth/auth_impl.test.ts +++ b/packages-exp/auth-exp/src/core/auth/auth_impl.test.ts @@ -489,6 +489,22 @@ describe('core/auth/auth_impl useEmulator', () => { expect(normalEndpoint.calls.length).to.eq(0); expect(emulatorEndpoint.calls.length).to.eq(1); }); + + it('checks the scheme properly', () => { + expect(() => auth.useEmulator('http://localhost:2020')).not.to.throw; + delete auth.config.emulator; + expect(() => auth.useEmulator('https://localhost:2020')).not.to.throw; + delete auth.config.emulator; + expect(() => auth.useEmulator('ssh://localhost:2020')).to.throw( + FirebaseError, + 'auth/invalid-emulator-scheme' + ); + delete auth.config.emulator; + expect(() => auth.useEmulator('localhost:2020')).to.throw( + FirebaseError, + 'auth/invalid-emulator-scheme' + ); + }); }); context('toJSON', () => { diff --git a/packages-exp/auth-exp/src/core/auth/auth_impl.ts b/packages-exp/auth-exp/src/core/auth/auth_impl.ts index 5c00cec7a8c..ea0389e2823 100644 --- a/packages-exp/auth-exp/src/core/auth/auth_impl.ts +++ b/packages-exp/auth-exp/src/core/auth/auth_impl.ts @@ -203,6 +203,10 @@ export class AuthImpl implements Auth, _FirebaseService { appName: this.name }); + assert(/^https?:\/\//.test(url), AuthErrorCode.INVALID_EMULATOR_SCHEME, { + appName: this.name + }); + this.config.emulator = { url }; this.settings.appVerificationDisabledForTesting = true; } diff --git a/packages-exp/auth-exp/src/core/errors.ts b/packages-exp/auth-exp/src/core/errors.ts index a48e5fc8de7..46f61e4ba61 100644 --- a/packages-exp/auth-exp/src/core/errors.ts +++ b/packages-exp/auth-exp/src/core/errors.ts @@ -56,6 +56,7 @@ export const enum AuthErrorCode { INVALID_CUSTOM_TOKEN = 'invalid-custom-token', INVALID_DYNAMIC_LINK_DOMAIN = 'invalid-dynamic-link-domain', INVALID_EMAIL = 'invalid-email', + INVALID_EMULATOR_SCHEME = 'invalid-emulator-scheme', INVALID_IDP_RESPONSE = 'invalid-credential', INVALID_MESSAGE_PAYLOAD = 'invalid-message-payload', INVALID_MFA_SESSION = 'invalid-multi-factor-session', @@ -189,6 +190,8 @@ const ERRORS: ErrorMap = { [AuthErrorCode.INVALID_DYNAMIC_LINK_DOMAIN]: 'The provided dynamic link domain is not configured or authorized for the current project.', [AuthErrorCode.INVALID_EMAIL]: 'The email address is badly formatted.', + [AuthErrorCode.INVALID_EMULATOR_SCHEME]: + 'Emulator URL must start with a valid scheme (http:// or https://).', [AuthErrorCode.INVALID_API_KEY]: 'Your API key is invalid, please check you have copied it correctly.', [AuthErrorCode.INVALID_CERT_HASH]: From add9d211deea37ffb700811fbba87ecef3f0df41 Mon Sep 17 00:00:00 2001 From: Sebastian Schmidt Date: Wed, 14 Oct 2020 14:49:32 -0700 Subject: [PATCH 003/624] Using async functions in Component initialization (#3929) --- packages/firestore/exp/src/api/components.ts | 87 +++++++++----------- 1 file changed, 40 insertions(+), 47 deletions(-) diff --git a/packages/firestore/exp/src/api/components.ts b/packages/firestore/exp/src/api/components.ts index 749cc390a46..b7c7e17983d 100644 --- a/packages/firestore/exp/src/api/components.ts +++ b/packages/firestore/exp/src/api/components.ts @@ -23,7 +23,6 @@ import { OnlineComponentProvider } from '../../../src/core/component_provider'; import { handleUserChange, LocalStore } from '../../../src/local/local_store'; -import { Deferred } from '../../../src/util/promise'; import { logDebug } from '../../../src/util/log'; import { RemoteStore, @@ -36,7 +35,8 @@ import { } from '../../../src/core/sync_engine'; import { Persistence } from '../../../src/local/persistence'; import { EventManager } from '../../../src/core/event_manager'; -export const LOG_TAG = 'ComponentProvider'; + +const LOG_TAG = 'ComponentProvider'; // The components module manages the lifetime of dependencies of the Firestore // client. Dependencies can be lazily constructed and only one exists per @@ -46,11 +46,11 @@ export const LOG_TAG = 'ComponentProvider'; // Firestore instance. const offlineComponentProviders = new Map< FirebaseFirestore, - Promise + OfflineComponentProvider >(); const onlineComponentProviders = new Map< FirebaseFirestore, - Promise + OnlineComponentProvider >(); export async function setOfflineComponentProvider( @@ -58,13 +58,10 @@ export async function setOfflineComponentProvider( persistenceSettings: PersistenceSettings, offlineComponentProvider: OfflineComponentProvider ): Promise { - const offlineDeferred = new Deferred(); - offlineComponentProviders.set(firestore, offlineDeferred.promise); - + logDebug(LOG_TAG, 'Initializing OfflineComponentProvider'); const configuration = await firestore._getConfiguration(); configuration.persistenceSettings = persistenceSettings; - logDebug(LOG_TAG, 'Initializing OfflineComponentProvider'); await offlineComponentProvider.initialize(configuration); firestore._setCredentialChangeListener(user => // TODO(firestorexp): This should be a retryable IndexedDB operation @@ -79,15 +76,15 @@ export async function setOfflineComponentProvider( offlineComponentProvider.persistence.setDatabaseDeletedListener(() => firestore._delete() ); - offlineDeferred.resolve(offlineComponentProvider); + + offlineComponentProviders.set(firestore, offlineComponentProvider); } export async function setOnlineComponentProvider( firestore: FirebaseFirestore, onlineComponentProvider: OnlineComponentProvider ): Promise { - const onlineDeferred = new Deferred(); - onlineComponentProviders.set(firestore, onlineDeferred.promise); + firestore._queue.verifyOperationInProgress(); const configuration = await firestore._getConfiguration(); const offlineComponentProvider = await getOfflineComponentProvider(firestore); @@ -108,86 +105,82 @@ export async function setOnlineComponentProvider( ) ) ); - onlineDeferred.resolve(onlineComponentProvider); + + onlineComponentProviders.set(firestore, onlineComponentProvider); } -function getOfflineComponentProvider( +async function getOfflineComponentProvider( firestore: FirebaseFirestore ): Promise { firestore._queue.verifyOperationInProgress(); if (!offlineComponentProviders.has(firestore)) { logDebug(LOG_TAG, 'Using default OfflineComponentProvider'); - // eslint-disable-next-line @typescript-eslint/no-floating-promises - setOfflineComponentProvider( + await setOfflineComponentProvider( firestore, { durable: false }, new MemoryOfflineComponentProvider() ); } + return offlineComponentProviders.get(firestore)!; } -function getOnlineComponentProvider( +async function getOnlineComponentProvider( firestore: FirebaseFirestore ): Promise { firestore._queue.verifyOperationInProgress(); if (!onlineComponentProviders.has(firestore)) { logDebug(LOG_TAG, 'Using default OnlineComponentProvider'); - // eslint-disable-next-line @typescript-eslint/no-floating-promises - setOnlineComponentProvider(firestore, new OnlineComponentProvider()); + await setOnlineComponentProvider(firestore, new OnlineComponentProvider()); } + return onlineComponentProviders.get(firestore)!; } -// Note: These functions cannot be `async` since we want to throw an exception -// when Firestore is terminated (via `getOnlineComponentProvider()`). - -export function getSyncEngine( +export async function getSyncEngine( firestore: FirebaseFirestore ): Promise { - return getOnlineComponentProvider(firestore).then( - components => components.syncEngine - ); + const onlineComponentProvider = await getOnlineComponentProvider(firestore); + return onlineComponentProvider.syncEngine; } -export function getRemoteStore( +export async function getRemoteStore( firestore: FirebaseFirestore ): Promise { - return getOnlineComponentProvider(firestore).then( - components => components.remoteStore - ); + const onlineComponentProvider = await getOnlineComponentProvider(firestore); + return onlineComponentProvider.remoteStore; } -export function getEventManager( +export async function getEventManager( firestore: FirebaseFirestore ): Promise { - return getOnlineComponentProvider(firestore).then(components => { - const eventManager = components.eventManager; - eventManager.onListen = syncEngineListen.bind(null, components.syncEngine); - eventManager.onUnlisten = syncEngineUnlisten.bind( - null, - components.syncEngine - ); - return eventManager; - }); + const onlineComponentProvider = await getOnlineComponentProvider(firestore); + const eventManager = onlineComponentProvider.eventManager; + eventManager.onListen = syncEngineListen.bind( + null, + onlineComponentProvider.syncEngine + ); + eventManager.onUnlisten = syncEngineUnlisten.bind( + null, + onlineComponentProvider.syncEngine + ); + return eventManager; } -export function getPersistence( +export async function getPersistence( firestore: FirebaseFirestore ): Promise { - return getOfflineComponentProvider(firestore).then( - components => components.persistence - ); + const offlineComponentProvider = await getOfflineComponentProvider(firestore); + return offlineComponentProvider.persistence; } -export function getLocalStore( +export async function getLocalStore( firestore: FirebaseFirestore ): Promise { - return getOfflineComponentProvider(firestore).then( - provider => provider.localStore - ); + const offlineComponentProvider = await getOfflineComponentProvider(firestore); + return offlineComponentProvider.localStore; } /** From 2c1764dce62da24948a388e7428c2f066d42369b Mon Sep 17 00:00:00 2001 From: Alex Volkovitsky Date: Wed, 14 Oct 2020 16:28:08 -0700 Subject: [PATCH 004/624] Add documentation for auth@next (#3938) * Add documentation for auth@next * Update packages-exp/auth-types-exp/index.d.ts Co-authored-by: Sam Horlbeck Olsen * Update packages-exp/auth-types-exp/index.d.ts Co-authored-by: Sam Horlbeck Olsen * Update packages-exp/auth-types-exp/index.d.ts Co-authored-by: Sam Horlbeck Olsen * Update packages-exp/auth-types-exp/index.d.ts Co-authored-by: Sam Horlbeck Olsen * Update packages-exp/auth-types-exp/index.d.ts Co-authored-by: Sam Horlbeck Olsen * Update packages-exp/auth-types-exp/index.d.ts Co-authored-by: Sam Horlbeck Olsen * Update packages-exp/auth-types-exp/index.d.ts Co-authored-by: Sam Horlbeck Olsen * Update packages-exp/auth-types-exp/index.d.ts Co-authored-by: Sam Horlbeck Olsen * Update packages-exp/auth-types-exp/index.d.ts Co-authored-by: Sam Horlbeck Olsen * Update packages-exp/auth-types-exp/index.d.ts Co-authored-by: Sam Horlbeck Olsen * Update packages-exp/auth-types-exp/index.d.ts Co-authored-by: Sam Horlbeck Olsen * Update packages-exp/auth-types-exp/index.d.ts Co-authored-by: Sam Horlbeck Olsen * Update packages-exp/auth-types-exp/index.d.ts Co-authored-by: Sam Horlbeck Olsen * PR Feedback * More docs + PR feedback * Fix typo and remove stray hyphen * One more pass of feedback Co-authored-by: Sam Horlbeck Olsen --- common/api-review/auth-types-exp.api.md | 147 +-- docs-exp/auth-types.actioncodeinfo.data.md | 8 + docs-exp/auth-types.actioncodeinfo.md | 6 +- .../auth-types.actioncodeinfo.operation.md | 2 + .../auth-types.actioncodesettings.android.md | 2 + ...es.actioncodesettings.dynamiclinkdomain.md | 2 + ...ypes.actioncodesettings.handlecodeinapp.md | 2 + docs-exp/auth-types.actioncodesettings.ios.md | 4 + docs-exp/auth-types.actioncodesettings.md | 12 +- docs-exp/auth-types.actioncodesettings.url.md | 2 + ...auth-types.additionaluserinfo.isnewuser.md | 2 + docs-exp/auth-types.additionaluserinfo.md | 10 +- .../auth-types.additionaluserinfo.profile.md | 2 + ...uth-types.additionaluserinfo.providerid.md | 2 + .../auth-types.additionaluserinfo.username.md | 2 + docs-exp/auth-types.applicationverifier.md | 6 +- .../auth-types.applicationverifier.type.md | 2 + .../auth-types.applicationverifier.verify.md | 4 + docs-exp/auth-types.auth.config.md | 2 + docs-exp/auth-types.auth.currentuser.md | 2 + docs-exp/auth-types.auth.languagecode.md | 2 + docs-exp/auth-types.auth.md | 30 +- docs-exp/auth-types.auth.name.md | 2 + .../auth-types.auth.onauthstatechanged.md | 10 +- docs-exp/auth-types.auth.onidtokenchanged.md | 8 +- docs-exp/auth-types.auth.setpersistence.md | 14 +- docs-exp/auth-types.auth.settings.md | 2 + docs-exp/auth-types.auth.signout.md | 2 + docs-exp/auth-types.auth.tenantid.md | 16 + docs-exp/auth-types.auth.updatecurrentuser.md | 8 +- docs-exp/auth-types.auth.usedevicelanguage.md | 2 + docs-exp/auth-types.auth.useemulator.md | 4 +- .../auth-types.authcredential.fromjson.md | 6 +- docs-exp/auth-types.authcredential.md | 10 +- .../auth-types.authcredential.providerid.md | 2 + .../auth-types.authcredential.signinmethod.md | 2 + docs-exp/auth-types.authcredential.tojson.md | 4 + docs-exp/auth-types.autherror.appname.md | 2 + docs-exp/auth-types.autherror.email.md | 2 + docs-exp/auth-types.autherror.md | 9 +- docs-exp/auth-types.autherror.phonenumber.md | 2 + docs-exp/auth-types.autherror.tenantid.md | 2 + docs-exp/auth-types.authprovider.md | 6 +- .../auth-types.authprovider.providerid.md | 2 + ...tings.appverificationdisabledfortesting.md | 6 + docs-exp/auth-types.authsettings.md | 4 +- docs-exp/auth-types.config.apihost.md | 2 + docs-exp/auth-types.config.apikey.md | 2 + docs-exp/auth-types.config.apischeme.md | 2 + docs-exp/auth-types.config.authdomain.md | 2 + docs-exp/auth-types.config.md | 14 +- .../auth-types.config.sdkclientversion.md | 2 + docs-exp/auth-types.config.tokenapihost.md | 2 + .../auth-types.confirmationresult.confirm.md | 14 +- docs-exp/auth-types.confirmationresult.md | 6 +- ...types.confirmationresult.verificationid.md | 2 + ...auth-types.emailauthprovider.credential.md | 25 +- ...es.emailauthprovider.credentialwithlink.md | 29 +- ...lauthprovider.email_link_sign_in_method.md | 2 + ...hprovider.email_password_sign_in_method.md | 2 + docs-exp/auth-types.emailauthprovider.md | 16 +- ...uth-types.emailauthprovider.provider_id.md | 2 + ...auth-types.emailauthprovider.providerid.md | 2 + docs-exp/auth-types.idtokenresult.authtime.md | 2 + docs-exp/auth-types.idtokenresult.claims.md | 2 + ...auth-types.idtokenresult.expirationtime.md | 2 + .../auth-types.idtokenresult.issuedattime.md | 2 + docs-exp/auth-types.idtokenresult.md | 18 +- ...auth-types.idtokenresult.signinprovider.md | 2 + ...-types.idtokenresult.signinsecondfactor.md | 2 + docs-exp/auth-types.idtokenresult.token.md | 2 + docs-exp/auth-types.md | 86 +- ...uth-types.multifactorassertion.factorid.md | 2 + docs-exp/auth-types.multifactorassertion.md | 4 +- .../auth-types.multifactorerror.credential.md | 2 + docs-exp/auth-types.multifactorerror.md | 32 +- ...th-types.multifactorerror.operationtype.md | 2 + .../auth-types.multifactorinfo.displayname.md | 2 + ...th-types.multifactorinfo.enrollmenttime.md | 2 + .../auth-types.multifactorinfo.factorid.md | 2 + docs-exp/auth-types.multifactorinfo.md | 10 +- docs-exp/auth-types.multifactorinfo.uid.md | 2 + .../auth-types.multifactorresolver.hints.md | 2 + docs-exp/auth-types.multifactorresolver.md | 51 +- ...types.multifactorresolver.resolvesignin.md | 16 +- .../auth-types.multifactorresolver.session.md | 2 + docs-exp/auth-types.multifactorsession.md | 2 +- docs-exp/auth-types.multifactoruser.enroll.md | 29 +- ...h-types.multifactoruser.enrolledfactors.md | 2 + .../auth-types.multifactoruser.getsession.md | 26 + docs-exp/auth-types.multifactoruser.md | 10 +- .../auth-types.multifactoruser.unenroll.md | 16 +- docs-exp/auth-types.nextorobserver.md | 2 +- .../auth-types.oauthcredential.accesstoken.md | 2 + .../auth-types.oauthcredential.fromjson.md | 6 +- .../auth-types.oauthcredential.idtoken.md | 2 + docs-exp/auth-types.oauthcredential.md | 10 +- docs-exp/auth-types.oauthcredential.secret.md | 2 + docs-exp/auth-types.operation.md | 14 +- docs-exp/auth-types.operationtype.md | 8 +- docs-exp/auth-types.parsedtoken.auth_time.md | 2 + docs-exp/auth-types.parsedtoken.exp.md | 2 + docs-exp/auth-types.parsedtoken.firebase.md | 2 + docs-exp/auth-types.parsedtoken.iat.md | 2 + docs-exp/auth-types.parsedtoken.md | 14 +- docs-exp/auth-types.parsedtoken.sub.md | 2 + docs-exp/auth-types.persistence.md | 4 +- docs-exp/auth-types.persistence.type.md | 2 + ...auth-types.phoneauthcredential.fromjson.md | 2 + docs-exp/auth-types.phoneauthcredential.md | 4 +- ...h-types.phoneauthprovider._constructor_.md | 2 +- ...auth-types.phoneauthprovider.credential.md | 31 +- docs-exp/auth-types.phoneauthprovider.md | 28 +- ....phoneauthprovider.phone_sign_in_method.md | 2 + ...uth-types.phoneauthprovider.provider_id.md | 2 + ...auth-types.phoneauthprovider.providerid.md | 2 + ...pes.phoneauthprovider.verifyphonenumber.md | 31 +- docs-exp/auth-types.phoneinfooptions.md | 2 +- .../auth-types.phonemultifactorassertion.md | 2 +- ...types.phonemultifactorenrollinfooptions.md | 6 +- ...ultifactorenrollinfooptions.phonenumber.md | 2 + ...onemultifactorenrollinfooptions.session.md | 2 + ...pes.phonemultifactorgenerator.assertion.md | 6 +- ...pes.phonemultifactorgenerator.factor_id.md | 2 + .../auth-types.phonemultifactorgenerator.md | 6 +- ...types.phonemultifactorsignininfooptions.md | 8 +- ...factorsignininfooptions.multifactorhint.md | 4 + ...ifactorsignininfooptions.multifactoruid.md | 4 + ...onemultifactorsignininfooptions.session.md | 2 + ...auth-types.phonesinglefactorinfooptions.md | 4 +- ...honesinglefactorinfooptions.phonenumber.md | 2 + docs-exp/auth-types.popupredirectresolver.md | 2 +- docs-exp/auth-types.providerid.md | 2 +- ...h-types.reactnativeasyncstorage.getitem.md | 4 +- .../auth-types.reactnativeasyncstorage.md | 8 +- ...ypes.reactnativeasyncstorage.removeitem.md | 4 +- ...h-types.reactnativeasyncstorage.setitem.md | 6 +- .../auth-types.recaptchaverifier.clear.md | 2 + docs-exp/auth-types.recaptchaverifier.md | 10 +- .../auth-types.recaptchaverifier.render.md | 4 + docs-exp/auth-types.recaptchaverifier.type.md | 2 + .../auth-types.recaptchaverifier.verify.md | 4 + docs-exp/auth-types.signinmethod.md | 2 +- docs-exp/auth-types.user.delete.md | 4 + docs-exp/auth-types.user.emailverified.md | 2 + docs-exp/auth-types.user.getidtoken.md | 6 +- docs-exp/auth-types.user.getidtokenresult.md | 6 +- docs-exp/auth-types.user.isanonymous.md | 2 + docs-exp/auth-types.user.md | 24 +- docs-exp/auth-types.user.metadata.md | 2 + docs-exp/auth-types.user.providerdata.md | 2 + docs-exp/auth-types.user.refreshtoken.md | 2 + docs-exp/auth-types.user.reload.md | 2 + docs-exp/auth-types.user.tenantid.md | 16 + docs-exp/auth-types.user.tojson.md | 4 + docs-exp/auth-types.usercredential.md | 8 +- ...auth-types.usercredential.operationtype.md | 2 + .../auth-types.usercredential.providerid.md | 2 + docs-exp/auth-types.usercredential.user.md | 2 + docs-exp/auth-types.userinfo.displayname.md | 2 + docs-exp/auth-types.userinfo.email.md | 2 + docs-exp/auth-types.userinfo.md | 14 +- docs-exp/auth-types.userinfo.phonenumber.md | 2 + docs-exp/auth-types.userinfo.photourl.md | 2 + docs-exp/auth-types.userinfo.providerid.md | 2 + docs-exp/auth-types.userinfo.uid.md | 2 + .../auth-types.usermetadata.creationtime.md | 2 + .../auth-types.usermetadata.lastsignintime.md | 2 + docs-exp/auth-types.usermetadata.md | 6 +- docs-exp/auth-types.userprofile.md | 2 +- packages-exp/auth-types-exp/index.d.ts | 989 +++++++++++++++++- 171 files changed, 1785 insertions(+), 450 deletions(-) diff --git a/common/api-review/auth-types-exp.api.md b/common/api-review/auth-types-exp.api.md index 8b8efb4585a..ea4cc5cbe18 100644 --- a/common/api-review/auth-types-exp.api.md +++ b/common/api-review/auth-types-exp.api.md @@ -13,33 +13,26 @@ import { Unsubscribe } from '@firebase/util'; // @public export interface ActionCodeInfo { - // (undocumented) data: { email?: string | null; multiFactorInfo?: MultiFactorInfo | null; previousEmail?: string | null; }; - // (undocumented) operation: Operation; } // @public export interface ActionCodeSettings { - // (undocumented) android?: { installApp?: boolean; minimumVersion?: string; packageName: string; }; - // (undocumented) dynamicLinkDomain?: string; - // (undocumented) handleCodeInApp?: boolean; - // (undocumented) iOS?: { bundleId: string; }; - // (undocumented) url: string; } @@ -56,199 +49,136 @@ export abstract class ActionCodeURL { // @public export interface AdditionalUserInfo { - // (undocumented) readonly isNewUser: boolean; - // (undocumented) readonly profile: UserProfile | null; - // (undocumented) readonly providerId: ProviderId | null; - // (undocumented) readonly username?: string | null; } // @public export interface ApplicationVerifier { - // (undocumented) readonly type: string; - // (undocumented) verify(): Promise; } // @public export interface Auth { - // (undocumented) readonly config: Config; - // (undocumented) readonly currentUser: User | null; - // (undocumented) languageCode: string | null; - // (undocumented) readonly name: string; - // (undocumented) onAuthStateChanged( nextOrObserver: NextOrObserver, error?: ErrorFn, completed?: CompleteFn ): Unsubscribe; - // (undocumented) onIdTokenChanged( nextOrObserver: NextOrObserver, error?: ErrorFn, completed?: CompleteFn ): Unsubscribe; - // (undocumented) setPersistence(persistence: Persistence): void; - // (undocumented) readonly settings: AuthSettings; - // (undocumented) signOut(): Promise; - // (undocumented) tenantId: string | null; - // (undocumented) updateCurrentUser(user: User | null): Promise; - // (undocumented) useDeviceLanguage(): void; - // (undocumented) useEmulator(url: string): void; } // @public export abstract class AuthCredential { - // (undocumented) static fromJSON(json: object | string): AuthCredential | null; - // (undocumented) readonly providerId: string; - // (undocumented) readonly signInMethod: string; - // (undocumented) toJSON(): object; } -// @public +// @public (undocumented) export interface AuthError extends FirebaseError { - // (undocumented) readonly appName: string; - - // (undocumented) readonly email?: string; - - // (undocumented) readonly phoneNumber?: string; - - // (undocumented) readonly tenantid?: string; } // @public export interface AuthProvider { - // (undocumented) readonly providerId: string; } // @public export interface AuthSettings { - // (undocumented) appVerificationDisabledForTesting: boolean; } // @public export interface Config { - // (undocumented) apiHost: string; - // (undocumented) apiKey: string; - // (undocumented) apiScheme: string; - // (undocumented) authDomain?: string; - // (undocumented) sdkClientVersion: string; - // (undocumented) tokenApiHost: string; } // @public export interface ConfirmationResult { - // (undocumented) confirm(verificationCode: string): Promise; - // (undocumented) readonly verificationId: string; } // @public export abstract class EmailAuthProvider implements AuthProvider { - // (undocumented) static credential(email: string, password: string): AuthCredential; - // (undocumented) static credentialWithLink( auth: Auth, email: string, emailLink: string ): AuthCredential; - // (undocumented) static readonly EMAIL_LINK_SIGN_IN_METHOD: SignInMethod; - // (undocumented) static readonly EMAIL_PASSWORD_SIGN_IN_METHOD: SignInMethod; - // (undocumented) static readonly PROVIDER_ID: ProviderId; - // (undocumented) readonly providerId: ProviderId; } // @public export interface IdTokenResult { - // (undocumented) authTime: string; - // (undocumented) claims: ParsedToken; - // (undocumented) expirationTime: string; - // (undocumented) issuedAtTime: string; - // (undocumented) signInProvider: string | null; - // (undocumented) signInSecondFactor: string | null; - // (undocumented) token: string; } // @public export interface MultiFactorAssertion { - // (undocumented) readonly factorId: string; } // @public export interface MultiFactorError extends AuthError { - // (undocumented) readonly credential: AuthCredential; - // (undocumented) readonly operationType: OperationType; } // @public export interface MultiFactorInfo { - // (undocumented) readonly displayName?: string | null; - // (undocumented) readonly enrollmentTime: string; - // (undocumented) readonly factorId: ProviderId; - // (undocumented) readonly uid: string; } // @public export abstract class MultiFactorResolver { - // (undocumented) hints: MultiFactorInfo[]; - // (undocumented) resolveSignIn(assertion: MultiFactorAssertion): Promise; - // (undocumented) session: MultiFactorSession; } @@ -257,16 +187,12 @@ export interface MultiFactorSession {} // @public export interface MultiFactorUser { - // (undocumented) enroll( assertion: MultiFactorAssertion, displayName?: string | null ): Promise; - // (undocumented) readonly enrolledFactors: MultiFactorInfo[]; - // (undocumented) getSession(): Promise; - // (undocumented) unenroll(option: MultiFactorInfo | string): Promise; } @@ -275,91 +201,65 @@ export type NextOrObserver = NextFn | Observer; // @public export abstract class OAuthCredential extends AuthCredential { - // (undocumented) readonly accessToken?: string; - // (undocumented) static fromJSON(json: object | string): OAuthCredential | null; - // (undocumented) readonly idToken?: string; - // (undocumented) readonly secret?: string; } // @public export const enum Operation { - // (undocumented) EMAIL_SIGNIN = 'EMAIL_SIGNIN', - // (undocumented) PASSWORD_RESET = 'PASSWORD_RESET', - // (undocumented) RECOVER_EMAIL = 'RECOVER_EMAIL', - // (undocumented) REVERT_SECOND_FACTOR_ADDITION = 'REVERT_SECOND_FACTOR_ADDITION', - // (undocumented) VERIFY_AND_CHANGE_EMAIL = 'VERIFY_AND_CHANGE_EMAIL', - // (undocumented) VERIFY_EMAIL = 'VERIFY_EMAIL' } // @public export const enum OperationType { - // (undocumented) LINK = 'link', - // (undocumented) REAUTHENTICATE = 'reauthenticate', - // (undocumented) SIGN_IN = 'signIn' } // @public export interface ParsedToken { - // (undocumented) [key: string]: string | object | undefined; - // (undocumented) 'auth_time'?: string; - // (undocumented) 'exp'?: string; - // (undocumented) 'firebase'?: { 'sign_in_provider'?: string; 'sign_in_second_factor'?: string; }; - // (undocumented) 'iat'?: string; - // (undocumented) 'sub'?: string; } // @public export interface Persistence { - // (undocumented) readonly type: 'SESSION' | 'LOCAL' | 'NONE'; } // @public export abstract class PhoneAuthCredential extends AuthCredential { - // (undocumented) static fromJSON(json: object | string): PhoneAuthCredential | null; } // @public export class PhoneAuthProvider implements AuthProvider { constructor(auth?: Auth | null); - // (undocumented) static credential( verificationId: string, verificationCode: string ): AuthCredential; - // (undocumented) static readonly PHONE_SIGN_IN_METHOD: SignInMethod; - // (undocumented) static readonly PROVIDER_ID: ProviderId; - // (undocumented) readonly providerId: ProviderId; - // (undocumented) verifyPhoneNumber( phoneInfoOptions: PhoneInfoOptions | string, applicationVerifier: ApplicationVerifier @@ -375,37 +275,29 @@ export type PhoneInfoOptions = // @public export interface PhoneMultiFactorAssertion extends MultiFactorAssertion {} -// @public (undocumented) +// @public export interface PhoneMultiFactorEnrollInfoOptions { - // (undocumented) phoneNumber: string; - // (undocumented) session: MultiFactorSession; } // @public export abstract class PhoneMultiFactorGenerator { - // (undocumented) static assertion( phoneAuthCredential: PhoneAuthCredential ): PhoneMultiFactorAssertion; - // (undocumented) static FACTOR_ID: ProviderId; } -// @public (undocumented) +// @public export interface PhoneMultiFactorSignInInfoOptions { - // (undocumented) multiFactorHint?: MultiFactorInfo; - // (undocumented) multiFactorUid?: string; - // (undocumented) session: MultiFactorSession; } -// @public (undocumented) +// @public export interface PhoneSingleFactorInfoOptions { - // (undocumented) phoneNumber: string; } @@ -434,13 +326,10 @@ export const enum ProviderId { TWITTER = 'twitter.com' } -// @public (undocumented) +// @public export interface ReactNativeAsyncStorage { - // (undocumented) getItem(key: string): Promise; - // (undocumented) removeItem(key: string): Promise; - // (undocumented) setItem(key: string, value: string): Promise; } @@ -451,13 +340,9 @@ export abstract class RecaptchaVerifier implements ApplicationVerifier { parameters?: Object | null, auth?: Auth | null ); - // (undocumented) clear(): void; - // (undocumented) render(): Promise; - // (undocumented) readonly type: string; - // (undocumented) verify(): Promise; } @@ -483,61 +368,39 @@ export const enum SignInMethod { // @public export interface User extends UserInfo { - // (undocumented) delete(): Promise; - // (undocumented) readonly emailVerified: boolean; - // (undocumented) getIdToken(forceRefresh?: boolean): Promise; - // (undocumented) getIdTokenResult(forceRefresh?: boolean): Promise; - // (undocumented) readonly isAnonymous: boolean; - // (undocumented) readonly metadata: UserMetadata; - // (undocumented) readonly providerData: UserInfo[]; - // (undocumented) readonly refreshToken: string; - // (undocumented) reload(): Promise; - // (undocumented) readonly tenantId: string | null; - // (undocumented) toJSON(): object; } // @public export interface UserCredential { - // (undocumented) operationType: OperationType; - // (undocumented) providerId: ProviderId | null; - // (undocumented) user: User; } // @public export interface UserInfo { - // (undocumented) readonly displayName: string | null; - // (undocumented) readonly email: string | null; - // (undocumented) readonly phoneNumber: string | null; - // (undocumented) readonly photoURL: string | null; - // (undocumented) readonly providerId: string; - // (undocumented) readonly uid: string; } // @public export interface UserMetadata { - // (undocumented) readonly creationTime?: string; - // (undocumented) readonly lastSignInTime?: string; } diff --git a/docs-exp/auth-types.actioncodeinfo.data.md b/docs-exp/auth-types.actioncodeinfo.data.md index fcb46b989bb..36b056bafbb 100644 --- a/docs-exp/auth-types.actioncodeinfo.data.md +++ b/docs-exp/auth-types.actioncodeinfo.data.md @@ -4,6 +4,14 @@ ## ActionCodeInfo.data property +The data associated with the action code. For the [Operation.PASSWORD\_RESET](./auth-types.operation.password_reset.md), [Operation.VERIFY\_EMAIL](./auth-types.operation.verify_email.md), and [Operation.RECOVER\_EMAIL](./auth-types.operation.recover_email.md) actions, this object contains an email field with the address the email was sent to. + +For the [Operation.RECOVER\_EMAIL](./auth-types.operation.recover_email.md) action, which allows a user to undo an email address change, this object also contains a `previousEmail` field with the user account's current email address. After the action completes, the user's email address will revert to the value in the `email` field from the value in `previousEmail` field. + +For the [Operation.VERIFY\_AND\_CHANGE\_EMAIL](./auth-types.operation.verify_and_change_email.md) action, which allows a user to verify the email before updating it, this object contains a `previousEmail` field with the user account's email address before updating. After the action completes, the user's email address will be updated to the value in the `email` field from the value in `previousEmail` field. + +For the [Operation.REVERT\_SECOND\_FACTOR\_ADDITION](./auth-types.operation.revert_second_factor_addition.md) action, which allows a user to unenroll a newly added second factor, this object contains a `multiFactorInfo` field with the information about the second factor. For phone second factor, the `multiFactorInfo` is a [MultiFactorInfo](./auth-types.multifactorinfo.md) object, which contains the phone number. + Signature: ```typescript diff --git a/docs-exp/auth-types.actioncodeinfo.md b/docs-exp/auth-types.actioncodeinfo.md index 2c94067f213..5fb1ee74f22 100644 --- a/docs-exp/auth-types.actioncodeinfo.md +++ b/docs-exp/auth-types.actioncodeinfo.md @@ -4,7 +4,7 @@ ## ActionCodeInfo interface -https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeInfo +A response from `checkActionCode`. Signature: @@ -16,6 +16,6 @@ export interface ActionCodeInfo | Property | Type | Description | | --- | --- | --- | -| [data](./auth-types.actioncodeinfo.data.md) | { email?: string \| null; multiFactorInfo?: [MultiFactorInfo](./auth-types.multifactorinfo.md) \| null; previousEmail?: string \| null; } | | -| [operation](./auth-types.actioncodeinfo.operation.md) | [Operation](./auth-types.operation.md) | | +| [data](./auth-types.actioncodeinfo.data.md) | { email?: string \| null; multiFactorInfo?: [MultiFactorInfo](./auth-types.multifactorinfo.md) \| null; previousEmail?: string \| null; } | The data associated with the action code. For the [Operation.PASSWORD\_RESET](./auth-types.operation.password_reset.md), [Operation.VERIFY\_EMAIL](./auth-types.operation.verify_email.md), and [Operation.RECOVER\_EMAIL](./auth-types.operation.recover_email.md) actions, this object contains an email field with the address the email was sent to.For the [Operation.RECOVER\_EMAIL](./auth-types.operation.recover_email.md) action, which allows a user to undo an email address change, this object also contains a previousEmail field with the user account's current email address. After the action completes, the user's email address will revert to the value in the email field from the value in previousEmail field.For the [Operation.VERIFY\_AND\_CHANGE\_EMAIL](./auth-types.operation.verify_and_change_email.md) action, which allows a user to verify the email before updating it, this object contains a previousEmail field with the user account's email address before updating. After the action completes, the user's email address will be updated to the value in the email field from the value in previousEmail field.For the [Operation.REVERT\_SECOND\_FACTOR\_ADDITION](./auth-types.operation.revert_second_factor_addition.md) action, which allows a user to unenroll a newly added second factor, this object contains a multiFactorInfo field with the information about the second factor. For phone second factor, the multiFactorInfo is a [MultiFactorInfo](./auth-types.multifactorinfo.md) object, which contains the phone number. | +| [operation](./auth-types.actioncodeinfo.operation.md) | [Operation](./auth-types.operation.md) | The type of operation that generated the action code. | diff --git a/docs-exp/auth-types.actioncodeinfo.operation.md b/docs-exp/auth-types.actioncodeinfo.operation.md index 107a974d87a..dfc9fb485f6 100644 --- a/docs-exp/auth-types.actioncodeinfo.operation.md +++ b/docs-exp/auth-types.actioncodeinfo.operation.md @@ -4,6 +4,8 @@ ## ActionCodeInfo.operation property +The type of operation that generated the action code. + Signature: ```typescript diff --git a/docs-exp/auth-types.actioncodesettings.android.md b/docs-exp/auth-types.actioncodesettings.android.md index 3f2fb765245..e275039ca3b 100644 --- a/docs-exp/auth-types.actioncodesettings.android.md +++ b/docs-exp/auth-types.actioncodesettings.android.md @@ -4,6 +4,8 @@ ## ActionCodeSettings.android property +Sets the Android package name. This will try to open the link in an android app if it is installed. If `installApp` is passed, it specifies whether to install the Android app if the device supports it and the app is not already installed. If this field is provided without a `packageName`, an error is thrown explaining that the `packageName` must be provided in conjunction with this field. If `minimumVersion` is specified, and an older version of the app is installed, the user is taken to the Play Store to upgrade the app. + Signature: ```typescript diff --git a/docs-exp/auth-types.actioncodesettings.dynamiclinkdomain.md b/docs-exp/auth-types.actioncodesettings.dynamiclinkdomain.md index b99eda2a742..31a23fdd59e 100644 --- a/docs-exp/auth-types.actioncodesettings.dynamiclinkdomain.md +++ b/docs-exp/auth-types.actioncodesettings.dynamiclinkdomain.md @@ -4,6 +4,8 @@ ## ActionCodeSettings.dynamicLinkDomain property +When multiple custom dynamic link domains are defined for a project, specify which one to use when the link is to be opened via a specified mobile app (for example, `example.page.link`). Otherwise the first domain is automatically selected. + Signature: ```typescript diff --git a/docs-exp/auth-types.actioncodesettings.handlecodeinapp.md b/docs-exp/auth-types.actioncodesettings.handlecodeinapp.md index 44f86269269..b4b6277429e 100644 --- a/docs-exp/auth-types.actioncodesettings.handlecodeinapp.md +++ b/docs-exp/auth-types.actioncodesettings.handlecodeinapp.md @@ -4,6 +4,8 @@ ## ActionCodeSettings.handleCodeInApp property +The default is false. When set to true, the action code link will be be sent as a Universal Link or Android App Link and will be opened by the app if installed. In the false case, the code will be sent to the web widget first and then on continue will redirect to the app if installed. + Signature: ```typescript diff --git a/docs-exp/auth-types.actioncodesettings.ios.md b/docs-exp/auth-types.actioncodesettings.ios.md index fd66f5e5485..e5ab5a0da60 100644 --- a/docs-exp/auth-types.actioncodesettings.ios.md +++ b/docs-exp/auth-types.actioncodesettings.ios.md @@ -4,6 +4,10 @@ ## ActionCodeSettings.iOS property +Sets the iOS bundle ID. This will try to open the link in an iOS app if it is installed. + +App installation is not supported for iOS. + Signature: ```typescript diff --git a/docs-exp/auth-types.actioncodesettings.md b/docs-exp/auth-types.actioncodesettings.md index 3a3c1455397..4677ad18086 100644 --- a/docs-exp/auth-types.actioncodesettings.md +++ b/docs-exp/auth-types.actioncodesettings.md @@ -4,7 +4,7 @@ ## ActionCodeSettings interface -https://firebase.google.com/docs/reference/js/firebase.auth\#actioncodesettings +This is the interface that defines the required continue/state URL with optional Android and iOS bundle identifiers. Signature: @@ -16,9 +16,9 @@ export interface ActionCodeSettings | Property | Type | Description | | --- | --- | --- | -| [android](./auth-types.actioncodesettings.android.md) | { installApp?: boolean; minimumVersion?: string; packageName: string; } | | -| [dynamicLinkDomain](./auth-types.actioncodesettings.dynamiclinkdomain.md) | string | | -| [handleCodeInApp](./auth-types.actioncodesettings.handlecodeinapp.md) | boolean | | -| [iOS](./auth-types.actioncodesettings.ios.md) | { bundleId: string; } | | -| [url](./auth-types.actioncodesettings.url.md) | string | | +| [android](./auth-types.actioncodesettings.android.md) | { installApp?: boolean; minimumVersion?: string; packageName: string; } | Sets the Android package name. This will try to open the link in an android app if it is installed. If installApp is passed, it specifies whether to install the Android app if the device supports it and the app is not already installed. If this field is provided without a packageName, an error is thrown explaining that the packageName must be provided in conjunction with this field. If minimumVersion is specified, and an older version of the app is installed, the user is taken to the Play Store to upgrade the app. | +| [dynamicLinkDomain](./auth-types.actioncodesettings.dynamiclinkdomain.md) | string | When multiple custom dynamic link domains are defined for a project, specify which one to use when the link is to be opened via a specified mobile app (for example, example.page.link). Otherwise the first domain is automatically selected. | +| [handleCodeInApp](./auth-types.actioncodesettings.handlecodeinapp.md) | boolean | The default is false. When set to true, the action code link will be be sent as a Universal Link or Android App Link and will be opened by the app if installed. In the false case, the code will be sent to the web widget first and then on continue will redirect to the app if installed. | +| [iOS](./auth-types.actioncodesettings.ios.md) | { bundleId: string; } | Sets the iOS bundle ID. This will try to open the link in an iOS app if it is installed.App installation is not supported for iOS. | +| [url](./auth-types.actioncodesettings.url.md) | string | Sets the link continue/state URL, which has different meanings in different contexts: - When the link is handled in the web action widgets, this is the deep link in the continueUrl query parameter. - When the link is handled in the app directly, this is the continueUrl query parameter in the deep link of the Dynamic Link. | diff --git a/docs-exp/auth-types.actioncodesettings.url.md b/docs-exp/auth-types.actioncodesettings.url.md index ab2ef041a8d..8de2c2860d6 100644 --- a/docs-exp/auth-types.actioncodesettings.url.md +++ b/docs-exp/auth-types.actioncodesettings.url.md @@ -4,6 +4,8 @@ ## ActionCodeSettings.url property +Sets the link continue/state URL, which has different meanings in different contexts: - When the link is handled in the web action widgets, this is the deep link in the `continueUrl` query parameter. - When the link is handled in the app directly, this is the `continueUrl` query parameter in the deep link of the Dynamic Link. + Signature: ```typescript diff --git a/docs-exp/auth-types.additionaluserinfo.isnewuser.md b/docs-exp/auth-types.additionaluserinfo.isnewuser.md index 7a35baf9a6b..a29dfe61440 100644 --- a/docs-exp/auth-types.additionaluserinfo.isnewuser.md +++ b/docs-exp/auth-types.additionaluserinfo.isnewuser.md @@ -4,6 +4,8 @@ ## AdditionalUserInfo.isNewUser property +Whether the user is new (created via sign-up) or existing (authenticated using sign-in). + Signature: ```typescript diff --git a/docs-exp/auth-types.additionaluserinfo.md b/docs-exp/auth-types.additionaluserinfo.md index dcda2f0fcc4..61c8adbbd75 100644 --- a/docs-exp/auth-types.additionaluserinfo.md +++ b/docs-exp/auth-types.additionaluserinfo.md @@ -4,7 +4,7 @@ ## AdditionalUserInfo interface -Additional user information. +A structure containing additional user information from a federated identity provider. Signature: @@ -16,8 +16,8 @@ export interface AdditionalUserInfo | Property | Type | Description | | --- | --- | --- | -| [isNewUser](./auth-types.additionaluserinfo.isnewuser.md) | boolean | | -| [profile](./auth-types.additionaluserinfo.profile.md) | [UserProfile](./auth-types.userprofile.md) \| null | | -| [providerId](./auth-types.additionaluserinfo.providerid.md) | [ProviderId](./auth-types.providerid.md) \| null | | -| [username](./auth-types.additionaluserinfo.username.md) | string \| null | | +| [isNewUser](./auth-types.additionaluserinfo.isnewuser.md) | boolean | Whether the user is new (created via sign-up) or existing (authenticated using sign-in). | +| [profile](./auth-types.additionaluserinfo.profile.md) | [UserProfile](./auth-types.userprofile.md) \| null | Map containing IDP-specific user data. | +| [providerId](./auth-types.additionaluserinfo.providerid.md) | [ProviderId](./auth-types.providerid.md) \| null | Identifier for the provider used to authenticate this user. | +| [username](./auth-types.additionaluserinfo.username.md) | string \| null | The username if the provider is GitHub or Twitter. | diff --git a/docs-exp/auth-types.additionaluserinfo.profile.md b/docs-exp/auth-types.additionaluserinfo.profile.md index 367352cc9f3..9509ac67416 100644 --- a/docs-exp/auth-types.additionaluserinfo.profile.md +++ b/docs-exp/auth-types.additionaluserinfo.profile.md @@ -4,6 +4,8 @@ ## AdditionalUserInfo.profile property +Map containing IDP-specific user data. + Signature: ```typescript diff --git a/docs-exp/auth-types.additionaluserinfo.providerid.md b/docs-exp/auth-types.additionaluserinfo.providerid.md index 457c6c9da9e..d7413fa1be1 100644 --- a/docs-exp/auth-types.additionaluserinfo.providerid.md +++ b/docs-exp/auth-types.additionaluserinfo.providerid.md @@ -4,6 +4,8 @@ ## AdditionalUserInfo.providerId property +Identifier for the provider used to authenticate this user. + Signature: ```typescript diff --git a/docs-exp/auth-types.additionaluserinfo.username.md b/docs-exp/auth-types.additionaluserinfo.username.md index 0690abf0c09..5f28757a6f9 100644 --- a/docs-exp/auth-types.additionaluserinfo.username.md +++ b/docs-exp/auth-types.additionaluserinfo.username.md @@ -4,6 +4,8 @@ ## AdditionalUserInfo.username property +The username if the provider is GitHub or Twitter. + Signature: ```typescript diff --git a/docs-exp/auth-types.applicationverifier.md b/docs-exp/auth-types.applicationverifier.md index b62ba6a19c8..74f9b3dc2f3 100644 --- a/docs-exp/auth-types.applicationverifier.md +++ b/docs-exp/auth-types.applicationverifier.md @@ -4,7 +4,7 @@ ## ApplicationVerifier interface -https://firebase.google.com/docs/reference/js/firebase.auth.ApplicationVerifier +A verifier for domain verification and abuse prevention. Currently, the only implementation is [RecaptchaVerifier](./auth-types.recaptchaverifier.md). Signature: @@ -16,11 +16,11 @@ export interface ApplicationVerifier | Property | Type | Description | | --- | --- | --- | -| [type](./auth-types.applicationverifier.type.md) | string | | +| [type](./auth-types.applicationverifier.type.md) | string | Identifies the type of application verifier (e.g. "recaptcha"). | ## Methods | Method | Description | | --- | --- | -| [verify()](./auth-types.applicationverifier.verify.md) | | +| [verify()](./auth-types.applicationverifier.verify.md) | Executes the verification process. | diff --git a/docs-exp/auth-types.applicationverifier.type.md b/docs-exp/auth-types.applicationverifier.type.md index 7be9a80fb70..04902982e5c 100644 --- a/docs-exp/auth-types.applicationverifier.type.md +++ b/docs-exp/auth-types.applicationverifier.type.md @@ -4,6 +4,8 @@ ## ApplicationVerifier.type property +Identifies the type of application verifier (e.g. "recaptcha"). + Signature: ```typescript diff --git a/docs-exp/auth-types.applicationverifier.verify.md b/docs-exp/auth-types.applicationverifier.verify.md index 088e9c8cb4d..223a4856077 100644 --- a/docs-exp/auth-types.applicationverifier.verify.md +++ b/docs-exp/auth-types.applicationverifier.verify.md @@ -4,6 +4,8 @@ ## ApplicationVerifier.verify() method +Executes the verification process. + Signature: ```typescript @@ -13,3 +15,5 @@ verify(): Promise; Promise<string> +A Promise for a token that can be used to assert the validity of a request. + diff --git a/docs-exp/auth-types.auth.config.md b/docs-exp/auth-types.auth.config.md index 707a520af87..6f7c340c83d 100644 --- a/docs-exp/auth-types.auth.config.md +++ b/docs-exp/auth-types.auth.config.md @@ -4,6 +4,8 @@ ## Auth.config property +The [Config](./auth-types.config.md) used to initialize this instance. + Signature: ```typescript diff --git a/docs-exp/auth-types.auth.currentuser.md b/docs-exp/auth-types.auth.currentuser.md index f25aed8a581..fb9dcea93ff 100644 --- a/docs-exp/auth-types.auth.currentuser.md +++ b/docs-exp/auth-types.auth.currentuser.md @@ -4,6 +4,8 @@ ## Auth.currentUser property +The currently signed-in user (or null). + Signature: ```typescript diff --git a/docs-exp/auth-types.auth.languagecode.md b/docs-exp/auth-types.auth.languagecode.md index f7ccb01afda..43d7d1c93d2 100644 --- a/docs-exp/auth-types.auth.languagecode.md +++ b/docs-exp/auth-types.auth.languagecode.md @@ -4,6 +4,8 @@ ## Auth.languageCode property +The Auth instance's language code. This is a readable/writable property. When set to null, the default Firebase Console language setting is applied. The language code will propagate to email action templates (password reset, email verification and email change revocation), SMS templates for phone authentication, reCAPTCHA verifier and OAuth popup/redirect operations provided the specified providers support localization with the language code specified. + Signature: ```typescript diff --git a/docs-exp/auth-types.auth.md b/docs-exp/auth-types.auth.md index 40732f59ae2..6e4319c0b7b 100644 --- a/docs-exp/auth-types.auth.md +++ b/docs-exp/auth-types.auth.md @@ -4,7 +4,9 @@ ## Auth interface -https://firebase.google.com/docs/reference/js/firebase.auth.Auth +The Firebase Auth service interface. + +See [Firebase Authentication](https://firebase.google.com/docs/auth/) for a full guide on how to use the Firebase Auth service. Signature: @@ -16,22 +18,22 @@ export interface Auth | Property | Type | Description | | --- | --- | --- | -| [config](./auth-types.auth.config.md) | [Config](./auth-types.config.md) | | -| [currentUser](./auth-types.auth.currentuser.md) | [User](./auth-types.user.md) \| null | | -| [languageCode](./auth-types.auth.languagecode.md) | string \| null | | -| [name](./auth-types.auth.name.md) | string | | -| [settings](./auth-types.auth.settings.md) | [AuthSettings](./auth-types.authsettings.md) | | -| [tenantId](./auth-types.auth.tenantid.md) | string \| null | | +| [config](./auth-types.auth.config.md) | [Config](./auth-types.config.md) | The [Config](./auth-types.config.md) used to initialize this instance. | +| [currentUser](./auth-types.auth.currentuser.md) | [User](./auth-types.user.md) \| null | The currently signed-in user (or null). | +| [languageCode](./auth-types.auth.languagecode.md) | string \| null | The Auth instance's language code. This is a readable/writable property. When set to null, the default Firebase Console language setting is applied. The language code will propagate to email action templates (password reset, email verification and email change revocation), SMS templates for phone authentication, reCAPTCHA verifier and OAuth popup/redirect operations provided the specified providers support localization with the language code specified. | +| [name](./auth-types.auth.name.md) | string | The name of the app associated with the Auth service instance. | +| [settings](./auth-types.auth.settings.md) | [AuthSettings](./auth-types.authsettings.md) | The Auth instance's settings. This is used to edit/read configuration related options like app verification mode for phone authentication. | +| [tenantId](./auth-types.auth.tenantid.md) | string \| null | The Auth instance's tenant ID. This is a readable/writable property. When you set the tenant ID of an Auth instance, all future sign-in/sign-up operations will pass this tenant ID and sign in or sign up users to the specified tenant project. When set to null, users are signed in to the parent project. By default, this is set to null. | ## Methods | Method | Description | | --- | --- | -| [onAuthStateChanged(nextOrObserver, error, completed)](./auth-types.auth.onauthstatechanged.md) | | -| [onIdTokenChanged(nextOrObserver, error, completed)](./auth-types.auth.onidtokenchanged.md) | | -| [setPersistence(persistence)](./auth-types.auth.setpersistence.md) | | -| [signOut()](./auth-types.auth.signout.md) | | -| [updateCurrentUser(user)](./auth-types.auth.updatecurrentuser.md) | | -| [useDeviceLanguage()](./auth-types.auth.usedevicelanguage.md) | | -| [useEmulator(url)](./auth-types.auth.useemulator.md) | | +| [onAuthStateChanged(nextOrObserver, error, completed)](./auth-types.auth.onauthstatechanged.md) | Adds an observer for changes to the user's sign-in state.To keep the old behavior, see [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md). | +| [onIdTokenChanged(nextOrObserver, error, completed)](./auth-types.auth.onidtokenchanged.md) | Adds an observer for changes to the signed-in user's ID token, which includes sign-in, sign-out, and token refresh events. | +| [setPersistence(persistence)](./auth-types.auth.setpersistence.md) | Changes the type of persistence on the Auth instance for the currently saved Auth session and applies this type of persistence for future sign-in requests, including sign-in with redirect requests.This makes it easy for a user signing in to specify whether their session should be remembered or not. It also makes it easier to never persist the Auth state for applications that are shared by other users or have sensitive data. | +| [signOut()](./auth-types.auth.signout.md) | Signs out the current user. | +| [updateCurrentUser(user)](./auth-types.auth.updatecurrentuser.md) | Asynchronously sets the provided user as currentUser on the Auth instance. A new instance copy of the user provided will be made and set as currentUser.This will trigger [Auth.onAuthStateChanged()](./auth-types.auth.onauthstatechanged.md) and [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md) listeners like other sign in methods.The operation fails with an error if the user to be updated belongs to a different Firebase project. | +| [useDeviceLanguage()](./auth-types.auth.usedevicelanguage.md) | Sets the current language to the default device/browser preference. | +| [useEmulator(url)](./auth-types.auth.useemulator.md) | Modify this Auth instance to communicate with the Firebase Auth emulator. This must be called synchronously immediately following the first call to initializeAuth(). Do not use with production credentials as emulator traffic is not encrypted. | diff --git a/docs-exp/auth-types.auth.name.md b/docs-exp/auth-types.auth.name.md index 3efeb1ac5b2..695a7a051be 100644 --- a/docs-exp/auth-types.auth.name.md +++ b/docs-exp/auth-types.auth.name.md @@ -4,6 +4,8 @@ ## Auth.name property +The name of the app associated with the Auth service instance. + Signature: ```typescript diff --git a/docs-exp/auth-types.auth.onauthstatechanged.md b/docs-exp/auth-types.auth.onauthstatechanged.md index a3b1905f277..0f4292b70b4 100644 --- a/docs-exp/auth-types.auth.onauthstatechanged.md +++ b/docs-exp/auth-types.auth.onauthstatechanged.md @@ -4,6 +4,10 @@ ## Auth.onAuthStateChanged() method +Adds an observer for changes to the user's sign-in state. + +To keep the old behavior, see [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md). + Signature: ```typescript @@ -18,9 +22,9 @@ onAuthStateChanged( | Parameter | Type | Description | | --- | --- | --- | -| nextOrObserver | [NextOrObserver](./auth-types.nextorobserver.md)<[User](./auth-types.user.md)> | | -| error | ErrorFn | | -| completed | CompleteFn | | +| nextOrObserver | [NextOrObserver](./auth-types.nextorobserver.md)<[User](./auth-types.user.md)> | callback triggered on change. | +| error | ErrorFn | callback triggered on error. | +| completed | CompleteFn | callback triggered when observer is removed. | Returns: diff --git a/docs-exp/auth-types.auth.onidtokenchanged.md b/docs-exp/auth-types.auth.onidtokenchanged.md index 954413feb5f..0857e19cc2a 100644 --- a/docs-exp/auth-types.auth.onidtokenchanged.md +++ b/docs-exp/auth-types.auth.onidtokenchanged.md @@ -4,6 +4,8 @@ ## Auth.onIdTokenChanged() method +Adds an observer for changes to the signed-in user's ID token, which includes sign-in, sign-out, and token refresh events. + Signature: ```typescript @@ -18,9 +20,9 @@ onIdTokenChanged( | Parameter | Type | Description | | --- | --- | --- | -| nextOrObserver | [NextOrObserver](./auth-types.nextorobserver.md)<[User](./auth-types.user.md)> | | -| error | ErrorFn | | -| completed | CompleteFn | | +| nextOrObserver | [NextOrObserver](./auth-types.nextorobserver.md)<[User](./auth-types.user.md)> | callback triggered on change. | +| error | ErrorFn | callback triggered on error. | +| completed | CompleteFn | callback triggered when observer is removed. | Returns: diff --git a/docs-exp/auth-types.auth.setpersistence.md b/docs-exp/auth-types.auth.setpersistence.md index c0e164d0b52..3e1eeac3cba 100644 --- a/docs-exp/auth-types.auth.setpersistence.md +++ b/docs-exp/auth-types.auth.setpersistence.md @@ -4,6 +4,10 @@ ## Auth.setPersistence() method +Changes the type of persistence on the Auth instance for the currently saved Auth session and applies this type of persistence for future sign-in requests, including sign-in with redirect requests. + +This makes it easy for a user signing in to specify whether their session should be remembered or not. It also makes it easier to never persist the Auth state for applications that are shared by other users or have sensitive data. + Signature: ```typescript @@ -14,9 +18,17 @@ setPersistence(persistence: Persistence): void; | Parameter | Type | Description | | --- | --- | --- | -| persistence | [Persistence](./auth-types.persistence.md) | | +| persistence | [Persistence](./auth-types.persistence.md) | The [Persistence](./auth-types.persistence.md) to use. | Returns: void +## Example + + +```javascript +auth.setPersistence(browserSessionPersistence); + +``` + diff --git a/docs-exp/auth-types.auth.settings.md b/docs-exp/auth-types.auth.settings.md index 5ea4d5c65e1..37a2d8b25ed 100644 --- a/docs-exp/auth-types.auth.settings.md +++ b/docs-exp/auth-types.auth.settings.md @@ -4,6 +4,8 @@ ## Auth.settings property +The Auth instance's settings. This is used to edit/read configuration related options like app verification mode for phone authentication. + Signature: ```typescript diff --git a/docs-exp/auth-types.auth.signout.md b/docs-exp/auth-types.auth.signout.md index e6a44b038bc..57bc6589146 100644 --- a/docs-exp/auth-types.auth.signout.md +++ b/docs-exp/auth-types.auth.signout.md @@ -4,6 +4,8 @@ ## Auth.signOut() method +Signs out the current user. + Signature: ```typescript diff --git a/docs-exp/auth-types.auth.tenantid.md b/docs-exp/auth-types.auth.tenantid.md index 57cba12a545..1f57720fe45 100644 --- a/docs-exp/auth-types.auth.tenantid.md +++ b/docs-exp/auth-types.auth.tenantid.md @@ -4,8 +4,24 @@ ## Auth.tenantId property +The Auth instance's tenant ID. This is a readable/writable property. When you set the tenant ID of an Auth instance, all future sign-in/sign-up operations will pass this tenant ID and sign in or sign up users to the specified tenant project. When set to null, users are signed in to the parent project. By default, this is set to null. + Signature: ```typescript tenantId: string | null; ``` + +## Example + + +```javascript +// Set the tenant ID on Auth instance. +auth.tenantId = 'TENANT_PROJECT_ID'; + +// All future sign-in request now include tenant ID. +const result = await signInWithEmailAndPassword(auth, email, password); +// result.user.tenantId should be 'TENANT_PROJECT_ID'. + +``` + diff --git a/docs-exp/auth-types.auth.updatecurrentuser.md b/docs-exp/auth-types.auth.updatecurrentuser.md index 3bcd24c70e1..545e2fd1122 100644 --- a/docs-exp/auth-types.auth.updatecurrentuser.md +++ b/docs-exp/auth-types.auth.updatecurrentuser.md @@ -4,6 +4,12 @@ ## Auth.updateCurrentUser() method +Asynchronously sets the provided user as `currentUser` on the Auth instance. A new instance copy of the user provided will be made and set as currentUser. + +This will trigger [Auth.onAuthStateChanged()](./auth-types.auth.onauthstatechanged.md) and [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md) listeners like other sign in methods. + +The operation fails with an error if the user to be updated belongs to a different Firebase project. + Signature: ```typescript @@ -14,7 +20,7 @@ updateCurrentUser(user: User | null): Promise; | Parameter | Type | Description | | --- | --- | --- | -| user | [User](./auth-types.user.md) \| null | | +| user | [User](./auth-types.user.md) \| null | The new [User](./auth-types.user.md). | Returns: diff --git a/docs-exp/auth-types.auth.usedevicelanguage.md b/docs-exp/auth-types.auth.usedevicelanguage.md index 8a19378f071..d39ebe945c0 100644 --- a/docs-exp/auth-types.auth.usedevicelanguage.md +++ b/docs-exp/auth-types.auth.usedevicelanguage.md @@ -4,6 +4,8 @@ ## Auth.useDeviceLanguage() method +Sets the current language to the default device/browser preference. + Signature: ```typescript diff --git a/docs-exp/auth-types.auth.useemulator.md b/docs-exp/auth-types.auth.useemulator.md index 675456aa60b..5d741617811 100644 --- a/docs-exp/auth-types.auth.useemulator.md +++ b/docs-exp/auth-types.auth.useemulator.md @@ -4,6 +4,8 @@ ## Auth.useEmulator() method +Modify this Auth instance to communicate with the Firebase Auth emulator. This must be called synchronously immediately following the first call to `initializeAuth()`. Do not use with production credentials as emulator traffic is not encrypted. + Signature: ```typescript @@ -14,7 +16,7 @@ useEmulator(url: string): void; | Parameter | Type | Description | | --- | --- | --- | -| url | string | | +| url | string | The URL at which the emulator is running (eg, 'http://localhost:9099'). | Returns: diff --git a/docs-exp/auth-types.authcredential.fromjson.md b/docs-exp/auth-types.authcredential.fromjson.md index 47f8f53921d..61a3e8ed00a 100644 --- a/docs-exp/auth-types.authcredential.fromjson.md +++ b/docs-exp/auth-types.authcredential.fromjson.md @@ -4,6 +4,8 @@ ## AuthCredential.fromJSON() method +Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth-types.authcredential.md). + Signature: ```typescript @@ -14,9 +16,11 @@ static fromJSON(json: object | string): AuthCredential | null; | Parameter | Type | Description | | --- | --- | --- | -| json | object \| string | | +| json | object \| string | Either object or the stringified representation of the object. When string is provided, JSON.parse would be called first. | Returns: [AuthCredential](./auth-types.authcredential.md) \| null +If the JSON input does not represent an [AuthCredential](./auth-types.authcredential.md), null is returned. + diff --git a/docs-exp/auth-types.authcredential.md b/docs-exp/auth-types.authcredential.md index 6796708cf90..cc05c945cae 100644 --- a/docs-exp/auth-types.authcredential.md +++ b/docs-exp/auth-types.authcredential.md @@ -4,7 +4,7 @@ ## AuthCredential class -https://firebase.google.com/docs/reference/js/firebase.auth.AuthCredential +Interface that represents the credentials returned by an auth provider. Implementations specify the details about each auth provider's credential requirements. Signature: @@ -16,13 +16,13 @@ export abstract class AuthCredential | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [providerId](./auth-types.authcredential.providerid.md) | | string | | -| [signInMethod](./auth-types.authcredential.signinmethod.md) | | string | | +| [providerId](./auth-types.authcredential.providerid.md) | | string | The authentication provider ID for the credential. For example, 'facebook.com', or 'google.com'. | +| [signInMethod](./auth-types.authcredential.signinmethod.md) | | string | The authentication sign in method for the credential. For example, [SignInMethod.EMAIL\_PASSWORD](./auth-types.signinmethod.email_password.md), or [SignInMethod.EMAIL\_LINK](./auth-types.signinmethod.email_link.md). This corresponds to the sign-in method identifier as returned in fetchSignInMethodsForEmail. | ## Methods | Method | Modifiers | Description | | --- | --- | --- | -| [fromJSON(json)](./auth-types.authcredential.fromjson.md) | static | | -| [toJSON()](./auth-types.authcredential.tojson.md) | | | +| [fromJSON(json)](./auth-types.authcredential.fromjson.md) | static | Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth-types.authcredential.md). | +| [toJSON()](./auth-types.authcredential.tojson.md) | | Returns a JSON-serializable representation of this object. | diff --git a/docs-exp/auth-types.authcredential.providerid.md b/docs-exp/auth-types.authcredential.providerid.md index 260a7e8889b..ae332c4bf0a 100644 --- a/docs-exp/auth-types.authcredential.providerid.md +++ b/docs-exp/auth-types.authcredential.providerid.md @@ -4,6 +4,8 @@ ## AuthCredential.providerId property +The authentication provider ID for the credential. For example, 'facebook.com', or 'google.com'. + Signature: ```typescript diff --git a/docs-exp/auth-types.authcredential.signinmethod.md b/docs-exp/auth-types.authcredential.signinmethod.md index 083a4421d8b..9f33f338e34 100644 --- a/docs-exp/auth-types.authcredential.signinmethod.md +++ b/docs-exp/auth-types.authcredential.signinmethod.md @@ -4,6 +4,8 @@ ## AuthCredential.signInMethod property +The authentication sign in method for the credential. For example, [SignInMethod.EMAIL\_PASSWORD](./auth-types.signinmethod.email_password.md), or [SignInMethod.EMAIL\_LINK](./auth-types.signinmethod.email_link.md). This corresponds to the sign-in method identifier as returned in `fetchSignInMethodsForEmail`. + Signature: ```typescript diff --git a/docs-exp/auth-types.authcredential.tojson.md b/docs-exp/auth-types.authcredential.tojson.md index a60ba35bd59..a85af3ab78e 100644 --- a/docs-exp/auth-types.authcredential.tojson.md +++ b/docs-exp/auth-types.authcredential.tojson.md @@ -4,6 +4,8 @@ ## AuthCredential.toJSON() method +Returns a JSON-serializable representation of this object. + Signature: ```typescript @@ -13,3 +15,5 @@ toJSON(): object; object +a JSON-serializable representation of this object. + diff --git a/docs-exp/auth-types.autherror.appname.md b/docs-exp/auth-types.autherror.appname.md index 5d214250458..e81faf120a6 100644 --- a/docs-exp/auth-types.autherror.appname.md +++ b/docs-exp/auth-types.autherror.appname.md @@ -4,6 +4,8 @@ ## AuthError.appName property +The name of the Firebase App which triggered this error. + Signature: ```typescript diff --git a/docs-exp/auth-types.autherror.email.md b/docs-exp/auth-types.autherror.email.md index 8e1fe38b659..2267e3f9aef 100644 --- a/docs-exp/auth-types.autherror.email.md +++ b/docs-exp/auth-types.autherror.email.md @@ -4,6 +4,8 @@ ## AuthError.email property +The email of the user's account, used for sign-in/linking. + Signature: ```typescript diff --git a/docs-exp/auth-types.autherror.md b/docs-exp/auth-types.autherror.md index 79b5615f737..049734bd44b 100644 --- a/docs-exp/auth-types.autherror.md +++ b/docs-exp/auth-types.autherror.md @@ -4,7 +4,6 @@ ## AuthError interface -https://firebase.google.com/docs/reference/js/firebase.auth.AuthError Signature: @@ -17,8 +16,8 @@ export interface AuthError extends FirebaseError | Property | Type | Description | | --- | --- | --- | -| [appName](./auth-types.autherror.appname.md) | string | | -| [email](./auth-types.autherror.email.md) | string | | -| [phoneNumber](./auth-types.autherror.phonenumber.md) | string | | -| [tenantid](./auth-types.autherror.tenantid.md) | string | | +| [appName](./auth-types.autherror.appname.md) | string | The name of the Firebase App which triggered this error. | +| [email](./auth-types.autherror.email.md) | string | The email of the user's account, used for sign-in/linking. | +| [phoneNumber](./auth-types.autherror.phonenumber.md) | string | The phone number of the user's account, used for sign-in/linking. | +| [tenantid](./auth-types.autherror.tenantid.md) | string | The tenant ID being used for sign-in/linking. If you use signInWithRedirect to sign in, you have to set the tenant ID on [Auth](./auth-types.auth.md) instance again as the tenant ID is not persisted after redirection. | diff --git a/docs-exp/auth-types.autherror.phonenumber.md b/docs-exp/auth-types.autherror.phonenumber.md index ffce6d1fe59..8b8c41a0e7e 100644 --- a/docs-exp/auth-types.autherror.phonenumber.md +++ b/docs-exp/auth-types.autherror.phonenumber.md @@ -4,6 +4,8 @@ ## AuthError.phoneNumber property +The phone number of the user's account, used for sign-in/linking. + Signature: ```typescript diff --git a/docs-exp/auth-types.autherror.tenantid.md b/docs-exp/auth-types.autherror.tenantid.md index a3c396633d7..1ac2110482d 100644 --- a/docs-exp/auth-types.autherror.tenantid.md +++ b/docs-exp/auth-types.autherror.tenantid.md @@ -4,6 +4,8 @@ ## AuthError.tenantid property +The tenant ID being used for sign-in/linking. If you use `signInWithRedirect` to sign in, you have to set the tenant ID on [Auth](./auth-types.auth.md) instance again as the tenant ID is not persisted after redirection. + Signature: ```typescript diff --git a/docs-exp/auth-types.authprovider.md b/docs-exp/auth-types.authprovider.md index c9a29ec6d6c..334599c9f78 100644 --- a/docs-exp/auth-types.authprovider.md +++ b/docs-exp/auth-types.authprovider.md @@ -4,9 +4,7 @@ ## AuthProvider interface -A provider for generating credentials - -https://firebase.google.com/docs/reference/js/firebase.auth.AuthProvider +Interface that represents an auth provider, used to facilitate creating [AuthCredential](./auth-types.authcredential.md). Signature: @@ -18,5 +16,5 @@ export interface AuthProvider | Property | Type | Description | | --- | --- | --- | -| [providerId](./auth-types.authprovider.providerid.md) | string | | +| [providerId](./auth-types.authprovider.providerid.md) | string | Provider for which credentials can be constructed. | diff --git a/docs-exp/auth-types.authprovider.providerid.md b/docs-exp/auth-types.authprovider.providerid.md index a8af80c7e7a..a66cf608028 100644 --- a/docs-exp/auth-types.authprovider.providerid.md +++ b/docs-exp/auth-types.authprovider.providerid.md @@ -4,6 +4,8 @@ ## AuthProvider.providerId property +Provider for which credentials can be constructed. + Signature: ```typescript diff --git a/docs-exp/auth-types.authsettings.appverificationdisabledfortesting.md b/docs-exp/auth-types.authsettings.appverificationdisabledfortesting.md index f2512d1887a..6b7e06d62a8 100644 --- a/docs-exp/auth-types.authsettings.appverificationdisabledfortesting.md +++ b/docs-exp/auth-types.authsettings.appverificationdisabledfortesting.md @@ -4,6 +4,12 @@ ## AuthSettings.appVerificationDisabledForTesting property +When set, this property disables app verification for the purpose of testing phone authentication. For this property to take effect, it needs to be set before rendering a reCAPTCHA app verifier. When this is disabled, a mock reCAPTCHA is rendered instead. This is useful for manual testing during development or for automated integration tests. + +In order to use this feature, you will need to [whitelist your phone number](https://firebase.google.com/docs/auth/web/phone-auth#test-with-whitelisted-phone-numbers) via the Firebase Console. + +The default value is false (app verification is enabled). + Signature: ```typescript diff --git a/docs-exp/auth-types.authsettings.md b/docs-exp/auth-types.authsettings.md index 92ea98b6768..83d2efde315 100644 --- a/docs-exp/auth-types.authsettings.md +++ b/docs-exp/auth-types.authsettings.md @@ -4,7 +4,7 @@ ## AuthSettings interface -https://firebase.google.com/docs/reference/js/firebase.auth.AuthSettings +Interface representing an Auth instance's settings, currently used for enabling/disabling app verification for phone Auth testing. Signature: @@ -16,5 +16,5 @@ export interface AuthSettings | Property | Type | Description | | --- | --- | --- | -| [appVerificationDisabledForTesting](./auth-types.authsettings.appverificationdisabledfortesting.md) | boolean | | +| [appVerificationDisabledForTesting](./auth-types.authsettings.appverificationdisabledfortesting.md) | boolean | When set, this property disables app verification for the purpose of testing phone authentication. For this property to take effect, it needs to be set before rendering a reCAPTCHA app verifier. When this is disabled, a mock reCAPTCHA is rendered instead. This is useful for manual testing during development or for automated integration tests.In order to use this feature, you will need to [whitelist your phone number](https://firebase.google.com/docs/auth/web/phone-auth#test-with-whitelisted-phone-numbers) via the Firebase Console.The default value is false (app verification is enabled). | diff --git a/docs-exp/auth-types.config.apihost.md b/docs-exp/auth-types.config.apihost.md index 0b2fa63a20e..106e5d2b67b 100644 --- a/docs-exp/auth-types.config.apihost.md +++ b/docs-exp/auth-types.config.apihost.md @@ -4,6 +4,8 @@ ## Config.apiHost property +The host at which the Firebase Auth backend is running. + Signature: ```typescript diff --git a/docs-exp/auth-types.config.apikey.md b/docs-exp/auth-types.config.apikey.md index c7cc7fe1591..ca8e646361d 100644 --- a/docs-exp/auth-types.config.apikey.md +++ b/docs-exp/auth-types.config.apikey.md @@ -4,6 +4,8 @@ ## Config.apiKey property +The API Key used to communicate with the Firebase Auth backend. + Signature: ```typescript diff --git a/docs-exp/auth-types.config.apischeme.md b/docs-exp/auth-types.config.apischeme.md index a9af37a5dcd..dc28a29abc4 100644 --- a/docs-exp/auth-types.config.apischeme.md +++ b/docs-exp/auth-types.config.apischeme.md @@ -4,6 +4,8 @@ ## Config.apiScheme property +The scheme used to communicate with the Firebase Auth backend. + Signature: ```typescript diff --git a/docs-exp/auth-types.config.authdomain.md b/docs-exp/auth-types.config.authdomain.md index ef2fa19916c..fda7e1ff3e8 100644 --- a/docs-exp/auth-types.config.authdomain.md +++ b/docs-exp/auth-types.config.authdomain.md @@ -4,6 +4,8 @@ ## Config.authDomain property +The domain at which the web widgets are hosted (provided via Firebase Config). + Signature: ```typescript diff --git a/docs-exp/auth-types.config.md b/docs-exp/auth-types.config.md index 099ba33075e..a2d855b17e2 100644 --- a/docs-exp/auth-types.config.md +++ b/docs-exp/auth-types.config.md @@ -4,7 +4,7 @@ ## Config interface -Auth config object +Auth config object. Signature: @@ -16,10 +16,10 @@ export interface Config | Property | Type | Description | | --- | --- | --- | -| [apiHost](./auth-types.config.apihost.md) | string | | -| [apiKey](./auth-types.config.apikey.md) | string | | -| [apiScheme](./auth-types.config.apischeme.md) | string | | -| [authDomain](./auth-types.config.authdomain.md) | string | | -| [sdkClientVersion](./auth-types.config.sdkclientversion.md) | string | | -| [tokenApiHost](./auth-types.config.tokenapihost.md) | string | | +| [apiHost](./auth-types.config.apihost.md) | string | The host at which the Firebase Auth backend is running. | +| [apiKey](./auth-types.config.apikey.md) | string | The API Key used to communicate with the Firebase Auth backend. | +| [apiScheme](./auth-types.config.apischeme.md) | string | The scheme used to communicate with the Firebase Auth backend. | +| [authDomain](./auth-types.config.authdomain.md) | string | The domain at which the web widgets are hosted (provided via Firebase Config). | +| [sdkClientVersion](./auth-types.config.sdkclientversion.md) | string | The SDK Client Version. | +| [tokenApiHost](./auth-types.config.tokenapihost.md) | string | The host at which the Secure Token API is running. | diff --git a/docs-exp/auth-types.config.sdkclientversion.md b/docs-exp/auth-types.config.sdkclientversion.md index 0b9e404605a..29edfdba0f8 100644 --- a/docs-exp/auth-types.config.sdkclientversion.md +++ b/docs-exp/auth-types.config.sdkclientversion.md @@ -4,6 +4,8 @@ ## Config.sdkClientVersion property +The SDK Client Version. + Signature: ```typescript diff --git a/docs-exp/auth-types.config.tokenapihost.md b/docs-exp/auth-types.config.tokenapihost.md index 2b2af334b34..f896fac07a0 100644 --- a/docs-exp/auth-types.config.tokenapihost.md +++ b/docs-exp/auth-types.config.tokenapihost.md @@ -4,6 +4,8 @@ ## Config.tokenApiHost property +The host at which the Secure Token API is running. + Signature: ```typescript diff --git a/docs-exp/auth-types.confirmationresult.confirm.md b/docs-exp/auth-types.confirmationresult.confirm.md index 703f435a1be..78292434837 100644 --- a/docs-exp/auth-types.confirmationresult.confirm.md +++ b/docs-exp/auth-types.confirmationresult.confirm.md @@ -4,6 +4,8 @@ ## ConfirmationResult.confirm() method +Finishes a phone number sign-in, link, or reauthentication. + Signature: ```typescript @@ -14,9 +16,19 @@ confirm(verificationCode: string): Promise; | Parameter | Type | Description | | --- | --- | --- | -| verificationCode | string | | +| verificationCode | string | The code that was sent to the user's mobile device. | Returns: Promise<[UserCredential](./auth-types.usercredential.md)> +## Example + + +```javascript +const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier); +// Obtain verificationCode from the user. +const userCredential = await confirmationResult.confirm(verificationCode); + +``` + diff --git a/docs-exp/auth-types.confirmationresult.md b/docs-exp/auth-types.confirmationresult.md index 305be1c045b..b97ca4bca8a 100644 --- a/docs-exp/auth-types.confirmationresult.md +++ b/docs-exp/auth-types.confirmationresult.md @@ -4,7 +4,7 @@ ## ConfirmationResult interface -https://firebase.google.com/docs/reference/js/firebase.auth.ConfirmationResult +A result from a phone number sign-in, link, or reauthenticate call. Signature: @@ -16,11 +16,11 @@ export interface ConfirmationResult | Property | Type | Description | | --- | --- | --- | -| [verificationId](./auth-types.confirmationresult.verificationid.md) | string | | +| [verificationId](./auth-types.confirmationresult.verificationid.md) | string | The phone number authentication operation's verification ID. This can be used along with the verification code to initialize a phone auth credential. | ## Methods | Method | Description | | --- | --- | -| [confirm(verificationCode)](./auth-types.confirmationresult.confirm.md) | | +| [confirm(verificationCode)](./auth-types.confirmationresult.confirm.md) | Finishes a phone number sign-in, link, or reauthentication. | diff --git a/docs-exp/auth-types.confirmationresult.verificationid.md b/docs-exp/auth-types.confirmationresult.verificationid.md index afc0eb72872..11e8ff1f103 100644 --- a/docs-exp/auth-types.confirmationresult.verificationid.md +++ b/docs-exp/auth-types.confirmationresult.verificationid.md @@ -4,6 +4,8 @@ ## ConfirmationResult.verificationId property +The phone number authentication operation's verification ID. This can be used along with the verification code to initialize a phone auth credential. + Signature: ```typescript diff --git a/docs-exp/auth-types.emailauthprovider.credential.md b/docs-exp/auth-types.emailauthprovider.credential.md index 1489fd2b067..8a2c22128e6 100644 --- a/docs-exp/auth-types.emailauthprovider.credential.md +++ b/docs-exp/auth-types.emailauthprovider.credential.md @@ -4,6 +4,8 @@ ## EmailAuthProvider.credential() method +Initialize an [AuthCredential](./auth-types.authcredential.md) using an email and password. + Signature: ```typescript @@ -14,10 +16,29 @@ static credential(email: string, password: string): AuthCredential; | Parameter | Type | Description | | --- | --- | --- | -| email | string | | -| password | string | | +| email | string | Email address. | +| password | string | User account password. | Returns: [AuthCredential](./auth-types.authcredential.md) +The auth provider credential. + +## Example 1 + + +```javascript +const authCredential = EmailAuthProvider.credential(email, password); +const userCredential = await signInWithCredential(auth, authCredential); + +``` + +## Example 2 + + +```javascript +const userCredential = await signInWithEmailAndPassword(auth, email, password); + +``` + diff --git a/docs-exp/auth-types.emailauthprovider.credentialwithlink.md b/docs-exp/auth-types.emailauthprovider.credentialwithlink.md index 2857ddd8cba..4bc7ba2bc8d 100644 --- a/docs-exp/auth-types.emailauthprovider.credentialwithlink.md +++ b/docs-exp/auth-types.emailauthprovider.credentialwithlink.md @@ -4,6 +4,8 @@ ## EmailAuthProvider.credentialWithLink() method +Initialize an [AuthCredential](./auth-types.authcredential.md) using an email and an email link after a sign in with email link operation. + Signature: ```typescript @@ -18,11 +20,32 @@ static credentialWithLink( | Parameter | Type | Description | | --- | --- | --- | -| auth | [Auth](./auth-types.auth.md) | | -| email | string | | -| emailLink | string | | +| auth | [Auth](./auth-types.auth.md) | The Auth instance used to verify the link. | +| email | string | Email address. | +| emailLink | string | Sign-in email link. | Returns: [AuthCredential](./auth-types.authcredential.md) +- The auth provider credential. + +## Example 1 + + +```javascript +const authCredential = EmailAuthProvider.credentialWithLink(auth, email, emailLink); +const userCredential = await signInWithCredential(auth, authCredential); + +``` + +## Example 2 + + +```javascript +await sendSignInLinkToEmail(auth, email); +// Obtain emailLink from user. +const userCredential = await signInWithEmailLink(auth, email, emailLink); + +``` + diff --git a/docs-exp/auth-types.emailauthprovider.email_link_sign_in_method.md b/docs-exp/auth-types.emailauthprovider.email_link_sign_in_method.md index 3118cbe2354..ffbd4c920a1 100644 --- a/docs-exp/auth-types.emailauthprovider.email_link_sign_in_method.md +++ b/docs-exp/auth-types.emailauthprovider.email_link_sign_in_method.md @@ -4,6 +4,8 @@ ## EmailAuthProvider.EMAIL\_LINK\_SIGN\_IN\_METHOD property +Always set to [SignInMethod.EMAIL\_LINK](./auth-types.signinmethod.email_link.md). + Signature: ```typescript diff --git a/docs-exp/auth-types.emailauthprovider.email_password_sign_in_method.md b/docs-exp/auth-types.emailauthprovider.email_password_sign_in_method.md index 8dabf3dfc9a..436ad010c43 100644 --- a/docs-exp/auth-types.emailauthprovider.email_password_sign_in_method.md +++ b/docs-exp/auth-types.emailauthprovider.email_password_sign_in_method.md @@ -4,6 +4,8 @@ ## EmailAuthProvider.EMAIL\_PASSWORD\_SIGN\_IN\_METHOD property +Always set to [SignInMethod.EMAIL\_PASSWORD](./auth-types.signinmethod.email_password.md). + Signature: ```typescript diff --git a/docs-exp/auth-types.emailauthprovider.md b/docs-exp/auth-types.emailauthprovider.md index 18019b248e3..a57424f1da8 100644 --- a/docs-exp/auth-types.emailauthprovider.md +++ b/docs-exp/auth-types.emailauthprovider.md @@ -4,9 +4,7 @@ ## EmailAuthProvider class -A provider for generating email & password and email link credentials - -https://firebase.google.com/docs/reference/js/firebase.auth.EmailAuthProvider +Email and password auth provider implementation. Signature: @@ -19,15 +17,15 @@ export abstract class EmailAuthProvider implements AuthProvider | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [EMAIL\_LINK\_SIGN\_IN\_METHOD](./auth-types.emailauthprovider.email_link_sign_in_method.md) | static | [SignInMethod](./auth-types.signinmethod.md) | | -| [EMAIL\_PASSWORD\_SIGN\_IN\_METHOD](./auth-types.emailauthprovider.email_password_sign_in_method.md) | static | [SignInMethod](./auth-types.signinmethod.md) | | -| [PROVIDER\_ID](./auth-types.emailauthprovider.provider_id.md) | static | [ProviderId](./auth-types.providerid.md) | | -| [providerId](./auth-types.emailauthprovider.providerid.md) | | [ProviderId](./auth-types.providerid.md) | | +| [EMAIL\_LINK\_SIGN\_IN\_METHOD](./auth-types.emailauthprovider.email_link_sign_in_method.md) | static | [SignInMethod](./auth-types.signinmethod.md) | Always set to [SignInMethod.EMAIL\_LINK](./auth-types.signinmethod.email_link.md). | +| [EMAIL\_PASSWORD\_SIGN\_IN\_METHOD](./auth-types.emailauthprovider.email_password_sign_in_method.md) | static | [SignInMethod](./auth-types.signinmethod.md) | Always set to [SignInMethod.EMAIL\_PASSWORD](./auth-types.signinmethod.email_password.md). | +| [PROVIDER\_ID](./auth-types.emailauthprovider.provider_id.md) | static | [ProviderId](./auth-types.providerid.md) | Always set to [ProviderId.PASSWORD](./auth-types.providerid.password.md), even for email link. | +| [providerId](./auth-types.emailauthprovider.providerid.md) | | [ProviderId](./auth-types.providerid.md) | Always set to [ProviderId.PASSWORD](./auth-types.providerid.password.md), even for email link. | ## Methods | Method | Modifiers | Description | | --- | --- | --- | -| [credential(email, password)](./auth-types.emailauthprovider.credential.md) | static | | -| [credentialWithLink(auth, email, emailLink)](./auth-types.emailauthprovider.credentialwithlink.md) | static | | +| [credential(email, password)](./auth-types.emailauthprovider.credential.md) | static | Initialize an [AuthCredential](./auth-types.authcredential.md) using an email and password. | +| [credentialWithLink(auth, email, emailLink)](./auth-types.emailauthprovider.credentialwithlink.md) | static | Initialize an [AuthCredential](./auth-types.authcredential.md) using an email and an email link after a sign in with email link operation. | diff --git a/docs-exp/auth-types.emailauthprovider.provider_id.md b/docs-exp/auth-types.emailauthprovider.provider_id.md index f6f44c17f10..a34b96cc0e6 100644 --- a/docs-exp/auth-types.emailauthprovider.provider_id.md +++ b/docs-exp/auth-types.emailauthprovider.provider_id.md @@ -4,6 +4,8 @@ ## EmailAuthProvider.PROVIDER\_ID property +Always set to [ProviderId.PASSWORD](./auth-types.providerid.password.md), even for email link. + Signature: ```typescript diff --git a/docs-exp/auth-types.emailauthprovider.providerid.md b/docs-exp/auth-types.emailauthprovider.providerid.md index 235ffe71a2d..28f28ec6d17 100644 --- a/docs-exp/auth-types.emailauthprovider.providerid.md +++ b/docs-exp/auth-types.emailauthprovider.providerid.md @@ -4,6 +4,8 @@ ## EmailAuthProvider.providerId property +Always set to [ProviderId.PASSWORD](./auth-types.providerid.password.md), even for email link. + Signature: ```typescript diff --git a/docs-exp/auth-types.idtokenresult.authtime.md b/docs-exp/auth-types.idtokenresult.authtime.md index 86cdd6c275c..7b9312e6355 100644 --- a/docs-exp/auth-types.idtokenresult.authtime.md +++ b/docs-exp/auth-types.idtokenresult.authtime.md @@ -4,6 +4,8 @@ ## IdTokenResult.authTime property +The authentication time formatted as a UTC string. This is the time the user authenticated (signed in) and not the time the token was refreshed. + Signature: ```typescript diff --git a/docs-exp/auth-types.idtokenresult.claims.md b/docs-exp/auth-types.idtokenresult.claims.md index 8947f1a3e1c..7e25e4d4ad8 100644 --- a/docs-exp/auth-types.idtokenresult.claims.md +++ b/docs-exp/auth-types.idtokenresult.claims.md @@ -4,6 +4,8 @@ ## IdTokenResult.claims property +The entire payload claims of the ID token including the standard reserved claims as well as the custom claims. + Signature: ```typescript diff --git a/docs-exp/auth-types.idtokenresult.expirationtime.md b/docs-exp/auth-types.idtokenresult.expirationtime.md index 73aacfd4c98..b3ef039be4a 100644 --- a/docs-exp/auth-types.idtokenresult.expirationtime.md +++ b/docs-exp/auth-types.idtokenresult.expirationtime.md @@ -4,6 +4,8 @@ ## IdTokenResult.expirationTime property +The ID token expiration time formatted as a UTC string. + Signature: ```typescript diff --git a/docs-exp/auth-types.idtokenresult.issuedattime.md b/docs-exp/auth-types.idtokenresult.issuedattime.md index 931e4797660..cfa4f7117cf 100644 --- a/docs-exp/auth-types.idtokenresult.issuedattime.md +++ b/docs-exp/auth-types.idtokenresult.issuedattime.md @@ -4,6 +4,8 @@ ## IdTokenResult.issuedAtTime property +The ID token issuance time formatted as a UTC string. + Signature: ```typescript diff --git a/docs-exp/auth-types.idtokenresult.md b/docs-exp/auth-types.idtokenresult.md index b7c7dc66b6f..de7393ba273 100644 --- a/docs-exp/auth-types.idtokenresult.md +++ b/docs-exp/auth-types.idtokenresult.md @@ -4,9 +4,9 @@ ## IdTokenResult interface -Parsed IdToken for use in public API +Interface representing ID token result obtained from `getIdTokenResult`. It contains the ID token JWT string and other helper properties for getting different data associated with the token as well as all the decoded payload claims. -https://firebase.google.com/docs/reference/js/firebase.auth.IDTokenResult +Note that these claims are not to be trusted as they are parsed client side. Only server side verification can guarantee the integrity of the token claims. Signature: @@ -18,11 +18,11 @@ export interface IdTokenResult | Property | Type | Description | | --- | --- | --- | -| [authTime](./auth-types.idtokenresult.authtime.md) | string | | -| [claims](./auth-types.idtokenresult.claims.md) | [ParsedToken](./auth-types.parsedtoken.md) | | -| [expirationTime](./auth-types.idtokenresult.expirationtime.md) | string | | -| [issuedAtTime](./auth-types.idtokenresult.issuedattime.md) | string | | -| [signInProvider](./auth-types.idtokenresult.signinprovider.md) | string \| null | | -| [signInSecondFactor](./auth-types.idtokenresult.signinsecondfactor.md) | string \| null | | -| [token](./auth-types.idtokenresult.token.md) | string | | +| [authTime](./auth-types.idtokenresult.authtime.md) | string | The authentication time formatted as a UTC string. This is the time the user authenticated (signed in) and not the time the token was refreshed. | +| [claims](./auth-types.idtokenresult.claims.md) | [ParsedToken](./auth-types.parsedtoken.md) | The entire payload claims of the ID token including the standard reserved claims as well as the custom claims. | +| [expirationTime](./auth-types.idtokenresult.expirationtime.md) | string | The ID token expiration time formatted as a UTC string. | +| [issuedAtTime](./auth-types.idtokenresult.issuedattime.md) | string | The ID token issuance time formatted as a UTC string. | +| [signInProvider](./auth-types.idtokenresult.signinprovider.md) | string \| null | The sign-in provider through which the ID token was obtained (anonymous, custom, phone, password, etc). Note, this does not map to provider IDs. | +| [signInSecondFactor](./auth-types.idtokenresult.signinsecondfactor.md) | string \| null | The type of second factor associated with this session, provided the user was multi-factor authenticated (eg. phone, etc). | +| [token](./auth-types.idtokenresult.token.md) | string | The Firebase Auth ID token JWT string. | diff --git a/docs-exp/auth-types.idtokenresult.signinprovider.md b/docs-exp/auth-types.idtokenresult.signinprovider.md index 62819045f53..f2457987cdc 100644 --- a/docs-exp/auth-types.idtokenresult.signinprovider.md +++ b/docs-exp/auth-types.idtokenresult.signinprovider.md @@ -4,6 +4,8 @@ ## IdTokenResult.signInProvider property +The sign-in provider through which the ID token was obtained (anonymous, custom, phone, password, etc). Note, this does not map to provider IDs. + Signature: ```typescript diff --git a/docs-exp/auth-types.idtokenresult.signinsecondfactor.md b/docs-exp/auth-types.idtokenresult.signinsecondfactor.md index c0228609989..d1ae55482dc 100644 --- a/docs-exp/auth-types.idtokenresult.signinsecondfactor.md +++ b/docs-exp/auth-types.idtokenresult.signinsecondfactor.md @@ -4,6 +4,8 @@ ## IdTokenResult.signInSecondFactor property +The type of second factor associated with this session, provided the user was multi-factor authenticated (eg. phone, etc). + Signature: ```typescript diff --git a/docs-exp/auth-types.idtokenresult.token.md b/docs-exp/auth-types.idtokenresult.token.md index 222cf970c2e..1947e05d8f4 100644 --- a/docs-exp/auth-types.idtokenresult.token.md +++ b/docs-exp/auth-types.idtokenresult.token.md @@ -4,6 +4,8 @@ ## IdTokenResult.token property +The Firebase Auth ID token JWT string. + Signature: ```typescript diff --git a/docs-exp/auth-types.md b/docs-exp/auth-types.md index 8fed5c4494f..d7deb0718f1 100644 --- a/docs-exp/auth-types.md +++ b/docs-exp/auth-types.md @@ -9,62 +9,62 @@ | Class | Description | | --- | --- | | [ActionCodeURL](./auth-types.actioncodeurl.md) | A utility class to parse email action URLs such as password reset, email verification, email link sign in, etc. | -| [AuthCredential](./auth-types.authcredential.md) | https://firebase.google.com/docs/reference/js/firebase.auth.AuthCredential | -| [EmailAuthProvider](./auth-types.emailauthprovider.md) | A provider for generating email & password and email link credentialshttps://firebase.google.com/docs/reference/js/firebase.auth.EmailAuthProvider | -| [MultiFactorResolver](./auth-types.multifactorresolver.md) | https://firebase.google.com/docs/reference/js/firebase.auth.multifactorresolver | -| [OAuthCredential](./auth-types.oauthcredential.md) | https://firebase.google.com/docs/reference/js/firebase.auth.OAuthCredential | -| [PhoneAuthCredential](./auth-types.phoneauthcredential.md) | https://firebase.google.com/docs/reference/js/firebase.auth.phoneauthcredential | -| [PhoneAuthProvider](./auth-types.phoneauthprovider.md) | A provider for generating phone credentialshttps://firebase.google.com/docs/reference/js/firebase.auth.PhoneAuthProvider | -| [PhoneMultiFactorGenerator](./auth-types.phonemultifactorgenerator.md) | https://firebase.google.com/docs/reference/js/firebase.auth.phonemultifactorgenerator | -| [RecaptchaVerifier](./auth-types.recaptchaverifier.md) | https://firebase.google.com/docs/reference/js/firebase.auth.RecaptchaVerifier | +| [AuthCredential](./auth-types.authcredential.md) | Interface that represents the credentials returned by an auth provider. Implementations specify the details about each auth provider's credential requirements. | +| [EmailAuthProvider](./auth-types.emailauthprovider.md) | Email and password auth provider implementation. | +| [MultiFactorResolver](./auth-types.multifactorresolver.md) | The class used to facilitate recovery from [MultiFactorError](./auth-types.multifactorerror.md) when a user needs to provide a second factor to sign in. | +| [OAuthCredential](./auth-types.oauthcredential.md) | Interface that represents the OAuth credentials returned by an OAuth provider. Implementations specify the details about each auth provider's credential requirements. | +| [PhoneAuthCredential](./auth-types.phoneauthcredential.md) | Class that represents the Phone Auth credentials returned by a [PhoneAuthProvider](./auth-types.phoneauthprovider.md). | +| [PhoneAuthProvider](./auth-types.phoneauthprovider.md) | A provider for generating phone credentials. | +| [PhoneMultiFactorGenerator](./auth-types.phonemultifactorgenerator.md) | The class used to initialize a [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md). | +| [RecaptchaVerifier](./auth-types.recaptchaverifier.md) | An [reCAPTCHA](https://www.google.com/recaptcha/)-based application verifier. | ## Enumerations | Enumeration | Description | | --- | --- | -| [Operation](./auth-types.operation.md) | https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeInfo\#operation\_2 | -| [OperationType](./auth-types.operationtype.md) | Supported operation types | -| [ProviderId](./auth-types.providerid.md) | Supported providers | -| [SignInMethod](./auth-types.signinmethod.md) | Supported sign in methods | +| [Operation](./auth-types.operation.md) | An enumeration of the possible email action types. | +| [OperationType](./auth-types.operationtype.md) | Supported operation types. | +| [ProviderId](./auth-types.providerid.md) | Supported providers. | +| [SignInMethod](./auth-types.signinmethod.md) | Supported sign-in methods. | ## Interfaces | Interface | Description | | --- | --- | -| [ActionCodeInfo](./auth-types.actioncodeinfo.md) | https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeInfo | -| [ActionCodeSettings](./auth-types.actioncodesettings.md) | https://firebase.google.com/docs/reference/js/firebase.auth\#actioncodesettings | -| [AdditionalUserInfo](./auth-types.additionaluserinfo.md) | Additional user information. | -| [ApplicationVerifier](./auth-types.applicationverifier.md) | https://firebase.google.com/docs/reference/js/firebase.auth.ApplicationVerifier | -| [Auth](./auth-types.auth.md) | https://firebase.google.com/docs/reference/js/firebase.auth.Auth | -| [AuthError](./auth-types.autherror.md) | https://firebase.google.com/docs/reference/js/firebase.auth.AuthError | -| [AuthProvider](./auth-types.authprovider.md) | A provider for generating credentialshttps://firebase.google.com/docs/reference/js/firebase.auth.AuthProvider | -| [AuthSettings](./auth-types.authsettings.md) | https://firebase.google.com/docs/reference/js/firebase.auth.AuthSettings | -| [Config](./auth-types.config.md) | Auth config object | -| [ConfirmationResult](./auth-types.confirmationresult.md) | https://firebase.google.com/docs/reference/js/firebase.auth.ConfirmationResult | -| [IdTokenResult](./auth-types.idtokenresult.md) | Parsed IdToken for use in public APIhttps://firebase.google.com/docs/reference/js/firebase.auth.IDTokenResult | -| [MultiFactorAssertion](./auth-types.multifactorassertion.md) | https://firebase.google.com/docs/reference/js/firebase.auth.multifactorassertion | -| [MultiFactorError](./auth-types.multifactorerror.md) | https://firebase.google.com/docs/reference/js/firebase.auth.multifactorerror | -| [MultiFactorInfo](./auth-types.multifactorinfo.md) | https://firebase.google.com/docs/reference/js/firebase.auth.multifactorinfo | -| [MultiFactorSession](./auth-types.multifactorsession.md) | https://firebase.google.com/docs/reference/js/firebase.auth.multifactorsession | -| [MultiFactorUser](./auth-types.multifactoruser.md) | https://firebase.google.com/docs/reference/js/firebase.user.multifactoruser | -| [ParsedToken](./auth-types.parsedtoken.md) | Parsed Id TokenTODO(avolkovi): consolidate with parsed\_token in implementation | -| [Persistence](./auth-types.persistence.md) | https://firebase.google.com/docs/reference/js/firebase.auth.Auth\#persistence | -| [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) | https://firebase.google.com/docs/reference/js/firebase.auth.phonemultifactorassertion | -| [PhoneMultiFactorEnrollInfoOptions](./auth-types.phonemultifactorenrollinfooptions.md) | | -| [PhoneMultiFactorSignInInfoOptions](./auth-types.phonemultifactorsignininfooptions.md) | | -| [PhoneSingleFactorInfoOptions](./auth-types.phonesinglefactorinfooptions.md) | | -| [PopupRedirectResolver](./auth-types.popupredirectresolver.md) | No documentation for this yet | -| [ReactNativeAsyncStorage](./auth-types.reactnativeasyncstorage.md) | | -| [User](./auth-types.user.md) | https://firebase.google.com/docs/reference/js/firebase.User | -| [UserCredential](./auth-types.usercredential.md) | https://firebase.google.com/docs/reference/js/firebase.auth\#usercredential | -| [UserInfo](./auth-types.userinfo.md) | https://firebase.google.com/docs/reference/js/firebase.UserInfo | -| [UserMetadata](./auth-types.usermetadata.md) | https://firebase.google.com/docs/reference/js/firebase.auth.UserMetadata | +| [ActionCodeInfo](./auth-types.actioncodeinfo.md) | A response from checkActionCode. | +| [ActionCodeSettings](./auth-types.actioncodesettings.md) | This is the interface that defines the required continue/state URL with optional Android and iOS bundle identifiers. | +| [AdditionalUserInfo](./auth-types.additionaluserinfo.md) | A structure containing additional user information from a federated identity provider. | +| [ApplicationVerifier](./auth-types.applicationverifier.md) | A verifier for domain verification and abuse prevention. Currently, the only implementation is [RecaptchaVerifier](./auth-types.recaptchaverifier.md). | +| [Auth](./auth-types.auth.md) | The Firebase Auth service interface.See [Firebase Authentication](https://firebase.google.com/docs/auth/) for a full guide on how to use the Firebase Auth service. | +| [AuthError](./auth-types.autherror.md) | | +| [AuthProvider](./auth-types.authprovider.md) | Interface that represents an auth provider, used to facilitate creating [AuthCredential](./auth-types.authcredential.md). | +| [AuthSettings](./auth-types.authsettings.md) | Interface representing an Auth instance's settings, currently used for enabling/disabling app verification for phone Auth testing. | +| [Config](./auth-types.config.md) | Auth config object. | +| [ConfirmationResult](./auth-types.confirmationresult.md) | A result from a phone number sign-in, link, or reauthenticate call. | +| [IdTokenResult](./auth-types.idtokenresult.md) | Interface representing ID token result obtained from getIdTokenResult. It contains the ID token JWT string and other helper properties for getting different data associated with the token as well as all the decoded payload claims.Note that these claims are not to be trusted as they are parsed client side. Only server side verification can guarantee the integrity of the token claims. | +| [MultiFactorAssertion](./auth-types.multifactorassertion.md) | The base class for asserting ownership of a second factor. This is used to facilitate enrollment of a second factor on an existing user or sign-in of a user who already verified the first factor. | +| [MultiFactorError](./auth-types.multifactorerror.md) | The error thrown when the user needs to provide a second factor to sign in successfully. The error code for this error is auth/multi-factor-auth-required. | +| [MultiFactorInfo](./auth-types.multifactorinfo.md) | A structure containing the information of a second factor entity. | +| [MultiFactorSession](./auth-types.multifactorsession.md) | The multi-factor session object used for enrolling a second factor on a user or helping sign in an enrolled user with a second factor. | +| [MultiFactorUser](./auth-types.multifactoruser.md) | This is the interface that defines the multi-factor related properties and operations pertaining to a [User](./auth-types.user.md). | +| [ParsedToken](./auth-types.parsedtoken.md) | Parsed ID token. | +| [Persistence](./auth-types.persistence.md) | An enumeration of the possible persistence mechanism types. | +| [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) | The class for asserting ownership of a phone second factor. Provided by [PhoneMultiFactorGenerator.assertion()](./auth-types.phonemultifactorgenerator.assertion.md). | +| [PhoneMultiFactorEnrollInfoOptions](./auth-types.phonemultifactorenrollinfooptions.md) | Options used for enrolling a second factor. | +| [PhoneMultiFactorSignInInfoOptions](./auth-types.phonemultifactorsignininfooptions.md) | Options used for signing-in with a second factor. | +| [PhoneSingleFactorInfoOptions](./auth-types.phonesinglefactorinfooptions.md) | Options used for single-factor sign-in. | +| [PopupRedirectResolver](./auth-types.popupredirectresolver.md) | A resolver used for handling DOM specific operations like signInWithPopup() or signInWithRedirect(). | +| [ReactNativeAsyncStorage](./auth-types.reactnativeasyncstorage.md) | Interface for a supplied AsyncStorage. | +| [User](./auth-types.user.md) | A user account. | +| [UserCredential](./auth-types.usercredential.md) | A structure containing a [User](./auth-types.user.md), an [AuthCredential](./auth-types.authcredential.md), the [OperationType](./auth-types.operationtype.md), and any additional user information that was returned from the identity provider. operationType could be [OperationType.SIGN\_IN](./auth-types.operationtype.sign_in.md) for a sign-in operation, [OperationType.LINK](./auth-types.operationtype.link.md) for a linking operation and [OperationType.REAUTHENTICATE](./auth-types.operationtype.reauthenticate.md) for a reauthentication operation. | +| [UserInfo](./auth-types.userinfo.md) | User profile information, visible only to the Firebase project's apps. | +| [UserMetadata](./auth-types.usermetadata.md) | Interface representing a user's metadata. | ## Type Aliases | Type Alias | Description | | --- | --- | -| [NextOrObserver](./auth-types.nextorobserver.md) | TODO(avolkovi): should we consolidate with Subscribe since we're changing the API anyway? | -| [PhoneInfoOptions](./auth-types.phoneinfooptions.md) | https://firebase.google.com/docs/reference/js/firebase.auth\#phoneinfooptions | -| [UserProfile](./auth-types.userprofile.md) | User profile used in AdditionalUserInfo | +| [NextOrObserver](./auth-types.nextorobserver.md) | Type definition for an event callback. | +| [PhoneInfoOptions](./auth-types.phoneinfooptions.md) | The information required to verify the ownership of a phone number. The information that's required depends on whether you are doing single-factor sign-in, multi-factor enrollment or multi-factor sign-in. | +| [UserProfile](./auth-types.userprofile.md) | User profile used in [AdditionalUserInfo](./auth-types.additionaluserinfo.md). | diff --git a/docs-exp/auth-types.multifactorassertion.factorid.md b/docs-exp/auth-types.multifactorassertion.factorid.md index 75339bf067f..389f8d5583b 100644 --- a/docs-exp/auth-types.multifactorassertion.factorid.md +++ b/docs-exp/auth-types.multifactorassertion.factorid.md @@ -4,6 +4,8 @@ ## MultiFactorAssertion.factorId property +The identifier of the second factor. + Signature: ```typescript diff --git a/docs-exp/auth-types.multifactorassertion.md b/docs-exp/auth-types.multifactorassertion.md index 15569fc4db3..e2bb7bee388 100644 --- a/docs-exp/auth-types.multifactorassertion.md +++ b/docs-exp/auth-types.multifactorassertion.md @@ -4,7 +4,7 @@ ## MultiFactorAssertion interface -https://firebase.google.com/docs/reference/js/firebase.auth.multifactorassertion +The base class for asserting ownership of a second factor. This is used to facilitate enrollment of a second factor on an existing user or sign-in of a user who already verified the first factor. Signature: @@ -16,5 +16,5 @@ export interface MultiFactorAssertion | Property | Type | Description | | --- | --- | --- | -| [factorId](./auth-types.multifactorassertion.factorid.md) | string | | +| [factorId](./auth-types.multifactorassertion.factorid.md) | string | The identifier of the second factor. | diff --git a/docs-exp/auth-types.multifactorerror.credential.md b/docs-exp/auth-types.multifactorerror.credential.md index 96bf195d2a7..6a2c9d8461d 100644 --- a/docs-exp/auth-types.multifactorerror.credential.md +++ b/docs-exp/auth-types.multifactorerror.credential.md @@ -4,6 +4,8 @@ ## MultiFactorError.credential property +The original credential used as a first factor. + Signature: ```typescript diff --git a/docs-exp/auth-types.multifactorerror.md b/docs-exp/auth-types.multifactorerror.md index b3de26523cf..2d42aa7888b 100644 --- a/docs-exp/auth-types.multifactorerror.md +++ b/docs-exp/auth-types.multifactorerror.md @@ -4,7 +4,7 @@ ## MultiFactorError interface -https://firebase.google.com/docs/reference/js/firebase.auth.multifactorerror +The error thrown when the user needs to provide a second factor to sign in successfully. The error code for this error is `auth/multi-factor-auth-required`. Signature: @@ -13,10 +13,36 @@ export interface MultiFactorError extends AuthError ``` Extends: [AuthError](./auth-types.autherror.md) +## Example + + +```javascript +let resolver; +let multiFactorHints; + +signInWithEmailAndPassword(auth, email, password) + .then((result) => { + // User signed in. No 2nd factor challenge is needed. + }) + .catch((error) => { + if (error.code == 'auth/multi-factor-auth-required') { + resolver = getMultiFactorResolver(auth, error); + multiFactorHints = resolver.hints; + } else { + // Handle other errors. + } + }); + +// Obtain a multiFactorAssertion by verifying the second factor. + +const userCredential = await resolver.resolveSignIn(multiFactorAssertion); + +``` + ## Properties | Property | Type | Description | | --- | --- | --- | -| [credential](./auth-types.multifactorerror.credential.md) | [AuthCredential](./auth-types.authcredential.md) | | -| [operationType](./auth-types.multifactorerror.operationtype.md) | [OperationType](./auth-types.operationtype.md) | | +| [credential](./auth-types.multifactorerror.credential.md) | [AuthCredential](./auth-types.authcredential.md) | The original credential used as a first factor. | +| [operationType](./auth-types.multifactorerror.operationtype.md) | [OperationType](./auth-types.operationtype.md) | The type of operation (e.g., sign-in, link, or reauthenticate) during which the error was raised. | diff --git a/docs-exp/auth-types.multifactorerror.operationtype.md b/docs-exp/auth-types.multifactorerror.operationtype.md index 9720ba8e154..194fe01bb90 100644 --- a/docs-exp/auth-types.multifactorerror.operationtype.md +++ b/docs-exp/auth-types.multifactorerror.operationtype.md @@ -4,6 +4,8 @@ ## MultiFactorError.operationType property +The type of operation (e.g., sign-in, link, or reauthenticate) during which the error was raised. + Signature: ```typescript diff --git a/docs-exp/auth-types.multifactorinfo.displayname.md b/docs-exp/auth-types.multifactorinfo.displayname.md index 5d52c8f06db..5501594b816 100644 --- a/docs-exp/auth-types.multifactorinfo.displayname.md +++ b/docs-exp/auth-types.multifactorinfo.displayname.md @@ -4,6 +4,8 @@ ## MultiFactorInfo.displayName property +The user friendly name of the current second factor. + Signature: ```typescript diff --git a/docs-exp/auth-types.multifactorinfo.enrollmenttime.md b/docs-exp/auth-types.multifactorinfo.enrollmenttime.md index a205bd20065..8bc3596ac22 100644 --- a/docs-exp/auth-types.multifactorinfo.enrollmenttime.md +++ b/docs-exp/auth-types.multifactorinfo.enrollmenttime.md @@ -4,6 +4,8 @@ ## MultiFactorInfo.enrollmentTime property +The enrollment date of the second factor formatted as a UTC string. + Signature: ```typescript diff --git a/docs-exp/auth-types.multifactorinfo.factorid.md b/docs-exp/auth-types.multifactorinfo.factorid.md index 9b6413c3c36..bea535fdc0e 100644 --- a/docs-exp/auth-types.multifactorinfo.factorid.md +++ b/docs-exp/auth-types.multifactorinfo.factorid.md @@ -4,6 +4,8 @@ ## MultiFactorInfo.factorId property +The identifier of the second factor. + Signature: ```typescript diff --git a/docs-exp/auth-types.multifactorinfo.md b/docs-exp/auth-types.multifactorinfo.md index fc8f15d3944..179b8a1f475 100644 --- a/docs-exp/auth-types.multifactorinfo.md +++ b/docs-exp/auth-types.multifactorinfo.md @@ -4,7 +4,7 @@ ## MultiFactorInfo interface -https://firebase.google.com/docs/reference/js/firebase.auth.multifactorinfo +A structure containing the information of a second factor entity. Signature: @@ -16,8 +16,8 @@ export interface MultiFactorInfo | Property | Type | Description | | --- | --- | --- | -| [displayName](./auth-types.multifactorinfo.displayname.md) | string \| null | | -| [enrollmentTime](./auth-types.multifactorinfo.enrollmenttime.md) | string | | -| [factorId](./auth-types.multifactorinfo.factorid.md) | [ProviderId](./auth-types.providerid.md) | | -| [uid](./auth-types.multifactorinfo.uid.md) | string | | +| [displayName](./auth-types.multifactorinfo.displayname.md) | string \| null | The user friendly name of the current second factor. | +| [enrollmentTime](./auth-types.multifactorinfo.enrollmenttime.md) | string | The enrollment date of the second factor formatted as a UTC string. | +| [factorId](./auth-types.multifactorinfo.factorid.md) | [ProviderId](./auth-types.providerid.md) | The identifier of the second factor. | +| [uid](./auth-types.multifactorinfo.uid.md) | string | The multi-factor enrollment ID. | diff --git a/docs-exp/auth-types.multifactorinfo.uid.md b/docs-exp/auth-types.multifactorinfo.uid.md index 7c2dad6df7a..58ba0a91783 100644 --- a/docs-exp/auth-types.multifactorinfo.uid.md +++ b/docs-exp/auth-types.multifactorinfo.uid.md @@ -4,6 +4,8 @@ ## MultiFactorInfo.uid property +The multi-factor enrollment ID. + Signature: ```typescript diff --git a/docs-exp/auth-types.multifactorresolver.hints.md b/docs-exp/auth-types.multifactorresolver.hints.md index 1fe9ff6c0ff..36ccd07f62d 100644 --- a/docs-exp/auth-types.multifactorresolver.hints.md +++ b/docs-exp/auth-types.multifactorresolver.hints.md @@ -4,6 +4,8 @@ ## MultiFactorResolver.hints property +The list of hints for the second factors needed to complete the sign-in for the current session. + Signature: ```typescript diff --git a/docs-exp/auth-types.multifactorresolver.md b/docs-exp/auth-types.multifactorresolver.md index 46316dac83d..89a27a59427 100644 --- a/docs-exp/auth-types.multifactorresolver.md +++ b/docs-exp/auth-types.multifactorresolver.md @@ -4,7 +4,7 @@ ## MultiFactorResolver class -https://firebase.google.com/docs/reference/js/firebase.auth.multifactorresolver +The class used to facilitate recovery from [MultiFactorError](./auth-types.multifactorerror.md) when a user needs to provide a second factor to sign in. Signature: @@ -12,16 +12,59 @@ https://firebase.google.com/docs/reference/js/firebase.auth.multifactorresolver export abstract class MultiFactorResolver ``` +## Example + + +```javascript +let resolver; +let multiFactorHints; + +signInWithEmailAndPassword(auth, email, password) + .then((result) => { + // User signed in. No 2nd factor challenge is needed. + }) + .catch((error) => { + if (error.code == 'auth/multi-factor-auth-required') { + resolver = getMultiFactorResolver(auth, error); + // Show UI to let user select second factor. + multiFactorHints = resolver.hints; + } else { + // Handle other errors. + } + }); + +// The enrolled second factors that can be used to complete +// sign-in are returned in the `MultiFactorResolver.hints` list. +// UI needs to be presented to allow the user to select a second factor +// from that list. + +const selectedHint = // ; selected from multiFactorHints +const phoneAuthProvider = new PhoneAuthProvider(auth); +const phoneInfoOptions = { + multiFactorHint: selectedHint, + session: resolver.session +}; +const verificationId = phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, appVerifier); +// Store `verificationId` and show UI to let user enter verification code. + +// UI to enter verification code and continue. +// Continue button click handler +const phoneAuthCredential = PhoneAuthProvider.credential(verificationId, verificationCode); +const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(phoneAuthCredential); +const userCredential = await resolver.resolveSignIn(multiFactorAssertion); + +``` + ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [hints](./auth-types.multifactorresolver.hints.md) | | [MultiFactorInfo](./auth-types.multifactorinfo.md)\[\] | | -| [session](./auth-types.multifactorresolver.session.md) | | [MultiFactorSession](./auth-types.multifactorsession.md) | | +| [hints](./auth-types.multifactorresolver.hints.md) | | [MultiFactorInfo](./auth-types.multifactorinfo.md)\[\] | The list of hints for the second factors needed to complete the sign-in for the current session. | +| [session](./auth-types.multifactorresolver.session.md) | | [MultiFactorSession](./auth-types.multifactorsession.md) | The session identifier for the current sign-in flow, which can be used to complete the second factor sign-in. | ## Methods | Method | Modifiers | Description | | --- | --- | --- | -| [resolveSignIn(assertion)](./auth-types.multifactorresolver.resolvesignin.md) | | | +| [resolveSignIn(assertion)](./auth-types.multifactorresolver.resolvesignin.md) | | A helper function to help users complete sign in with a second factor using an [MultiFactorAssertion](./auth-types.multifactorassertion.md) confirming the user successfully completed the second factor challenge. | diff --git a/docs-exp/auth-types.multifactorresolver.resolvesignin.md b/docs-exp/auth-types.multifactorresolver.resolvesignin.md index 245110ec88c..c2b085a3cd0 100644 --- a/docs-exp/auth-types.multifactorresolver.resolvesignin.md +++ b/docs-exp/auth-types.multifactorresolver.resolvesignin.md @@ -4,6 +4,8 @@ ## MultiFactorResolver.resolveSignIn() method +A helper function to help users complete sign in with a second factor using an [MultiFactorAssertion](./auth-types.multifactorassertion.md) confirming the user successfully completed the second factor challenge. + Signature: ```typescript @@ -14,9 +16,21 @@ resolveSignIn(assertion: MultiFactorAssertion): Promise; | Parameter | Type | Description | | --- | --- | --- | -| assertion | [MultiFactorAssertion](./auth-types.multifactorassertion.md) | | +| assertion | [MultiFactorAssertion](./auth-types.multifactorassertion.md) | The multi-factor assertion to resolve sign-in with. | Returns: Promise<[UserCredential](./auth-types.usercredential.md)> +The promise that resolves with the user credential object. + +## Example + + +```javascript +const phoneAuthCredential = PhoneAuthProvider.credential(verificationId, verificationCode); +const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(phoneAuthCredential); +const userCredential = await resolver.resolveSignIn(multiFactorAssertion); + +``` + diff --git a/docs-exp/auth-types.multifactorresolver.session.md b/docs-exp/auth-types.multifactorresolver.session.md index ab51c8b820d..982d6804257 100644 --- a/docs-exp/auth-types.multifactorresolver.session.md +++ b/docs-exp/auth-types.multifactorresolver.session.md @@ -4,6 +4,8 @@ ## MultiFactorResolver.session property +The session identifier for the current sign-in flow, which can be used to complete the second factor sign-in. + Signature: ```typescript diff --git a/docs-exp/auth-types.multifactorsession.md b/docs-exp/auth-types.multifactorsession.md index fa4c4349441..436b748c34e 100644 --- a/docs-exp/auth-types.multifactorsession.md +++ b/docs-exp/auth-types.multifactorsession.md @@ -4,7 +4,7 @@ ## MultiFactorSession interface -https://firebase.google.com/docs/reference/js/firebase.auth.multifactorsession +The multi-factor session object used for enrolling a second factor on a user or helping sign in an enrolled user with a second factor. Signature: diff --git a/docs-exp/auth-types.multifactoruser.enroll.md b/docs-exp/auth-types.multifactoruser.enroll.md index e31fe0fc83c..a51b67ad58b 100644 --- a/docs-exp/auth-types.multifactoruser.enroll.md +++ b/docs-exp/auth-types.multifactoruser.enroll.md @@ -4,6 +4,8 @@ ## MultiFactorUser.enroll() method +Enrolls a second factor as identified by the [MultiFactorAssertion](./auth-types.multifactorassertion.md) for the user. On resolution, the user tokens are updated to reflect the change in the JWT payload. Accepts an additional display name parameter used to identify the second factor to the end user. Recent re-authentication is required for this operation to succeed. On successful enrollment, existing Firebase sessions (refresh tokens) are revoked. When a new factor is enrolled, an email notification is sent to the user’s email. + Signature: ```typescript @@ -17,10 +19,33 @@ enroll( | Parameter | Type | Description | | --- | --- | --- | -| assertion | [MultiFactorAssertion](./auth-types.multifactorassertion.md) | | -| displayName | string \| null | | +| assertion | [MultiFactorAssertion](./auth-types.multifactorassertion.md) | The multi-factor assertion to enroll with. | +| displayName | string \| null | The display name of the second factor. | Returns: Promise<void> +## Example + + +```javascript +const multiFactorUser = multiFactor(auth.currentUser); +const multiFactorSession = await multiFactorUser.getSession(); + +// Send verification code. +const phoneAuthProvider = new PhoneAuthProvider(auth); +const phoneInfoOptions = { + phoneNumber: phoneNumber, + session: multiFactorSession +}; +const verificationId = await phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, appVerifier); + +// Obtain verification code from user. +const phoneAuthCredential = PhoneAuthProvider.credential(verificationId, verificationCode); +const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(phoneAuthCredential); +await multiFactorUser.enroll(multiFactorAssertion); +// Second factor enrolled. + +``` + diff --git a/docs-exp/auth-types.multifactoruser.enrolledfactors.md b/docs-exp/auth-types.multifactoruser.enrolledfactors.md index 2f04912ecb1..7919a1505b4 100644 --- a/docs-exp/auth-types.multifactoruser.enrolledfactors.md +++ b/docs-exp/auth-types.multifactoruser.enrolledfactors.md @@ -4,6 +4,8 @@ ## MultiFactorUser.enrolledFactors property +Returns a list of the user's enrolled second factors. + Signature: ```typescript diff --git a/docs-exp/auth-types.multifactoruser.getsession.md b/docs-exp/auth-types.multifactoruser.getsession.md index 70d23240cea..9944464e9eb 100644 --- a/docs-exp/auth-types.multifactoruser.getsession.md +++ b/docs-exp/auth-types.multifactoruser.getsession.md @@ -4,6 +4,8 @@ ## MultiFactorUser.getSession() method +Returns the session identifier for a second factor enrollment operation. This is used to identify the user trying to enroll a second factor. + Signature: ```typescript @@ -13,3 +15,27 @@ getSession(): Promise; Promise<[MultiFactorSession](./auth-types.multifactorsession.md)> +The promise that resolves with the [MultiFactorSession](./auth-types.multifactorsession.md). + +## Example + + +```javascript +const multiFactorUser = multiFactor(auth.currentUser); +const multiFactorSession = await multiFactorUser.getSession(); + +// Send verification code. +const phoneAuthProvider = new PhoneAuthProvider(auth); +const phoneInfoOptions = { + phoneNumber: phoneNumber, + session: multiFactorSession +}; +const verificationId = await phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, appVerifier); + +// Obtain verification code from user. +const phoneAuthCredential = PhoneAuthProvider.credential(verificationId, verificationCode); +const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(phoneAuthCredential); +await multiFactorUser.enroll(multiFactorAssertion); + +``` + diff --git a/docs-exp/auth-types.multifactoruser.md b/docs-exp/auth-types.multifactoruser.md index cb5ee260d3e..e40bb6ce3ba 100644 --- a/docs-exp/auth-types.multifactoruser.md +++ b/docs-exp/auth-types.multifactoruser.md @@ -4,7 +4,7 @@ ## MultiFactorUser interface -https://firebase.google.com/docs/reference/js/firebase.user.multifactoruser +This is the interface that defines the multi-factor related properties and operations pertaining to a [User](./auth-types.user.md). Signature: @@ -16,13 +16,13 @@ export interface MultiFactorUser | Property | Type | Description | | --- | --- | --- | -| [enrolledFactors](./auth-types.multifactoruser.enrolledfactors.md) | [MultiFactorInfo](./auth-types.multifactorinfo.md)\[\] | | +| [enrolledFactors](./auth-types.multifactoruser.enrolledfactors.md) | [MultiFactorInfo](./auth-types.multifactorinfo.md)\[\] | Returns a list of the user's enrolled second factors. | ## Methods | Method | Description | | --- | --- | -| [enroll(assertion, displayName)](./auth-types.multifactoruser.enroll.md) | | -| [getSession()](./auth-types.multifactoruser.getsession.md) | | -| [unenroll(option)](./auth-types.multifactoruser.unenroll.md) | | +| [enroll(assertion, displayName)](./auth-types.multifactoruser.enroll.md) | Enrolls a second factor as identified by the [MultiFactorAssertion](./auth-types.multifactorassertion.md) for the user. On resolution, the user tokens are updated to reflect the change in the JWT payload. Accepts an additional display name parameter used to identify the second factor to the end user. Recent re-authentication is required for this operation to succeed. On successful enrollment, existing Firebase sessions (refresh tokens) are revoked. When a new factor is enrolled, an email notification is sent to the user’s email. | +| [getSession()](./auth-types.multifactoruser.getsession.md) | Returns the session identifier for a second factor enrollment operation. This is used to identify the user trying to enroll a second factor. | +| [unenroll(option)](./auth-types.multifactoruser.unenroll.md) | Unenrolls the specified second factor. To specify the factor to remove, pass a [MultiFactorInfo](./auth-types.multifactorinfo.md) object (retrieved from [MultiFactorUser.enrolledFactors](./auth-types.multifactoruser.enrolledfactors.md)) or the factor's UID string. Sessions are not revoked when the account is unenrolled. An email notification is likely to be sent to the user notifying them of the change. Recent re-authentication is required for this operation to succeed. When an existing factor is unenrolled, an email notification is sent to the user’s email. | diff --git a/docs-exp/auth-types.multifactoruser.unenroll.md b/docs-exp/auth-types.multifactoruser.unenroll.md index efb4ac0cdfd..1ee948e90eb 100644 --- a/docs-exp/auth-types.multifactoruser.unenroll.md +++ b/docs-exp/auth-types.multifactoruser.unenroll.md @@ -4,6 +4,8 @@ ## MultiFactorUser.unenroll() method +Unenrolls the specified second factor. To specify the factor to remove, pass a [MultiFactorInfo](./auth-types.multifactorinfo.md) object (retrieved from [MultiFactorUser.enrolledFactors](./auth-types.multifactoruser.enrolledfactors.md)) or the factor's UID string. Sessions are not revoked when the account is unenrolled. An email notification is likely to be sent to the user notifying them of the change. Recent re-authentication is required for this operation to succeed. When an existing factor is unenrolled, an email notification is sent to the user’s email. + Signature: ```typescript @@ -14,9 +16,21 @@ unenroll(option: MultiFactorInfo | string): Promise; | Parameter | Type | Description | | --- | --- | --- | -| option | [MultiFactorInfo](./auth-types.multifactorinfo.md) \| string | | +| option | [MultiFactorInfo](./auth-types.multifactorinfo.md) \| string | The multi-factor option to unenroll. | Returns: Promise<void> +- A promise which resolves when the unenroll operation is complete. + +## Example + + +```javascript +const multiFactorUser = multiFactor(auth.currentUser); +// Present user the option to choose which factor to unenroll. +await multiFactorUser.unenroll(multiFactorUser.enrolledFactors[i]) + +``` + diff --git a/docs-exp/auth-types.nextorobserver.md b/docs-exp/auth-types.nextorobserver.md index 9daf288571a..8671703ca9d 100644 --- a/docs-exp/auth-types.nextorobserver.md +++ b/docs-exp/auth-types.nextorobserver.md @@ -4,7 +4,7 @@ ## NextOrObserver type -TODO(avolkovi): should we consolidate with Subscribe since we're changing the API anyway? +Type definition for an event callback. Signature: diff --git a/docs-exp/auth-types.oauthcredential.accesstoken.md b/docs-exp/auth-types.oauthcredential.accesstoken.md index 276bacfae87..62c79284b66 100644 --- a/docs-exp/auth-types.oauthcredential.accesstoken.md +++ b/docs-exp/auth-types.oauthcredential.accesstoken.md @@ -4,6 +4,8 @@ ## OAuthCredential.accessToken property +The OAuth access token associated with the credential if it belongs to an OAuth provider, such as `facebook.com`, `twitter.com`, etc. + Signature: ```typescript diff --git a/docs-exp/auth-types.oauthcredential.fromjson.md b/docs-exp/auth-types.oauthcredential.fromjson.md index 483f8a78712..2b2869abf23 100644 --- a/docs-exp/auth-types.oauthcredential.fromjson.md +++ b/docs-exp/auth-types.oauthcredential.fromjson.md @@ -4,6 +4,8 @@ ## OAuthCredential.fromJSON() method +Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth-types.authcredential.md). + Signature: ```typescript @@ -14,9 +16,11 @@ static fromJSON(json: object | string): OAuthCredential | null; | Parameter | Type | Description | | --- | --- | --- | -| json | object \| string | | +| json | object \| string | Input can be either Object or the stringified representation of the object. When string is provided, JSON.parse would be called first. | Returns: [OAuthCredential](./auth-types.oauthcredential.md) \| null +If the JSON input does not represent an [AuthCredential](./auth-types.authcredential.md), null is returned. + diff --git a/docs-exp/auth-types.oauthcredential.idtoken.md b/docs-exp/auth-types.oauthcredential.idtoken.md index 833cf622122..5f2bf89aee4 100644 --- a/docs-exp/auth-types.oauthcredential.idtoken.md +++ b/docs-exp/auth-types.oauthcredential.idtoken.md @@ -4,6 +4,8 @@ ## OAuthCredential.idToken property +The OAuth ID token associated with the credential if it belongs to an OIDC provider, such as `google.com`. + Signature: ```typescript diff --git a/docs-exp/auth-types.oauthcredential.md b/docs-exp/auth-types.oauthcredential.md index 526916240a9..89e79d18518 100644 --- a/docs-exp/auth-types.oauthcredential.md +++ b/docs-exp/auth-types.oauthcredential.md @@ -4,7 +4,7 @@ ## OAuthCredential class -https://firebase.google.com/docs/reference/js/firebase.auth.OAuthCredential +Interface that represents the OAuth credentials returned by an OAuth provider. Implementations specify the details about each auth provider's credential requirements. Signature: @@ -17,13 +17,13 @@ export abstract class OAuthCredential extends AuthCredential | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [accessToken](./auth-types.oauthcredential.accesstoken.md) | | string | | -| [idToken](./auth-types.oauthcredential.idtoken.md) | | string | | -| [secret](./auth-types.oauthcredential.secret.md) | | string | | +| [accessToken](./auth-types.oauthcredential.accesstoken.md) | | string | The OAuth access token associated with the credential if it belongs to an OAuth provider, such as facebook.com, twitter.com, etc. | +| [idToken](./auth-types.oauthcredential.idtoken.md) | | string | The OAuth ID token associated with the credential if it belongs to an OIDC provider, such as google.com. | +| [secret](./auth-types.oauthcredential.secret.md) | | string | The OAuth access token secret associated with the credential if it belongs to an OAuth 1.0 provider, such as twitter.com. | ## Methods | Method | Modifiers | Description | | --- | --- | --- | -| [fromJSON(json)](./auth-types.oauthcredential.fromjson.md) | static | | +| [fromJSON(json)](./auth-types.oauthcredential.fromjson.md) | static | Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth-types.authcredential.md). | diff --git a/docs-exp/auth-types.oauthcredential.secret.md b/docs-exp/auth-types.oauthcredential.secret.md index 21bbcee19c7..830e5a8e2d0 100644 --- a/docs-exp/auth-types.oauthcredential.secret.md +++ b/docs-exp/auth-types.oauthcredential.secret.md @@ -4,6 +4,8 @@ ## OAuthCredential.secret property +The OAuth access token secret associated with the credential if it belongs to an OAuth 1.0 provider, such as `twitter.com`. + Signature: ```typescript diff --git a/docs-exp/auth-types.operation.md b/docs-exp/auth-types.operation.md index 46abf37184e..1bc7ca0c9d3 100644 --- a/docs-exp/auth-types.operation.md +++ b/docs-exp/auth-types.operation.md @@ -4,7 +4,7 @@ ## Operation enum -https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeInfo\#operation\_2 +An enumeration of the possible email action types. Signature: @@ -16,10 +16,10 @@ export const enum Operation | Member | Value | Description | | --- | --- | --- | -| EMAIL\_SIGNIN | 'EMAIL_SIGNIN' | | -| PASSWORD\_RESET | 'PASSWORD_RESET' | | -| RECOVER\_EMAIL | 'RECOVER_EMAIL' | | -| REVERT\_SECOND\_FACTOR\_ADDITION | 'REVERT_SECOND_FACTOR_ADDITION' | | -| VERIFY\_AND\_CHANGE\_EMAIL | 'VERIFY_AND_CHANGE_EMAIL' | | -| VERIFY\_EMAIL | 'VERIFY_EMAIL' | | +| EMAIL\_SIGNIN | 'EMAIL_SIGNIN' | The email link sign-in action. | +| PASSWORD\_RESET | 'PASSWORD_RESET' | The password reset action. | +| RECOVER\_EMAIL | 'RECOVER_EMAIL' | The email revocation action. | +| REVERT\_SECOND\_FACTOR\_ADDITION | 'REVERT_SECOND_FACTOR_ADDITION' | The revert second factor addition email action. | +| VERIFY\_AND\_CHANGE\_EMAIL | 'VERIFY_AND_CHANGE_EMAIL' | The revert second factor addition email action. | +| VERIFY\_EMAIL | 'VERIFY_EMAIL' | The email verification action. | diff --git a/docs-exp/auth-types.operationtype.md b/docs-exp/auth-types.operationtype.md index 8dd44a52b3c..99d4207adbd 100644 --- a/docs-exp/auth-types.operationtype.md +++ b/docs-exp/auth-types.operationtype.md @@ -4,7 +4,7 @@ ## OperationType enum -Supported operation types +Supported operation types. Signature: @@ -16,7 +16,7 @@ export const enum OperationType | Member | Value | Description | | --- | --- | --- | -| LINK | 'link' | | -| REAUTHENTICATE | 'reauthenticate' | | -| SIGN\_IN | 'signIn' | | +| LINK | 'link' | Operation involving linking an additional provider to an already signed-in user. | +| REAUTHENTICATE | 'reauthenticate' | Operation involving using a provider to reauthenticate an already signed-in user. | +| SIGN\_IN | 'signIn' | Operation involving signing in a user. | diff --git a/docs-exp/auth-types.parsedtoken.auth_time.md b/docs-exp/auth-types.parsedtoken.auth_time.md index ba89759d0a2..5be5afa1fcb 100644 --- a/docs-exp/auth-types.parsedtoken.auth_time.md +++ b/docs-exp/auth-types.parsedtoken.auth_time.md @@ -4,6 +4,8 @@ ## ParsedToken.auth\_time property +Time at which authentication was performed. + Signature: ```typescript diff --git a/docs-exp/auth-types.parsedtoken.exp.md b/docs-exp/auth-types.parsedtoken.exp.md index fa63501e70a..1526e1198ad 100644 --- a/docs-exp/auth-types.parsedtoken.exp.md +++ b/docs-exp/auth-types.parsedtoken.exp.md @@ -4,6 +4,8 @@ ## ParsedToken.exp property +Expiration time of the token. + Signature: ```typescript diff --git a/docs-exp/auth-types.parsedtoken.firebase.md b/docs-exp/auth-types.parsedtoken.firebase.md index 946fa7eeb66..189d10ba64e 100644 --- a/docs-exp/auth-types.parsedtoken.firebase.md +++ b/docs-exp/auth-types.parsedtoken.firebase.md @@ -4,6 +4,8 @@ ## ParsedToken.firebase property +Firebase specific claims, containing the provider(s) used to authenticate the user. + Signature: ```typescript diff --git a/docs-exp/auth-types.parsedtoken.iat.md b/docs-exp/auth-types.parsedtoken.iat.md index 1f233edcb1f..c480bacc989 100644 --- a/docs-exp/auth-types.parsedtoken.iat.md +++ b/docs-exp/auth-types.parsedtoken.iat.md @@ -4,6 +4,8 @@ ## ParsedToken.iat property +Issuance time of the token. + Signature: ```typescript diff --git a/docs-exp/auth-types.parsedtoken.md b/docs-exp/auth-types.parsedtoken.md index 30466793bd3..c192ad7ffea 100644 --- a/docs-exp/auth-types.parsedtoken.md +++ b/docs-exp/auth-types.parsedtoken.md @@ -4,9 +4,7 @@ ## ParsedToken interface -Parsed Id Token - -TODO(avolkovi): consolidate with parsed\_token in implementation +Parsed ID token. Signature: @@ -18,9 +16,9 @@ export interface ParsedToken | Property | Type | Description | | --- | --- | --- | -| [auth\_time](./auth-types.parsedtoken.auth_time.md) | string | | -| [exp](./auth-types.parsedtoken.exp.md) | string | | -| [firebase](./auth-types.parsedtoken.firebase.md) | { 'sign\_in\_provider'?: string; 'sign\_in\_second\_factor'?: string; } | | -| [iat](./auth-types.parsedtoken.iat.md) | string | | -| [sub](./auth-types.parsedtoken.sub.md) | string | | +| [auth\_time](./auth-types.parsedtoken.auth_time.md) | string | Time at which authentication was performed. | +| [exp](./auth-types.parsedtoken.exp.md) | string | Expiration time of the token. | +| [firebase](./auth-types.parsedtoken.firebase.md) | { 'sign\_in\_provider'?: string; 'sign\_in\_second\_factor'?: string; } | Firebase specific claims, containing the provider(s) used to authenticate the user. | +| [iat](./auth-types.parsedtoken.iat.md) | string | Issuance time of the token. | +| [sub](./auth-types.parsedtoken.sub.md) | string | UID of the user. | diff --git a/docs-exp/auth-types.parsedtoken.sub.md b/docs-exp/auth-types.parsedtoken.sub.md index 0307efde1f5..262a05c5d4c 100644 --- a/docs-exp/auth-types.parsedtoken.sub.md +++ b/docs-exp/auth-types.parsedtoken.sub.md @@ -4,6 +4,8 @@ ## ParsedToken.sub property +UID of the user. + Signature: ```typescript diff --git a/docs-exp/auth-types.persistence.md b/docs-exp/auth-types.persistence.md index 5b785a55f33..c290291bc50 100644 --- a/docs-exp/auth-types.persistence.md +++ b/docs-exp/auth-types.persistence.md @@ -4,7 +4,7 @@ ## Persistence interface -https://firebase.google.com/docs/reference/js/firebase.auth.Auth\#persistence +An enumeration of the possible persistence mechanism types. Signature: @@ -16,5 +16,5 @@ export interface Persistence | Property | Type | Description | | --- | --- | --- | -| [type](./auth-types.persistence.type.md) | 'SESSION' \| 'LOCAL' \| 'NONE' | | +| [type](./auth-types.persistence.type.md) | 'SESSION' \| 'LOCAL' \| 'NONE' | Type of Persistence. - 'SESSION' is used for temporary persistence such as sessionStorage. - 'LOCAL' is used for long term persistence such as localStorage or 'IndexedDB\`. - 'NONE' is used for in-memory, or no persistence. | diff --git a/docs-exp/auth-types.persistence.type.md b/docs-exp/auth-types.persistence.type.md index 9de2d0c0bee..6cdd734f962 100644 --- a/docs-exp/auth-types.persistence.type.md +++ b/docs-exp/auth-types.persistence.type.md @@ -4,6 +4,8 @@ ## Persistence.type property +Type of Persistence. - 'SESSION' is used for temporary persistence such as `sessionStorage`. - 'LOCAL' is used for long term persistence such as `localStorage` or 'IndexedDB\`. - 'NONE' is used for in-memory, or no persistence. + Signature: ```typescript diff --git a/docs-exp/auth-types.phoneauthcredential.fromjson.md b/docs-exp/auth-types.phoneauthcredential.fromjson.md index fc2ba74883a..9046b450f7b 100644 --- a/docs-exp/auth-types.phoneauthcredential.fromjson.md +++ b/docs-exp/auth-types.phoneauthcredential.fromjson.md @@ -4,6 +4,8 @@ ## PhoneAuthCredential.fromJSON() method +Interface that represents the credentials returned by an auth provider. Implementations specify the details about each auth provider's credential requirements. + Signature: ```typescript diff --git a/docs-exp/auth-types.phoneauthcredential.md b/docs-exp/auth-types.phoneauthcredential.md index 8cb19042899..db7fe60eac5 100644 --- a/docs-exp/auth-types.phoneauthcredential.md +++ b/docs-exp/auth-types.phoneauthcredential.md @@ -4,7 +4,7 @@ ## PhoneAuthCredential class -https://firebase.google.com/docs/reference/js/firebase.auth.phoneauthcredential +Class that represents the Phone Auth credentials returned by a [PhoneAuthProvider](./auth-types.phoneauthprovider.md). Signature: @@ -17,5 +17,5 @@ export abstract class PhoneAuthCredential extends AuthCredential | Method | Modifiers | Description | | --- | --- | --- | -| [fromJSON(json)](./auth-types.phoneauthcredential.fromjson.md) | static | | +| [fromJSON(json)](./auth-types.phoneauthcredential.fromjson.md) | static | Interface that represents the credentials returned by an auth provider. Implementations specify the details about each auth provider's credential requirements. | diff --git a/docs-exp/auth-types.phoneauthprovider._constructor_.md b/docs-exp/auth-types.phoneauthprovider._constructor_.md index 27251f405c8..e008f4b6fba 100644 --- a/docs-exp/auth-types.phoneauthprovider._constructor_.md +++ b/docs-exp/auth-types.phoneauthprovider._constructor_.md @@ -16,5 +16,5 @@ constructor(auth?: Auth | null); | Parameter | Type | Description | | --- | --- | --- | -| auth | [Auth](./auth-types.auth.md) \| null | | +| auth | [Auth](./auth-types.auth.md) \| null | The Firebase Auth instance in which sign-ins should occur. Uses the default Auth instance if unspecified. | diff --git a/docs-exp/auth-types.phoneauthprovider.credential.md b/docs-exp/auth-types.phoneauthprovider.credential.md index 3e063737cf0..ae24c0ef86c 100644 --- a/docs-exp/auth-types.phoneauthprovider.credential.md +++ b/docs-exp/auth-types.phoneauthprovider.credential.md @@ -4,6 +4,8 @@ ## PhoneAuthProvider.credential() method +Creates a phone auth credential, given the verification ID from [PhoneAuthProvider.verifyPhoneNumber()](./auth-types.phoneauthprovider.verifyphonenumber.md) and the code that was sent to the user's mobile device. + Signature: ```typescript @@ -17,10 +19,35 @@ static credential( | Parameter | Type | Description | | --- | --- | --- | -| verificationId | string | | -| verificationCode | string | | +| verificationId | string | The verification ID returned from [PhoneAuthProvider.verifyPhoneNumber()](./auth-types.phoneauthprovider.verifyphonenumber.md). | +| verificationCode | string | The verification code sent to the user's mobile device. | Returns: [AuthCredential](./auth-types.authcredential.md) +The auth provider credential. + +## Example 1 + + +```javascript +const provider = new PhoneAuthProvider(auth); +const verificationId = provider.verifyPhoneNumber(phoneNumber, applicationVerifier); +// Obtain verificationCode from the user. +const authCredential = PhoneAuthProvider.credential(verificationId, verificationCode); +const userCredential = signInWithCredential(auth, authCredential); + +``` + +## Example 2 + +An alternative flow is provided using the `signInWithPhoneNumber` method. + +```javascript +const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier); +// Obtain verificationCode from the user. +const userCredential = await confirmationResult.confirm(verificationCode); + +``` + diff --git a/docs-exp/auth-types.phoneauthprovider.md b/docs-exp/auth-types.phoneauthprovider.md index 2321bd78d72..584991d57aa 100644 --- a/docs-exp/auth-types.phoneauthprovider.md +++ b/docs-exp/auth-types.phoneauthprovider.md @@ -4,9 +4,7 @@ ## PhoneAuthProvider class -A provider for generating phone credentials - -https://firebase.google.com/docs/reference/js/firebase.auth.PhoneAuthProvider +A provider for generating phone credentials. Signature: @@ -15,6 +13,20 @@ export class PhoneAuthProvider implements AuthProvider ``` Implements: [AuthProvider](./auth-types.authprovider.md) +## Example + + +```javascript +// 'recaptcha-container' is the ID of an element in the DOM. +const applicationVerifier = new RecaptchaVerifier('recaptcha-container'); +const provider = new PhoneAuthProvider(auth); +const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier); +const verificationCode = window.prompt('Please enter the verification code that was sent to your mobile device.'); +const phoneCredential = await PhoneAuthProvider.credential(verificationId, verificationCode); +const userCredential = await signInWithCredential(auth, phoneCredential); + +``` + ## Constructors | Constructor | Modifiers | Description | @@ -25,14 +37,14 @@ export class PhoneAuthProvider implements AuthProvider | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [PHONE\_SIGN\_IN\_METHOD](./auth-types.phoneauthprovider.phone_sign_in_method.md) | static | [SignInMethod](./auth-types.signinmethod.md) | | -| [PROVIDER\_ID](./auth-types.phoneauthprovider.provider_id.md) | static | [ProviderId](./auth-types.providerid.md) | | -| [providerId](./auth-types.phoneauthprovider.providerid.md) | | [ProviderId](./auth-types.providerid.md) | | +| [PHONE\_SIGN\_IN\_METHOD](./auth-types.phoneauthprovider.phone_sign_in_method.md) | static | [SignInMethod](./auth-types.signinmethod.md) | Always set to [SignInMethod.PHONE](./auth-types.signinmethod.phone.md). | +| [PROVIDER\_ID](./auth-types.phoneauthprovider.provider_id.md) | static | [ProviderId](./auth-types.providerid.md) | Always set to [ProviderId.PHONE](./auth-types.providerid.phone.md). | +| [providerId](./auth-types.phoneauthprovider.providerid.md) | | [ProviderId](./auth-types.providerid.md) | Always set to [ProviderId.PHONE](./auth-types.providerid.phone.md). | ## Methods | Method | Modifiers | Description | | --- | --- | --- | -| [credential(verificationId, verificationCode)](./auth-types.phoneauthprovider.credential.md) | static | | -| [verifyPhoneNumber(phoneInfoOptions, applicationVerifier)](./auth-types.phoneauthprovider.verifyphonenumber.md) | | | +| [credential(verificationId, verificationCode)](./auth-types.phoneauthprovider.credential.md) | static | Creates a phone auth credential, given the verification ID from [PhoneAuthProvider.verifyPhoneNumber()](./auth-types.phoneauthprovider.verifyphonenumber.md) and the code that was sent to the user's mobile device. | +| [verifyPhoneNumber(phoneInfoOptions, applicationVerifier)](./auth-types.phoneauthprovider.verifyphonenumber.md) | | Starts a phone number authentication flow by sending a verification code to the given phone number. Returns an ID that can be passed to [PhoneAuthProvider.credential()](./auth-types.phoneauthprovider.credential.md) to identify this flow. | diff --git a/docs-exp/auth-types.phoneauthprovider.phone_sign_in_method.md b/docs-exp/auth-types.phoneauthprovider.phone_sign_in_method.md index a138cf4f643..b3f8a844518 100644 --- a/docs-exp/auth-types.phoneauthprovider.phone_sign_in_method.md +++ b/docs-exp/auth-types.phoneauthprovider.phone_sign_in_method.md @@ -4,6 +4,8 @@ ## PhoneAuthProvider.PHONE\_SIGN\_IN\_METHOD property +Always set to [SignInMethod.PHONE](./auth-types.signinmethod.phone.md). + Signature: ```typescript diff --git a/docs-exp/auth-types.phoneauthprovider.provider_id.md b/docs-exp/auth-types.phoneauthprovider.provider_id.md index a2d422cc365..2e767a1dcc1 100644 --- a/docs-exp/auth-types.phoneauthprovider.provider_id.md +++ b/docs-exp/auth-types.phoneauthprovider.provider_id.md @@ -4,6 +4,8 @@ ## PhoneAuthProvider.PROVIDER\_ID property +Always set to [ProviderId.PHONE](./auth-types.providerid.phone.md). + Signature: ```typescript diff --git a/docs-exp/auth-types.phoneauthprovider.providerid.md b/docs-exp/auth-types.phoneauthprovider.providerid.md index d93c98f1f8c..87fee5e4e1b 100644 --- a/docs-exp/auth-types.phoneauthprovider.providerid.md +++ b/docs-exp/auth-types.phoneauthprovider.providerid.md @@ -4,6 +4,8 @@ ## PhoneAuthProvider.providerId property +Always set to [ProviderId.PHONE](./auth-types.providerid.phone.md). + Signature: ```typescript diff --git a/docs-exp/auth-types.phoneauthprovider.verifyphonenumber.md b/docs-exp/auth-types.phoneauthprovider.verifyphonenumber.md index 83f934ddb82..4bd36b87c32 100644 --- a/docs-exp/auth-types.phoneauthprovider.verifyphonenumber.md +++ b/docs-exp/auth-types.phoneauthprovider.verifyphonenumber.md @@ -4,6 +4,8 @@ ## PhoneAuthProvider.verifyPhoneNumber() method +Starts a phone number authentication flow by sending a verification code to the given phone number. Returns an ID that can be passed to [PhoneAuthProvider.credential()](./auth-types.phoneauthprovider.credential.md) to identify this flow. + Signature: ```typescript @@ -17,10 +19,35 @@ verifyPhoneNumber( | Parameter | Type | Description | | --- | --- | --- | -| phoneInfoOptions | [PhoneInfoOptions](./auth-types.phoneinfooptions.md) \| string | | -| applicationVerifier | [ApplicationVerifier](./auth-types.applicationverifier.md) | | +| phoneInfoOptions | [PhoneInfoOptions](./auth-types.phoneinfooptions.md) \| string | The user's [PhoneInfoOptions](./auth-types.phoneinfooptions.md). The phone number should be in E.164 format (e.g. +16505550101). | +| applicationVerifier | [ApplicationVerifier](./auth-types.applicationverifier.md) | For abuse prevention, this method also requires a [ApplicationVerifier](./auth-types.applicationverifier.md). This SDK includes a reCAPTCHA-based implementation, [RecaptchaVerifier](./auth-types.recaptchaverifier.md). | Returns: Promise<string> +A Promise for the verification ID. + +## Example 1 + + +```javascript +const provider = new PhoneAuthProvider(auth); +const verificationId = await provider.verifyPhoneNumber(phoneNumber, applicationVerifier); +// Obtain verificationCode from the user. +const authCredential = PhoneAuthProvider.credential(verificationId, verificationCode); +const userCredential = await signInWithCredential(auth, authCredential); + +``` + +## Example 2 + +An alternative flow is provided using the `signInWithPhoneNumber` method. + +```javascript +const confirmationResult = signInWithPhoneNumber(auth, phoneNumber, applicationVerifier); +// Obtain verificationCode from the user. +const userCredential = confirmationResult.confirm(verificationCode); + +``` + diff --git a/docs-exp/auth-types.phoneinfooptions.md b/docs-exp/auth-types.phoneinfooptions.md index a46d881bfb5..3371b2b01d1 100644 --- a/docs-exp/auth-types.phoneinfooptions.md +++ b/docs-exp/auth-types.phoneinfooptions.md @@ -4,7 +4,7 @@ ## PhoneInfoOptions type -https://firebase.google.com/docs/reference/js/firebase.auth\#phoneinfooptions +The information required to verify the ownership of a phone number. The information that's required depends on whether you are doing single-factor sign-in, multi-factor enrollment or multi-factor sign-in. Signature: diff --git a/docs-exp/auth-types.phonemultifactorassertion.md b/docs-exp/auth-types.phonemultifactorassertion.md index d2e6a47de25..57ae9731875 100644 --- a/docs-exp/auth-types.phonemultifactorassertion.md +++ b/docs-exp/auth-types.phonemultifactorassertion.md @@ -4,7 +4,7 @@ ## PhoneMultiFactorAssertion interface -https://firebase.google.com/docs/reference/js/firebase.auth.phonemultifactorassertion +The class for asserting ownership of a phone second factor. Provided by [PhoneMultiFactorGenerator.assertion()](./auth-types.phonemultifactorgenerator.assertion.md). Signature: diff --git a/docs-exp/auth-types.phonemultifactorenrollinfooptions.md b/docs-exp/auth-types.phonemultifactorenrollinfooptions.md index 447376d2446..75d8fe0a63f 100644 --- a/docs-exp/auth-types.phonemultifactorenrollinfooptions.md +++ b/docs-exp/auth-types.phonemultifactorenrollinfooptions.md @@ -4,6 +4,8 @@ ## PhoneMultiFactorEnrollInfoOptions interface +Options used for enrolling a second factor. + Signature: ```typescript @@ -14,6 +16,6 @@ export interface PhoneMultiFactorEnrollInfoOptions | Property | Type | Description | | --- | --- | --- | -| [phoneNumber](./auth-types.phonemultifactorenrollinfooptions.phonenumber.md) | string | | -| [session](./auth-types.phonemultifactorenrollinfooptions.session.md) | [MultiFactorSession](./auth-types.multifactorsession.md) | | +| [phoneNumber](./auth-types.phonemultifactorenrollinfooptions.phonenumber.md) | string | Phone number to send a verification code to. | +| [session](./auth-types.phonemultifactorenrollinfooptions.session.md) | [MultiFactorSession](./auth-types.multifactorsession.md) | The [MultiFactorSession](./auth-types.multifactorsession.md) obtained via [MultiFactorUser.getSession()](./auth-types.multifactoruser.getsession.md). | diff --git a/docs-exp/auth-types.phonemultifactorenrollinfooptions.phonenumber.md b/docs-exp/auth-types.phonemultifactorenrollinfooptions.phonenumber.md index 8fe88cafa7c..79b6353dd74 100644 --- a/docs-exp/auth-types.phonemultifactorenrollinfooptions.phonenumber.md +++ b/docs-exp/auth-types.phonemultifactorenrollinfooptions.phonenumber.md @@ -4,6 +4,8 @@ ## PhoneMultiFactorEnrollInfoOptions.phoneNumber property +Phone number to send a verification code to. + Signature: ```typescript diff --git a/docs-exp/auth-types.phonemultifactorenrollinfooptions.session.md b/docs-exp/auth-types.phonemultifactorenrollinfooptions.session.md index db214681f5b..12ffa79b846 100644 --- a/docs-exp/auth-types.phonemultifactorenrollinfooptions.session.md +++ b/docs-exp/auth-types.phonemultifactorenrollinfooptions.session.md @@ -4,6 +4,8 @@ ## PhoneMultiFactorEnrollInfoOptions.session property +The [MultiFactorSession](./auth-types.multifactorsession.md) obtained via [MultiFactorUser.getSession()](./auth-types.multifactoruser.getsession.md). + Signature: ```typescript diff --git a/docs-exp/auth-types.phonemultifactorgenerator.assertion.md b/docs-exp/auth-types.phonemultifactorgenerator.assertion.md index 7a4565c9a98..1ddcf2b450e 100644 --- a/docs-exp/auth-types.phonemultifactorgenerator.assertion.md +++ b/docs-exp/auth-types.phonemultifactorgenerator.assertion.md @@ -4,6 +4,8 @@ ## PhoneMultiFactorGenerator.assertion() method +Provides a [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) to confirm ownership of the phone second factor. + Signature: ```typescript @@ -16,9 +18,11 @@ static assertion( | Parameter | Type | Description | | --- | --- | --- | -| phoneAuthCredential | [PhoneAuthCredential](./auth-types.phoneauthcredential.md) | | +| phoneAuthCredential | [PhoneAuthCredential](./auth-types.phoneauthcredential.md) | A credential provided by [PhoneAuthProvider.credential()](./auth-types.phoneauthprovider.credential.md). | Returns: [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) +A [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) which can be used with [MultiFactorResolver.resolveSignIn()](./auth-types.multifactorresolver.resolvesignin.md) + diff --git a/docs-exp/auth-types.phonemultifactorgenerator.factor_id.md b/docs-exp/auth-types.phonemultifactorgenerator.factor_id.md index 94552bd4c90..f95635dc72a 100644 --- a/docs-exp/auth-types.phonemultifactorgenerator.factor_id.md +++ b/docs-exp/auth-types.phonemultifactorgenerator.factor_id.md @@ -4,6 +4,8 @@ ## PhoneMultiFactorGenerator.FACTOR\_ID property +The identifier of the phone second factor: [ProviderId.PHONE](./auth-types.providerid.phone.md). + Signature: ```typescript diff --git a/docs-exp/auth-types.phonemultifactorgenerator.md b/docs-exp/auth-types.phonemultifactorgenerator.md index 140e132e5c7..54414a615ce 100644 --- a/docs-exp/auth-types.phonemultifactorgenerator.md +++ b/docs-exp/auth-types.phonemultifactorgenerator.md @@ -4,7 +4,7 @@ ## PhoneMultiFactorGenerator class -https://firebase.google.com/docs/reference/js/firebase.auth.phonemultifactorgenerator +The class used to initialize a [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md). Signature: @@ -16,11 +16,11 @@ export abstract class PhoneMultiFactorGenerator | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [FACTOR\_ID](./auth-types.phonemultifactorgenerator.factor_id.md) | static | [ProviderId](./auth-types.providerid.md) | | +| [FACTOR\_ID](./auth-types.phonemultifactorgenerator.factor_id.md) | static | [ProviderId](./auth-types.providerid.md) | The identifier of the phone second factor: [ProviderId.PHONE](./auth-types.providerid.phone.md). | ## Methods | Method | Modifiers | Description | | --- | --- | --- | -| [assertion(phoneAuthCredential)](./auth-types.phonemultifactorgenerator.assertion.md) | static | | +| [assertion(phoneAuthCredential)](./auth-types.phonemultifactorgenerator.assertion.md) | static | Provides a [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) to confirm ownership of the phone second factor. | diff --git a/docs-exp/auth-types.phonemultifactorsignininfooptions.md b/docs-exp/auth-types.phonemultifactorsignininfooptions.md index dae9188a691..b6d627cfd4b 100644 --- a/docs-exp/auth-types.phonemultifactorsignininfooptions.md +++ b/docs-exp/auth-types.phonemultifactorsignininfooptions.md @@ -4,6 +4,8 @@ ## PhoneMultiFactorSignInInfoOptions interface +Options used for signing-in with a second factor. + Signature: ```typescript @@ -14,7 +16,7 @@ export interface PhoneMultiFactorSignInInfoOptions | Property | Type | Description | | --- | --- | --- | -| [multiFactorHint](./auth-types.phonemultifactorsignininfooptions.multifactorhint.md) | [MultiFactorInfo](./auth-types.multifactorinfo.md) | | -| [multiFactorUid](./auth-types.phonemultifactorsignininfooptions.multifactoruid.md) | string | | -| [session](./auth-types.phonemultifactorsignininfooptions.session.md) | [MultiFactorSession](./auth-types.multifactorsession.md) | | +| [multiFactorHint](./auth-types.phonemultifactorsignininfooptions.multifactorhint.md) | [MultiFactorInfo](./auth-types.multifactorinfo.md) | The [MultiFactorInfo](./auth-types.multifactorinfo.md) obtained via [MultiFactorResolver.hints](./auth-types.multifactorresolver.hints.md).One of multiFactorHint or multiFactorUid is required. | +| [multiFactorUid](./auth-types.phonemultifactorsignininfooptions.multifactoruid.md) | string | The uid of the second factor.One of multiFactorHint or multiFactorUid is required. | +| [session](./auth-types.phonemultifactorsignininfooptions.session.md) | [MultiFactorSession](./auth-types.multifactorsession.md) | The [MultiFactorSession](./auth-types.multifactorsession.md) obtained via [MultiFactorResolver.session](./auth-types.multifactorresolver.session.md). | diff --git a/docs-exp/auth-types.phonemultifactorsignininfooptions.multifactorhint.md b/docs-exp/auth-types.phonemultifactorsignininfooptions.multifactorhint.md index add03e11348..9224ca91ed4 100644 --- a/docs-exp/auth-types.phonemultifactorsignininfooptions.multifactorhint.md +++ b/docs-exp/auth-types.phonemultifactorsignininfooptions.multifactorhint.md @@ -4,6 +4,10 @@ ## PhoneMultiFactorSignInInfoOptions.multiFactorHint property +The [MultiFactorInfo](./auth-types.multifactorinfo.md) obtained via [MultiFactorResolver.hints](./auth-types.multifactorresolver.hints.md). + +One of `multiFactorHint` or `multiFactorUid` is required. + Signature: ```typescript diff --git a/docs-exp/auth-types.phonemultifactorsignininfooptions.multifactoruid.md b/docs-exp/auth-types.phonemultifactorsignininfooptions.multifactoruid.md index 684026a83f0..690d97a442d 100644 --- a/docs-exp/auth-types.phonemultifactorsignininfooptions.multifactoruid.md +++ b/docs-exp/auth-types.phonemultifactorsignininfooptions.multifactoruid.md @@ -4,6 +4,10 @@ ## PhoneMultiFactorSignInInfoOptions.multiFactorUid property +The uid of the second factor. + +One of `multiFactorHint` or `multiFactorUid` is required. + Signature: ```typescript diff --git a/docs-exp/auth-types.phonemultifactorsignininfooptions.session.md b/docs-exp/auth-types.phonemultifactorsignininfooptions.session.md index 7a6f51c6d60..4d30851de0b 100644 --- a/docs-exp/auth-types.phonemultifactorsignininfooptions.session.md +++ b/docs-exp/auth-types.phonemultifactorsignininfooptions.session.md @@ -4,6 +4,8 @@ ## PhoneMultiFactorSignInInfoOptions.session property +The [MultiFactorSession](./auth-types.multifactorsession.md) obtained via [MultiFactorResolver.session](./auth-types.multifactorresolver.session.md). + Signature: ```typescript diff --git a/docs-exp/auth-types.phonesinglefactorinfooptions.md b/docs-exp/auth-types.phonesinglefactorinfooptions.md index 69f54678555..fc4612d2d74 100644 --- a/docs-exp/auth-types.phonesinglefactorinfooptions.md +++ b/docs-exp/auth-types.phonesinglefactorinfooptions.md @@ -4,6 +4,8 @@ ## PhoneSingleFactorInfoOptions interface +Options used for single-factor sign-in. + Signature: ```typescript @@ -14,5 +16,5 @@ export interface PhoneSingleFactorInfoOptions | Property | Type | Description | | --- | --- | --- | -| [phoneNumber](./auth-types.phonesinglefactorinfooptions.phonenumber.md) | string | | +| [phoneNumber](./auth-types.phonesinglefactorinfooptions.phonenumber.md) | string | Phone number to send a verification code to. | diff --git a/docs-exp/auth-types.phonesinglefactorinfooptions.phonenumber.md b/docs-exp/auth-types.phonesinglefactorinfooptions.phonenumber.md index 97e1de367f5..a7fb6242833 100644 --- a/docs-exp/auth-types.phonesinglefactorinfooptions.phonenumber.md +++ b/docs-exp/auth-types.phonesinglefactorinfooptions.phonenumber.md @@ -4,6 +4,8 @@ ## PhoneSingleFactorInfoOptions.phoneNumber property +Phone number to send a verification code to. + Signature: ```typescript diff --git a/docs-exp/auth-types.popupredirectresolver.md b/docs-exp/auth-types.popupredirectresolver.md index 5faf7698f91..26074dd7421 100644 --- a/docs-exp/auth-types.popupredirectresolver.md +++ b/docs-exp/auth-types.popupredirectresolver.md @@ -4,7 +4,7 @@ ## PopupRedirectResolver interface -No documentation for this yet +A resolver used for handling DOM specific operations like `signInWithPopup()` or `signInWithRedirect()`. Signature: diff --git a/docs-exp/auth-types.providerid.md b/docs-exp/auth-types.providerid.md index aaf1e9a3a35..fec988ae5fc 100644 --- a/docs-exp/auth-types.providerid.md +++ b/docs-exp/auth-types.providerid.md @@ -4,7 +4,7 @@ ## ProviderId enum -Supported providers +Supported providers. Signature: diff --git a/docs-exp/auth-types.reactnativeasyncstorage.getitem.md b/docs-exp/auth-types.reactnativeasyncstorage.getitem.md index 94b149edb56..6eb2028d14c 100644 --- a/docs-exp/auth-types.reactnativeasyncstorage.getitem.md +++ b/docs-exp/auth-types.reactnativeasyncstorage.getitem.md @@ -4,6 +4,8 @@ ## ReactNativeAsyncStorage.getItem() method +Retrieve an item from storage. + Signature: ```typescript @@ -14,7 +16,7 @@ getItem(key: string): Promise; | Parameter | Type | Description | | --- | --- | --- | -| key | string | | +| key | string | storage key. | Returns: diff --git a/docs-exp/auth-types.reactnativeasyncstorage.md b/docs-exp/auth-types.reactnativeasyncstorage.md index 3804977e864..5393b3910b5 100644 --- a/docs-exp/auth-types.reactnativeasyncstorage.md +++ b/docs-exp/auth-types.reactnativeasyncstorage.md @@ -4,6 +4,8 @@ ## ReactNativeAsyncStorage interface +Interface for a supplied AsyncStorage. + Signature: ```typescript @@ -14,7 +16,7 @@ export interface ReactNativeAsyncStorage | Method | Description | | --- | --- | -| [getItem(key)](./auth-types.reactnativeasyncstorage.getitem.md) | | -| [removeItem(key)](./auth-types.reactnativeasyncstorage.removeitem.md) | | -| [setItem(key, value)](./auth-types.reactnativeasyncstorage.setitem.md) | | +| [getItem(key)](./auth-types.reactnativeasyncstorage.getitem.md) | Retrieve an item from storage. | +| [removeItem(key)](./auth-types.reactnativeasyncstorage.removeitem.md) | Remove an item from storage. | +| [setItem(key, value)](./auth-types.reactnativeasyncstorage.setitem.md) | Persist an item in storage. | diff --git a/docs-exp/auth-types.reactnativeasyncstorage.removeitem.md b/docs-exp/auth-types.reactnativeasyncstorage.removeitem.md index 98e273c4d05..ddaa392cf9f 100644 --- a/docs-exp/auth-types.reactnativeasyncstorage.removeitem.md +++ b/docs-exp/auth-types.reactnativeasyncstorage.removeitem.md @@ -4,6 +4,8 @@ ## ReactNativeAsyncStorage.removeItem() method +Remove an item from storage. + Signature: ```typescript @@ -14,7 +16,7 @@ removeItem(key: string): Promise; | Parameter | Type | Description | | --- | --- | --- | -| key | string | | +| key | string | storage key. | Returns: diff --git a/docs-exp/auth-types.reactnativeasyncstorage.setitem.md b/docs-exp/auth-types.reactnativeasyncstorage.setitem.md index 17531386e46..d7b228616cd 100644 --- a/docs-exp/auth-types.reactnativeasyncstorage.setitem.md +++ b/docs-exp/auth-types.reactnativeasyncstorage.setitem.md @@ -4,6 +4,8 @@ ## ReactNativeAsyncStorage.setItem() method +Persist an item in storage. + Signature: ```typescript @@ -14,8 +16,8 @@ setItem(key: string, value: string): Promise; | Parameter | Type | Description | | --- | --- | --- | -| key | string | | -| value | string | | +| key | string | storage key. | +| value | string | storage value. | Returns: diff --git a/docs-exp/auth-types.recaptchaverifier.clear.md b/docs-exp/auth-types.recaptchaverifier.clear.md index 55d3f1ca3c1..e25d32ae7b5 100644 --- a/docs-exp/auth-types.recaptchaverifier.clear.md +++ b/docs-exp/auth-types.recaptchaverifier.clear.md @@ -4,6 +4,8 @@ ## RecaptchaVerifier.clear() method +Clears the reCAPTCHA widget from the page and destroys the instance. + Signature: ```typescript diff --git a/docs-exp/auth-types.recaptchaverifier.md b/docs-exp/auth-types.recaptchaverifier.md index 1c9bdf40a67..ceb3edb7692 100644 --- a/docs-exp/auth-types.recaptchaverifier.md +++ b/docs-exp/auth-types.recaptchaverifier.md @@ -4,7 +4,7 @@ ## RecaptchaVerifier class -https://firebase.google.com/docs/reference/js/firebase.auth.RecaptchaVerifier +An [reCAPTCHA](https://www.google.com/recaptcha/)-based application verifier. Signature: @@ -23,13 +23,13 @@ export abstract class RecaptchaVerifier implements ApplicationVerifier | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [type](./auth-types.recaptchaverifier.type.md) | | string | | +| [type](./auth-types.recaptchaverifier.type.md) | | string | The application verifier type. For a reCAPTCHA verifier, this is 'recaptcha'. | ## Methods | Method | Modifiers | Description | | --- | --- | --- | -| [clear()](./auth-types.recaptchaverifier.clear.md) | | | -| [render()](./auth-types.recaptchaverifier.render.md) | | | -| [verify()](./auth-types.recaptchaverifier.verify.md) | | | +| [clear()](./auth-types.recaptchaverifier.clear.md) | | Clears the reCAPTCHA widget from the page and destroys the instance. | +| [render()](./auth-types.recaptchaverifier.render.md) | | Renders the reCAPTCHA widget on the page. | +| [verify()](./auth-types.recaptchaverifier.verify.md) | | Waits for the user to solve the reCAPTCHA and resolves with the reCAPTCHA token. | diff --git a/docs-exp/auth-types.recaptchaverifier.render.md b/docs-exp/auth-types.recaptchaverifier.render.md index 728caab96d0..5cbfa0b6be2 100644 --- a/docs-exp/auth-types.recaptchaverifier.render.md +++ b/docs-exp/auth-types.recaptchaverifier.render.md @@ -4,6 +4,8 @@ ## RecaptchaVerifier.render() method +Renders the reCAPTCHA widget on the page. + Signature: ```typescript @@ -13,3 +15,5 @@ render(): Promise; Promise<number> +A Promise that resolves with the reCAPTCHA widget ID. + diff --git a/docs-exp/auth-types.recaptchaverifier.type.md b/docs-exp/auth-types.recaptchaverifier.type.md index 4e000332c59..7e202a68f8d 100644 --- a/docs-exp/auth-types.recaptchaverifier.type.md +++ b/docs-exp/auth-types.recaptchaverifier.type.md @@ -4,6 +4,8 @@ ## RecaptchaVerifier.type property +The application verifier type. For a reCAPTCHA verifier, this is 'recaptcha'. + Signature: ```typescript diff --git a/docs-exp/auth-types.recaptchaverifier.verify.md b/docs-exp/auth-types.recaptchaverifier.verify.md index e0335cb7a98..7977ae388f7 100644 --- a/docs-exp/auth-types.recaptchaverifier.verify.md +++ b/docs-exp/auth-types.recaptchaverifier.verify.md @@ -4,6 +4,8 @@ ## RecaptchaVerifier.verify() method +Waits for the user to solve the reCAPTCHA and resolves with the reCAPTCHA token. + Signature: ```typescript @@ -13,3 +15,5 @@ verify(): Promise; Promise<string> +A Promise for the reCAPTCHA token. + diff --git a/docs-exp/auth-types.signinmethod.md b/docs-exp/auth-types.signinmethod.md index dfd7ca0ceb0..6871ee95bd6 100644 --- a/docs-exp/auth-types.signinmethod.md +++ b/docs-exp/auth-types.signinmethod.md @@ -4,7 +4,7 @@ ## SignInMethod enum -Supported sign in methods +Supported sign-in methods. Signature: diff --git a/docs-exp/auth-types.user.delete.md b/docs-exp/auth-types.user.delete.md index e8868741dc3..86f63287cb8 100644 --- a/docs-exp/auth-types.user.delete.md +++ b/docs-exp/auth-types.user.delete.md @@ -4,6 +4,10 @@ ## User.delete() method +Deletes and signs out the user. + +Important: this is a security-sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and then call one of the reauthentication methods like `reauthenticateWithCredential`. + Signature: ```typescript diff --git a/docs-exp/auth-types.user.emailverified.md b/docs-exp/auth-types.user.emailverified.md index 98b1999336f..32bde397782 100644 --- a/docs-exp/auth-types.user.emailverified.md +++ b/docs-exp/auth-types.user.emailverified.md @@ -4,6 +4,8 @@ ## User.emailVerified property +Whether the email has been verified with `sendEmailVerification` and `applyActionCode`. + Signature: ```typescript diff --git a/docs-exp/auth-types.user.getidtoken.md b/docs-exp/auth-types.user.getidtoken.md index 83a13d93420..e1a421159c2 100644 --- a/docs-exp/auth-types.user.getidtoken.md +++ b/docs-exp/auth-types.user.getidtoken.md @@ -4,6 +4,10 @@ ## User.getIdToken() method +Returns a JSON Web Token (JWT) used to identify the user to a Firebase service. + +Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one. + Signature: ```typescript @@ -14,7 +18,7 @@ getIdToken(forceRefresh?: boolean): Promise; | Parameter | Type | Description | | --- | --- | --- | -| forceRefresh | boolean | | +| forceRefresh | boolean | Force refresh regardless of token expiration. | Returns: diff --git a/docs-exp/auth-types.user.getidtokenresult.md b/docs-exp/auth-types.user.getidtokenresult.md index 29fa689f867..db451357842 100644 --- a/docs-exp/auth-types.user.getidtokenresult.md +++ b/docs-exp/auth-types.user.getidtokenresult.md @@ -4,6 +4,10 @@ ## User.getIdTokenResult() method +Returns a deserialized JSON Web Token (JWT) used to identitfy the user to a Firebase service. + +Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one. + Signature: ```typescript @@ -14,7 +18,7 @@ getIdTokenResult(forceRefresh?: boolean): Promise; | Parameter | Type | Description | | --- | --- | --- | -| forceRefresh | boolean | | +| forceRefresh | boolean | Force refresh regardless of token expiration. | Returns: diff --git a/docs-exp/auth-types.user.isanonymous.md b/docs-exp/auth-types.user.isanonymous.md index 9e679c81b09..9ac4e143aaf 100644 --- a/docs-exp/auth-types.user.isanonymous.md +++ b/docs-exp/auth-types.user.isanonymous.md @@ -4,6 +4,8 @@ ## User.isAnonymous property +Whether the user is authenticated using the [ProviderId.ANONYMOUS](./auth-types.providerid.anonymous.md) provider. + Signature: ```typescript diff --git a/docs-exp/auth-types.user.md b/docs-exp/auth-types.user.md index 73a5dcbd3ae..f6ce6aa8656 100644 --- a/docs-exp/auth-types.user.md +++ b/docs-exp/auth-types.user.md @@ -4,7 +4,7 @@ ## User interface -https://firebase.google.com/docs/reference/js/firebase.User +A user account. Signature: @@ -17,20 +17,20 @@ export interface User extends UserInfo | Property | Type | Description | | --- | --- | --- | -| [emailVerified](./auth-types.user.emailverified.md) | boolean | | -| [isAnonymous](./auth-types.user.isanonymous.md) | boolean | | -| [metadata](./auth-types.user.metadata.md) | [UserMetadata](./auth-types.usermetadata.md) | | -| [providerData](./auth-types.user.providerdata.md) | [UserInfo](./auth-types.userinfo.md)\[\] | | -| [refreshToken](./auth-types.user.refreshtoken.md) | string | | -| [tenantId](./auth-types.user.tenantid.md) | string \| null | | +| [emailVerified](./auth-types.user.emailverified.md) | boolean | Whether the email has been verified with sendEmailVerification and applyActionCode. | +| [isAnonymous](./auth-types.user.isanonymous.md) | boolean | Whether the user is authenticated using the [ProviderId.ANONYMOUS](./auth-types.providerid.anonymous.md) provider. | +| [metadata](./auth-types.user.metadata.md) | [UserMetadata](./auth-types.usermetadata.md) | Additional metadata around user creation and sign-in times. | +| [providerData](./auth-types.user.providerdata.md) | [UserInfo](./auth-types.userinfo.md)\[\] | Additional per provider such as displayName and profile information. | +| [refreshToken](./auth-types.user.refreshtoken.md) | string | Refresh token used to reauthenticate the user. Avoid using this directly and prefer to refresh the ID token instead. | +| [tenantId](./auth-types.user.tenantid.md) | string \| null | The user's tenant ID. This is a read-only property, which indicates the tenant ID used to sign in the user. This is null if the user is signed in from the parent project. | ## Methods | Method | Description | | --- | --- | -| [delete()](./auth-types.user.delete.md) | | -| [getIdToken(forceRefresh)](./auth-types.user.getidtoken.md) | | -| [getIdTokenResult(forceRefresh)](./auth-types.user.getidtokenresult.md) | | -| [reload()](./auth-types.user.reload.md) | | -| [toJSON()](./auth-types.user.tojson.md) | | +| [delete()](./auth-types.user.delete.md) | Deletes and signs out the user.Important: this is a security-sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and then call one of the reauthentication methods like reauthenticateWithCredential. | +| [getIdToken(forceRefresh)](./auth-types.user.getidtoken.md) | Returns a JSON Web Token (JWT) used to identify the user to a Firebase service.Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one. | +| [getIdTokenResult(forceRefresh)](./auth-types.user.getidtokenresult.md) | Returns a deserialized JSON Web Token (JWT) used to identitfy the user to a Firebase service.Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one. | +| [reload()](./auth-types.user.reload.md) | Refreshes the user, if signed in. | +| [toJSON()](./auth-types.user.tojson.md) | Returns a JSON-serializable representation of this object. | diff --git a/docs-exp/auth-types.user.metadata.md b/docs-exp/auth-types.user.metadata.md index 5ea9521b2cd..a7829f2fe04 100644 --- a/docs-exp/auth-types.user.metadata.md +++ b/docs-exp/auth-types.user.metadata.md @@ -4,6 +4,8 @@ ## User.metadata property +Additional metadata around user creation and sign-in times. + Signature: ```typescript diff --git a/docs-exp/auth-types.user.providerdata.md b/docs-exp/auth-types.user.providerdata.md index 6c7cf6def44..e0f43210ec2 100644 --- a/docs-exp/auth-types.user.providerdata.md +++ b/docs-exp/auth-types.user.providerdata.md @@ -4,6 +4,8 @@ ## User.providerData property +Additional per provider such as displayName and profile information. + Signature: ```typescript diff --git a/docs-exp/auth-types.user.refreshtoken.md b/docs-exp/auth-types.user.refreshtoken.md index 953ed1c4e54..4267915a368 100644 --- a/docs-exp/auth-types.user.refreshtoken.md +++ b/docs-exp/auth-types.user.refreshtoken.md @@ -4,6 +4,8 @@ ## User.refreshToken property +Refresh token used to reauthenticate the user. Avoid using this directly and prefer to refresh the ID token instead. + Signature: ```typescript diff --git a/docs-exp/auth-types.user.reload.md b/docs-exp/auth-types.user.reload.md index 3a9879344d0..4e231909ae9 100644 --- a/docs-exp/auth-types.user.reload.md +++ b/docs-exp/auth-types.user.reload.md @@ -4,6 +4,8 @@ ## User.reload() method +Refreshes the user, if signed in. + Signature: ```typescript diff --git a/docs-exp/auth-types.user.tenantid.md b/docs-exp/auth-types.user.tenantid.md index 5a4f180bd65..f10c3439ed1 100644 --- a/docs-exp/auth-types.user.tenantid.md +++ b/docs-exp/auth-types.user.tenantid.md @@ -4,8 +4,24 @@ ## User.tenantId property +The user's tenant ID. This is a read-only property, which indicates the tenant ID used to sign in the user. This is null if the user is signed in from the parent project. + Signature: ```typescript readonly tenantId: string | null; ``` + +## Example + + +```javascript +// Set the tenant ID on Auth instance. +auth.tenantId = 'TENANT_PROJECT_ID'; + +// All future sign-in request now include tenant ID. +const result = await signInWithEmailAndPassword(auth, email, password); +// result.user.tenantId should be 'TENANT_PROJECT_ID'. + +``` + diff --git a/docs-exp/auth-types.user.tojson.md b/docs-exp/auth-types.user.tojson.md index 31d1264ddae..a5ca14bac91 100644 --- a/docs-exp/auth-types.user.tojson.md +++ b/docs-exp/auth-types.user.tojson.md @@ -4,6 +4,8 @@ ## User.toJSON() method +Returns a JSON-serializable representation of this object. + Signature: ```typescript @@ -13,3 +15,5 @@ toJSON(): object; object +A JSON-serializable representation of this object. + diff --git a/docs-exp/auth-types.usercredential.md b/docs-exp/auth-types.usercredential.md index a13cfd6eb6e..ebf5ccd06c8 100644 --- a/docs-exp/auth-types.usercredential.md +++ b/docs-exp/auth-types.usercredential.md @@ -4,7 +4,7 @@ ## UserCredential interface -https://firebase.google.com/docs/reference/js/firebase.auth\#usercredential +A structure containing a [User](./auth-types.user.md), an [AuthCredential](./auth-types.authcredential.md), the [OperationType](./auth-types.operationtype.md), and any additional user information that was returned from the identity provider. `operationType` could be [OperationType.SIGN\_IN](./auth-types.operationtype.sign_in.md) for a sign-in operation, [OperationType.LINK](./auth-types.operationtype.link.md) for a linking operation and [OperationType.REAUTHENTICATE](./auth-types.operationtype.reauthenticate.md) for a reauthentication operation. Signature: @@ -16,7 +16,7 @@ export interface UserCredential | Property | Type | Description | | --- | --- | --- | -| [operationType](./auth-types.usercredential.operationtype.md) | [OperationType](./auth-types.operationtype.md) | | -| [providerId](./auth-types.usercredential.providerid.md) | [ProviderId](./auth-types.providerid.md) \| null | | -| [user](./auth-types.usercredential.user.md) | [User](./auth-types.user.md) | | +| [operationType](./auth-types.usercredential.operationtype.md) | [OperationType](./auth-types.operationtype.md) | The type of operation which was used to authenticate the user (such as sign-in or link). | +| [providerId](./auth-types.usercredential.providerid.md) | [ProviderId](./auth-types.providerid.md) \| null | The provider which was used to authenticate the user. | +| [user](./auth-types.usercredential.user.md) | [User](./auth-types.user.md) | The user authenticated by this credential. | diff --git a/docs-exp/auth-types.usercredential.operationtype.md b/docs-exp/auth-types.usercredential.operationtype.md index a36c2ad6eb7..a083cd7624f 100644 --- a/docs-exp/auth-types.usercredential.operationtype.md +++ b/docs-exp/auth-types.usercredential.operationtype.md @@ -4,6 +4,8 @@ ## UserCredential.operationType property +The type of operation which was used to authenticate the user (such as sign-in or link). + Signature: ```typescript diff --git a/docs-exp/auth-types.usercredential.providerid.md b/docs-exp/auth-types.usercredential.providerid.md index 425e9fc157a..957add917b8 100644 --- a/docs-exp/auth-types.usercredential.providerid.md +++ b/docs-exp/auth-types.usercredential.providerid.md @@ -4,6 +4,8 @@ ## UserCredential.providerId property +The provider which was used to authenticate the user. + Signature: ```typescript diff --git a/docs-exp/auth-types.usercredential.user.md b/docs-exp/auth-types.usercredential.user.md index e89a6407fa9..4e0556e5bb3 100644 --- a/docs-exp/auth-types.usercredential.user.md +++ b/docs-exp/auth-types.usercredential.user.md @@ -4,6 +4,8 @@ ## UserCredential.user property +The user authenticated by this credential. + Signature: ```typescript diff --git a/docs-exp/auth-types.userinfo.displayname.md b/docs-exp/auth-types.userinfo.displayname.md index 87e72d23cc3..a45ec5c965d 100644 --- a/docs-exp/auth-types.userinfo.displayname.md +++ b/docs-exp/auth-types.userinfo.displayname.md @@ -4,6 +4,8 @@ ## UserInfo.displayName property +The display name of the user. + Signature: ```typescript diff --git a/docs-exp/auth-types.userinfo.email.md b/docs-exp/auth-types.userinfo.email.md index 32d0cb4813e..ad5fdaa4274 100644 --- a/docs-exp/auth-types.userinfo.email.md +++ b/docs-exp/auth-types.userinfo.email.md @@ -4,6 +4,8 @@ ## UserInfo.email property +The email of the user. + Signature: ```typescript diff --git a/docs-exp/auth-types.userinfo.md b/docs-exp/auth-types.userinfo.md index ff8607e0bf1..def00ec097a 100644 --- a/docs-exp/auth-types.userinfo.md +++ b/docs-exp/auth-types.userinfo.md @@ -4,7 +4,7 @@ ## UserInfo interface -https://firebase.google.com/docs/reference/js/firebase.UserInfo +User profile information, visible only to the Firebase project's apps. Signature: @@ -16,10 +16,10 @@ export interface UserInfo | Property | Type | Description | | --- | --- | --- | -| [displayName](./auth-types.userinfo.displayname.md) | string \| null | | -| [email](./auth-types.userinfo.email.md) | string \| null | | -| [phoneNumber](./auth-types.userinfo.phonenumber.md) | string \| null | | -| [photoURL](./auth-types.userinfo.photourl.md) | string \| null | | -| [providerId](./auth-types.userinfo.providerid.md) | string | | -| [uid](./auth-types.userinfo.uid.md) | string | | +| [displayName](./auth-types.userinfo.displayname.md) | string \| null | The display name of the user. | +| [email](./auth-types.userinfo.email.md) | string \| null | The email of the user. | +| [phoneNumber](./auth-types.userinfo.phonenumber.md) | string \| null | The phone number normalized based on the E.164 standard (e.g. +16505550101) for the user. This is null if the user has no phone credential linked to the account. | +| [photoURL](./auth-types.userinfo.photourl.md) | string \| null | The profile photo URL of the user. | +| [providerId](./auth-types.userinfo.providerid.md) | string | The provider used to authenticate the user. | +| [uid](./auth-types.userinfo.uid.md) | string | The user's unique ID, scoped to the project. | diff --git a/docs-exp/auth-types.userinfo.phonenumber.md b/docs-exp/auth-types.userinfo.phonenumber.md index 38a13f54cec..441d36f0623 100644 --- a/docs-exp/auth-types.userinfo.phonenumber.md +++ b/docs-exp/auth-types.userinfo.phonenumber.md @@ -4,6 +4,8 @@ ## UserInfo.phoneNumber property +The phone number normalized based on the E.164 standard (e.g. +16505550101) for the user. This is null if the user has no phone credential linked to the account. + Signature: ```typescript diff --git a/docs-exp/auth-types.userinfo.photourl.md b/docs-exp/auth-types.userinfo.photourl.md index e096f2726b2..149aaa71ae1 100644 --- a/docs-exp/auth-types.userinfo.photourl.md +++ b/docs-exp/auth-types.userinfo.photourl.md @@ -4,6 +4,8 @@ ## UserInfo.photoURL property +The profile photo URL of the user. + Signature: ```typescript diff --git a/docs-exp/auth-types.userinfo.providerid.md b/docs-exp/auth-types.userinfo.providerid.md index 46602904366..a8d7a633d36 100644 --- a/docs-exp/auth-types.userinfo.providerid.md +++ b/docs-exp/auth-types.userinfo.providerid.md @@ -4,6 +4,8 @@ ## UserInfo.providerId property +The provider used to authenticate the user. + Signature: ```typescript diff --git a/docs-exp/auth-types.userinfo.uid.md b/docs-exp/auth-types.userinfo.uid.md index 6a5a4b5ee33..1d6b3e31cf5 100644 --- a/docs-exp/auth-types.userinfo.uid.md +++ b/docs-exp/auth-types.userinfo.uid.md @@ -4,6 +4,8 @@ ## UserInfo.uid property +The user's unique ID, scoped to the project. + Signature: ```typescript diff --git a/docs-exp/auth-types.usermetadata.creationtime.md b/docs-exp/auth-types.usermetadata.creationtime.md index 8f878555a12..1a4413c0979 100644 --- a/docs-exp/auth-types.usermetadata.creationtime.md +++ b/docs-exp/auth-types.usermetadata.creationtime.md @@ -4,6 +4,8 @@ ## UserMetadata.creationTime property +Time the user was created. + Signature: ```typescript diff --git a/docs-exp/auth-types.usermetadata.lastsignintime.md b/docs-exp/auth-types.usermetadata.lastsignintime.md index a27139887e5..501abcb0de9 100644 --- a/docs-exp/auth-types.usermetadata.lastsignintime.md +++ b/docs-exp/auth-types.usermetadata.lastsignintime.md @@ -4,6 +4,8 @@ ## UserMetadata.lastSignInTime property +Time the user last signed in. + Signature: ```typescript diff --git a/docs-exp/auth-types.usermetadata.md b/docs-exp/auth-types.usermetadata.md index 7f7aa8397e4..1015735260e 100644 --- a/docs-exp/auth-types.usermetadata.md +++ b/docs-exp/auth-types.usermetadata.md @@ -4,7 +4,7 @@ ## UserMetadata interface -https://firebase.google.com/docs/reference/js/firebase.auth.UserMetadata +Interface representing a user's metadata. Signature: @@ -16,6 +16,6 @@ export interface UserMetadata | Property | Type | Description | | --- | --- | --- | -| [creationTime](./auth-types.usermetadata.creationtime.md) | string | | -| [lastSignInTime](./auth-types.usermetadata.lastsignintime.md) | string | | +| [creationTime](./auth-types.usermetadata.creationtime.md) | string | Time the user was created. | +| [lastSignInTime](./auth-types.usermetadata.lastsignintime.md) | string | Time the user last signed in. | diff --git a/docs-exp/auth-types.userprofile.md b/docs-exp/auth-types.userprofile.md index 4a099d88872..6dbb9562406 100644 --- a/docs-exp/auth-types.userprofile.md +++ b/docs-exp/auth-types.userprofile.md @@ -4,7 +4,7 @@ ## UserProfile type -User profile used in `AdditionalUserInfo` +User profile used in [AdditionalUserInfo](./auth-types.additionaluserinfo.md). Signature: diff --git a/packages-exp/auth-types-exp/index.d.ts b/packages-exp/auth-types-exp/index.d.ts index c24d133b7c8..30bfc64d20a 100644 --- a/packages-exp/auth-types-exp/index.d.ts +++ b/packages-exp/auth-types-exp/index.d.ts @@ -25,7 +25,9 @@ import { } from '@firebase/util'; /** - * Supported providers + * Supported providers. + * + * @public */ export const enum ProviderId { ANONYMOUS = 'anonymous', @@ -40,7 +42,9 @@ export const enum ProviderId { } /** - * Supported sign in methods + * Supported sign-in methods. + * + * @public */ export const enum SignInMethod { ANONYMOUS = 'anonymous', @@ -54,153 +58,406 @@ export const enum SignInMethod { } /** - * Supported operation types + * Supported operation types. + * + * @public */ export const enum OperationType { + /** Operation involving linking an additional provider to an already signed-in user. */ LINK = 'link', + /** Operation involving using a provider to reauthenticate an already signed-in user. */ REAUTHENTICATE = 'reauthenticate', + /** Operation involving signing in a user. */ SIGN_IN = 'signIn' } /** - * Auth config object + * Auth config object. + * + * @public */ export interface Config { + /** + * The API Key used to communicate with the Firebase Auth backend. + */ apiKey: string; + /** + * The host at which the Firebase Auth backend is running. + */ apiHost: string; + /** + * The scheme used to communicate with the Firebase Auth backend. + */ apiScheme: string; + /** + * The host at which the Secure Token API is running. + */ tokenApiHost: string; + /** + * The SDK Client Version. + */ sdkClientVersion: string; + /** + * The domain at which the web widgets are hosted (provided via Firebase Config). + */ authDomain?: string; } /** - * Parsed Id Token + * Parsed ID token. + * + * @privateRemarks TODO(avolkovi): consolidate with parsed_token in implementation. * - * TODO(avolkovi): consolidate with parsed_token in implementation + * @public */ export interface ParsedToken { + /** Expiration time of the token. */ 'exp'?: string; + /** UID of the user. */ 'sub'?: string; + /** Time at which authentication was performed. */ 'auth_time'?: string; + /** Issuance time of the token. */ 'iat'?: string; + /** Firebase specific claims, containing the provider(s) used to authenticate the user. */ 'firebase'?: { 'sign_in_provider'?: string; 'sign_in_second_factor'?: string; }; + /** Map of any additional custom claims. */ [key: string]: string | object | undefined; } /** - * TODO(avolkovi): should we consolidate with Subscribe since we're changing the API anyway? + * Type definition for an event callback. + * + * @privateRemarks TODO(avolkovi): should we consolidate with Subscribe since we're changing the API anyway? + * + * @public */ export type NextOrObserver = NextFn | Observer; /** - * https://firebase.google.com/docs/reference/js/firebase.auth.AuthError + * @public */ export interface AuthError extends FirebaseError { + /** The name of the Firebase App which triggered this error. */ readonly appName: string; - + /** The email of the user's account, used for sign-in/linking. */ readonly email?: string; + /** The phone number of the user's account, used for sign-in/linking. */ readonly phoneNumber?: string; + /** + * The tenant ID being used for sign-in/linking. If you use `signInWithRedirect` to sign in, + * you have to set the tenant ID on {@link Auth} instance again as the tenant ID is not persisted + * after redirection. + */ readonly tenantid?: string; } /** - * https://firebase.google.com/docs/reference/js/firebase.auth.AuthSettings + * Interface representing an Auth instance's settings, currently used for enabling/disabling app + * verification for phone Auth testing. + * + * @public */ export interface AuthSettings { + /** + * When set, this property disables app verification for the purpose of testing phone + * authentication. For this property to take effect, it needs to be set before rendering a + * reCAPTCHA app verifier. When this is disabled, a mock reCAPTCHA is rendered instead. This is + * useful for manual testing during development or for automated integration tests. + * + * In order to use this feature, you will need to + * {@link https://firebase.google.com/docs/auth/web/phone-auth#test-with-whitelisted-phone-numbers | whitelist your phone number} + * via the Firebase Console. + * + * The default value is false (app verification is enabled). + */ appVerificationDisabledForTesting: boolean; } /** - * https://firebase.google.com/docs/reference/js/firebase.auth.Auth + * The Firebase Auth service interface. + * + * See {@link https://firebase.google.com/docs/auth/ | Firebase Authentication} for a full guide + * on how to use the Firebase Auth service. + * + * @public */ export interface Auth { + /** The name of the app associated with the Auth service instance. */ readonly name: string; + /** The {@link Config} used to initialize this instance. */ readonly config: Config; + /** + * Changes the type of persistence on the Auth instance for the currently saved + * Auth session and applies this type of persistence for future sign-in requests, including + * sign-in with redirect requests. + * + * This makes it easy for a user signing in to specify whether their session should be + * remembered or not. It also makes it easier to never persist the Auth state for applications + * that are shared by other users or have sensitive data. + * + * @example + * ```javascript + * auth.setPersistence(browserSessionPersistence); + * ``` + * + * @param persistence - The {@link Persistence} to use. + */ setPersistence(persistence: Persistence): void; + /** + * The Auth instance's language code. This is a readable/writable property. When set to + * null, the default Firebase Console language setting is applied. The language code will + * propagate to email action templates (password reset, email verification and email change + * revocation), SMS templates for phone authentication, reCAPTCHA verifier and OAuth + * popup/redirect operations provided the specified providers support localization with the + * language code specified. + */ languageCode: string | null; + /** + * The Auth instance's tenant ID. This is a readable/writable property. When you set + * the tenant ID of an Auth instance, all future sign-in/sign-up operations will pass this + * tenant ID and sign in or sign up users to the specified tenant project. When set to null, + * users are signed in to the parent project. By default, this is set to null. + * + * @example + * ```javascript + * // Set the tenant ID on Auth instance. + * auth.tenantId = 'TENANT_PROJECT_ID'; + * + * // All future sign-in request now include tenant ID. + * const result = await signInWithEmailAndPassword(auth, email, password); + * // result.user.tenantId should be 'TENANT_PROJECT_ID'. + * ``` + */ tenantId: string | null; + /** + * The Auth instance's settings. This is used to edit/read configuration related options + * like app verification mode for phone authentication. + */ readonly settings: AuthSettings; + /** + * Adds an observer for changes to the user's sign-in state. + * + * To keep the old behavior, see {@link Auth.onIdTokenChanged}. + * + * @param nextOrObserver - callback triggered on change. + * @param error - callback triggered on error. + * @param completed - callback triggered when observer is removed. + */ onAuthStateChanged( nextOrObserver: NextOrObserver, error?: ErrorFn, completed?: CompleteFn ): Unsubscribe; + /** + * Adds an observer for changes to the signed-in user's ID token, which includes sign-in, + * sign-out, and token refresh events. + * + * @param nextOrObserver - callback triggered on change. + * @param error - callback triggered on error. + * @param completed - callback triggered when observer is removed. + */ onIdTokenChanged( nextOrObserver: NextOrObserver, error?: ErrorFn, completed?: CompleteFn ): Unsubscribe; + /** The currently signed-in user (or null). */ readonly currentUser: User | null; + /** + * Asynchronously sets the provided user as `currentUser` on the Auth instance. A new + * instance copy of the user provided will be made and set as currentUser. + * + * This will trigger {@link Auth.onAuthStateChanged} and {@link Auth.onIdTokenChanged} listeners + * like other sign in methods. + * + * The operation fails with an error if the user to be updated belongs to a different Firebase + * project. + * + * @param user - The new {@link User}. + */ updateCurrentUser(user: User | null): Promise; + /** + * Sets the current language to the default device/browser preference. + */ useDeviceLanguage(): void; + /** + * Modify this Auth instance to communicate with the Firebase Auth emulator. This must be + * called synchronously immediately following the first call to `initializeAuth()`. Do not use + * with production credentials as emulator traffic is not encrypted. + * + * @param url - The URL at which the emulator is running (eg, 'http://localhost:9099'). + */ useEmulator(url: string): void; + /** + * Signs out the current user. + */ signOut(): Promise; } /** - * https://firebase.google.com/docs/reference/js/firebase.auth.Auth#persistence + * An enumeration of the possible persistence mechanism types. + * + * @public */ export interface Persistence { + /** + * Type of Persistence. + * - 'SESSION' is used for temporary persistence such as `sessionStorage`. + * - 'LOCAL' is used for long term persistence such as `localStorage` or 'IndexedDB`. + * - 'NONE' is used for in-memory, or no persistence. + */ readonly type: 'SESSION' | 'LOCAL' | 'NONE'; } /** - * Parsed IdToken for use in public API + * Interface representing ID token result obtained from `getIdTokenResult`. It contains the ID + * token JWT string and other helper properties for getting different data associated with the + * token as well as all the decoded payload claims. + * + * Note that these claims are not to be trusted as they are parsed client side. Only server side + * verification can guarantee the integrity of the token claims. * - * https://firebase.google.com/docs/reference/js/firebase.auth.IDTokenResult + * @public */ export interface IdTokenResult { + /** + * The authentication time formatted as a UTC string. This is the time the user authenticated + * (signed in) and not the time the token was refreshed. + */ authTime: string; + /** The ID token expiration time formatted as a UTC string. */ expirationTime: string; + /** The ID token issuance time formatted as a UTC string. */ issuedAtTime: string; + /** + * The sign-in provider through which the ID token was obtained (anonymous, custom, phone, + * password, etc). Note, this does not map to provider IDs. + */ signInProvider: string | null; + /** + * The type of second factor associated with this session, provided the user was multi-factor + * authenticated (eg. phone, etc). + */ signInSecondFactor: string | null; + /** The Firebase Auth ID token JWT string. */ token: string; + /** + * The entire payload claims of the ID token including the standard reserved claims as well as + * the custom claims. + */ claims: ParsedToken; } /** - * https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeInfo + * A response from `checkActionCode`. + * + * @public */ export interface ActionCodeInfo { + /** + * The data associated with the action code. + * For the {@link Operation.PASSWORD_RESET}, {@link Operation.VERIFY_EMAIL}, and + * {@link Operation.RECOVER_EMAIL} actions, this object contains an email field with the address + * the email was sent to. + * + * For the {@link Operation.RECOVER_EMAIL} action, which allows a user to undo an email address + * change, this object also contains a `previousEmail` field with the user account's current + * email address. After the action completes, the user's email address will revert to the value + * in the `email` field from the value in `previousEmail` field. + * + * For the {@link Operation.VERIFY_AND_CHANGE_EMAIL} action, which allows a user to verify the + * email before updating it, this object contains a `previousEmail` field with the user account's + * email address before updating. After the action completes, the user's email address will be + * updated to the value in the `email` field from the value in `previousEmail` field. + * + * For the {@link Operation.REVERT_SECOND_FACTOR_ADDITION} action, which allows a user to + * unenroll a newly added second factor, this object contains a `multiFactorInfo` field with + * the information about the second factor. For phone second factor, the `multiFactorInfo` + * is a {@link MultiFactorInfo} object, which contains the phone number. + */ data: { email?: string | null; multiFactorInfo?: MultiFactorInfo | null; previousEmail?: string | null; }; + /** + * The type of operation that generated the action code. + */ operation: Operation; } /** - * https://firebase.google.com/docs/reference/js/firebase.auth.ActionCodeInfo#operation_2 + * An enumeration of the possible email action types. + * + * @public */ export const enum Operation { + /** The email link sign-in action. */ EMAIL_SIGNIN = 'EMAIL_SIGNIN', + /** The password reset action. */ PASSWORD_RESET = 'PASSWORD_RESET', + /** The email revocation action. */ RECOVER_EMAIL = 'RECOVER_EMAIL', + /** The revert second factor addition email action. */ REVERT_SECOND_FACTOR_ADDITION = 'REVERT_SECOND_FACTOR_ADDITION', + /** The revert second factor addition email action. */ VERIFY_AND_CHANGE_EMAIL = 'VERIFY_AND_CHANGE_EMAIL', + /** The email verification action. */ VERIFY_EMAIL = 'VERIFY_EMAIL' } /** - * https://firebase.google.com/docs/reference/js/firebase.auth#actioncodesettings + * This is the interface that defines the required continue/state URL with optional Android and iOS + * bundle identifiers. + * + * @public */ export interface ActionCodeSettings { + /** + * Sets the Android package name. This will try to open the link in an android app if it is + * installed. If `installApp` is passed, it specifies whether to install the Android app if the + * device supports it and the app is not already installed. If this field is provided without + * a `packageName`, an error is thrown explaining that the `packageName` must be provided in + * conjunction with this field. If `minimumVersion` is specified, and an older version of the + * app is installed, the user is taken to the Play Store to upgrade the app. + */ android?: { installApp?: boolean; minimumVersion?: string; packageName: string; }; + /** + * The default is false. When set to true, the action code link will be be sent as a Universal + * Link or Android App Link and will be opened by the app if installed. In the false case, + * the code will be sent to the web widget first and then on continue will redirect to the app + * if installed. + */ handleCodeInApp?: boolean; + /** + * Sets the iOS bundle ID. This will try to open the link in an iOS app if it is installed. + * + * App installation is not supported for iOS. + */ iOS?: { bundleId: string; }; + /** + * Sets the link continue/state URL, which has different meanings in different contexts: + * - When the link is handled in the web action widgets, this is the deep link in the + * `continueUrl` query parameter. + * - When the link is handled in the app directly, this is the `continueUrl` query parameter in + * the deep link of the Dynamic Link. + */ url: string; + /** + * When multiple custom dynamic link domains are defined for a project, specify which one to use + * when the link is to be opened via a specified mobile app (for example, `example.page.link`). + * Otherwise the first domain is automatically selected. + */ dynamicLinkDomain?: string; } @@ -228,7 +485,8 @@ export abstract class ActionCodeURL { */ readonly languageCode: string | null; /** - * The action performed by the email action link. It returns from one of the types from {@link ActionCodeInfo} + * The action performed by the email action link. It returns from one of the types from + * {@link ActionCodeInfo} */ readonly operation: Operation; /** @@ -237,7 +495,8 @@ export abstract class ActionCodeURL { readonly tenantId: string | null; /** - * Parses the email action link string and returns an ActionCodeURL object if the link is valid, otherwise returns null. + * Parses the email action link string and returns an ActionCodeURL object if the link is valid, + * otherwise returns null. * * @param link - The email action link string. * @returns The ActionCodeURL object, or null if the link is invalid. @@ -248,101 +507,330 @@ export abstract class ActionCodeURL { } /** - * https://firebase.google.com/docs/reference/js/firebase.auth.ApplicationVerifier + * A verifier for domain verification and abuse prevention. Currently, the only implementation is + * {@link RecaptchaVerifier}. + * + * @public */ export interface ApplicationVerifier { + /** + * Identifies the type of application verifier (e.g. "recaptcha"). + */ readonly type: string; + /** + * Executes the verification process. + * + * @returns A Promise for a token that can be used to assert the validity of a request. + */ verify(): Promise; } /** - * https://firebase.google.com/docs/reference/js/firebase.auth.RecaptchaVerifier + * An {@link https://www.google.com/recaptcha/ | reCAPTCHA}-based application verifier. + * + * @public */ export abstract class RecaptchaVerifier implements ApplicationVerifier { constructor( + /** + * The reCAPTCHA container parameter. This has different meaning depending on whether the + * reCAPTCHA is hidden or visible. For a visible reCAPTCHA the container must be empty. If a + * string is used, it has to correspond to an element ID. The corresponding element must also + * must be in the DOM at the time of initialization. + */ container: any | string, + /** + * The optional reCAPTCHA parameters. Check the reCAPTCHA docs for a comprehensive list. + * All parameters are accepted except for the sitekey. Firebase Auth backend provisions a + * reCAPTCHA for each project and will configure this upon rendering. For an invisible + * reCAPTCHA, a size key must have the value 'invisible'. + */ parameters?: Object | null, + /** + * The corresponding Firebase Auth instance. If none is provided, the default Firebase Auth + * instance is used. A Firebase Auth instance must be initialized with an API key, otherwise + * an error will be thrown. + */ auth?: Auth | null ); + /** + * Clears the reCAPTCHA widget from the page and destroys the instance. + */ clear(): void; + /** + * Renders the reCAPTCHA widget on the page. + * + * @returns A Promise that resolves with the reCAPTCHA widget ID. + */ render(): Promise; + /** + * The application verifier type. For a reCAPTCHA verifier, this is 'recaptcha'. + */ readonly type: string; + /** + * Waits for the user to solve the reCAPTCHA and resolves with the reCAPTCHA token. + * + * @returns A Promise for the reCAPTCHA token. + */ verify(): Promise; } /** - * https://firebase.google.com/docs/reference/js/firebase.auth.AuthCredential + * Interface that represents the credentials returned by an auth provider. Implementations specify + * the details about each auth provider's credential requirements. + * + * @public */ export abstract class AuthCredential { + /** + * Static method to deserialize a JSON representation of an object into an {@link AuthCredential}. + * + * @param json - Either `object` or the stringified representation of the object. When string is + * provided, `JSON.parse` would be called first. + * + * @returns If the JSON input does not represent an {@link AuthCredential}, null is returned. + */ static fromJSON(json: object | string): AuthCredential | null; + /** + * The authentication provider ID for the credential. For example, 'facebook.com', or + * 'google.com'. + */ readonly providerId: string; + /** + * The authentication sign in method for the credential. For example, + * {@link SignInMethod.EMAIL_PASSWORD}, or {@link SignInMethod.EMAIL_LINK}. This corresponds to + * the sign-in method identifier as returned in `fetchSignInMethodsForEmail`. + */ readonly signInMethod: string; + /** + * Returns a JSON-serializable representation of this object. + * + * @returns a JSON-serializable representation of this object. + */ toJSON(): object; } /** - * https://firebase.google.com/docs/reference/js/firebase.auth.OAuthCredential + * Interface that represents the OAuth credentials returned by an OAuth provider. Implementations + * specify the details about each auth provider's credential requirements. + * + * @public */ export abstract class OAuthCredential extends AuthCredential { + /** + * Static method to deserialize a JSON representation of an object into an + * {@link AuthCredential}. + * + * @param json - Input can be either Object or the stringified representation of the object. + * When string is provided, JSON.parse would be called first. + * + * @returns If the JSON input does not represent an {@link AuthCredential}, null is returned. + */ static fromJSON(json: object | string): OAuthCredential | null; + /** + * The OAuth access token associated with the credential if it belongs to an OAuth provider, + * such as `facebook.com`, `twitter.com`, etc. + */ readonly accessToken?: string; + /** + * The OAuth ID token associated with the credential if it belongs to an OIDC provider, + * such as `google.com`. + */ readonly idToken?: string; + /** + * The OAuth access token secret associated with the credential if it belongs to an OAuth 1.0 + * provider, such as `twitter.com`. + */ readonly secret?: string; } + /** - * https://firebase.google.com/docs/reference/js/firebase.auth.phoneauthcredential + * Class that represents the Phone Auth credentials returned by a {@link PhoneAuthProvider}. + * + * @public */ export abstract class PhoneAuthCredential extends AuthCredential { + /** {@inheritdoc AuthCredential} */ static fromJSON(json: object | string): PhoneAuthCredential | null; } /** - * A provider for generating credentials + * Interface that represents an auth provider, used to facilitate creating {@link AuthCredential}. * - * https://firebase.google.com/docs/reference/js/firebase.auth.AuthProvider + * @public */ export interface AuthProvider { + /** + * Provider for which credentials can be constructed. + */ readonly providerId: string; } /** - * A provider for generating email & password and email link credentials + * Email and password auth provider implementation. * - * https://firebase.google.com/docs/reference/js/firebase.auth.EmailAuthProvider + * @public */ export abstract class EmailAuthProvider implements AuthProvider { private constructor(); + /** + * Always set to {@link ProviderId.PASSWORD}, even for email link. + */ static readonly PROVIDER_ID: ProviderId; + /** + * Always set to {@link SignInMethod.EMAIL_PASSWORD}. + */ static readonly EMAIL_PASSWORD_SIGN_IN_METHOD: SignInMethod; + /** + * Always set to {@link SignInMethod.EMAIL_LINK}. + */ static readonly EMAIL_LINK_SIGN_IN_METHOD: SignInMethod; + /** + * Initialize an {@link AuthCredential} using an email and password. + * + * @example + * ```javascript + * const authCredential = EmailAuthProvider.credential(email, password); + * const userCredential = await signInWithCredential(auth, authCredential); + * ``` + * + * @example + * ```javascript + * const userCredential = await signInWithEmailAndPassword(auth, email, password); + * ``` + * + * @param email - Email address. + * @param password - User account password. + * @returns The auth provider credential. + */ static credential(email: string, password: string): AuthCredential; + /** + * Initialize an {@link AuthCredential} using an email and an email link after a sign in with + * email link operation. + * + * @example + * ```javascript + * const authCredential = EmailAuthProvider.credentialWithLink(auth, email, emailLink); + * const userCredential = await signInWithCredential(auth, authCredential); + * ``` + * + * @example + * ```javascript + * await sendSignInLinkToEmail(auth, email); + * // Obtain emailLink from user. + * const userCredential = await signInWithEmailLink(auth, email, emailLink); + * ``` + * + * @param auth - The Auth instance used to verify the link. + * @param email - Email address. + * @param emailLink - Sign-in email link. + * @returns - The auth provider credential. + */ static credentialWithLink( auth: Auth, email: string, emailLink: string ): AuthCredential; + /** + * Always set to {@link ProviderId.PASSWORD}, even for email link. + */ readonly providerId: ProviderId; } /** - * A provider for generating phone credentials + * A provider for generating phone credentials. * - * https://firebase.google.com/docs/reference/js/firebase.auth.PhoneAuthProvider + * @example + * ```javascript + * // 'recaptcha-container' is the ID of an element in the DOM. + * const applicationVerifier = new RecaptchaVerifier('recaptcha-container'); + * const provider = new PhoneAuthProvider(auth); + * const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier); + * const verificationCode = window.prompt('Please enter the verification code that was sent to your mobile device.'); + * const phoneCredential = await PhoneAuthProvider.credential(verificationId, verificationCode); + * const userCredential = await signInWithCredential(auth, phoneCredential); + * ``` + * + * @public */ export class PhoneAuthProvider implements AuthProvider { + /** Always set to {@link ProviderId.PHONE}. */ static readonly PROVIDER_ID: ProviderId; + /** Always set to {@link SignInMethod.PHONE}. */ static readonly PHONE_SIGN_IN_METHOD: SignInMethod; + /** + * Creates a phone auth credential, given the verification ID from + * {@link PhoneAuthProvider.verifyPhoneNumber} and the code that was sent to the user's + * mobile device. + * + * @example + * ```javascript + * const provider = new PhoneAuthProvider(auth); + * const verificationId = provider.verifyPhoneNumber(phoneNumber, applicationVerifier); + * // Obtain verificationCode from the user. + * const authCredential = PhoneAuthProvider.credential(verificationId, verificationCode); + * const userCredential = signInWithCredential(auth, authCredential); + * ``` + * + * @example + * An alternative flow is provided using the `signInWithPhoneNumber` method. + * ```javascript + * const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier); + * // Obtain verificationCode from the user. + * const userCredential = await confirmationResult.confirm(verificationCode); + * ``` + * + * @param verificationId - The verification ID returned from + * {@link PhoneAuthProvider.verifyPhoneNumber}. + * @param verificationCode - The verification code sent to the user's mobile device. + * + * @returns The auth provider credential. + */ static credential( verificationId: string, verificationCode: string ): AuthCredential; - + /** + * @param auth - The Firebase Auth instance in which sign-ins should occur. Uses the default Auth + * instance if unspecified. + */ constructor(auth?: Auth | null); - + /** Always set to {@link ProviderId.PHONE}. */ readonly providerId: ProviderId; + /** + * + * Starts a phone number authentication flow by sending a verification code to the given phone + * number. Returns an ID that can be passed to {@link PhoneAuthProvider.credential} to identify + * this flow. + * + * @example + * ```javascript + * const provider = new PhoneAuthProvider(auth); + * const verificationId = await provider.verifyPhoneNumber(phoneNumber, applicationVerifier); + * // Obtain verificationCode from the user. + * const authCredential = PhoneAuthProvider.credential(verificationId, verificationCode); + * const userCredential = await signInWithCredential(auth, authCredential); + * ``` + * + * @example + * An alternative flow is provided using the `signInWithPhoneNumber` method. + * ```javascript + * const confirmationResult = signInWithPhoneNumber(auth, phoneNumber, applicationVerifier); + * // Obtain verificationCode from the user. + * const userCredential = confirmationResult.confirm(verificationCode); + * ``` + * + * @param phoneInfoOptions - The user's {@link PhoneInfoOptions}. The phone number should be in + * E.164 format (e.g. +16505550101). + * @param applicationVerifier - For abuse prevention, this method also requires a + * {@link ApplicationVerifier}. This SDK includes a reCAPTCHA-based implementation, + * {@link RecaptchaVerifier}. + * + * @returns A Promise for the verification ID. + */ verifyPhoneNumber( phoneInfoOptions: PhoneInfoOptions | string, applicationVerifier: ApplicationVerifier @@ -350,172 +838,571 @@ export class PhoneAuthProvider implements AuthProvider { } /** - * https://firebase.google.com/docs/reference/js/firebase.auth.ConfirmationResult + * A result from a phone number sign-in, link, or reauthenticate call. + * + * @public */ export interface ConfirmationResult { + /** + * The phone number authentication operation's verification ID. This can be used along with the + * verification code to initialize a phone auth credential. + */ readonly verificationId: string; + /** + * Finishes a phone number sign-in, link, or reauthentication. + * + * @example + * ```javascript + * const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier); + * // Obtain verificationCode from the user. + * const userCredential = await confirmationResult.confirm(verificationCode); + * ``` + * + * @param verificationCode - The code that was sent to the user's mobile device. + */ confirm(verificationCode: string): Promise; } /** - * https://firebase.google.com/docs/reference/js/firebase.auth.multifactorassertion + * The base class for asserting ownership of a second factor. This is used to facilitate enrollment + * of a second factor on an existing user or sign-in of a user who already verified the first + * factor. + * + * @public */ export interface MultiFactorAssertion { + /** The identifier of the second factor. */ readonly factorId: string; } /** - * https://firebase.google.com/docs/reference/js/firebase.auth.multifactorerror + * The error thrown when the user needs to provide a second factor to sign in successfully. The + * error code for this error is `auth/multi-factor-auth-required`. + * + * @example + * ```javascript + * let resolver; + * let multiFactorHints; + * + * signInWithEmailAndPassword(auth, email, password) + * .then((result) => { + * // User signed in. No 2nd factor challenge is needed. + * }) + * .catch((error) => { + * if (error.code == 'auth/multi-factor-auth-required') { + * resolver = getMultiFactorResolver(auth, error); + * multiFactorHints = resolver.hints; + * } else { + * // Handle other errors. + * } + * }); + * + * // Obtain a multiFactorAssertion by verifying the second factor. + * + * const userCredential = await resolver.resolveSignIn(multiFactorAssertion); + * ``` + * + * @public */ export interface MultiFactorError extends AuthError { + /** + * The original credential used as a first factor. + */ readonly credential: AuthCredential; + /** + * The type of operation (e.g., sign-in, link, or reauthenticate) during which the error was raised. + */ readonly operationType: OperationType; } /** - * https://firebase.google.com/docs/reference/js/firebase.auth.multifactorinfo + * A structure containing the information of a second factor entity. + * + * @public */ export interface MultiFactorInfo { + /** The multi-factor enrollment ID. */ readonly uid: string; + /** The user friendly name of the current second factor. */ readonly displayName?: string | null; + /** The enrollment date of the second factor formatted as a UTC string. */ readonly enrollmentTime: string; + /** The identifier of the second factor. */ readonly factorId: ProviderId; } /** - * https://firebase.google.com/docs/reference/js/firebase.auth.multifactorresolver + * The class used to facilitate recovery from {@link MultiFactorError} when a user needs to + * provide a second factor to sign in. + * + * @example + * ```javascript + * let resolver; + * let multiFactorHints; + * + * signInWithEmailAndPassword(auth, email, password) + * .then((result) => { + * // User signed in. No 2nd factor challenge is needed. + * }) + * .catch((error) => { + * if (error.code == 'auth/multi-factor-auth-required') { + * resolver = getMultiFactorResolver(auth, error); + * // Show UI to let user select second factor. + * multiFactorHints = resolver.hints; + * } else { + * // Handle other errors. + * } + * }); + * + * // The enrolled second factors that can be used to complete + * // sign-in are returned in the `MultiFactorResolver.hints` list. + * // UI needs to be presented to allow the user to select a second factor + * // from that list. + * + * const selectedHint = // ; selected from multiFactorHints + * const phoneAuthProvider = new PhoneAuthProvider(auth); + * const phoneInfoOptions = { + * multiFactorHint: selectedHint, + * session: resolver.session + * }; + * const verificationId = phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, appVerifier); + * // Store `verificationId` and show UI to let user enter verification code. + * + * // UI to enter verification code and continue. + * // Continue button click handler + * const phoneAuthCredential = PhoneAuthProvider.credential(verificationId, verificationCode); + * const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(phoneAuthCredential); + * const userCredential = await resolver.resolveSignIn(multiFactorAssertion); + * ``` + * + * @public */ export abstract class MultiFactorResolver { + /** + * The list of hints for the second factors needed to complete the sign-in for the current + * session. + */ hints: MultiFactorInfo[]; + /** + * The session identifier for the current sign-in flow, which can be used to complete the second + * factor sign-in. + */ session: MultiFactorSession; + /** + * A helper function to help users complete sign in with a second factor using an + * {@link MultiFactorAssertion} confirming the user successfully completed the second factor + * challenge. + * + * @example + * ```javascript + * const phoneAuthCredential = PhoneAuthProvider.credential(verificationId, verificationCode); + * const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(phoneAuthCredential); + * const userCredential = await resolver.resolveSignIn(multiFactorAssertion); + * ``` + * + * @param assertion - The multi-factor assertion to resolve sign-in with. + * @returns The promise that resolves with the user credential object. + */ resolveSignIn(assertion: MultiFactorAssertion): Promise; } /** - * https://firebase.google.com/docs/reference/js/firebase.auth.multifactorsession + * The multi-factor session object used for enrolling a second factor on a user or helping sign in + * an enrolled user with a second factor. + * + * @public */ export interface MultiFactorSession {} /** - * https://firebase.google.com/docs/reference/js/firebase.user.multifactoruser + * This is the interface that defines the multi-factor related properties and operations pertaining + * to a {@link User}. + * + * @public */ export interface MultiFactorUser { + /** Returns a list of the user's enrolled second factors. */ readonly enrolledFactors: MultiFactorInfo[]; + /** + * Returns the session identifier for a second factor enrollment operation. This is used to + * identify the user trying to enroll a second factor. + * + * @example + * ```javascript + * const multiFactorUser = multiFactor(auth.currentUser); + * const multiFactorSession = await multiFactorUser.getSession(); + * + * // Send verification code. + * const phoneAuthProvider = new PhoneAuthProvider(auth); + * const phoneInfoOptions = { + * phoneNumber: phoneNumber, + * session: multiFactorSession + * }; + * const verificationId = await phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, appVerifier); + * + * // Obtain verification code from user. + * const phoneAuthCredential = PhoneAuthProvider.credential(verificationId, verificationCode); + * const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(phoneAuthCredential); + * await multiFactorUser.enroll(multiFactorAssertion); + * ``` + * + * @returns The promise that resolves with the {@link MultiFactorSession}. + */ getSession(): Promise; + /** + * + * Enrolls a second factor as identified by the {@link MultiFactorAssertion} for the + * user. On resolution, the user tokens are updated to reflect the change in the JWT payload. + * Accepts an additional display name parameter used to identify the second factor to the end + * user. Recent re-authentication is required for this operation to succeed. On successful + * enrollment, existing Firebase sessions (refresh tokens) are revoked. When a new factor is + * enrolled, an email notification is sent to the user’s email. + * + * @example + * ```javascript + * const multiFactorUser = multiFactor(auth.currentUser); + * const multiFactorSession = await multiFactorUser.getSession(); + * + * // Send verification code. + * const phoneAuthProvider = new PhoneAuthProvider(auth); + * const phoneInfoOptions = { + * phoneNumber: phoneNumber, + * session: multiFactorSession + * }; + * const verificationId = await phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, appVerifier); + * + * // Obtain verification code from user. + * const phoneAuthCredential = PhoneAuthProvider.credential(verificationId, verificationCode); + * const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(phoneAuthCredential); + * await multiFactorUser.enroll(multiFactorAssertion); + * // Second factor enrolled. + * ``` + * + * @param assertion - The multi-factor assertion to enroll with. + * @param displayName - The display name of the second factor. + */ enroll( assertion: MultiFactorAssertion, displayName?: string | null ): Promise; + /** + * Unenrolls the specified second factor. To specify the factor to remove, pass a + * {@link MultiFactorInfo} object (retrieved from {@link MultiFactorUser.enrolledFactors}) or the + * factor's UID string. Sessions are not revoked when the account is unenrolled. An email + * notification is likely to be sent to the user notifying them of the change. Recent + * re-authentication is required for this operation to succeed. When an existing factor is + * unenrolled, an email notification is sent to the user’s email. + * + * @example + * ```javascript + * const multiFactorUser = multiFactor(auth.currentUser); + * // Present user the option to choose which factor to unenroll. + * await multiFactorUser.unenroll(multiFactorUser.enrolledFactors[i]) + * ``` + * + * @param option - The multi-factor option to unenroll. + * @returns - A promise which resolves when the unenroll operation is complete. + */ unenroll(option: MultiFactorInfo | string): Promise; } /** - * https://firebase.google.com/docs/reference/js/firebase.auth.phonemultifactorassertion + * The class for asserting ownership of a phone second factor. Provided by + * {@link PhoneMultiFactorGenerator.assertion}. + * + * @public */ export interface PhoneMultiFactorAssertion extends MultiFactorAssertion {} /** - * https://firebase.google.com/docs/reference/js/firebase.auth.phonemultifactorgenerator + * The class used to initialize a {@link PhoneMultiFactorAssertion}. + * + * @public */ export abstract class PhoneMultiFactorGenerator { + /** + * The identifier of the phone second factor: {@link ProviderId.PHONE}. + */ static FACTOR_ID: ProviderId; + /** + * Provides a {@link PhoneMultiFactorAssertion} to confirm ownership of the phone second factor. + * + * @param phoneAuthCredential - A credential provided by {@link PhoneAuthProvider.credential}. + * @returns A {@link PhoneMultiFactorAssertion} which can be used with {@link MultiFactorResolver.resolveSignIn} + */ static assertion( phoneAuthCredential: PhoneAuthCredential ): PhoneMultiFactorAssertion; } /** - * https://firebase.google.com/docs/reference/js/firebase.auth#phoneinfooptions + * The information required to verify the ownership of a phone number. The information that's + * required depends on whether you are doing single-factor sign-in, multi-factor enrollment or + * multi-factor sign-in. + * + * @public */ export type PhoneInfoOptions = | PhoneSingleFactorInfoOptions | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions; +/** + * Options used for single-factor sign-in. + * + * @public + */ export interface PhoneSingleFactorInfoOptions { + /** Phone number to send a verification code to. */ phoneNumber: string; } +/** + * Options used for enrolling a second factor. + * + * @public + */ export interface PhoneMultiFactorEnrollInfoOptions { + /** Phone number to send a verification code to. */ phoneNumber: string; + /** The {@link MultiFactorSession} obtained via {@link MultiFactorUser.getSession}. */ session: MultiFactorSession; } - +/** + * Options used for signing-in with a second factor. + * + * @public + */ export interface PhoneMultiFactorSignInInfoOptions { + /** + * The {@link MultiFactorInfo} obtained via {@link MultiFactorResolver.hints}. + * + * One of `multiFactorHint` or `multiFactorUid` is required. + */ multiFactorHint?: MultiFactorInfo; + /** + * The uid of the second factor. + * + * One of `multiFactorHint` or `multiFactorUid` is required. + */ multiFactorUid?: string; + /** The {@link MultiFactorSession} obtained via {@link MultiFactorResolver.session}. */ session: MultiFactorSession; } +/** + * Interface for a supplied AsyncStorage. + * + * @public + */ export interface ReactNativeAsyncStorage { + /** + * Persist an item in storage. + * + * @param key - storage key. + * @param value - storage value. + */ setItem(key: string, value: string): Promise; + /** + * Retrieve an item from storage. + * + * @param key - storage key. + */ getItem(key: string): Promise; + /** + * Remove an item from storage. + * + * @param key - storage key. + */ removeItem(key: string): Promise; } /** - * https://firebase.google.com/docs/reference/js/firebase.User + * A user account. + * + * @public */ export interface User extends UserInfo { + /** + * Whether the email has been verified with `sendEmailVerification` and `applyActionCode`. + */ readonly emailVerified: boolean; + /** + * Whether the user is authenticated using the {@link ProviderId.ANONYMOUS} provider. + */ readonly isAnonymous: boolean; + /** + * Additional metadata around user creation and sign-in times. + */ readonly metadata: UserMetadata; + /** + * Additional per provider such as displayName and profile information. + */ readonly providerData: UserInfo[]; + /** + * Refresh token used to reauthenticate the user. Avoid using this directly and prefer + * {@link User.getIdToken()} to refresh the ID token instead. + */ readonly refreshToken: string; + /** + * The user's tenant ID. This is a read-only property, which indicates the tenant ID + * used to sign in the user. This is null if the user is signed in from the parent + * project. + * + * @example + * ```javascript + * // Set the tenant ID on Auth instance. + * auth.tenantId = 'TENANT_PROJECT_ID'; + * + * // All future sign-in request now include tenant ID. + * const result = await signInWithEmailAndPassword(auth, email, password); + * // result.user.tenantId should be 'TENANT_PROJECT_ID'. + * ``` + */ readonly tenantId: string | null; - + /** + * Deletes and signs out the user. + * + * Important: this is a security-sensitive operation that requires the user to have recently + * signed in. If this requirement isn't met, ask the user to authenticate again and then call + * one of the reauthentication methods like `reauthenticateWithCredential`. + */ delete(): Promise; + /** + * Returns a JSON Web Token (JWT) used to identify the user to a Firebase service. + * + * Returns the current token if it has not expired or if it will not expire in the next five + * minutes. Otherwise, this will refresh the token and return a new one. + * + * @param forceRefresh - Force refresh regardless of token expiration. + */ getIdToken(forceRefresh?: boolean): Promise; + /** + * Returns a deserialized JSON Web Token (JWT) used to identitfy the user to a Firebase service. + * + * Returns the current token if it has not expired or if it will not expire in the next five + * minutes. Otherwise, this will refresh the token and return a new one. + * + * @param forceRefresh - Force refresh regardless of token expiration. + */ getIdTokenResult(forceRefresh?: boolean): Promise; + /** + * Refreshes the user, if signed in. + */ reload(): Promise; + /** + * Returns a JSON-serializable representation of this object. + * + * @returns A JSON-serializable representation of this object. + */ toJSON(): object; } /** - * https://firebase.google.com/docs/reference/js/firebase.auth#usercredential + * A structure containing a {@link User}, an {@link AuthCredential}, the {@link OperationType}, + * and any additional user information that was returned from the identity provider. `operationType` + * could be {@link OperationType.SIGN_IN} for a sign-in operation, {@link OperationType.LINK} for a + * linking operation and {@link OperationType.REAUTHENTICATE} for a reauthentication operation. + * + * @public */ export interface UserCredential { + /** + * The user authenticated by this credential. + */ user: User; + /** + * The provider which was used to authenticate the user. + */ providerId: ProviderId | null; + /** + * The type of operation which was used to authenticate the user (such as sign-in or link). + */ operationType: OperationType; } /** - * https://firebase.google.com/docs/reference/js/firebase.UserInfo + * User profile information, visible only to the Firebase project's apps. + * + * @public */ export interface UserInfo { + /** + * The display name of the user. + */ readonly displayName: string | null; + /** + * The email of the user. + */ readonly email: string | null; + /** + * The phone number normalized based on the E.164 standard (e.g. +16505550101) for the + * user. This is null if the user has no phone credential linked to the account. + */ readonly phoneNumber: string | null; + /** + * The profile photo URL of the user. + */ readonly photoURL: string | null; + /** + * The provider used to authenticate the user. + */ readonly providerId: string; + /** + * The user's unique ID, scoped to the project. + */ readonly uid: string; } /** - * https://firebase.google.com/docs/reference/js/firebase.auth.UserMetadata + * Interface representing a user's metadata. + * + * @public */ export interface UserMetadata { + /** Time the user was created. */ readonly creationTime?: string; + /** Time the user last signed in. */ readonly lastSignInTime?: string; } /** - * Additional user information. + * A structure containing additional user information from a federated identity provider. + * + * @public */ export interface AdditionalUserInfo { + /** + * Whether the user is new (created via sign-up) or existing (authenticated using sign-in). + */ readonly isNewUser: boolean; + /** + * Map containing IDP-specific user data. + */ readonly profile: UserProfile | null; + /** + * Identifier for the provider used to authenticate this user. + */ readonly providerId: ProviderId | null; + /** + * The username if the provider is GitHub or Twitter. + */ readonly username?: string | null; } /** - * User profile used in `AdditionalUserInfo` + * User profile used in {@link AdditionalUserInfo}. + * + * @public */ export type UserProfile = Record; -/** No documentation for this yet */ +/** + * A resolver used for handling DOM specific operations like `signInWithPopup()` or + * `signInWithRedirect()`. + * + * @public + */ export interface PopupRedirectResolver {} declare module '@firebase/component' { From 344bd88566e2c42fd7ee92f28bb0f784629b48ee Mon Sep 17 00:00:00 2001 From: Sebastian Schmidt Date: Thu, 15 Oct 2020 09:40:45 -0700 Subject: [PATCH 005/624] Remove experimentalTabSynchronization (#3943) --- .changeset/shy-trees-divide.md | 6 ++++++ packages/firebase/index.d.ts | 17 +++------------ packages/firestore/src/api/database.ts | 29 +++++++++----------------- 3 files changed, 19 insertions(+), 33 deletions(-) create mode 100644 .changeset/shy-trees-divide.md diff --git a/.changeset/shy-trees-divide.md b/.changeset/shy-trees-divide.md new file mode 100644 index 00000000000..8bc7b66e887 --- /dev/null +++ b/.changeset/shy-trees-divide.md @@ -0,0 +1,6 @@ +--- +"firebase": major +"@firebase/firestore": major +--- + +Removed depreacted `experimentalTabSynchronization` settings. To enable multi-tab sychronization, use `synchronizeTabs` instead. diff --git a/packages/firebase/index.d.ts b/packages/firebase/index.d.ts index 01e76372722..3dbef9e2c19 100644 --- a/packages/firebase/index.d.ts +++ b/packages/firebase/index.d.ts @@ -1813,7 +1813,7 @@ declare namespace firebase.functions { /** * Changes this instance to point to a Cloud Functions emulator running * locally. See https://firebase.google.com/docs/functions/local-emulator - * + * * @deprecated Prefer the useEmulator(host, port) method. * @param origin The origin of the local emulator, such as * "http://localhost:5005". @@ -3132,10 +3132,10 @@ declare namespace firebase.auth { */ useDeviceLanguage(): void; /** - * Modify this Auth instance to communicate with the Firebase Auth emulator. This must be + * Modify this Auth instance to communicate with the Firebase Auth emulator. This must be * called synchronously immediately following the first call to `firebase.auth()`. Do not use * with production credentials as emulator traffic is not encrypted. - * + * * @param url The URL at which the emulator is running (eg, 'http://localhost:9099') */ useEmulator(url: string): void; @@ -7954,17 +7954,6 @@ declare namespace firebase.firestore { */ synchronizeTabs?: boolean; - /** - * Whether to synchronize the in-memory state of multiple tabs. Setting this - * to `true` in all open tabs enables shared access to local persistence, - * shared execution of queries and latency-compensated local document updates - * across all connected instances. - * - * @deprecated This setting is deprecated. To enable synchronization between - * multiple tabs, please use `synchronizeTabs: true` instead. - */ - experimentalTabSynchronization?: boolean; - /** * Whether to force enable persistence for the client. This cannot be used * with `synchronizeTabs:true` and is primarily intended for use with Web diff --git a/packages/firestore/src/api/database.ts b/packages/firestore/src/api/database.ts index c9912e81a9f..9ac0a2e27e3 100644 --- a/packages/firestore/src/api/database.ts +++ b/packages/firestore/src/api/database.ts @@ -159,6 +159,7 @@ export const CACHE_SIZE_UNLIMITED = LruParams.COLLECTION_DISABLED; // enablePersistence() defaults: const DEFAULT_SYNCHRONIZE_TABS = false; +const DEFAULT_FORCE_OWNING_TAB = false; /** Undocumented, private additional settings not exposed in our public API. */ interface PrivateSettings extends PublicSettings { @@ -461,26 +462,16 @@ export class Firestore implements PublicFirestore, FirebaseService { let experimentalForceOwningTab = false; if (settings) { - if (settings.experimentalTabSynchronization !== undefined) { - logError( - "The 'experimentalTabSynchronization' setting will be removed. Use 'synchronizeTabs' instead." - ); - } - synchronizeTabs = - settings.synchronizeTabs ?? - settings.experimentalTabSynchronization ?? - DEFAULT_SYNCHRONIZE_TABS; - - experimentalForceOwningTab = settings.experimentalForceOwningTab - ? settings.experimentalForceOwningTab - : false; + synchronizeTabs = settings.synchronizeTabs ?? DEFAULT_SYNCHRONIZE_TABS; + experimentalForceOwningTab = + settings.experimentalForceOwningTab ?? DEFAULT_FORCE_OWNING_TAB; - if (synchronizeTabs && experimentalForceOwningTab) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - "The 'experimentalForceOwningTab' setting cannot be used with 'synchronizeTabs'." - ); - } + validateIsNotUsedTogether( + 'synchronizeTabs', + synchronizeTabs, + 'experimentalForceOwningTab', + experimentalForceOwningTab + ); } return this.configureClient( From 6a8086c5bd10126211ef2805eccc22faf908eaa0 Mon Sep 17 00:00:00 2001 From: Sam Horlbeck Olsen Date: Thu, 15 Oct 2020 11:53:04 -0700 Subject: [PATCH 006/624] Copy the auth user on updateCurrentUser(), also assert the app name matches (#3947) * Make a copy of the user when called from public updateCurrentUser method * Formatting * Rename parameters to avoid an API change * API review --- .../auth-exp/src/core/auth/auth_impl.test.ts | 60 ++++++++++++------- .../auth-exp/src/core/auth/auth_impl.ts | 23 +++++-- .../src/core/auth/firebase_internal.test.ts | 6 +- .../src/core/strategies/anonymous.test.ts | 2 +- .../auth-exp/src/core/strategies/anonymous.ts | 11 ++-- .../src/core/strategies/credential.ts | 2 +- .../src/core/strategies/custom_token.ts | 2 +- .../src/core/strategies/email_and_password.ts | 5 +- .../src/core/user/account_info.test.ts | 2 +- .../src/core/user/invalidation.test.ts | 4 +- .../src/core/user/link_unlink.test.ts | 2 +- .../src/core/user/token_manager.test.ts | 14 +++++ .../auth-exp/src/core/user/token_manager.ts | 6 +- .../core/user/user_credential_impl.test.ts | 4 +- .../auth-exp/src/core/user/user_impl.test.ts | 29 ++++++++- .../auth-exp/src/core/user/user_impl.ts | 16 ++++- packages-exp/auth-exp/src/mfa/mfa_resolver.ts | 11 ++-- packages-exp/auth-exp/src/model/auth.ts | 2 +- packages-exp/auth-exp/src/model/user.ts | 21 +++---- .../strategies/redirect.test.ts | 8 +-- 20 files changed, 162 insertions(+), 68 deletions(-) diff --git a/packages-exp/auth-exp/src/core/auth/auth_impl.test.ts b/packages-exp/auth-exp/src/core/auth/auth_impl.test.ts index 6abacb74e54..99cbab07435 100644 --- a/packages-exp/auth-exp/src/core/auth/auth_impl.test.ts +++ b/packages-exp/auth-exp/src/core/auth/auth_impl.test.ts @@ -77,11 +77,31 @@ describe('core/auth/auth_impl', () => { describe('#updateCurrentUser', () => { it('sets the field on the auth object', async () => { + const user = testUser(auth, 'uid'); + await auth._updateCurrentUser(user); + expect(auth.currentUser).to.eq(user); + }); + + it('public version makes a copy', async () => { const user = testUser(auth, 'uid'); await auth.updateCurrentUser(user); + + // currentUser should deeply equal the user passed in, but should be a + // different block in memory. + expect(auth.currentUser).not.to.eq(user); expect(auth.currentUser).to.eql(user); }); + it('public version throws if the auth is mismatched', async () => { + const auth2 = await testAuth(); + Object.assign(auth2, { name: 'not-the-right-auth' }); + const user = testUser(auth2, 'uid'); + await expect(auth.updateCurrentUser(user)).to.be.rejectedWith( + FirebaseError, + 'auth/argument-error' + ); + }); + it('orders async operations correctly', async () => { const users = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10].map(n => { return testUser(auth, `${n}`); @@ -94,7 +114,7 @@ describe('core/auth/auth_impl', () => { }); }); - await Promise.all(users.map(u => auth.updateCurrentUser(u))); + await Promise.all(users.map(u => auth._updateCurrentUser(u))); for (let i = 0; i < 10; i++) { expect(persistenceStub._set.getCall(i)).to.have.been.calledWith( sinon.match.any, @@ -104,14 +124,14 @@ describe('core/auth/auth_impl', () => { }); it('setting to null triggers a remove call', async () => { - await auth.updateCurrentUser(null); + await auth._updateCurrentUser(null); expect(persistenceStub._remove).to.have.been.called; }); it('should throw an error if the user is from a different tenant', async () => { const user = testUser(auth, 'uid'); user.tenantId = 'other-tenant-id'; - await expect(auth.updateCurrentUser(user)).to.be.rejectedWith( + await expect(auth._updateCurrentUser(user)).to.be.rejectedWith( FirebaseError, '(auth/tenant-id-mismatch)' ); @@ -120,7 +140,7 @@ describe('core/auth/auth_impl', () => { describe('#signOut', () => { it('sets currentUser to null, calls remove', async () => { - await auth.updateCurrentUser(testUser(auth, 'test')); + await auth._updateCurrentUser(testUser(auth, 'test')); await auth.signOut(); expect(persistenceStub._remove).to.have.been.called; expect(auth.currentUser).to.be.null; @@ -206,18 +226,18 @@ describe('core/auth/auth_impl', () => { beforeEach(async () => { auth.onAuthStateChanged(authStateCallback); auth.onIdTokenChanged(idTokenCallback); - await auth.updateCurrentUser(null); + await auth._updateCurrentUser(null); authStateCallback.resetHistory(); idTokenCallback.resetHistory(); }); it('onAuthStateChange triggers on log in', async () => { - await auth.updateCurrentUser(user); + await auth._updateCurrentUser(user); expect(authStateCallback).to.have.been.calledWith(user); }); it('onIdTokenChange triggers on log in', async () => { - await auth.updateCurrentUser(user); + await auth._updateCurrentUser(user); expect(idTokenCallback).to.have.been.calledWith(user); }); }); @@ -226,36 +246,36 @@ describe('core/auth/auth_impl', () => { beforeEach(async () => { auth.onAuthStateChanged(authStateCallback); auth.onIdTokenChanged(idTokenCallback); - await auth.updateCurrentUser(user); + await auth._updateCurrentUser(user); authStateCallback.resetHistory(); idTokenCallback.resetHistory(); }); it('onAuthStateChange triggers on log out', async () => { - await auth.updateCurrentUser(null); + await auth._updateCurrentUser(null); expect(authStateCallback).to.have.been.calledWith(null); }); it('onIdTokenChange triggers on log out', async () => { - await auth.updateCurrentUser(null); + await auth._updateCurrentUser(null); expect(idTokenCallback).to.have.been.calledWith(null); }); it('onAuthStateChange does not trigger for user props change', async () => { user.photoURL = 'blah'; - await auth.updateCurrentUser(user); + await auth._updateCurrentUser(user); expect(authStateCallback).not.to.have.been.called; }); it('onIdTokenChange triggers for user props change', async () => { user.photoURL = 'hey look I changed'; - await auth.updateCurrentUser(user); + await auth._updateCurrentUser(user); expect(idTokenCallback).to.have.been.calledWith(user); }); it('onAuthStateChange triggers if uid changes', async () => { const newUser = testUser(auth, 'different-uid'); - await auth.updateCurrentUser(newUser); + await auth._updateCurrentUser(newUser); expect(authStateCallback).to.have.been.calledWith(newUser); }); }); @@ -265,11 +285,11 @@ describe('core/auth/auth_impl', () => { const cb2 = sinon.spy(); auth.onAuthStateChanged(cb1); auth.onAuthStateChanged(cb2); - await auth.updateCurrentUser(null); + await auth._updateCurrentUser(null); cb1.resetHistory(); cb2.resetHistory(); - await auth.updateCurrentUser(user); + await auth._updateCurrentUser(user); expect(cb1).to.have.been.calledWith(user); expect(cb2).to.have.been.calledWith(user); }); @@ -279,11 +299,11 @@ describe('core/auth/auth_impl', () => { const cb2 = sinon.spy(); auth.onIdTokenChanged(cb1); auth.onIdTokenChanged(cb2); - await auth.updateCurrentUser(null); + await auth._updateCurrentUser(null); cb1.resetHistory(); cb2.resetHistory(); - await auth.updateCurrentUser(user); + await auth._updateCurrentUser(user); expect(cb1).to.have.been.calledWith(user); expect(cb2).to.have.been.calledWith(user); }); @@ -299,7 +319,7 @@ describe('core/auth/auth_impl', () => { idTokenCallback = sinon.spy(); auth.onAuthStateChanged(authStateCallback); auth.onIdTokenChanged(idTokenCallback); - await auth.updateCurrentUser(null); // force event handlers to clear out + await auth._updateCurrentUser(null); // force event handlers to clear out authStateCallback.resetHistory(); idTokenCallback.resetHistory(); }); @@ -337,7 +357,7 @@ describe('core/auth/auth_impl', () => { beforeEach(async () => { user = testUser(auth, 'uid', undefined, true); - await auth.updateCurrentUser(user); + await auth._updateCurrentUser(user); authStateCallback.resetHistory(); idTokenCallback.resetHistory(); }); @@ -442,7 +462,7 @@ describe('core/auth/auth_impl', () => { await Promise.resolve(); spy.resetHistory(); await (auth as AuthImpl)._delete(); - await auth.updateCurrentUser(testUser(auth, 'blah')); + await auth._updateCurrentUser(testUser(auth, 'blah')); expect(spy).not.to.have.been.called; }); }); diff --git a/packages-exp/auth-exp/src/core/auth/auth_impl.ts b/packages-exp/auth-exp/src/core/auth/auth_impl.ts index ea0389e2823..8b03862e67e 100644 --- a/packages-exp/auth-exp/src/core/auth/auth_impl.ts +++ b/packages-exp/auth-exp/src/core/auth/auth_impl.ts @@ -138,7 +138,7 @@ export class AuthImpl implements Auth, _FirebaseService { // If the same user is to be synchronized. if (this.currentUser && user && this.currentUser.uid === user.uid) { // Data update, simply copy data changes. - this._currentUser._copy(user); + this._currentUser._assign(user); // If tokens changed from previous user tokens, this will trigger // notifyAuthListeners_. await this.currentUser.getIdToken(); @@ -146,7 +146,7 @@ export class AuthImpl implements Auth, _FirebaseService { } // Update current Auth state. Either a new login or logout. - await this.updateCurrentUser(user); + await this._updateCurrentUser(user); // Notify external Auth changes of Auth change event. this.notifyAuthListeners(); } @@ -215,7 +215,22 @@ export class AuthImpl implements Auth, _FirebaseService { this._deleted = true; } - async updateCurrentUser(user: externs.User | null): Promise { + async updateCurrentUser(userExtern: externs.User | null): Promise { + // The public updateCurrentUser method needs to make a copy of the user, + // and also needs to verify that the app matches + const user = userExtern as User | null; + assert( + !user || user.auth.name === this.name, + AuthErrorCode.ARGUMENT_ERROR, + { + appName: this.name + } + ); + + return this._updateCurrentUser(user && user._clone()); + } + + async _updateCurrentUser(user: externs.User | null): Promise { if (this._deleted) { return; } @@ -238,7 +253,7 @@ export class AuthImpl implements Auth, _FirebaseService { await this._setRedirectUser(null); } - return this.updateCurrentUser(null); + return this._updateCurrentUser(null); } setPersistence(persistence: externs.Persistence): Promise { diff --git a/packages-exp/auth-exp/src/core/auth/firebase_internal.test.ts b/packages-exp/auth-exp/src/core/auth/firebase_internal.test.ts index b5a84490890..a8ba62e3b01 100644 --- a/packages-exp/auth-exp/src/core/auth/firebase_internal.test.ts +++ b/packages-exp/auth-exp/src/core/auth/firebase_internal.test.ts @@ -42,7 +42,7 @@ describe('src/core/auth/firebase_internal', () => { it('returns the uid of the user if set', async () => { const user = testUser(auth, 'uid'); - await auth.updateCurrentUser(user); + await auth._updateCurrentUser(user); expect(authInternal.getUid()).to.eq('uid'); }); }); @@ -54,7 +54,7 @@ describe('src/core/auth/firebase_internal', () => { it('returns the id token of the current user correctly', async () => { const user = testUser(auth, 'uid'); - await auth.updateCurrentUser(user); + await auth._updateCurrentUser(user); user.stsTokenManager.accessToken = 'access-token'; user.stsTokenManager.expirationTime = Date.now() + 1000 * 60 * 60 * 24; expect(await authInternal.getToken()).to.eql({ @@ -69,7 +69,7 @@ describe('src/core/auth/firebase_internal', () => { beforeEach(async () => { user = testUser(auth, 'uid', undefined, true); - await auth.updateCurrentUser(user); + await auth._updateCurrentUser(user); let i = 0; sinon.stub(user.stsTokenManager, 'getToken').callsFake(async () => { i += 1; diff --git a/packages-exp/auth-exp/src/core/strategies/anonymous.test.ts b/packages-exp/auth-exp/src/core/strategies/anonymous.test.ts index 5e9af147f76..279541f3852 100644 --- a/packages-exp/auth-exp/src/core/strategies/anonymous.test.ts +++ b/packages-exp/auth-exp/src/core/strategies/anonymous.test.ts @@ -70,7 +70,7 @@ describe('core/strategies/anonymous', () => { context('already signed in with a non-anonymous account', () => { it('should sign in as a new user user', async () => { const fakeUser = testUser(auth, 'other-uid'); - await auth.updateCurrentUser(fakeUser); + await auth._updateCurrentUser(fakeUser); expect(fakeUser.isAnonymous).to.be.false; const { user, operationType } = await signInAnonymously(auth); diff --git a/packages-exp/auth-exp/src/core/strategies/anonymous.ts b/packages-exp/auth-exp/src/core/strategies/anonymous.ts index d613ca692ff..693b082a222 100644 --- a/packages-exp/auth-exp/src/core/strategies/anonymous.ts +++ b/packages-exp/auth-exp/src/core/strategies/anonymous.ts @@ -24,23 +24,24 @@ import { _castAuth } from '../auth/auth_impl'; export async function signInAnonymously( auth: externs.Auth ): Promise { - if (auth.currentUser?.isAnonymous) { + const authInternal = _castAuth(auth); + if (authInternal.currentUser?.isAnonymous) { // If an anonymous user is already signed in, no need to sign them in again. return new UserCredentialImpl({ - user: auth.currentUser as User, + user: authInternal.currentUser as User, providerId: null, operationType: externs.OperationType.SIGN_IN }); } - const response = await signUp(auth, { + const response = await signUp(authInternal, { returnSecureToken: true }); const userCredential = await UserCredentialImpl._fromIdTokenResponse( - _castAuth(auth), + authInternal, externs.OperationType.SIGN_IN, response, true ); - await auth.updateCurrentUser(userCredential.user); + await authInternal._updateCurrentUser(userCredential.user); return userCredential; } diff --git a/packages-exp/auth-exp/src/core/strategies/credential.ts b/packages-exp/auth-exp/src/core/strategies/credential.ts index e5615be244a..4ac77ce12cc 100644 --- a/packages-exp/auth-exp/src/core/strategies/credential.ts +++ b/packages-exp/auth-exp/src/core/strategies/credential.ts @@ -42,7 +42,7 @@ export async function _signInWithCredential( operationType, response ); - await auth.updateCurrentUser(userCredential.user); + await auth._updateCurrentUser(userCredential.user); return userCredential; } diff --git a/packages-exp/auth-exp/src/core/strategies/custom_token.ts b/packages-exp/auth-exp/src/core/strategies/custom_token.ts index 448c115cc5e..234fa057203 100644 --- a/packages-exp/auth-exp/src/core/strategies/custom_token.ts +++ b/packages-exp/auth-exp/src/core/strategies/custom_token.ts @@ -35,6 +35,6 @@ export async function signInWithCustomToken( externs.OperationType.SIGN_IN, response ); - await auth.updateCurrentUser(cred.user); + await auth._updateCurrentUser(cred.user); return cred; } diff --git a/packages-exp/auth-exp/src/core/strategies/email_and_password.ts b/packages-exp/auth-exp/src/core/strategies/email_and_password.ts index 5d8134673ff..d0b71cd9e0d 100644 --- a/packages-exp/auth-exp/src/core/strategies/email_and_password.ts +++ b/packages-exp/auth-exp/src/core/strategies/email_and_password.ts @@ -136,6 +136,7 @@ export async function createUserWithEmailAndPassword( email: string, password: string ): Promise { + const authInternal = _castAuth(auth); const response = await signUp(auth, { returnSecureToken: true, email, @@ -143,11 +144,11 @@ export async function createUserWithEmailAndPassword( }); const userCredential = await UserCredentialImpl._fromIdTokenResponse( - _castAuth(auth), + authInternal, externs.OperationType.SIGN_IN, response ); - await auth.updateCurrentUser(userCredential.user); + await authInternal._updateCurrentUser(userCredential.user); return userCredential; } diff --git a/packages-exp/auth-exp/src/core/user/account_info.test.ts b/packages-exp/auth-exp/src/core/user/account_info.test.ts index b7180e73700..3744bbbff73 100644 --- a/packages-exp/auth-exp/src/core/user/account_info.test.ts +++ b/packages-exp/auth-exp/src/core/user/account_info.test.ts @@ -150,7 +150,7 @@ describe('core/user/profile', () => { auth.onIdTokenChanged(idTokenChange); // Flush token change promises which are floating - await auth.updateCurrentUser(user); + await auth._updateCurrentUser(user); auth._isInitialized = true; idTokenChange.resetHistory(); }); diff --git a/packages-exp/auth-exp/src/core/user/invalidation.test.ts b/packages-exp/auth-exp/src/core/user/invalidation.test.ts index 2505f47628d..36e1f8d0561 100644 --- a/packages-exp/auth-exp/src/core/user/invalidation.test.ts +++ b/packages-exp/auth-exp/src/core/user/invalidation.test.ts @@ -35,7 +35,7 @@ describe('src/core/user/invalidation', () => { beforeEach(async () => { auth = await testAuth(); user = testUser(auth, 'uid'); - await auth.updateCurrentUser(user); + await auth._updateCurrentUser(user); }); function makeError(code: AuthErrorCode): FirebaseError { @@ -76,7 +76,7 @@ describe('src/core/user/invalidation', () => { beforeEach(async () => { user2 = testUser(auth, 'uid2'); - await auth.updateCurrentUser(user2); + await auth._updateCurrentUser(user2); }); it('does not log out user2 if the error is user_disabled', async () => { diff --git a/packages-exp/auth-exp/src/core/user/link_unlink.test.ts b/packages-exp/auth-exp/src/core/user/link_unlink.test.ts index 45a80ce583a..512a8865c4c 100644 --- a/packages-exp/auth-exp/src/core/user/link_unlink.test.ts +++ b/packages-exp/auth-exp/src/core/user/link_unlink.test.ts @@ -39,7 +39,7 @@ describe('core/user/link_unlink', () => { beforeEach(async () => { auth = await testAuth(); user = testUser(auth, 'uid', '', true); - await auth.updateCurrentUser(user); + await auth._updateCurrentUser(user); fetch.setUp(); }); diff --git a/packages-exp/auth-exp/src/core/user/token_manager.test.ts b/packages-exp/auth-exp/src/core/user/token_manager.test.ts index e26c1823c26..bba09a1d29a 100644 --- a/packages-exp/auth-exp/src/core/user/token_manager.test.ts +++ b/packages-exp/auth-exp/src/core/user/token_manager.test.ts @@ -158,6 +158,20 @@ describe('core/user/token_manager', () => { }); }); + describe('#_clone', () => { + it('copies the manager to a new object', () => { + Object.assign(stsTokenManager, { + accessToken: 'token', + refreshToken: 'refresh', + expirationTime: now + }); + + const copy = stsTokenManager._clone(); + expect(copy).not.to.eq(stsTokenManager); + expect(copy.toJSON()).to.eql(stsTokenManager.toJSON()); + }); + }); + describe('.fromJSON', () => { const errorString = 'Firebase: An internal AuthError has occurred. (auth/internal-error).'; diff --git a/packages-exp/auth-exp/src/core/user/token_manager.ts b/packages-exp/auth-exp/src/core/user/token_manager.ts index 75c69e784a9..0ab9fae8b7b 100644 --- a/packages-exp/auth-exp/src/core/user/token_manager.ts +++ b/packages-exp/auth-exp/src/core/user/token_manager.ts @@ -124,12 +124,16 @@ export class StsTokenManager { }; } - _copy(stsTokenManager: StsTokenManager): void { + _assign(stsTokenManager: StsTokenManager): void { this.accessToken = stsTokenManager.accessToken; this.refreshToken = stsTokenManager.refreshToken; this.expirationTime = stsTokenManager.expirationTime; } + _clone(): StsTokenManager { + return Object.assign(new StsTokenManager(), this.toJSON()); + } + _performRefresh(): never { return debugFail('not implemented'); } diff --git a/packages-exp/auth-exp/src/core/user/user_credential_impl.test.ts b/packages-exp/auth-exp/src/core/user/user_credential_impl.test.ts index 7102393e8c3..b6ad020a356 100644 --- a/packages-exp/auth-exp/src/core/user/user_credential_impl.test.ts +++ b/packages-exp/auth-exp/src/core/user/user_credential_impl.test.ts @@ -83,7 +83,7 @@ describe('core/user/user_credential_impl', () => { it('should not trigger callbacks', async () => { const cb = sinon.spy(); auth.onAuthStateChanged(cb); - await auth.updateCurrentUser(null); + await auth._updateCurrentUser(null); cb.resetHistory(); await UserCredentialImpl._fromIdTokenResponse( @@ -100,7 +100,7 @@ describe('core/user/user_credential_impl', () => { beforeEach(async () => { user = testUser(auth, 'uid', 'email', true); - await auth.updateCurrentUser(user); + await auth._updateCurrentUser(user); }); it('gets a credential based on the response', async () => { diff --git a/packages-exp/auth-exp/src/core/user/user_impl.test.ts b/packages-exp/auth-exp/src/core/user/user_impl.test.ts index c1e88d8ab43..0e9280dd7ab 100644 --- a/packages-exp/auth-exp/src/core/user/user_impl.test.ts +++ b/packages-exp/auth-exp/src/core/user/user_impl.test.ts @@ -235,11 +235,38 @@ describe('core/user/user_impl', () => { it('should not trigger additional callbacks', async () => { const cb = sinon.spy(); auth.onAuthStateChanged(cb); - await auth.updateCurrentUser(null); + await auth._updateCurrentUser(null); cb.resetHistory(); await UserImpl._fromIdTokenResponse(auth, idTokenResponse); expect(cb).not.to.have.been.called; }); }); + + describe('_clone', () => { + it('copies the user to a new object', () => { + const stsTokenManager = Object.assign(new StsTokenManager(), { + accessToken: 'access-token', + refreshToken: 'refresh-token', + expirationTime: 3 + }); + + const user = new UserImpl({ + auth, + uid: 'uid', + stsTokenManager, + displayName: 'name', + email: 'email', + phoneNumber: 'number', + photoURL: 'photo', + emailVerified: false, + isAnonymous: true + }); + + const copy = user._clone(); + expect(copy).not.to.eq(user); + expect(copy.stsTokenManager).not.to.eq(user.stsTokenManager); + expect(copy.toJSON()).to.eql(user.toJSON()); + }); + }); }); diff --git a/packages-exp/auth-exp/src/core/user/user_impl.ts b/packages-exp/auth-exp/src/core/user/user_impl.ts index df109c953ee..7d5c1eb8a01 100644 --- a/packages-exp/auth-exp/src/core/user/user_impl.ts +++ b/packages-exp/auth-exp/src/core/user/user_impl.ts @@ -81,7 +81,10 @@ export class UserImpl implements User { this.phoneNumber = opt.phoneNumber || null; this.photoURL = opt.photoURL || null; this.isAnonymous = opt.isAnonymous || false; - this.metadata = new UserMetadata(opt.createdAt, opt.lastLoginAt); + this.metadata = new UserMetadata( + opt.createdAt || undefined, + opt.lastLoginAt || undefined + ); } async getIdToken(forceRefresh?: boolean): Promise { @@ -113,7 +116,7 @@ export class UserImpl implements User { private reloadUserInfo: APIUserInfo | null = null; private reloadListener: NextFn | null = null; - _copy(user: User): void { + _assign(user: User): void { if (this === user) { return; } @@ -129,7 +132,14 @@ export class UserImpl implements User { this.tenantId = user.tenantId; this.providerData = user.providerData.map(userInfo => ({ ...userInfo })); this.metadata._copy(user.metadata); - this.stsTokenManager._copy(user.stsTokenManager); + this.stsTokenManager._assign(user.stsTokenManager); + } + + _clone(): User { + return new UserImpl({ + ...this, + stsTokenManager: this.stsTokenManager._clone() + }); } _onReload(callback: NextFn): void { diff --git a/packages-exp/auth-exp/src/mfa/mfa_resolver.ts b/packages-exp/auth-exp/src/mfa/mfa_resolver.ts index 253d798ed00..c94fee919a3 100644 --- a/packages-exp/auth-exp/src/mfa/mfa_resolver.ts +++ b/packages-exp/auth-exp/src/mfa/mfa_resolver.ts @@ -37,11 +37,12 @@ export class MultiFactorResolver implements externs.MultiFactorResolver { ) {} static _fromError( - auth: externs.Auth, + authExtern: externs.Auth, error: MultiFactorError ): MultiFactorResolver { + const auth = _castAuth(authExtern); const hints = (error.serverResponse.mfaInfo || []).map(enrollment => - MultiFactorInfo._fromServerResponse(_castAuth(auth), enrollment) + MultiFactorInfo._fromServerResponse(auth, enrollment) ); assert( @@ -57,7 +58,7 @@ export class MultiFactorResolver implements externs.MultiFactorResolver { session, hints, async (assertion: MultiFactorAssertion): Promise => { - const mfaResponse = await assertion._process(_castAuth(auth), session); + const mfaResponse = await assertion._process(auth, session); // Clear out the unneeded fields from the old login response delete error.serverResponse.mfaInfo; delete error.serverResponse.mfaPendingCredential; @@ -73,11 +74,11 @@ export class MultiFactorResolver implements externs.MultiFactorResolver { switch (error.operationType) { case externs.OperationType.SIGN_IN: const userCredential = await UserCredentialImpl._fromIdTokenResponse( - _castAuth(auth), + auth, error.operationType, idTokenResponse ); - await auth.updateCurrentUser(userCredential.user); + await auth._updateCurrentUser(userCredential.user); return userCredential; case externs.OperationType.REAUTHENTICATE: assert(error.user, AuthErrorCode.INTERNAL_ERROR, { diff --git a/packages-exp/auth-exp/src/model/auth.ts b/packages-exp/auth-exp/src/model/auth.ts index 91bd7f20b72..1d7cdf172f7 100644 --- a/packages-exp/auth-exp/src/model/auth.ts +++ b/packages-exp/auth-exp/src/model/auth.ts @@ -35,7 +35,7 @@ export interface Auth extends externs.Auth { _canInitEmulator: boolean; _isInitialized: boolean; _initializationPromise: Promise | null; - updateCurrentUser(user: User | null): Promise; + _updateCurrentUser(user: User | null): Promise; _onStorageEvent(): void; diff --git a/packages-exp/auth-exp/src/model/user.ts b/packages-exp/auth-exp/src/model/user.ts index 3e21ac9a928..dfec0715e7e 100644 --- a/packages-exp/auth-exp/src/model/user.ts +++ b/packages-exp/auth-exp/src/model/user.ts @@ -34,16 +34,16 @@ export interface UserParameters { auth: Auth; stsTokenManager: StsTokenManager; - displayName?: string; - email?: string; - phoneNumber?: string; - photoURL?: string; - isAnonymous?: boolean; - emailVerified?: boolean; - tenantId?: string; + displayName?: string | null; + email?: string | null; + phoneNumber?: string | null; + photoURL?: string | null; + isAnonymous?: boolean | null; + emailVerified?: boolean | null; + tenantId?: string | null; - createdAt?: string; - lastLoginAt?: string; + createdAt?: string | null; + lastLoginAt?: string | null; } export interface User extends externs.User { @@ -68,7 +68,8 @@ export interface User extends externs.User { reload?: boolean ): Promise; - _copy(user: User): void; + _assign(user: User): void; + _clone(): User; _onReload: (cb: NextFn) => void; _notifyReloadListener: NextFn; _startProactiveRefresh: () => void; diff --git a/packages-exp/auth-exp/src/platform_browser/strategies/redirect.test.ts b/packages-exp/auth-exp/src/platform_browser/strategies/redirect.test.ts index 9b1fc3e623f..f6018a6b88e 100644 --- a/packages-exp/auth-exp/src/platform_browser/strategies/redirect.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/strategies/redirect.test.ts @@ -127,7 +127,7 @@ describe('src/core/strategies/redirect', () => { beforeEach(async () => { user = testUser(auth, 'uid', 'email', true); - await auth.updateCurrentUser(user); + await auth._updateCurrentUser(user); sinon.stub(link, '_assertLinkedStatus').returns(Promise.resolve()); }); @@ -185,7 +185,7 @@ describe('src/core/strategies/redirect', () => { }); it('persists the redirect user but not current user if diff currentUser', async () => { - await auth.updateCurrentUser(testUser(auth, 'not-uid', 'email', true)); + await auth._updateCurrentUser(testUser(auth, 'not-uid', 'email', true)); const redirectPersistence: Persistence = _getInstance( RedirectPersistence ); @@ -207,7 +207,7 @@ describe('src/core/strategies/redirect', () => { beforeEach(async () => { user = testUser(auth, 'uid', 'email', true); - await auth.updateCurrentUser(user); + await auth._updateCurrentUser(user); }); it('redirects the window', async () => { @@ -263,7 +263,7 @@ describe('src/core/strategies/redirect', () => { }); it('persists the redirect user but not current user if diff currentUser', async () => { - await auth.updateCurrentUser(testUser(auth, 'not-uid', 'email', true)); + await auth._updateCurrentUser(testUser(auth, 'not-uid', 'email', true)); const redirectPersistence: Persistence = _getInstance( RedirectPersistence ); From d0189bdda4827b3ea8f0c03855da8b879423d529 Mon Sep 17 00:00:00 2001 From: Sam Horlbeck Olsen Date: Thu, 15 Oct 2020 12:03:50 -0700 Subject: [PATCH 007/624] Add redirect persistence storage to auth compat layer (#3931) * Add redirect persistence storage * Formatting * PR feedback --- packages-exp/auth-compat-exp/src/auth.test.ts | 78 +++++++++++++++++++ packages-exp/auth-compat-exp/src/auth.ts | 57 +++++++++++++- .../auth-compat-exp/src/index.test.ts | 22 ------ packages-exp/auth-exp/internal/index.ts | 1 + .../auth-exp/src/core/auth/auth_impl.ts | 4 + .../persistence/persistence_user_manager.ts | 2 +- packages-exp/auth-exp/src/model/auth.ts | 1 + 7 files changed, 139 insertions(+), 26 deletions(-) create mode 100644 packages-exp/auth-compat-exp/src/auth.test.ts delete mode 100644 packages-exp/auth-compat-exp/src/index.test.ts diff --git a/packages-exp/auth-compat-exp/src/auth.test.ts b/packages-exp/auth-compat-exp/src/auth.test.ts new file mode 100644 index 00000000000..7df82ad21b8 --- /dev/null +++ b/packages-exp/auth-compat-exp/src/auth.test.ts @@ -0,0 +1,78 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { FirebaseApp } from '@firebase/app-types'; +import * as impl from '@firebase/auth-exp/internal'; +import { Config } from '@firebase/auth-types-exp'; +import { expect, use } from 'chai'; +import * as sinon from 'sinon'; +import * as sinonChai from 'sinon-chai'; +import { Auth } from './auth'; + +use(sinonChai); + +// For the most part, the auth methods just call straight through. Some parts +// of the auth compat layer are more complicated: these tests cover those +describe('auth compat', () => { + context('redirect persistence key storage', () => { + let underlyingAuth: impl.AuthImpl; + let app: FirebaseApp; + beforeEach(() => { + app = { options: { apiKey: 'api-key' } } as FirebaseApp; + underlyingAuth = new impl.AuthImpl(app, { + apiKey: 'api-key' + } as Config); + sinon.stub(underlyingAuth, '_initializeWithPersistence'); + }); + + afterEach(() => { + sinon.restore; + }); + + it('saves the persistence into session storage if available', () => { + const authCompat = new Auth(app, underlyingAuth); + if (typeof self !== 'undefined') { + sinon.stub(underlyingAuth, '_getPersistence').returns('TEST'); + // eslint-disable-next-line @typescript-eslint/no-floating-promises + authCompat.signInWithRedirect(new impl.GoogleAuthProvider('google')); + expect( + sessionStorage.getItem('firebase:persistence:api-key:undefined') + ).to.eq('TEST'); + } + }); + + it('pulls the persistence and sets as the main persitsence if set', () => { + if (typeof self !== 'undefined') { + sessionStorage.setItem( + 'firebase:persistence:api-key:undefined', + 'NONE' + ); + new Auth(app, underlyingAuth); + // eslint-disable-next-line @typescript-eslint/no-floating-promises + expect( + underlyingAuth._initializeWithPersistence + ).to.have.been.calledWith( + [ + impl._getInstance(impl.inMemoryPersistence), + impl._getInstance(impl.indexedDBLocalPersistence) + ], + impl.browserPopupRedirectResolver + ); + } + }); + }); +}); diff --git a/packages-exp/auth-compat-exp/src/auth.ts b/packages-exp/auth-compat-exp/src/auth.ts index e905c6feaf9..9f46f36a99a 100644 --- a/packages-exp/auth-compat-exp/src/auth.ts +++ b/packages-exp/auth-compat-exp/src/auth.ts @@ -36,6 +36,8 @@ import { } from './user_credential'; import { unwrap, Wrapper } from './wrap'; +const PERSISTENCE_KEY = 'persistence'; + export class Auth implements compat.FirebaseAuth, Wrapper, _FirebaseService { // private readonly auth: impl.AuthImpl; @@ -46,10 +48,15 @@ export class Auth return; } + // Note this is slightly different behavior: in this case, the stored + // persistence is checked *first* rather than last. This is because we want + // the fallback (if no user is found) to be the stored persistence type + const storedPersistence = this.getPersistenceFromRedirect(); + const persistences = storedPersistence ? [storedPersistence] : []; + persistences.push(impl.indexedDBLocalPersistence); + // TODO(avolkovi): Implement proper persistence fallback - const hierarchy = [impl.indexedDBLocalPersistence].map( - impl._getInstance - ); + const hierarchy = persistences.map(impl._getInstance); // TODO: platform needs to be determined using heuristics impl.assertFn(apiKey, impl.AuthErrorCode.INVALID_API_KEY, { @@ -279,6 +286,7 @@ export class Auth impl.AuthErrorCode.OPERATION_NOT_SUPPORTED, { appName: this.app.name } ); + this.savePersistenceForRedirect(); return impl.signInWithRedirect( this.auth, provider as externs.AuthProvider, @@ -297,6 +305,49 @@ export class Auth _delete(): Promise { return this.auth._delete(); } + + private savePersistenceForRedirect(): void { + const win = getSelfWindow(); + const key = impl._persistenceKeyName( + PERSISTENCE_KEY, + this.auth.config.apiKey, + this.auth.name + ); + if (win?.sessionStorage) { + win.sessionStorage.setItem(key, this.auth._getPersistence()); + } + } + + private getPersistenceFromRedirect(): externs.Persistence | null { + const win = getSelfWindow(); + if (!win?.sessionStorage) { + return null; + } + + const key = impl._persistenceKeyName( + PERSISTENCE_KEY, + this.auth.config.apiKey, + this.auth.name + ); + const persistence = win.sessionStorage.getItem(key); + + switch (persistence) { + case impl.inMemoryPersistence.type: + return impl.inMemoryPersistence; + case impl.indexedDBLocalPersistence.type: + return impl.indexedDBLocalPersistence; + case impl.browserSessionPersistence.type: + return impl.browserSessionPersistence; + case impl.browserLocalPersistence.type: + return impl.browserLocalPersistence; + default: + return null; + } + } +} + +function getSelfWindow(): Window | null { + return typeof window !== 'undefined' ? window : null; } function wrapObservers( diff --git a/packages-exp/auth-compat-exp/src/index.test.ts b/packages-exp/auth-compat-exp/src/index.test.ts deleted file mode 100644 index b06e4072476..00000000000 --- a/packages-exp/auth-compat-exp/src/index.test.ts +++ /dev/null @@ -1,22 +0,0 @@ -/** - * @license - * Copyright 2020 Google LLC - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -describe('auth-compat', () => { - it('nothing here yet', () => { - // TODO: write tests after the refactor - }); -}); diff --git a/packages-exp/auth-exp/internal/index.ts b/packages-exp/auth-exp/internal/index.ts index 4c794bf3c8c..d04a3452406 100644 --- a/packages-exp/auth-exp/internal/index.ts +++ b/packages-exp/auth-exp/internal/index.ts @@ -25,6 +25,7 @@ import { assert } from '../src/core/util/assert'; export { SignInWithIdpResponse } from '../src/api/authentication/idp'; export { AuthErrorCode } from '../src/core/errors'; export { Persistence } from '../src/core/persistence'; +export { _persistenceKeyName } from '../src/core/persistence/persistence_user_manager'; export { UserImpl } from '../src/core/user/user_impl'; export { _getInstance } from '../src/core/util/instantiator'; export { UserCredential, UserParameters } from '../src/model/user'; diff --git a/packages-exp/auth-exp/src/core/auth/auth_impl.ts b/packages-exp/auth-exp/src/core/auth/auth_impl.ts index 8b03862e67e..9af266b09f7 100644 --- a/packages-exp/auth-exp/src/core/auth/auth_impl.ts +++ b/packages-exp/auth-exp/src/core/auth/auth_impl.ts @@ -262,6 +262,10 @@ export class AuthImpl implements Auth, _FirebaseService { }); } + _getPersistence(): string { + return this.assertedPersistence.persistence.type; + } + onAuthStateChanged( nextOrObserver: externs.NextOrObserver, error?: ErrorFn, diff --git a/packages-exp/auth-exp/src/core/persistence/persistence_user_manager.ts b/packages-exp/auth-exp/src/core/persistence/persistence_user_manager.ts index 04b1f74203e..b10a7336a61 100644 --- a/packages-exp/auth-exp/src/core/persistence/persistence_user_manager.ts +++ b/packages-exp/auth-exp/src/core/persistence/persistence_user_manager.ts @@ -27,7 +27,7 @@ export const _REDIRECT_USER_KEY_NAME = 'redirectUser'; export const _PERSISTENCE_KEY_NAME = 'persistence'; const PERSISTENCE_NAMESPACE = 'firebase'; -function _persistenceKeyName( +export function _persistenceKeyName( key: string, apiKey: ApiKey, appName: AppName diff --git a/packages-exp/auth-exp/src/model/auth.ts b/packages-exp/auth-exp/src/model/auth.ts index 1d7cdf172f7..1b842c544f6 100644 --- a/packages-exp/auth-exp/src/model/auth.ts +++ b/packages-exp/auth-exp/src/model/auth.ts @@ -50,6 +50,7 @@ export interface Auth extends externs.Auth { _key(): string; _startProactiveRefresh(): void; _stopProactiveRefresh(): void; + _getPersistence(): string; readonly name: AppName; readonly config: ConfigInternal; From 1f229251142d8c6845058d3bafb52eaea6351696 Mon Sep 17 00:00:00 2001 From: Sebastian Schmidt Date: Thu, 15 Oct 2020 12:18:28 -0700 Subject: [PATCH 008/624] Simplify ComponentProviders (#3935) --- packages-exp/functions-exp/test/utils.ts | 3 +- packages/auth/src/auth.js | 2 +- packages/firestore/exp/src/api/components.ts | 5 - packages/firestore/exp/src/api/database.ts | 127 ++++++++++---- packages/firestore/index.memory.ts | 14 +- packages/firestore/index.node.memory.ts | 14 +- packages/firestore/index.node.ts | 17 +- packages/firestore/index.rn.memory.ts | 14 +- packages/firestore/index.rn.ts | 17 +- packages/firestore/index.ts | 17 +- packages/firestore/src/api/database.ts | 162 +++++++++++++----- .../firestore/src/core/component_provider.ts | 126 ++++++-------- .../firestore/src/core/firestore_client.ts | 67 +------- .../src/local/indexeddb_persistence.ts | 10 +- .../test/unit/specs/spec_test_components.ts | 13 +- .../test/unit/specs/spec_test_runner.ts | 33 +--- packages/firestore/test/util/api_helpers.ts | 15 +- 17 files changed, 296 insertions(+), 360 deletions(-) diff --git a/packages-exp/functions-exp/test/utils.ts b/packages-exp/functions-exp/test/utils.ts index f299c37f63b..a36dae606c6 100644 --- a/packages-exp/functions-exp/test/utils.ts +++ b/packages-exp/functions-exp/test/utils.ts @@ -68,7 +68,8 @@ export function createTestService( useFunctionsEmulator( functions, url.hostname, - Number.parseInt(url.port, 10)); + Number.parseInt(url.port, 10) + ); } return functions; } diff --git a/packages/auth/src/auth.js b/packages/auth/src/auth.js index 455d45de23d..2dd8d3e58a0 100644 --- a/packages/auth/src/auth.js +++ b/packages/auth/src/auth.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2017 Google Inc. + * Copyright 2017 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/packages/firestore/exp/src/api/components.ts b/packages/firestore/exp/src/api/components.ts index b7c7e17983d..9cf1d7b5225 100644 --- a/packages/firestore/exp/src/api/components.ts +++ b/packages/firestore/exp/src/api/components.ts @@ -16,7 +16,6 @@ */ import { FirebaseFirestore } from './database'; -import { PersistenceSettings } from '../../../src/core/firestore_client'; import { MemoryOfflineComponentProvider, OfflineComponentProvider, @@ -55,13 +54,10 @@ const onlineComponentProviders = new Map< export async function setOfflineComponentProvider( firestore: FirebaseFirestore, - persistenceSettings: PersistenceSettings, offlineComponentProvider: OfflineComponentProvider ): Promise { logDebug(LOG_TAG, 'Initializing OfflineComponentProvider'); const configuration = await firestore._getConfiguration(); - configuration.persistenceSettings = persistenceSettings; - await offlineComponentProvider.initialize(configuration); firestore._setCredentialChangeListener(user => // TODO(firestorexp): This should be a retryable IndexedDB operation @@ -118,7 +114,6 @@ async function getOfflineComponentProvider( logDebug(LOG_TAG, 'Using default OfflineComponentProvider'); await setOfflineComponentProvider( firestore, - { durable: false }, new MemoryOfflineComponentProvider() ); } diff --git a/packages/firestore/exp/src/api/database.ts b/packages/firestore/exp/src/api/database.ts index d8e9dba0a0a..ce06cd55e08 100644 --- a/packages/firestore/exp/src/api/database.ts +++ b/packages/firestore/exp/src/api/database.ts @@ -29,6 +29,7 @@ import { ComponentConfiguration, IndexedDbOfflineComponentProvider, MultiTabOfflineComponentProvider, + OfflineComponentProvider, OnlineComponentProvider } from '../../../src/core/component_provider'; import { @@ -66,6 +67,11 @@ import { PersistenceSettings } from '../../../exp-types'; const LOG_TAG = 'Firestore'; +/** DOMException error code constants. */ +const DOM_EXCEPTION_INVALID_STATE = 11; +const DOM_EXCEPTION_ABORTED = 20; +const DOM_EXCEPTION_QUOTA_EXCEEDED = 22; + export interface Settings extends LiteSettings { cacheSizeBytes?: number; } @@ -130,9 +136,7 @@ export class FirebaseFirestore clientId: this._clientId, credentials: this._credentials, initialUser: this._user, - maxConcurrentLimboResolutions: MAX_CONCURRENT_LIMBO_RESOLUTIONS, - // Note: This will be overwritten if IndexedDB persistence is enabled. - persistenceSettings: { durable: false } + maxConcurrentLimboResolutions: MAX_CONCURRENT_LIMBO_RESOLUTIONS }; } @@ -259,23 +263,15 @@ export function enableIndexedDbPersistence( const onlineComponentProvider = new OnlineComponentProvider(); const offlineComponentProvider = new IndexedDbOfflineComponentProvider( - onlineComponentProvider + onlineComponentProvider, + settings.cacheSizeBytes, + persistenceSettings?.forceOwnership + ); + return setPersistenceProviders( + firestore, + onlineComponentProvider, + offlineComponentProvider ); - - return firestore._queue.enqueue(async () => { - await setOfflineComponentProvider( - firestore, - { - durable: true, - synchronizeTabs: false, - cacheSizeBytes: - settings.cacheSizeBytes || LruParams.DEFAULT_CACHE_SIZE_BYTES, - forceOwningTab: !!persistenceSettings?.forceOwnership - }, - offlineComponentProvider - ); - await setOnlineComponentProvider(firestore, onlineComponentProvider); - }); } /** @@ -313,22 +309,87 @@ export function enableMultiTabIndexedDbPersistence( const onlineComponentProvider = new OnlineComponentProvider(); const offlineComponentProvider = new MultiTabOfflineComponentProvider( - onlineComponentProvider + onlineComponentProvider, + settings.cacheSizeBytes ); - return firestore._queue.enqueue(async () => { - await setOfflineComponentProvider( - firestore, - { - durable: true, - synchronizeTabs: true, - cacheSizeBytes: - settings.cacheSizeBytes || LruParams.DEFAULT_CACHE_SIZE_BYTES, - forceOwningTab: false - }, - offlineComponentProvider + return setPersistenceProviders( + firestore, + onlineComponentProvider, + offlineComponentProvider + ); +} + +/** + * Registers both the `OfflineComponentProvider` and `OnlineComponentProvider`. + * If the operation fails with a recoverable error (see + * `canRecoverFromIndexedDbError()` below), the returned Promise is rejected + * but the client remains usable. + */ +function setPersistenceProviders( + firestore: FirebaseFirestore, + onlineComponentProvider: OnlineComponentProvider, + offlineComponentProvider: OfflineComponentProvider +): Promise { + const persistenceResult = new Deferred(); + return firestore._queue + .enqueue(async () => { + try { + await setOfflineComponentProvider(firestore, offlineComponentProvider); + await setOnlineComponentProvider(firestore, onlineComponentProvider); + persistenceResult.resolve(); + } catch (e) { + if (!canFallbackFromIndexedDbError(e)) { + throw e; + } + console.warn( + 'Error enabling offline persistence. Falling back to ' + + 'persistence disabled: ' + + e + ); + persistenceResult.reject(e); + } + }) + .then(() => persistenceResult.promise); +} + +/** + * Decides whether the provided error allows us to gracefully disable + * persistence (as opposed to crashing the client). + */ +// TODO(schmidt-sebastian): Remove `export` in +// https://github.com/firebase/firebase-js-sdk/pull/3901 +export function canFallbackFromIndexedDbError( + error: FirestoreError | DOMException +): boolean { + if (error.name === 'FirebaseError') { + return ( + error.code === Code.FAILED_PRECONDITION || + error.code === Code.UNIMPLEMENTED ); - await setOnlineComponentProvider(firestore, onlineComponentProvider); - }); + } else if ( + typeof DOMException !== 'undefined' && + error instanceof DOMException + ) { + // There are a few known circumstances where we can open IndexedDb but + // trying to read/write will fail (e.g. quota exceeded). For + // well-understood cases, we attempt to detect these and then gracefully + // fall back to memory persistence. + // NOTE: Rather than continue to add to this list, we could decide to + // always fall back, with the risk that we might accidentally hide errors + // representing actual SDK bugs. + return ( + // When the browser is out of quota we could get either quota exceeded + // or an aborted error depending on whether the error happened during + // schema migration. + error.code === DOM_EXCEPTION_QUOTA_EXCEEDED || + error.code === DOM_EXCEPTION_ABORTED || + // Firefox Private Browsing mode disables IndexedDb and returns + // INVALID_STATE for any usage. + error.code === DOM_EXCEPTION_INVALID_STATE + ); + } + + return true; } /** diff --git a/packages/firestore/index.memory.ts b/packages/firestore/index.memory.ts index 50139a89e30..9b313aad439 100644 --- a/packages/firestore/index.memory.ts +++ b/packages/firestore/index.memory.ts @@ -18,11 +18,7 @@ import firebase from '@firebase/app'; import { FirebaseNamespace } from '@firebase/app-types'; -import { Firestore } from './src/api/database'; -import { - MemoryOfflineComponentProvider, - OnlineComponentProvider -} from './src/core/component_provider'; +import { Firestore, MemoryPersistenceProvider } from './src/api/database'; import { configureForFirebase } from './src/config'; import './register-module'; @@ -35,13 +31,7 @@ import { name, version } from './package.json'; export function registerFirestore(instance: FirebaseNamespace): void { configureForFirebase( instance, - (app, auth) => - new Firestore( - app, - auth, - new MemoryOfflineComponentProvider(), - new OnlineComponentProvider() - ) + (app, auth) => new Firestore(app, auth, new MemoryPersistenceProvider()) ); instance.registerVersion(name, version); } diff --git a/packages/firestore/index.node.memory.ts b/packages/firestore/index.node.memory.ts index 0b532326504..0982b38fe46 100644 --- a/packages/firestore/index.node.memory.ts +++ b/packages/firestore/index.node.memory.ts @@ -18,11 +18,7 @@ import firebase from '@firebase/app'; import { FirebaseNamespace } from '@firebase/app-types'; -import { Firestore } from './src/api/database'; -import { - MemoryOfflineComponentProvider, - OnlineComponentProvider -} from './src/core/component_provider'; +import { Firestore, MemoryPersistenceProvider } from './src/api/database'; import { configureForFirebase } from './src/config'; import './register-module'; @@ -35,13 +31,7 @@ import { name, version } from './package.json'; export function registerFirestore(instance: FirebaseNamespace): void { configureForFirebase( instance, - (app, auth) => - new Firestore( - app, - auth, - new MemoryOfflineComponentProvider(), - new OnlineComponentProvider() - ) + (app, auth) => new Firestore(app, auth, new MemoryPersistenceProvider()) ); instance.registerVersion(name, version, 'node'); } diff --git a/packages/firestore/index.node.ts b/packages/firestore/index.node.ts index 7347879e1d4..05d406ddb67 100644 --- a/packages/firestore/index.node.ts +++ b/packages/firestore/index.node.ts @@ -17,11 +17,7 @@ import firebase from '@firebase/app'; import { FirebaseNamespace } from '@firebase/app-types'; -import { Firestore } from './src/api/database'; -import { - MultiTabOfflineComponentProvider, - OnlineComponentProvider -} from './src/core/component_provider'; +import { Firestore, IndexedDbPersistenceProvider } from './src/api/database'; import { configureForFirebase } from './src/config'; import './register-module'; @@ -34,16 +30,7 @@ import { name, version } from './package.json'; */ export function registerFirestore(instance: FirebaseNamespace): void { configureForFirebase(instance, (app, auth) => { - const onlineComponentProvider = new OnlineComponentProvider(); - const offlineComponentProvider = new MultiTabOfflineComponentProvider( - onlineComponentProvider - ); - return new Firestore( - app, - auth, - offlineComponentProvider, - onlineComponentProvider - ); + return new Firestore(app, auth, new IndexedDbPersistenceProvider()); }); instance.registerVersion(name, version, 'node'); } diff --git a/packages/firestore/index.rn.memory.ts b/packages/firestore/index.rn.memory.ts index 041e777bb8c..4e6ce2537cc 100644 --- a/packages/firestore/index.rn.memory.ts +++ b/packages/firestore/index.rn.memory.ts @@ -18,11 +18,7 @@ import firebase from '@firebase/app'; import { FirebaseNamespace } from '@firebase/app-types'; -import { Firestore } from './src/api/database'; -import { - MemoryOfflineComponentProvider, - OnlineComponentProvider -} from './src/core/component_provider'; +import { Firestore, MemoryPersistenceProvider } from './src/api/database'; import { configureForFirebase } from './src/config'; import './register-module'; @@ -36,13 +32,7 @@ import { name, version } from './package.json'; export function registerFirestore(instance: FirebaseNamespace): void { configureForFirebase( instance, - (app, auth) => - new Firestore( - app, - auth, - new MemoryOfflineComponentProvider(), - new OnlineComponentProvider() - ) + (app, auth) => new Firestore(app, auth, new MemoryPersistenceProvider()) ); instance.registerVersion(name, version, 'rn'); } diff --git a/packages/firestore/index.rn.ts b/packages/firestore/index.rn.ts index 355469f1323..84cdcf2ffa3 100644 --- a/packages/firestore/index.rn.ts +++ b/packages/firestore/index.rn.ts @@ -17,11 +17,7 @@ import firebase from '@firebase/app'; import { FirebaseNamespace } from '@firebase/app-types'; -import { Firestore } from './src/api/database'; -import { - MultiTabOfflineComponentProvider, - OnlineComponentProvider -} from './src/core/component_provider'; +import { Firestore, IndexedDbPersistenceProvider } from './src/api/database'; import { configureForFirebase } from './src/config'; import './register-module'; @@ -33,16 +29,7 @@ import { name, version } from './package.json'; */ export function registerFirestore(instance: FirebaseNamespace): void { configureForFirebase(instance, (app, auth) => { - const onlineComponentProvider = new OnlineComponentProvider(); - const offlineComponentProvider = new MultiTabOfflineComponentProvider( - onlineComponentProvider - ); - return new Firestore( - app, - auth, - offlineComponentProvider, - onlineComponentProvider - ); + return new Firestore(app, auth, new IndexedDbPersistenceProvider()); }); instance.registerVersion(name, version, 'rn'); } diff --git a/packages/firestore/index.ts b/packages/firestore/index.ts index 37b5eff8a85..5b40359f0bf 100644 --- a/packages/firestore/index.ts +++ b/packages/firestore/index.ts @@ -18,11 +18,7 @@ import firebase from '@firebase/app'; import { FirebaseNamespace } from '@firebase/app-types'; -import { Firestore } from './src/api/database'; -import { - MultiTabOfflineComponentProvider, - OnlineComponentProvider -} from './src/core/component_provider'; +import { Firestore, IndexedDbPersistenceProvider } from './src/api/database'; import { configureForFirebase } from './src/config'; import { name, version } from './package.json'; @@ -34,16 +30,7 @@ import './register-module'; */ export function registerFirestore(instance: FirebaseNamespace): void { configureForFirebase(instance, (app, auth) => { - const onlineComponentProvider = new OnlineComponentProvider(); - const offlineComponentProvider = new MultiTabOfflineComponentProvider( - onlineComponentProvider - ); - return new Firestore( - app, - auth, - offlineComponentProvider, - onlineComponentProvider - ); + return new Firestore(app, auth, new IndexedDbPersistenceProvider()); }); instance.registerVersion(name, version); } diff --git a/packages/firestore/src/api/database.ts b/packages/firestore/src/api/database.ts index 9ac0a2e27e3..492338adb95 100644 --- a/packages/firestore/src/api/database.ts +++ b/packages/firestore/src/api/database.ts @@ -49,11 +49,13 @@ import { Blob } from './blob'; import { DatabaseId, DatabaseInfo } from '../core/database_info'; import { ListenOptions } from '../core/event_manager'; import { + IndexedDbOfflineComponentProvider, MemoryOfflineComponentProvider, + MultiTabOfflineComponentProvider, OfflineComponentProvider, OnlineComponentProvider } from '../core/component_provider'; -import { FirestoreClient, PersistenceSettings } from '../core/firestore_client'; +import { FirestoreClient } from '../core/firestore_client'; import { Bound, Direction, @@ -141,6 +143,10 @@ import { import { UserDataWriter } from './user_data_writer'; import { FirebaseAuthInternalName } from '@firebase/auth-interop-types'; import { Provider } from '@firebase/component'; +import { + indexedDbClearPersistence, + indexedDbStoragePrefix +} from '../local/indexeddb_persistence'; // settings() defaults: const DEFAULT_HOST = 'firestore.googleapis.com'; @@ -335,6 +341,104 @@ class FirestoreSettings { } } +/** + * A persistence provider for either memory-only or IndexedDB persistence. + * Mainly used to allow optional inclusion of IndexedDB code. + */ +export interface PersistenceProvider { + enableIndexedDbPersistence( + firestore: Firestore, + forceOwnership: boolean + ): Promise; + enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise; + clearIndexedDbPersistence(firestore: Firestore): Promise; +} + +const MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE = + 'You are using the memory-only build of Firestore. Persistence support is ' + + 'only available via the @firebase/firestore bundle or the ' + + 'firebase-firestore.js build.'; + +/** + * The persistence provider included with the memory-only SDK. This provider + * errors for all attempts to access persistence. + */ +export class MemoryPersistenceProvider implements PersistenceProvider { + enableIndexedDbPersistence( + firestore: Firestore, + forceOwnership: boolean + ): Promise { + throw new FirestoreError( + Code.FAILED_PRECONDITION, + MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE + ); + } + + enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise { + throw new FirestoreError( + Code.FAILED_PRECONDITION, + MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE + ); + } + + clearIndexedDbPersistence(firestore: Firestore): Promise { + throw new FirestoreError( + Code.FAILED_PRECONDITION, + MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE + ); + } +} + +/** + * The persistence provider included with the full Firestore SDK. + */ +export class IndexedDbPersistenceProvider implements PersistenceProvider { + enableIndexedDbPersistence( + firestore: Firestore, + forceOwnership: boolean + ): Promise { + const onlineComponentProvider = new OnlineComponentProvider(); + const offlineComponentProvider = new IndexedDbOfflineComponentProvider( + onlineComponentProvider, + firestore._getSettings().cacheSizeBytes, + forceOwnership + ); + return firestore._configureClient( + offlineComponentProvider, + onlineComponentProvider + ); + } + + enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise { + const onlineComponentProvider = new OnlineComponentProvider(); + const offlineComponentProvider = new MultiTabOfflineComponentProvider( + onlineComponentProvider, + firestore._getSettings().cacheSizeBytes + ); + return firestore._configureClient( + offlineComponentProvider, + onlineComponentProvider + ); + } + + clearIndexedDbPersistence(firestore: Firestore): Promise { + const deferred = new Deferred(); + firestore._queue.enqueueAndForgetEvenWhileRestricted(async () => { + try { + await indexedDbClearPersistence( + indexedDbStoragePrefix( + firestore._databaseId, + firestore._persistenceKey + ) + ); + deferred.resolve(); + } catch (e) { + deferred.reject(e); + } + }); + return deferred.promise; + } +} /** * The root reference to the database. */ @@ -343,7 +447,7 @@ export class Firestore implements PublicFirestore, FirebaseService { // compiled javascript so we want to flag our private members with a leading // underscore to discourage their use. readonly _databaseId: DatabaseId; - private readonly _persistenceKey: string; + readonly _persistenceKey: string; private _credentials: CredentialsProvider; private readonly _firebaseApp: FirebaseApp | null = null; private _settings: FirestoreSettings; @@ -362,14 +466,13 @@ export class Firestore implements PublicFirestore, FirebaseService { _userDataReader: UserDataReader | undefined; - // Note: We are using `MemoryComponentProvider` as a default + // Note: We are using `MemoryPersistenceProvider` as a default // ComponentProvider to ensure backwards compatibility with the format // expected by the console build. constructor( databaseIdOrApp: FirestoreDatabase | FirebaseApp, authProvider: Provider, - private _offlineComponentProvider: OfflineComponentProvider = new MemoryOfflineComponentProvider(), - private _onlineComponentProvider = new OnlineComponentProvider() + readonly _persistenceProvider: PersistenceProvider = new MemoryPersistenceProvider() ) { if (typeof (databaseIdOrApp as FirebaseApp).options === 'object') { // This is very likely a Firebase app object @@ -474,16 +577,12 @@ export class Firestore implements PublicFirestore, FirebaseService { ); } - return this.configureClient( - this._offlineComponentProvider, - this._onlineComponentProvider, - { - durable: true, - cacheSizeBytes: this._settings.cacheSizeBytes, - synchronizeTabs, - forceOwningTab: experimentalForceOwningTab - } - ); + return synchronizeTabs + ? this._persistenceProvider.enableMultiTabIndexedDbPersistence(this) + : this._persistenceProvider.enableIndexedDbPersistence( + this, + experimentalForceOwningTab + ); } async clearPersistence(): Promise { @@ -497,20 +596,7 @@ export class Firestore implements PublicFirestore, FirebaseService { 'initialized or after it is terminated.' ); } - - const deferred = new Deferred(); - this._queue.enqueueAndForgetEvenWhileRestricted(async () => { - try { - await this._offlineComponentProvider.clearPersistence( - this._databaseId, - this._persistenceKey - ); - deferred.resolve(); - } catch (e) { - deferred.reject(e); - } - }); - return deferred.promise; + return this._persistenceProvider.clearIndexedDbPersistence(this); } terminate(): Promise { @@ -550,12 +636,9 @@ export class Firestore implements PublicFirestore, FirebaseService { if (!this._firestoreClient) { // Kick off starting the client but don't actually wait for it. // eslint-disable-next-line @typescript-eslint/no-floating-promises - this.configureClient( + this._configureClient( new MemoryOfflineComponentProvider(), - new OnlineComponentProvider(), - { - durable: false - } + new OnlineComponentProvider() ); } return this._firestoreClient as FirestoreClient; @@ -572,13 +655,13 @@ export class Firestore implements PublicFirestore, FirebaseService { ); } - private configureClient( + // TODO(schmidt-sebastian): Make this private again in + // https://github.com/firebase/firebase-js-sdk/pull/3901. + _configureClient( offlineComponentProvider: OfflineComponentProvider, - onlineComponentProvider: OnlineComponentProvider, - persistenceSettings: PersistenceSettings + onlineComponentProvider: OnlineComponentProvider ): Promise { debugAssert(!!this._settings.host, 'FirestoreSettings.host is not set'); - debugAssert( !this._firestoreClient, 'configureClient() called multiple times' @@ -591,8 +674,7 @@ export class Firestore implements PublicFirestore, FirebaseService { return this._firestoreClient.start( databaseInfo, offlineComponentProvider, - onlineComponentProvider, - persistenceSettings + onlineComponentProvider ); } diff --git a/packages/firestore/src/core/component_provider.ts b/packages/firestore/src/core/component_provider.ts index 6ee568da187..500e20dfcbb 100644 --- a/packages/firestore/src/core/component_provider.ts +++ b/packages/firestore/src/core/component_provider.ts @@ -47,11 +47,9 @@ import { } from '../remote/remote_store'; import { EventManager, newEventManager } from './event_manager'; import { AsyncQueue } from '../util/async_queue'; -import { DatabaseId, DatabaseInfo } from './database_info'; +import { DatabaseInfo } from './database_info'; import { Datastore, newDatastore } from '../remote/datastore'; import { User } from '../auth/user'; -import { PersistenceSettings } from './firestore_client'; -import { debugAssert } from '../util/assert'; import { GarbageCollectionScheduler, Persistence } from '../local/persistence'; import { Code, FirestoreError } from '../util/error'; import { OnlineStateSource } from './types'; @@ -59,8 +57,7 @@ import { LruParams, LruScheduler } from '../local/lru_garbage_collector'; import { IndexFreeQueryEngine } from '../local/index_free_query_engine'; import { indexedDbStoragePrefix, - IndexedDbPersistence, - indexedDbClearPersistence + IndexedDbPersistence } from '../local/indexeddb_persistence'; import { MemoryEagerDelegate, @@ -71,11 +68,6 @@ import { newSerializer } from '../platform/serializer'; import { getDocument, getWindow } from '../platform/dom'; import { CredentialsProvider } from '../api/credentials'; -const MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE = - 'You are using the memory-only build of Firestore. Persistence support is ' + - 'only available via the @firebase/firestore bundle or the ' + - 'firebase-firestore.js build.'; - export interface ComponentConfiguration { asyncQueue: AsyncQueue; databaseInfo: DatabaseInfo; @@ -83,7 +75,6 @@ export interface ComponentConfiguration { clientId: ClientId; initialUser: User; maxConcurrentLimboResolutions: number; - persistenceSettings: PersistenceSettings; } /** @@ -95,15 +86,11 @@ export interface OfflineComponentProvider { sharedClientState: SharedClientState; localStore: LocalStore; gcScheduler: GarbageCollectionScheduler | null; + synchronizeTabs: boolean; initialize(cfg: ComponentConfiguration): Promise; terminate(): Promise; - - clearPersistence( - databaseId: DatabaseId, - persistenceKey: string - ): Promise; } /** @@ -116,6 +103,7 @@ export class MemoryOfflineComponentProvider sharedClientState!: SharedClientState; localStore!: LocalStore; gcScheduler!: GarbageCollectionScheduler | null; + synchronizeTabs = false; async initialize(cfg: ComponentConfiguration): Promise { this.sharedClientState = this.createSharedClientState(cfg); @@ -140,12 +128,6 @@ export class MemoryOfflineComponentProvider } createPersistence(cfg: ComponentConfiguration): Persistence { - if (cfg.persistenceSettings.durable) { - throw new FirestoreError( - Code.FAILED_PRECONDITION, - MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE - ); - } return new MemoryPersistence(MemoryEagerDelegate.factory); } @@ -160,16 +142,6 @@ export class MemoryOfflineComponentProvider await this.sharedClientState.shutdown(); await this.persistence.shutdown(); } - - clearPersistence( - databaseId: DatabaseId, - persistenceKey: string - ): Promise { - throw new FirestoreError( - Code.FAILED_PRECONDITION, - MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE - ); - } } /** @@ -180,9 +152,12 @@ export class IndexedDbOfflineComponentProvider extends MemoryOfflineComponentPro sharedClientState!: SharedClientState; localStore!: LocalStore; gcScheduler!: GarbageCollectionScheduler | null; + synchronizeTabs = false; constructor( - protected readonly onlineComponentProvider: OnlineComponentProvider + protected readonly onlineComponentProvider: OnlineComponentProvider, + protected readonly cacheSizeBytes: number | undefined, + protected readonly forceOwnership: boolean | undefined ) { super(); } @@ -207,42 +182,33 @@ export class IndexedDbOfflineComponentProvider extends MemoryOfflineComponentPro } createPersistence(cfg: ComponentConfiguration): IndexedDbPersistence { - debugAssert( - cfg.persistenceSettings.durable, - 'Can only start durable persistence' - ); - const persistenceKey = indexedDbStoragePrefix( cfg.databaseInfo.databaseId, cfg.databaseInfo.persistenceKey ); + const lruParams = + this.cacheSizeBytes !== undefined + ? LruParams.withCacheSize(this.cacheSizeBytes) + : LruParams.DEFAULT; const serializer = newSerializer(cfg.databaseInfo.databaseId); + return new IndexedDbPersistence( - cfg.persistenceSettings.synchronizeTabs, + this.synchronizeTabs, persistenceKey, cfg.clientId, - LruParams.withCacheSize(cfg.persistenceSettings.cacheSizeBytes), + lruParams, cfg.asyncQueue, getWindow(), getDocument(), serializer, this.sharedClientState, - cfg.persistenceSettings.forceOwningTab + !!this.forceOwnership ); } createSharedClientState(cfg: ComponentConfiguration): SharedClientState { return new MemorySharedClientState(); } - - clearPersistence( - databaseId: DatabaseId, - persistenceKey: string - ): Promise { - return indexedDbClearPersistence( - indexedDbStoragePrefix(databaseId, persistenceKey) - ); - } } /** @@ -254,6 +220,15 @@ export class IndexedDbOfflineComponentProvider extends MemoryOfflineComponentPro * `synchronizeTabs` will be enabled. */ export class MultiTabOfflineComponentProvider extends IndexedDbOfflineComponentProvider { + synchronizeTabs = true; + + constructor( + protected readonly onlineComponentProvider: OnlineComponentProvider, + protected readonly cacheSizeBytes: number | undefined + ) { + super(onlineComponentProvider, cacheSizeBytes, /* forceOwnership= */ false); + } + async initialize(cfg: ComponentConfiguration): Promise { await super.initialize(cfg); @@ -290,30 +265,24 @@ export class MultiTabOfflineComponentProvider extends IndexedDbOfflineComponentP } createSharedClientState(cfg: ComponentConfiguration): SharedClientState { - if ( - cfg.persistenceSettings.durable && - cfg.persistenceSettings.synchronizeTabs - ) { - const window = getWindow(); - if (!WebStorageSharedClientState.isAvailable(window)) { - throw new FirestoreError( - Code.UNIMPLEMENTED, - 'IndexedDB persistence is only available on platforms that support LocalStorage.' - ); - } - const persistenceKey = indexedDbStoragePrefix( - cfg.databaseInfo.databaseId, - cfg.databaseInfo.persistenceKey - ); - return new WebStorageSharedClientState( - window, - cfg.asyncQueue, - persistenceKey, - cfg.clientId, - cfg.initialUser + const window = getWindow(); + if (!WebStorageSharedClientState.isAvailable(window)) { + throw new FirestoreError( + Code.UNIMPLEMENTED, + 'IndexedDB persistence is only available on platforms that support LocalStorage.' ); } - return new MemorySharedClientState(); + const persistenceKey = indexedDbStoragePrefix( + cfg.databaseInfo.databaseId, + cfg.databaseInfo.persistenceKey + ); + return new WebStorageSharedClientState( + window, + cfg.asyncQueue, + persistenceKey, + cfg.clientId, + cfg.initialUser + ); } } @@ -344,7 +313,10 @@ export class OnlineComponentProvider { this.datastore = this.createDatastore(cfg); this.remoteStore = this.createRemoteStore(cfg); this.eventManager = this.createEventManager(cfg); - this.syncEngine = this.createSyncEngine(cfg); + this.syncEngine = this.createSyncEngine( + cfg, + /* startAsPrimary=*/ !offlineComponentProvider.synchronizeTabs + ); this.sharedClientState.onlineStateHandler = onlineState => applyOnlineStateChange( @@ -389,7 +361,10 @@ export class OnlineComponentProvider { ); } - createSyncEngine(cfg: ComponentConfiguration): SyncEngine { + createSyncEngine( + cfg: ComponentConfiguration, + startAsPrimary: boolean + ): SyncEngine { return newSyncEngine( this.localStore, this.remoteStore, @@ -397,8 +372,7 @@ export class OnlineComponentProvider { this.sharedClientState, cfg.initialUser, cfg.maxConcurrentLimboResolutions, - !cfg.persistenceSettings.durable || - !cfg.persistenceSettings.synchronizeTabs + startAsPrimary ); } diff --git a/packages/firestore/src/core/firestore_client.ts b/packages/firestore/src/core/firestore_client.ts index b9a34563988..e8a4ac3467f 100644 --- a/packages/firestore/src/core/firestore_client.ts +++ b/packages/firestore/src/core/firestore_client.ts @@ -72,26 +72,11 @@ import { AsyncObserver } from '../util/async_observer'; import { debugAssert } from '../util/assert'; import { TransactionRunner } from './transaction_runner'; import { Datastore } from '../remote/datastore'; +import { canFallbackFromIndexedDbError } from '../../exp/src/api/database'; const LOG_TAG = 'FirestoreClient'; export const MAX_CONCURRENT_LIMBO_RESOLUTIONS = 100; -/** DOMException error code constants. */ -const DOM_EXCEPTION_INVALID_STATE = 11; -const DOM_EXCEPTION_ABORTED = 20; -const DOM_EXCEPTION_QUOTA_EXCEEDED = 22; - -export type PersistenceSettings = - | { - readonly durable: false; - } - | { - readonly durable: true; - readonly cacheSizeBytes: number; - readonly synchronizeTabs: boolean; - readonly forceOwningTab: boolean; - }; - /** * FirestoreClient is a top-level class that constructs and owns all of the * pieces of the client SDK architecture. It is responsible for creating the @@ -173,8 +158,6 @@ export class FirestoreClient { * required for memory-only or IndexedDB persistence. * @param onlineComponentProvider Provider that returns all components * required for online support. - * @param persistenceSettings Settings object to configure offline - * persistence. * @returns A deferred result indicating the user-visible result of enabling * offline persistence. This method will reject this if IndexedDB fails to * start for any reason. If usePersistence is false this is @@ -183,8 +166,7 @@ export class FirestoreClient { start( databaseInfo: DatabaseInfo, offlineComponentProvider: OfflineComponentProvider, - onlineComponentProvider: OnlineComponentProvider, - persistenceSettings: PersistenceSettings + onlineComponentProvider: OnlineComponentProvider ): Promise { this.verifyNotTerminated(); @@ -208,7 +190,6 @@ export class FirestoreClient { return this.initializeComponents( offlineComponentProvider, onlineComponentProvider, - persistenceSettings, user, persistenceResult ).then(this.initializationDone.resolve, this.initializationDone.reject); @@ -249,7 +230,6 @@ export class FirestoreClient { * required for memory-only or IndexedDB persistence. * @param onlineComponentProvider Provider that returns all components * required for online support. - * @param persistenceSettings Settings object to configure offline persistence * @param user The initial user * @param persistenceResult A deferred result indicating the user-visible * result of enabling offline persistence. This method will reject this if @@ -262,7 +242,6 @@ export class FirestoreClient { private async initializeComponents( offlineComponentProvider: OfflineComponentProvider, onlineComponentProvider: OnlineComponentProvider, - persistenceSettings: PersistenceSettings, user: User, persistenceResult: Deferred ): Promise { @@ -273,8 +252,7 @@ export class FirestoreClient { clientId: this.clientId, credentials: this.credentials, initialUser: user, - maxConcurrentLimboResolutions: MAX_CONCURRENT_LIMBO_RESOLUTIONS, - persistenceSettings + maxConcurrentLimboResolutions: MAX_CONCURRENT_LIMBO_RESOLUTIONS }; await offlineComponentProvider.initialize(componentConfiguration); @@ -308,7 +286,7 @@ export class FirestoreClient { persistenceResult.reject(error); // An unknown failure on the first stage shuts everything down. - if (!this.canFallback(error)) { + if (!canFallbackFromIndexedDbError(error)) { throw error; } console.warn( @@ -319,49 +297,12 @@ export class FirestoreClient { return this.initializeComponents( new MemoryOfflineComponentProvider(), new OnlineComponentProvider(), - { durable: false }, user, persistenceResult ); } } - /** - * Decides whether the provided error allows us to gracefully disable - * persistence (as opposed to crashing the client). - */ - private canFallback(error: FirestoreError | DOMException): boolean { - if (error.name === 'FirebaseError') { - return ( - error.code === Code.FAILED_PRECONDITION || - error.code === Code.UNIMPLEMENTED - ); - } else if ( - typeof DOMException !== 'undefined' && - error instanceof DOMException - ) { - // There are a few known circumstances where we can open IndexedDb but - // trying to read/write will fail (e.g. quota exceeded). For - // well-understood cases, we attempt to detect these and then gracefully - // fall back to memory persistence. - // NOTE: Rather than continue to add to this list, we could decide to - // always fall back, with the risk that we might accidentally hide errors - // representing actual SDK bugs. - return ( - // When the browser is out of quota we could get either quota exceeded - // or an aborted error depending on whether the error happened during - // schema migration. - error.code === DOM_EXCEPTION_QUOTA_EXCEEDED || - error.code === DOM_EXCEPTION_ABORTED || - // Firefox Private Browsing mode disables IndexedDb and returns - // INVALID_STATE for any usage. - error.code === DOM_EXCEPTION_INVALID_STATE - ); - } - - return true; - } - /** * Checks that the client has not been terminated. Ensures that other methods on * this class cannot be called after the client is terminated. diff --git a/packages/firestore/src/local/indexeddb_persistence.ts b/packages/firestore/src/local/indexeddb_persistence.ts index 9ddebed34d7..8ea569dd1e3 100644 --- a/packages/firestore/src/local/indexeddb_persistence.ts +++ b/packages/firestore/src/local/indexeddb_persistence.ts @@ -105,15 +105,13 @@ const MAX_PRIMARY_ELIGIBLE_AGE_MS = 5000; const CLIENT_METADATA_REFRESH_INTERVAL_MS = 4000; /** User-facing error when the primary lease is required but not available. */ const PRIMARY_LEASE_EXCLUSIVE_ERROR_MSG = - 'Failed to obtain exclusive access to the persistence layer. ' + - 'To allow shared access, make sure to invoke ' + - '`enablePersistence()` with `synchronizeTabs:true` in all tabs. ' + + 'Failed to obtain exclusive access to the persistence layer. To allow ' + + 'shared access, multi-tab synchronization has to be enabled in all tabs. ' + 'If you are using `experimentalForceOwningTab:true`, make sure that only ' + 'one tab has persistence enabled at any given time.'; const UNSUPPORTED_PLATFORM_ERROR_MSG = - 'This platform is either missing' + - ' IndexedDB or is known to have an incomplete implementation. Offline' + - ' persistence has been disabled.'; + 'This platform is either missing IndexedDB or is known to have ' + + 'an incomplete implementation. Offline persistence has been disabled.'; // The format of the LocalStorage key that stores zombied client is: // firestore_zombie__ diff --git a/packages/firestore/test/unit/specs/spec_test_components.ts b/packages/firestore/test/unit/specs/spec_test_components.ts index ab6c672a888..1066b98da3d 100644 --- a/packages/firestore/test/unit/specs/spec_test_components.ts +++ b/packages/firestore/test/unit/specs/spec_test_components.ts @@ -167,11 +167,6 @@ export class MockMultiTabOfflineComponentProvider extends MultiTabOfflineCompone } createPersistence(cfg: ComponentConfiguration): MockIndexedDbPersistence { - debugAssert( - cfg.persistenceSettings.durable, - 'Can only start durable persistence' - ); - const persistenceKey = indexedDbStoragePrefix( cfg.databaseInfo.databaseId, cfg.databaseInfo.persistenceKey @@ -182,13 +177,13 @@ export class MockMultiTabOfflineComponentProvider extends MultiTabOfflineCompone /* allowTabSynchronization= */ true, persistenceKey, cfg.clientId, - LruParams.withCacheSize(cfg.persistenceSettings.cacheSizeBytes), + LruParams.DEFAULT, cfg.asyncQueue, this.window, this.document, serializer, this.sharedClientState, - cfg.persistenceSettings.forceOwningTab + /* forceOwningTab= */ false ); } } @@ -208,10 +203,6 @@ export class MockMemoryOfflineComponentProvider extends MemoryOfflineComponentPr } createPersistence(cfg: ComponentConfiguration): Persistence { - debugAssert( - !cfg.persistenceSettings.durable, - 'Can only start memory persistence' - ); return new MockMemoryPersistence( this.gcEnabled ? MemoryEagerDelegate.factory diff --git a/packages/firestore/test/unit/specs/spec_test_runner.ts b/packages/firestore/test/unit/specs/spec_test_runner.ts index d753010b13f..c0bdc21ff49 100644 --- a/packages/firestore/test/unit/specs/spec_test_runner.ts +++ b/packages/firestore/test/unit/specs/spec_test_runner.ts @@ -132,8 +132,6 @@ import { MULTI_CLIENT_TAG } from './describe_spec'; import { ByteString } from '../../../src/util/byte_string'; import { SortedSet } from '../../../src/util/sorted_set'; import { ActiveTargetMap, ActiveTargetSpec } from './spec_builder'; -import { LruParams } from '../../../src/local/lru_garbage_collector'; -import { PersistenceSettings } from '../../../src/core/firestore_client'; import { EventAggregator, MockConnection, @@ -231,7 +229,6 @@ abstract class TestRunner { constructor( private sharedWrites: SharedWriteTracker, - private persistenceSettings: PersistenceSettings, clientIndex: number, config: SpecConfig ) { @@ -275,8 +272,7 @@ abstract class TestRunner { clientId: this.clientId, initialUser: this.user, maxConcurrentLimboResolutions: - this.maxConcurrentLimboResolutions ?? Number.MAX_SAFE_INTEGER, - persistenceSettings: this.persistenceSettings + this.maxConcurrentLimboResolutions ?? Number.MAX_SAFE_INTEGER }; this.connection = new MockConnection(this.queue); @@ -1134,21 +1130,6 @@ abstract class TestRunner { } class MemoryTestRunner extends TestRunner { - constructor( - sharedWrites: SharedWriteTracker, - clientIndex: number, - config: SpecConfig - ) { - super( - sharedWrites, - { - durable: false - }, - clientIndex, - config - ); - } - protected async initializeOfflineComponentProvider( onlineComponentProvider: MockOnlineComponentProvider, configuration: ComponentConfiguration, @@ -1171,17 +1152,7 @@ class IndexedDbTestRunner extends TestRunner { clientIndex: number, config: SpecConfig ) { - super( - sharedWrites, - { - durable: true, - cacheSizeBytes: LruParams.DEFAULT_CACHE_SIZE_BYTES, - synchronizeTabs: true, - forceOwningTab: false - }, - clientIndex, - config - ); + super(sharedWrites, clientIndex, config); } protected async initializeOfflineComponentProvider( diff --git a/packages/firestore/test/util/api_helpers.ts b/packages/firestore/test/util/api_helpers.ts index b49195a87f6..6832e3780ae 100644 --- a/packages/firestore/test/util/api_helpers.ts +++ b/packages/firestore/test/util/api_helpers.ts @@ -23,13 +23,10 @@ import { DocumentReference, DocumentSnapshot, Firestore, + IndexedDbPersistenceProvider, Query, QuerySnapshot } from '../../src/api/database'; -import { - MultiTabOfflineComponentProvider, - OnlineComponentProvider -} from '../../src/core/component_provider'; import { newQueryForPath, Query as InternalQuery } from '../../src/core/query'; import { ChangeType, @@ -44,10 +41,6 @@ import { doc, key, path as pathFrom } from './helpers'; import { Provider, ComponentContainer } from '@firebase/component'; import { TEST_PROJECT } from '../unit/local/persistence_test_helpers'; -const onlineComponentProvider = new OnlineComponentProvider(); -const offlineComponentProvider = new MultiTabOfflineComponentProvider( - onlineComponentProvider -); /** * A mock Firestore. Will not work for integration test. */ @@ -57,8 +50,7 @@ export const FIRESTORE = new Firestore( database: '(default)' }, new Provider('auth-internal', new ComponentContainer('default')), - offlineComponentProvider, - onlineComponentProvider + new IndexedDbPersistenceProvider() ); export function firestore(): Firestore { @@ -72,8 +64,7 @@ export function newTestFirestore(): Firestore { database: '(default)' }, new Provider('auth-internal', new ComponentContainer('default')), - offlineComponentProvider, - onlineComponentProvider + new IndexedDbPersistenceProvider() ); } From f3554394dfdc26ee6bbfb05b925d1ed6a93c31a8 Mon Sep 17 00:00:00 2001 From: Feiyang Date: Thu, 15 Oct 2020 13:33:44 -0700 Subject: [PATCH 009/624] remove @firebase/testing from the repo (#3951) * remove @firebase/testing from the repo * skip deleted projects * fix script --- .changeset/config.json | 1 - .github/workflows/test-changed-misc.yml | 2 +- packages/testing/.firebaserc | 1 - packages/testing/CHANGELOG.md | 46 ---- packages/testing/README.md | 9 - packages/testing/firebase.json | 13 -- packages/testing/index.ts | 35 --- packages/testing/package.json | 42 ---- packages/testing/rollup.config.js | 37 ---- packages/testing/src/api/index.ts | 272 ------------------------ packages/testing/test/database.test.ts | 160 -------------- packages/testing/tsconfig.json | 9 - scripts/check_changeset.ts | 15 +- scripts/ci-test/tasks.ts | 11 +- scripts/ci-test/testConfig.ts | 7 +- 15 files changed, 22 insertions(+), 638 deletions(-) delete mode 100644 packages/testing/.firebaserc delete mode 100644 packages/testing/CHANGELOG.md delete mode 100644 packages/testing/README.md delete mode 100644 packages/testing/firebase.json delete mode 100644 packages/testing/index.ts delete mode 100644 packages/testing/package.json delete mode 100644 packages/testing/rollup.config.js delete mode 100644 packages/testing/src/api/index.ts delete mode 100644 packages/testing/test/database.test.ts delete mode 100644 packages/testing/tsconfig.json diff --git a/.changeset/config.json b/.changeset/config.json index 41f4c0e6574..5d0be005d42 100644 --- a/.changeset/config.json +++ b/.changeset/config.json @@ -21,7 +21,6 @@ "@firebase/installations-types-exp", "@firebase/performance-exp", "@firebase/performance-types-exp", - "@firebase/testing", "firebase-exp", "@firebase/app-compat", "@firebase/changelog-generator", diff --git a/.github/workflows/test-changed-misc.yml b/.github/workflows/test-changed-misc.yml index 6bdf4117ee0..50aad8ea227 100644 --- a/.github/workflows/test-changed-misc.yml +++ b/.github/workflows/test-changed-misc.yml @@ -1,4 +1,4 @@ -name: Test rxFire, @firebase/testing and @firebase/rules-unit-testing +name: Test rxFire and @firebase/rules-unit-testing on: pull_request diff --git a/packages/testing/.firebaserc b/packages/testing/.firebaserc deleted file mode 100644 index 0967ef424bc..00000000000 --- a/packages/testing/.firebaserc +++ /dev/null @@ -1 +0,0 @@ -{} diff --git a/packages/testing/CHANGELOG.md b/packages/testing/CHANGELOG.md deleted file mode 100644 index 924e879d77d..00000000000 --- a/packages/testing/CHANGELOG.md +++ /dev/null @@ -1,46 +0,0 @@ -# @firebase/testing - -## 0.20.11 - -### Patch Changes - -- Updated dependencies [[`d4ca3da0`](https://github.com/firebase/firebase-js-sdk/commit/d4ca3da0a59fcea1261ba69d7eb663bba38d3089), [`2a0d254f`](https://github.com/firebase/firebase-js-sdk/commit/2a0d254fa58e607842fc0380c8cfa7bbbb69df75), [`29327b21`](https://github.com/firebase/firebase-js-sdk/commit/29327b2198391a9f1e545bcd1172a4b3e12a522c)]: - - firebase@7.18.0 - - @firebase/util@0.3.1 - -## 0.20.10 - -### Patch Changes - -- Updated dependencies []: - - firebase@7.17.2 - -## 0.20.9 - -### Patch Changes - -- Updated dependencies [[`a87676b8`](https://github.com/firebase/firebase-js-sdk/commit/a87676b84b78ccc2f057a22eb947a5d13402949c)]: - - @firebase/util@0.3.0 - - firebase@7.17.1 - -## 0.20.8 - -### Patch Changes - -- Updated dependencies [[`02419ce8`](https://github.com/firebase/firebase-js-sdk/commit/02419ce8470141f012d9ce425a6a4a4aa912e480)]: - - firebase@7.17.0 - -## 0.20.7 - -### Patch Changes - -- Updated dependencies [[`9c409ea7`](https://github.com/firebase/firebase-js-sdk/commit/9c409ea74efd00fe17058c5c8b74450fae67e9ee), [`5a355360`](https://github.com/firebase/firebase-js-sdk/commit/5a3553609da893d45f7fe1897387f72eaedf2fe0), [`c2b737b2`](https://github.com/firebase/firebase-js-sdk/commit/c2b737b2187cb525af4d926ca477102db7835420), [`9a9a81fe`](https://github.com/firebase/firebase-js-sdk/commit/9a9a81fe4f001f23e9fe1db054c2e7159fca3ae3)]: - - firebase@7.16.1 - -## 0.20.6 - -### Patch Changes - -- Updated dependencies [[`a754645e`](https://github.com/firebase/firebase-js-sdk/commit/a754645ec2be1b8c205f25f510196eee298b0d6e), [`17c628eb`](https://github.com/firebase/firebase-js-sdk/commit/17c628eb228c21ad1d4db83fdae08d1142a2b902), [`bb740836`](https://github.com/firebase/firebase-js-sdk/commit/bb7408361519aa9a58c8256ae01914cf2830e118), [`39ca8ecf`](https://github.com/firebase/firebase-js-sdk/commit/39ca8ecf940472159d0bc58212f34a70146da60c), [`877c060c`](https://github.com/firebase/firebase-js-sdk/commit/877c060c47bb29a8efbd2b96d35d3334fd9d9a98), [`e90304c8`](https://github.com/firebase/firebase-js-sdk/commit/e90304c8ac4341d8b23b55da784eb21348b04025), [`469c8bdf`](https://github.com/firebase/firebase-js-sdk/commit/469c8bdf18c4a22e99d595a9896af2f934df20fd)]: - - firebase@7.16.0 - - @firebase/logger@0.2.6 diff --git a/packages/testing/README.md b/packages/testing/README.md deleted file mode 100644 index 40a72bb086d..00000000000 --- a/packages/testing/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# @firebase/testing - -A set of utilities useful for testing Security Rules with the Realtime Database or Cloud Firestore -emulators. - -See: - - * [Test your Cloud Firestore Security Rules](https://firebase.google.com/docs/firestore/security/test-rules-emulator) - * [Testing Security Rules with the Realtime Database Emulator](https://firebase.google.com/docs/database/security/test-rules-emulator) \ No newline at end of file diff --git a/packages/testing/firebase.json b/packages/testing/firebase.json deleted file mode 100644 index b2ba04fe7ea..00000000000 --- a/packages/testing/firebase.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "emulators": { - "firestore": { - "port": 9001 - }, - "database": { - "port": 9000 - }, - "ui": { - "enabled": false - } - } -} diff --git a/packages/testing/index.ts b/packages/testing/index.ts deleted file mode 100644 index 4c5c8a27bac..00000000000 --- a/packages/testing/index.ts +++ /dev/null @@ -1,35 +0,0 @@ -/** - * @license - * Copyright 2017 Google LLC - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -/* - * The testing module does not need to be registered since it should not ever - * come by default. The only way to use the testing module is by explicitly - * creating a dependency on @firebase/testing. - */ - -export { - apps, - assertFails, - assertSucceeds, - clearFirestoreData, - database, - firestore, - initializeAdminApp, - initializeTestApp, - loadDatabaseRules, - loadFirestoreRules -} from './src/api'; diff --git a/packages/testing/package.json b/packages/testing/package.json deleted file mode 100644 index 7d12eb512de..00000000000 --- a/packages/testing/package.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "name": "@firebase/testing", - "version": "0.20.11", - "description": "", - "author": "Firebase (https://firebase.google.com/)", - "main": "dist/index.cjs.js", - "engines": { - "node": "^8.13.0 || >=10.10.0" - }, - "files": ["dist"], - "scripts": { - "build": "rollup -c", - "build:deps": "lerna run --scope @firebase/testing --include-dependencies build", - "dev": "rollup -c -w", - "test:nyc": "TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --config ../../config/mocharc.node.js", - "test": "firebase --debug emulators:exec 'yarn test:nyc'", - "test:ci": "node ../../scripts/run_tests_in_ci.js -s test", - "prepare": "yarn build" - }, - "license": "Apache-2.0", - "dependencies": { - "firebase": "7.23.0", - "@firebase/logger": "0.2.6", - "@firebase/util": "0.3.2", - "request": "2.88.2" - }, - "devDependencies": { - "@types/request": "2.48.5", - "firebase-tools": "8.12.1", - "rollup": "2.29.0", - "rollup-plugin-typescript2": "0.27.3" - }, - "repository": { - "directory": "packages/testing", - "type": "git", - "url": "https://github.com/firebase/firebase-js-sdk.git" - }, - "typings": "dist/index.d.ts", - "bugs": { - "url": "https://github.com/firebase/firebase-js-sdk/issues" - } -} diff --git a/packages/testing/rollup.config.js b/packages/testing/rollup.config.js deleted file mode 100644 index d1399baf786..00000000000 --- a/packages/testing/rollup.config.js +++ /dev/null @@ -1,37 +0,0 @@ -/** - * @license - * Copyright 2018 Google LLC - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -import typescriptPlugin from 'rollup-plugin-typescript2'; -import pkg from './package.json'; -import typescript from 'typescript'; - -const plugins = [ - typescriptPlugin({ - typescript - }) -]; - -const deps = Object.keys( - Object.assign({}, pkg.peerDependencies, pkg.dependencies) -); - -export default { - input: 'index.ts', - output: [{ file: pkg.main, format: 'cjs', sourcemap: true }], - plugins: [...plugins], - external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)) -}; diff --git a/packages/testing/src/api/index.ts b/packages/testing/src/api/index.ts deleted file mode 100644 index c5207de5b17..00000000000 --- a/packages/testing/src/api/index.ts +++ /dev/null @@ -1,272 +0,0 @@ -/** - * @license - * Copyright 2018 Google LLC - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -import * as firebase from 'firebase'; -import { _FirebaseApp } from '@firebase/app-types/private'; -import { FirebaseAuthInternal } from '@firebase/auth-interop-types'; -import * as request from 'request'; -import { base64 } from '@firebase/util'; -import { setLogLevel, LogLevel } from '@firebase/logger'; -import { Component, ComponentType } from '@firebase/component'; - -export { database, firestore } from 'firebase'; - -/** If this environment variable is set, use it for the database emulator's address. */ -const DATABASE_ADDRESS_ENV: string = 'FIREBASE_DATABASE_EMULATOR_ADDRESS'; -/** The default address for the local database emulator. */ -const DATABASE_ADDRESS_DEFAULT: string = 'localhost:9000'; -/** The actual address for the database emulator */ -const DATABASE_ADDRESS: string = - process.env[DATABASE_ADDRESS_ENV] || DATABASE_ADDRESS_DEFAULT; - -/** If any of environment variable is set, use it for the Firestore emulator. */ -const FIRESTORE_ADDRESS_ENVS: string[] = [ - 'FIRESTORE_EMULATOR_HOST', - 'FIREBASE_FIRESTORE_EMULATOR_ADDRESS' -]; -/** The default address for the local Firestore emulator. */ -const FIRESTORE_ADDRESS_DEFAULT: string = 'localhost:8080'; -/** The actual address for the Firestore emulator */ -const FIRESTORE_ADDRESS: string = FIRESTORE_ADDRESS_ENVS.reduce( - (addr, name) => process.env[name] || addr, - FIRESTORE_ADDRESS_DEFAULT -); - -/** Passing this in tells the emulator to treat you as an admin. */ -const ADMIN_TOKEN = 'owner'; -/** Create an unsecured JWT for the given auth payload. See https://tools.ietf.org/html/rfc7519#section-6. */ -function createUnsecuredJwt(auth: object): string { - // Unsecured JWTs use "none" as the algorithm. - const header = { - alg: 'none', - kid: 'fakekid' - }; - // Ensure that the auth payload has a value for 'iat'. - (auth as any).iat = (auth as any).iat || 0; - // Use `uid` field as a backup when `sub` is missing. - (auth as any).sub = (auth as any).sub || (auth as any).uid; - if (!(auth as any).sub) { - throw new Error("auth must be an object with a 'sub' or 'uid' field"); - } - // Unsecured JWTs use the empty string as a signature. - const signature = ''; - return [ - base64.encodeString(JSON.stringify(header), /*webSafe=*/ false), - base64.encodeString(JSON.stringify(auth), /*webSafe=*/ false), - signature - ].join('.'); -} - -export function apps(): firebase.app.App[] { - return firebase.apps; -} - -export type AppOptions = { - databaseName?: string; - projectId?: string; - auth?: object; -}; -/** Construct an App authenticated with options.auth. */ -export function initializeTestApp(options: AppOptions): firebase.app.App { - return initializeApp( - options.auth ? createUnsecuredJwt(options.auth) : undefined, - options.databaseName, - options.projectId - ); -} - -export type AdminAppOptions = { - databaseName?: string; - projectId?: string; -}; -/** Construct an App authenticated as an admin user. */ -export function initializeAdminApp(options: AdminAppOptions): firebase.app.App { - return initializeApp(ADMIN_TOKEN, options.databaseName, options.projectId); -} - -function initializeApp( - accessToken?: string, - databaseName?: string, - projectId?: string -): firebase.app.App { - let appOptions: { [key: string]: string } = {}; - if (databaseName) { - appOptions['databaseURL'] = `http://${DATABASE_ADDRESS}?ns=${databaseName}`; - } - if (projectId) { - appOptions['projectId'] = projectId; - } - const appName = 'app-' + new Date().getTime() + '-' + Math.random(); - let app = firebase.initializeApp(appOptions, appName); - if (accessToken) { - const mockAuthComponent = new Component( - 'auth-internal', - () => - ({ - getToken: async () => ({ accessToken: accessToken }), - getUid: () => null, - addAuthTokenListener: listener => { - // Call listener once immediately with predefined accessToken. - listener(accessToken); - }, - removeAuthTokenListener: () => {} - } as FirebaseAuthInternal), - ComponentType.PRIVATE - ); - - ((app as unknown) as _FirebaseApp)._addOrOverwriteComponent( - mockAuthComponent - ); - } - if (databaseName) { - // Toggle network connectivity to force a reauthentication attempt. - // This mitigates a minor race condition where the client can send the - // first database request before authenticating. - app.database().goOffline(); - app.database().goOnline(); - } - if (projectId) { - app.firestore().settings({ - host: FIRESTORE_ADDRESS, - ssl: false - }); - } - /** - Mute warnings for the previously-created database and whatever other - objects were just created. - */ - setLogLevel(LogLevel.ERROR); - return app; -} - -export type LoadDatabaseRulesOptions = { - databaseName: string; - rules: string; -}; -export function loadDatabaseRules( - options: LoadDatabaseRulesOptions -): Promise { - if (!options.databaseName) { - throw Error('databaseName not specified'); - } - - if (!options.rules) { - throw Error('must provide rules to loadDatabaseRules'); - } - - return new Promise((resolve, reject) => { - request.put( - { - uri: `http://${DATABASE_ADDRESS}/.settings/rules.json?ns=${options.databaseName}`, - headers: { Authorization: 'Bearer owner' }, - body: options.rules - }, - (err, resp, body) => { - if (err) { - reject(err); - } else if (resp.statusCode !== 200) { - reject(JSON.parse(body).error); - } else { - resolve(); - } - } - ); - }); -} - -export type LoadFirestoreRulesOptions = { - projectId: string; - rules: string; -}; -export function loadFirestoreRules( - options: LoadFirestoreRulesOptions -): Promise { - if (!options.projectId) { - throw new Error('projectId not specified'); - } - - if (!options.rules) { - throw new Error('must provide rules to loadFirestoreRules'); - } - - return new Promise((resolve, reject) => { - request.put( - { - uri: `http://${FIRESTORE_ADDRESS}/emulator/v1/projects/${options.projectId}:securityRules`, - body: JSON.stringify({ - rules: { - files: [{ content: options.rules }] - } - }) - }, - (err, resp, body) => { - if (err) { - reject(err); - } else if (resp.statusCode !== 200) { - console.log('body', body); - reject(JSON.parse(body).error); - } else { - resolve(); - } - } - ); - }); -} - -export type ClearFirestoreDataOptions = { - projectId: string; -}; -export function clearFirestoreData( - options: ClearFirestoreDataOptions -): Promise { - if (!options.projectId) { - throw new Error('projectId not specified'); - } - - return new Promise((resolve, reject) => { - request.delete( - { - uri: `http://${FIRESTORE_ADDRESS}/emulator/v1/projects/${options.projectId}/databases/(default)/documents`, - body: JSON.stringify({ - database: `projects/${options.projectId}/databases/(default)` - }) - }, - (err, resp, body) => { - if (err) { - reject(err); - } else if (resp.statusCode !== 200) { - console.log('body', body); - reject(JSON.parse(body).error); - } else { - resolve(); - } - } - ); - }); -} - -export function assertFails(pr: Promise): any { - return pr.then( - v => - Promise.reject(new Error('Expected request to fail, but it succeeded.')), - err => err - ); -} - -export function assertSucceeds(pr: Promise): any { - return pr; -} diff --git a/packages/testing/test/database.test.ts b/packages/testing/test/database.test.ts deleted file mode 100644 index 034d941a6a8..00000000000 --- a/packages/testing/test/database.test.ts +++ /dev/null @@ -1,160 +0,0 @@ -/** - * @license - * Copyright 2017 Google LLC - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -import * as chai from 'chai'; -import * as chaiAsPromised from 'chai-as-promised'; -import * as firebase from '../src/api'; -import { base64 } from '@firebase/util'; -import { _FirebaseApp } from '@firebase/app-types/private'; - -const expect = chai.expect; - -before(() => { - chai.use(chaiAsPromised); -}); - -describe('Testing Module Tests', function () { - it('assertSucceeds() iff success', async function () { - const success = Promise.resolve('success'); - const failure = Promise.reject('failure'); - await firebase.assertSucceeds(success).catch(() => { - throw new Error('Expected success to succeed.'); - }); - await firebase - .assertSucceeds(failure) - .then(() => { - throw new Error('Expected failure to fail.'); - }) - .catch(() => {}); - }); - - it('assertFails() iff failure', async function () { - const success = Promise.resolve('success'); - const failure = Promise.reject('failure'); - await firebase - .assertFails(success) - .then(() => { - throw new Error('Expected success to fail.'); - }) - .catch(() => {}); - await firebase.assertFails(failure).catch(() => { - throw new Error('Expected failure to succeed.'); - }); - }); - - it('initializeTestApp() with auth=null does not set access token', async function () { - const app = firebase.initializeTestApp({ - projectId: 'foo', - auth: undefined - }); - - const authInternal = ((app as unknown) as _FirebaseApp).container - .getProvider('auth-internal') - .getImmediate({ optional: true }); - // Auth instance will not be available because no API Key is provided - expect(authInternal).to.be.null; - }); - - it('initializeTestApp() with auth sets the correct access token', async function () { - const auth = { uid: 'alice' }; - const app = firebase.initializeTestApp({ - projectId: 'foo', - auth: auth - }); - const authInternal = ((app as unknown) as _FirebaseApp).container - .getProvider('auth-internal') - .getImmediate(); - - const token = await authInternal.getToken(); - expect(token).to.have.keys('accessToken'); - const claims = JSON.parse( - base64.decodeString(token!.accessToken.split('.')[1], /*webSafe=*/ false) - ); - // We add an 'iat' field. - expect(claims).to.deep.equal({ uid: auth.uid, iat: 0, sub: auth.uid }); - }); - - it('initializeAdminApp() sets the access token to "owner"', async function () { - const app = firebase.initializeAdminApp({ projectId: 'foo' }); - const authInternal = ((app as unknown) as _FirebaseApp).container - .getProvider('auth-internal') - .getImmediate(); - - const token = await authInternal.getToken(); - expect(token).to.have.keys('accessToken'); - expect(token!.accessToken).to.be.string('owner'); - }); - - it('loadDatabaseRules() throws if no databaseName or rules', async function () { - // eslint-disable-next-line @typescript-eslint/no-explicit-any - await expect((firebase as any).loadDatabaseRules.bind(null, {})).to.throw( - /databaseName not specified/ - ); - // eslint-disable-next-line @typescript-eslint/no-explicit-any - await expect( - (firebase as any).loadDatabaseRules.bind(null, { - databaseName: 'foo' - }) as Promise - ).to.throw(/must provide rules/); - await expect( - // eslint-disable-next-line @typescript-eslint/no-explicit-any - (firebase as any).loadDatabaseRules.bind(null, { rules: '{}' }) - ).to.throw(/databaseName not specified/); - }); - - it('loadDatabaseRules() succeeds on valid input', async function () { - await firebase.loadDatabaseRules({ - databaseName: 'foo', - rules: '{ "rules": {} }' - }); - }); - - it('loadFirestoreRules() succeeds on valid input', async function () { - await firebase.loadFirestoreRules({ - projectId: 'foo', - rules: `service cloud.firestore { - match /databases/{db}/documents/{doc=**} { - allow read, write; - } - }` - }); - }); - - it('clearFirestoreData() succeeds on valid input', async function () { - await firebase.clearFirestoreData({ - projectId: 'foo' - }); - }); - - it('apps() returns apps created with initializeTestApp', async function () { - const numApps = firebase.apps().length; - await firebase.initializeTestApp({ databaseName: 'foo', auth: undefined }); - expect(firebase.apps().length).to.equal(numApps + 1); - await firebase.initializeTestApp({ databaseName: 'bar', auth: undefined }); - expect(firebase.apps().length).to.equal(numApps + 2); - }); - - it('there is a way to get database timestamps', function () { - expect(firebase.database.ServerValue.TIMESTAMP).to.deep.equal({ - '.sv': 'timestamp' - }); - }); - - it('there is a way to get firestore timestamps', function () { - expect(firebase.firestore.FieldValue.serverTimestamp()).not.to.be.null; - }); -}); diff --git a/packages/testing/tsconfig.json b/packages/testing/tsconfig.json deleted file mode 100644 index 09f747b4d46..00000000000 --- a/packages/testing/tsconfig.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "extends": "../../config/tsconfig.base.json", - "compilerOptions": { - "outDir": "dist" - }, - "exclude": [ - "dist/**/*" - ] -} diff --git a/scripts/check_changeset.ts b/scripts/check_changeset.ts index d906a4215f9..1ab8bf8b475 100644 --- a/scripts/check_changeset.ts +++ b/scripts/check_changeset.ts @@ -16,6 +16,7 @@ */ import { resolve } from 'path'; +import { existsSync } from 'fs'; import chalk from 'chalk'; import simpleGit from 'simple-git/promise'; import fs from 'mz/fs'; @@ -43,11 +44,15 @@ async function getDiffData(): Promise<{ // Check for changed files inside package dirs. const pkgMatch = filename.match('^(packages(-exp)?/[a-zA-Z0-9-]+)/.*'); if (pkgMatch && pkgMatch[1]) { - const changedPackage = require(resolve( - root, - pkgMatch[1], - 'package.json' - )); + // skip packages without package.json + // It could happen when we rename a package or remove a package from the repo + const pkgJsonPath = resolve(root, pkgMatch[1], 'package.json'); + + if (!existsSync(pkgJsonPath)) { + continue; + } + + const changedPackage = require(pkgJsonPath); if (changedPackage) { // Add the package itself. changedPackages.add(changedPackage.name); diff --git a/scripts/ci-test/tasks.ts b/scripts/ci-test/tasks.ts index 6669db4309d..655490219d5 100644 --- a/scripts/ci-test/tasks.ts +++ b/scripts/ci-test/tasks.ts @@ -16,6 +16,7 @@ */ import { resolve } from 'path'; +import { existsSync } from 'fs'; import { exec } from 'child-process-promise'; import chalk from 'chalk'; import simpleGit from 'simple-git/promise'; @@ -123,7 +124,15 @@ export async function getTestTasks(): Promise { // Check for changed files inside package dirs. const match = filename.match('^(packages(-exp)?/[a-zA-Z0-9-]+)/.*'); if (match && match[1]) { - const changedPkg = require(resolve(root, match[1], 'package.json')); + const pkgJsonPath = resolve(root, match[1], 'package.json'); + + // skip projects that don't have package.json + // It could happen when we rename a package or remove a package from the repo + if (!existsSync(pkgJsonPath)) { + continue; + } + + const changedPkg = require(pkgJsonPath); if (changedPkg) { const changedPkgName = changedPkg.name; const task = testTasks.find(t => t.pkgName === changedPkgName); diff --git a/scripts/ci-test/testConfig.ts b/scripts/ci-test/testConfig.ts index e8636e39084..02de5ea0781 100644 --- a/scripts/ci-test/testConfig.ts +++ b/scripts/ci-test/testConfig.ts @@ -37,7 +37,6 @@ export const testConfig: { 'firebase-firestore-integration-test', 'firebase-messaging-integration-test', 'firebase-namespace-integration-test', - '@firebase/testing', '@firebase/rules-unit-testing', 'rxfire', '@firebase/auth', @@ -55,11 +54,7 @@ export const testConfig: { 'onlyIncludePackages': ['firebase-messaging-integration-test'] }, 'misc': { - 'onlyIncludePackages': [ - '@firebase/testing', - '@firebase/rules-unit-testing', - 'rxfire' - ] + 'onlyIncludePackages': ['@firebase/rules-unit-testing', 'rxfire'] }, 'firebase-integration': { 'alwaysIncludePackages': ['firebase-namespace-integration-test'] From ffef32e3837d3ee1098129b237e7a6e2e738182d Mon Sep 17 00:00:00 2001 From: Brian Chen Date: Thu, 15 Oct 2020 16:06:35 -0500 Subject: [PATCH 010/624] Remove `timestampsInSnapshots` from FirestoreSettings (#3897) --- .changeset/strange-rabbits-wait.md | 7 ++ packages/firebase/index.d.ts | 34 --------- packages/firestore-types/index.d.ts | 1 - packages/firestore/exp/src/api/snapshot.ts | 2 - packages/firestore/lite/src/api/snapshot.ts | 2 - packages/firestore/src/api/database.ts | 35 --------- .../firestore/src/api/user_data_writer.ts | 13 +--- .../test/integration/api/fields.test.ts | 71 ------------------- .../test/unit/remote/serializer.helper.ts | 12 ++-- packages/firestore/test/util/helpers.ts | 1 - 10 files changed, 15 insertions(+), 163 deletions(-) create mode 100644 .changeset/strange-rabbits-wait.md diff --git a/.changeset/strange-rabbits-wait.md b/.changeset/strange-rabbits-wait.md new file mode 100644 index 00000000000..abd7ac5b703 --- /dev/null +++ b/.changeset/strange-rabbits-wait.md @@ -0,0 +1,7 @@ +--- +'firebase': major +'@firebase/firestore': major +'@firebase/firestore-types': major +--- + +Removed the `timestampsInSnapshots` option from `FirestoreSettings`. Now, Firestore always returns `Timestamp` values for all timestamp values. diff --git a/packages/firebase/index.d.ts b/packages/firebase/index.d.ts index 3dbef9e2c19..17862f58609 100644 --- a/packages/firebase/index.d.ts +++ b/packages/firebase/index.d.ts @@ -7845,40 +7845,6 @@ declare namespace firebase.firestore { /** Whether to use SSL when connecting. */ ssl?: boolean; - /** - * Specifies whether to use `Timestamp` objects for timestamp fields in - * `DocumentSnapshot`s. This is enabled by default and should not be - * disabled. - * - * Previously, Firestore returned timestamp fields as `Date` but `Date` - * only supports millisecond precision, which leads to truncation and - * causes unexpected behavior when using a timestamp from a snapshot as a - * part of a subsequent query. - * - * Now, Firestore returns `Timestamp` values for all timestamp values stored - * in Cloud Firestore instead of system `Date` objects, avoiding this kind - * of problem. Consequently, you must update your code to handle `Timestamp` - * objects instead of `Date` objects. - * - * If you want to **temporarily** opt into the old behavior of returning - * `Date` objects, you may **temporarily** set `timestampsInSnapshots` to - * false. Opting into this behavior will no longer be possible in the next - * major release of Firestore, after which code that expects Date objects - * **will break**. - * - * @example **Using Date objects in Firestore.** - * // With deprecated setting `timestampsInSnapshot: true`: - * const date : Date = snapshot.get('created_at'); - * // With new default behavior: - * const timestamp : Timestamp = snapshot.get('created_at'); - * const date : Date = timestamp.toDate(); - * - * @deprecated This setting will be removed in a future release. You should - * update your code to expect `Timestamp` objects and stop using the - * `timestampsInSnapshots` setting. - */ - timestampsInSnapshots?: boolean; - /** * An approximate cache size threshold for the on-disk data. If the cache grows beyond this * size, Firestore will start removing data that hasn't been recently used. The size is not a diff --git a/packages/firestore-types/index.d.ts b/packages/firestore-types/index.d.ts index 0222425dea3..bec92576778 100644 --- a/packages/firestore-types/index.d.ts +++ b/packages/firestore-types/index.d.ts @@ -26,7 +26,6 @@ export const CACHE_SIZE_UNLIMITED: number; export interface Settings { host?: string; ssl?: boolean; - timestampsInSnapshots?: boolean; cacheSizeBytes?: number; experimentalForceLongPolling?: boolean; experimentalAutoDetectLongPolling?: boolean; diff --git a/packages/firestore/exp/src/api/snapshot.ts b/packages/firestore/exp/src/api/snapshot.ts index c2cedac1b51..7002d725b39 100644 --- a/packages/firestore/exp/src/api/snapshot.ts +++ b/packages/firestore/exp/src/api/snapshot.ts @@ -236,7 +236,6 @@ export class DocumentSnapshot extends LiteDocumentSnapshot< } else { const userDataWriter = new UserDataWriter( this._firestoreImpl._databaseId, - /* timestampsInSnapshots= */ true, options?.serverTimestamps || DEFAULT_SERVER_TIMESTAMP_BEHAVIOR, key => new DocumentReference( @@ -276,7 +275,6 @@ export class DocumentSnapshot extends LiteDocumentSnapshot< if (value !== null) { const userDataWriter = new UserDataWriter( this._firestoreImpl._databaseId, - /* timestampsInSnapshots= */ true, options.serverTimestamps || DEFAULT_SERVER_TIMESTAMP_BEHAVIOR, key => new DocumentReference(this._firestore, this._converter, key.path), diff --git a/packages/firestore/lite/src/api/snapshot.ts b/packages/firestore/lite/src/api/snapshot.ts index 0b3f9582ad6..cff40b44c0b 100644 --- a/packages/firestore/lite/src/api/snapshot.ts +++ b/packages/firestore/lite/src/api/snapshot.ts @@ -171,7 +171,6 @@ export class DocumentSnapshot { } else { const userDataWriter = new UserDataWriter( this._firestore._databaseId, - /* timestampsInSnapshots= */ true, /* serverTimestampBehavior=*/ 'none', key => new DocumentReference( @@ -204,7 +203,6 @@ export class DocumentSnapshot { if (value !== null) { const userDataWriter = new UserDataWriter( this._firestore._databaseId, - /* timestampsInSnapshots= */ true, /* serverTimestampBehavior=*/ 'none', key => new DocumentReference(this._firestore, this._converter, key.path), diff --git a/packages/firestore/src/api/database.ts b/packages/firestore/src/api/database.ts index 492338adb95..a1d835afd8f 100644 --- a/packages/firestore/src/api/database.ts +++ b/packages/firestore/src/api/database.ts @@ -151,7 +151,6 @@ import { // settings() defaults: const DEFAULT_HOST = 'firestore.googleapis.com'; const DEFAULT_SSL = true; -const DEFAULT_TIMESTAMPS_IN_SNAPSHOTS = true; const DEFAULT_FORCE_LONG_POLLING = false; const DEFAULT_FORCE_AUTO_DETECT_LONG_POLLING = false; const DEFAULT_IGNORE_UNDEFINED_PROPERTIES = false; @@ -194,8 +193,6 @@ class FirestoreSettings { /** Whether to use SSL when connecting. */ readonly ssl: boolean; - readonly timestampsInSnapshots: boolean; - readonly cacheSizeBytes: number; readonly experimentalForceLongPolling: boolean; @@ -229,7 +226,6 @@ class FirestoreSettings { 'host', 'ssl', 'credentials', - 'timestampsInSnapshots', 'cacheSizeBytes', 'experimentalForceLongPolling', 'experimentalAutoDetectLongPolling', @@ -244,13 +240,6 @@ class FirestoreSettings { ); this.credentials = settings.credentials; - validateNamedOptionalType( - 'settings', - 'boolean', - 'timestampsInSnapshots', - settings.timestampsInSnapshots - ); - validateNamedOptionalType( 'settings', 'boolean', @@ -258,21 +247,6 @@ class FirestoreSettings { settings.ignoreUndefinedProperties ); - // Nobody should set timestampsInSnapshots anymore, but the error depends on - // whether they set it to true or false... - if (settings.timestampsInSnapshots === true) { - logError( - "The setting 'timestampsInSnapshots: true' is no longer required " + - 'and should be removed.' - ); - } else if (settings.timestampsInSnapshots === false) { - logError( - "Support for 'timestampsInSnapshots: false' will be removed soon. " + - 'You must update your code to handle Timestamp objects.' - ); - } - this.timestampsInSnapshots = - settings.timestampsInSnapshots ?? DEFAULT_TIMESTAMPS_IN_SNAPSHOTS; this.ignoreUndefinedProperties = settings.ignoreUndefinedProperties ?? DEFAULT_IGNORE_UNDEFINED_PROPERTIES; @@ -329,7 +303,6 @@ class FirestoreSettings { return ( this.host === other.host && this.ssl === other.ssl && - this.timestampsInSnapshots === other.timestampsInSnapshots && this.credentials === other.credentials && this.cacheSizeBytes === other.cacheSizeBytes && this.experimentalForceLongPolling === @@ -810,12 +783,6 @@ export class Firestore implements PublicFirestore, FirebaseService { setLogLevel(level); } - // Note: this is not a property because the minifier can't work correctly with - // the way TypeScript compiler outputs properties. - _areTimestampsInSnapshotsEnabled(): boolean { - return this._settings.timestampsInSnapshots; - } - // Visible for testing. _getSettings(): PublicSettings { return this._settings; @@ -1498,7 +1465,6 @@ export class DocumentSnapshot } else { const userDataWriter = new UserDataWriter( this._firestore._databaseId, - this._firestore._areTimestampsInSnapshotsEnabled(), options.serverTimestamps || 'none', key => new DocumentReference(key, this._firestore, /* converter= */ null), @@ -1524,7 +1490,6 @@ export class DocumentSnapshot if (value !== null) { const userDataWriter = new UserDataWriter( this._firestore._databaseId, - this._firestore._areTimestampsInSnapshotsEnabled(), options.serverTimestamps || 'none', key => new DocumentReference(key, this._firestore, this._converter), bytes => new Blob(bytes) diff --git a/packages/firestore/src/api/user_data_writer.ts b/packages/firestore/src/api/user_data_writer.ts index f36f9244a53..84888fe6fd2 100644 --- a/packages/firestore/src/api/user_data_writer.ts +++ b/packages/firestore/src/api/user_data_writer.ts @@ -57,7 +57,6 @@ export type ServerTimestampBehavior = 'estimate' | 'previous' | 'none'; export class UserDataWriter { constructor( private readonly databaseId: DatabaseId, - private readonly timestampsInSnapshots: boolean, private readonly serverTimestampBehavior: ServerTimestampBehavior, private readonly referenceFactory: ( key: DocumentKey @@ -128,17 +127,9 @@ export class UserDataWriter { } } - private convertTimestamp(value: ProtoTimestamp): Timestamp | Date { + private convertTimestamp(value: ProtoTimestamp): Timestamp { const normalizedValue = normalizeTimestamp(value); - const timestamp = new Timestamp( - normalizedValue.seconds, - normalizedValue.nanos - ); - if (this.timestampsInSnapshots) { - return timestamp; - } else { - return timestamp.toDate(); - } + return new Timestamp(normalizedValue.seconds, normalizedValue.nanos); } private convertReference(name: string): _DocumentKeyReference { diff --git a/packages/firestore/test/integration/api/fields.test.ts b/packages/firestore/test/integration/api/fields.test.ts index 5d3b7f09b34..6debcac6bc8 100644 --- a/packages/firestore/test/integration/api/fields.test.ts +++ b/packages/firestore/test/integration/api/fields.test.ts @@ -28,9 +28,7 @@ import { import { DEFAULT_SETTINGS } from '../util/settings'; const FieldPath = firebaseExport.FieldPath; -const FieldValue = firebaseExport.FieldValue; const Timestamp = firebaseExport.Timestamp; -const usesFunctionalApi = firebaseExport.usesFunctionalApi; // Allow custom types for testing. // eslint-disable-next-line @typescript-eslint/no-explicit-any @@ -354,44 +352,6 @@ apiDescribe('Timestamp Fields in snapshots', (persistence: boolean) => { return { timestamp: ts, nested: { timestamp2: ts } }; }; - // timestampInSnapshots is not support in the modular API. - // eslint-disable-next-line no-restricted-properties - (usesFunctionalApi() ? it.skip : it)( - 'are returned as native dates if timestampsInSnapshots set to false', - () => { - const settings = { ...DEFAULT_SETTINGS }; - settings['timestampsInSnapshots'] = false; - - const timestamp = new Timestamp(100, 123456789); - const testDocs = { a: testDataWithTimestamps(timestamp) }; - return withTestCollectionSettings( - persistence, - settings, - testDocs, - coll => { - return coll - .doc('a') - .get() - .then(docSnap => { - expect(docSnap.get('timestamp')) - .to.be.a('date') - .that.deep.equals(timestamp.toDate()); - expect(docSnap.data()!['timestamp']) - .to.be.a('date') - .that.deep.equals(timestamp.toDate()); - - expect(docSnap.get('nested.timestamp2')) - .to.be.a('date') - .that.deep.equals(timestamp.toDate()); - expect(docSnap.data()!['nested']['timestamp2']) - .to.be.a('date') - .that.deep.equals(timestamp.toDate()); - }); - } - ); - } - ); - it('are returned as Timestamps', () => { const timestamp = new Timestamp(100, 123456000); // Timestamps are currently truncated to microseconds after being written to @@ -423,37 +383,6 @@ apiDescribe('Timestamp Fields in snapshots', (persistence: boolean) => { }); }); }); - - // timestampInSnapshots is not support in the modular API. - // eslint-disable-next-line no-restricted-properties - (usesFunctionalApi() ? it.skip : it)( - 'timestampsInSnapshots affects server timestamps', - () => { - const settings = { ...DEFAULT_SETTINGS }; - settings['timestampsInSnapshots'] = false; - const testDocs = { - a: { timestamp: FieldValue.serverTimestamp() } - }; - - return withTestCollectionSettings( - persistence, - settings, - testDocs, - coll => { - return coll - .doc('a') - .get() - .then(docSnap => { - expect( - docSnap.get('timestamp', { - serverTimestamps: 'estimate' - }) - ).to.be.an.instanceof(Date); - }); - } - ); - } - ); }); apiDescribe('`undefined` properties', (persistence: boolean) => { diff --git a/packages/firestore/test/unit/remote/serializer.helper.ts b/packages/firestore/test/unit/remote/serializer.helper.ts index 5de62d045ca..2711be84c2a 100644 --- a/packages/firestore/test/unit/remote/serializer.helper.ts +++ b/packages/firestore/test/unit/remote/serializer.helper.ts @@ -310,8 +310,8 @@ export function serializerTest( it('converts TimestampValue from proto', () => { const examples = [ - new Date(Date.UTC(2016, 0, 2, 10, 20, 50, 850)), - new Date(Date.UTC(2016, 5, 17, 10, 50, 15, 0)) + new Timestamp(1451730050, 850000000), + new Timestamp(1466160615, 0) ]; const expectedJson = [ @@ -339,25 +339,25 @@ export function serializerTest( userDataWriter.convertValue({ timestampValue: '2017-03-07T07:42:58.916123456Z' }) - ).to.deep.equal(new Timestamp(1488872578, 916123456).toDate()); + ).to.deep.equal(new Timestamp(1488872578, 916123456)); expect( userDataWriter.convertValue({ timestampValue: '2017-03-07T07:42:58.916123Z' }) - ).to.deep.equal(new Timestamp(1488872578, 916123000).toDate()); + ).to.deep.equal(new Timestamp(1488872578, 916123000)); expect( userDataWriter.convertValue({ timestampValue: '2017-03-07T07:42:58.916Z' }) - ).to.deep.equal(new Timestamp(1488872578, 916000000).toDate()); + ).to.deep.equal(new Timestamp(1488872578, 916000000)); expect( userDataWriter.convertValue({ timestampValue: '2017-03-07T07:42:58Z' }) - ).to.deep.equal(new Timestamp(1488872578, 0).toDate()); + ).to.deep.equal(new Timestamp(1488872578, 0)); }); it('converts TimestampValue to string (useProto3Json=true)', () => { diff --git a/packages/firestore/test/util/helpers.ts b/packages/firestore/test/util/helpers.ts index ef111de3c56..67c63479b9d 100644 --- a/packages/firestore/test/util/helpers.ts +++ b/packages/firestore/test/util/helpers.ts @@ -111,7 +111,6 @@ export type TestSnapshotVersion = number; export function testUserDataWriter(): UserDataWriter { return new UserDataWriter( TEST_DATABASE_ID, - /* timestampsInSnapshots= */ false, 'none', key => new DocumentReference(key, FIRESTORE, /* converter= */ null), bytes => new Blob(bytes) From 8939aeca02921f9eacf1badb1068de22f670293e Mon Sep 17 00:00:00 2001 From: Sebastian Schmidt Date: Thu, 15 Oct 2020 16:26:56 -0700 Subject: [PATCH 011/624] Remove undocumented getLogLevel (#3944) --- .changeset/great-rice-smash.md | 6 ++++ packages/firestore/src/api/database.ts | 44 +++++++------------------- packages/firestore/src/config.ts | 5 +-- 3 files changed, 21 insertions(+), 34 deletions(-) create mode 100644 .changeset/great-rice-smash.md diff --git a/.changeset/great-rice-smash.md b/.changeset/great-rice-smash.md new file mode 100644 index 00000000000..e64535b5d33 --- /dev/null +++ b/.changeset/great-rice-smash.md @@ -0,0 +1,6 @@ +--- +"firebase": major +"@firebase/firestore": major +--- + +Removed the undocumented `Firestore.logLevel` property. diff --git a/packages/firestore/src/api/database.ts b/packages/firestore/src/api/database.ts index a1d835afd8f..22d81890db5 100644 --- a/packages/firestore/src/api/database.ts +++ b/packages/firestore/src/api/database.ts @@ -111,7 +111,7 @@ import { valueDescription, validateIsNotUsedTogether } from '../util/input_validation'; -import { getLogLevel, logError, LogLevel, setLogLevel } from '../util/log'; +import { logError, setLogLevel as setClientLogLevel } from '../util/log'; import { AutoId } from '../util/misc'; import { Deferred } from '../util/promise'; import { FieldPath as ExternalFieldPath } from './field_path'; @@ -752,43 +752,23 @@ export class Firestore implements PublicFirestore, FirebaseService { return new WriteBatch(this); } - static get logLevel(): PublicLogLevel { - switch (getLogLevel()) { - case LogLevel.DEBUG: - return 'debug'; - case LogLevel.ERROR: - return 'error'; - case LogLevel.SILENT: - return 'silent'; - case LogLevel.WARN: - return 'warn'; - case LogLevel.INFO: - return 'info'; - case LogLevel.VERBOSE: - return 'verbose'; - default: - // The default log level is error - return 'error'; - } - } - - static setLogLevel(level: PublicLogLevel): void { - validateExactNumberOfArgs('Firestore.setLogLevel', arguments, 1); - validateStringEnum( - 'setLogLevel', - ['debug', 'error', 'silent', 'warn', 'info', 'verbose'], - 1, - level - ); - setLogLevel(level); - } - // Visible for testing. _getSettings(): PublicSettings { return this._settings; } } +export function setLogLevel(level: PublicLogLevel): void { + validateExactNumberOfArgs('Firestore.setLogLevel', arguments, 1); + validateStringEnum( + 'setLogLevel', + ['debug', 'error', 'silent', 'warn', 'info', 'verbose'], + 1, + level + ); + setClientLogLevel(level); +} + /** * A reference to a transaction. */ diff --git a/packages/firestore/src/config.ts b/packages/firestore/src/config.ts index 42d5d48128a..8de2d9b9dca 100644 --- a/packages/firestore/src/config.ts +++ b/packages/firestore/src/config.ts @@ -29,7 +29,8 @@ import { QueryDocumentSnapshot, QuerySnapshot, Transaction, - WriteBatch + WriteBatch, + setLogLevel } from './api/database'; import { Blob } from './api/blob'; import { FieldPath } from './api/field_path'; @@ -52,7 +53,7 @@ const firestoreNamespace = { CollectionReference, FieldPath, FieldValue, - setLogLevel: Firestore.setLogLevel, + setLogLevel, CACHE_SIZE_UNLIMITED }; From 79b04937537b90422e051086112f6b43c2880cdb Mon Sep 17 00:00:00 2001 From: Sam Stern Date: Fri, 16 Oct 2020 07:19:39 -0400 Subject: [PATCH 012/624] Implement useEmulator for Firestore (#3909) --- .changeset/short-icons-travel.md | 7 ++++++ packages/firebase/index.d.ts | 10 ++++++++ packages/firestore-types/index.d.ts | 2 ++ packages/firestore/exp/test/shim.ts | 4 +++ packages/firestore/src/api/database.ts | 25 +++++++++++++++++-- .../test/integration/api/validation.test.ts | 20 ++++++++++++++- .../firestore/test/unit/api/database.test.ts | 19 ++++++++++++++ 7 files changed, 84 insertions(+), 3 deletions(-) create mode 100644 .changeset/short-icons-travel.md diff --git a/.changeset/short-icons-travel.md b/.changeset/short-icons-travel.md new file mode 100644 index 00000000000..eca27d87bdc --- /dev/null +++ b/.changeset/short-icons-travel.md @@ -0,0 +1,7 @@ +--- +'firebase': minor +'@firebase/firestore': minor +'@firebase/firestore-types': minor +--- + +Add a useEmulator(host, port) method to Firestore diff --git a/packages/firebase/index.d.ts b/packages/firebase/index.d.ts index 17862f58609..c0d71742d59 100644 --- a/packages/firebase/index.d.ts +++ b/packages/firebase/index.d.ts @@ -8030,6 +8030,16 @@ declare namespace firebase.firestore { */ settings(settings: Settings): void; + /** + * Modify this instance to communicate with the Cloud Firestore emulator. + * + *

Note: this must be called before this instance has been used to do any operations. + * + * @param host the emulator host (ex: localhost). + * @param port the emulator port (ex: 9000). + */ + useEmulator(host: string, port: number): void; + /** * Attempts to enable persistent storage, if possible. * diff --git a/packages/firestore-types/index.d.ts b/packages/firestore-types/index.d.ts index bec92576778..2c94ea2842f 100644 --- a/packages/firestore-types/index.d.ts +++ b/packages/firestore-types/index.d.ts @@ -61,6 +61,8 @@ export class FirebaseFirestore { settings(settings: Settings): void; + useEmulator(host: string, port: number): void; + enablePersistence(settings?: PersistenceSettings): Promise; collection(collectionPath: string): CollectionReference; diff --git a/packages/firestore/exp/test/shim.ts b/packages/firestore/exp/test/shim.ts index 4dcbbd61843..400e84a8e03 100644 --- a/packages/firestore/exp/test/shim.ts +++ b/packages/firestore/exp/test/shim.ts @@ -99,6 +99,10 @@ export class FirebaseFirestore initializeFirestore(this.app._delegate, settings); } + useEmulator(host: string, port: number): void { + this.settings({ host: `${host}:${port}`, ssl: false, merge: true }); + } + enablePersistence(settings?: legacy.PersistenceSettings): Promise { return settings?.synchronizeTabs ? enableMultiTabIndexedDbPersistence(this._delegate) diff --git a/packages/firestore/src/api/database.ts b/packages/firestore/src/api/database.ts index 22d81890db5..bf64f8970e9 100644 --- a/packages/firestore/src/api/database.ts +++ b/packages/firestore/src/api/database.ts @@ -111,7 +111,10 @@ import { valueDescription, validateIsNotUsedTogether } from '../util/input_validation'; -import { logError, setLogLevel as setClientLogLevel } from '../util/log'; +import { + setLogLevel as setClientLogLevel, + logWarn +} from '../util/log'; import { AutoId } from '../util/misc'; import { Deferred } from '../util/promise'; import { FieldPath as ExternalFieldPath } from './field_path'; @@ -503,7 +506,7 @@ export class Firestore implements PublicFirestore, FirebaseService { throw new FirestoreError( Code.FAILED_PRECONDITION, 'Firestore has already been started and its settings can no longer ' + - 'be changed. You can only call settings() before calling any other ' + + 'be changed. You can only modify settings before calling any other ' + 'methods on a Firestore object.' ); } @@ -514,6 +517,24 @@ export class Firestore implements PublicFirestore, FirebaseService { } } + useEmulator(host: string, port: number): void { + validateExactNumberOfArgs('Firestore.useEmulator', arguments, 2); + validateArgType('Firestore.useEmulator', 'string', 1, host); + validateArgType('Firestore.useEmulator', 'number', 2, port); + + if (this._settings.host !== DEFAULT_HOST) { + logWarn( + 'Host has been set in both settings() and useEmulator(), emulator host will be used' + ); + } + + this.settings({ + host: `${host}:${port}`, + ssl: false, + merge: true + }); + } + enableNetwork(): Promise { this.ensureClientConfigured(); return this._firestoreClient!.enableNetwork(); diff --git a/packages/firestore/test/integration/api/validation.test.ts b/packages/firestore/test/integration/api/validation.test.ts index ca5238686d9..223081dad95 100644 --- a/packages/firestore/test/integration/api/validation.test.ts +++ b/packages/firestore/test/integration/api/validation.test.ts @@ -159,7 +159,7 @@ apiDescribe('Validation:', (persistence: boolean) => { 'getFirestore()'; } else { errorMsg += - 'You can only call settings() before calling any other ' + + 'You can only modify settings before calling any other ' + 'methods on a Firestore object.'; } @@ -182,6 +182,24 @@ apiDescribe('Validation:', (persistence: boolean) => { // Verify that this doesn't throw. db.settings({ cacheSizeBytes: /* CACHE_SIZE_UNLIMITED= */ -1 }); }); + + validationIt(persistence, 'useEmulator can set host and port', () => { + const db = newTestFirestore('test-project'); + // Verify that this doesn't throw. + db.useEmulator('localhost', 9000); + }); + + validationIt( + persistence, + 'disallows calling useEmulator after use', + async db => { + const errorMsg = + 'Firestore has already been started and its settings can no longer be changed.'; + + await db.doc('foo/bar').set({}); + expect(() => db.useEmulator('localhost', 9000)).to.throw(errorMsg); + } + ); }); describe('Firestore', () => { diff --git a/packages/firestore/test/unit/api/database.test.ts b/packages/firestore/test/unit/api/database.test.ts index 9d55b1b56cf..725ecb51b22 100644 --- a/packages/firestore/test/unit/api/database.test.ts +++ b/packages/firestore/test/unit/api/database.test.ts @@ -195,4 +195,23 @@ describe('Settings', () => { expect(firestoreClient._getSettings().ignoreUndefinedProperties).to.be.true; expect(firestoreClient._getSettings().host).to.equal('other.host'); }); + + it('gets settings from useEmulator', () => { + // Use a new instance of Firestore in order to configure settings. + const firestoreClient = newTestFirestore(); + firestoreClient.useEmulator('localhost', 9000); + + expect(firestoreClient._getSettings().host).to.equal('localhost:9000'); + expect(firestoreClient._getSettings().ssl).to.be.false; + }); + + it('prefers host from useEmulator to host from settings', () => { + // Use a new instance of Firestore in order to configure settings. + const firestoreClient = newTestFirestore(); + firestoreClient.settings({ host: 'other.host' }); + firestoreClient.useEmulator('localhost', 9000); + + expect(firestoreClient._getSettings().host).to.equal('localhost:9000'); + expect(firestoreClient._getSettings().ssl).to.be.false; + }); }); From 959e21a11c158d6aa776597c5909bb954980f7d8 Mon Sep 17 00:00:00 2001 From: Alex Volkovitsky Date: Fri, 16 Oct 2020 13:48:34 -0700 Subject: [PATCH 013/624] Add tests for initializeAuth (#3957) --- .../auth-exp/src/core/auth/initialize.test.ts | 189 ++++++++++++++++++ 1 file changed, 189 insertions(+) create mode 100644 packages-exp/auth-exp/src/core/auth/initialize.test.ts diff --git a/packages-exp/auth-exp/src/core/auth/initialize.test.ts b/packages-exp/auth-exp/src/core/auth/initialize.test.ts new file mode 100644 index 00000000000..cb258b7305b --- /dev/null +++ b/packages-exp/auth-exp/src/core/auth/initialize.test.ts @@ -0,0 +1,189 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { deleteApp, initializeApp } from '@firebase/app-exp'; +import { FirebaseApp, _FirebaseService } from '@firebase/app-types-exp'; +import * as externs from '@firebase/auth-types-exp'; +import { isNode } from '@firebase/util'; + +import { expect } from 'chai'; +import { inMemoryPersistence } from '../../../internal'; + +import { Auth } from '../../model/auth'; +import { + PopupRedirectResolver, + AuthEventType, + EventManager, + AuthEventConsumer +} from '../../model/popup_redirect'; +import { AuthPopup } from '../../platform_browser/util/popup'; +import { + Persistence, + PersistenceType, + PersistenceValue, + StorageEventListener +} from '../persistence'; +import { ClientPlatform, _getClientVersion } from '../util/version'; +import { initializeAuth } from './initialize'; +import { registerAuth } from './register'; + +describe('src/core/auth/initialize', () => { + let fakeApp: FirebaseApp; + + class FakeSessionPersistence implements Persistence { + static type: 'SESSION' = 'SESSION'; + readonly type = PersistenceType.SESSION; + storage: Record = {}; + + async _isAvailable(): Promise { + return true; + } + async _set(_key: string, _value: PersistenceValue): Promise { + return; + } + async _get(_key: string): Promise { + return null; + } + async _remove(_key: string): Promise { + return; + } + _addListener(_key: string, _listener: StorageEventListener): void { + return; + } + _removeListener(_key: string, _listener: StorageEventListener): void { + return; + } + } + + const fakeSessionPersistence: externs.Persistence = FakeSessionPersistence; + + class FakePopupRedirectResolver implements PopupRedirectResolver { + readonly _redirectPersistence = fakeSessionPersistence; + + async _initialize(_auth: Auth): Promise { + return new (class implements EventManager { + registerConsumer(_authEventConsumer: AuthEventConsumer): void { + return; + } + unregisterConsumer(_authEventConsumer: AuthEventConsumer): void { + return; + } + })(); + } + async _openPopup( + _auth: Auth, + _provider: externs.AuthProvider, + _authType: AuthEventType, + _eventId?: string + ): Promise { + return new AuthPopup(null); + } + _openRedirect( + _auth: Auth, + _provider: externs.AuthProvider, + _authType: AuthEventType, + _eventId?: string + ): Promise { + return new Promise((_, reject) => reject()); + } + _isIframeWebStorageSupported( + _auth: Auth, + cb: (support: boolean) => unknown + ): void { + cb(true); + } + } + + const fakePopupRedirectResolver: externs.PopupRedirectResolver = FakePopupRedirectResolver; + + before(() => { + registerAuth(ClientPlatform.BROWSER); + }); + + beforeEach(() => { + fakeApp = initializeApp({ + apiKey: 'fake-key', + appId: 'fake-app-id', + authDomain: 'fake-auth-domain' + }); + }); + + afterEach(async () => { + await deleteApp(fakeApp); + }); + + describe('initializeAuth', () => { + it('should work with no deps', async () => { + const auth = initializeAuth(fakeApp) as Auth; + await auth._initializationPromise; + + expect(auth.name).to.eq(fakeApp.name); + const expectedSdkClientVersion = _getClientVersion( + isNode() ? ClientPlatform.NODE : ClientPlatform.BROWSER + ); + + expect(auth.config).to.eql({ + apiHost: 'identitytoolkit.googleapis.com', + apiKey: 'fake-key', + apiScheme: 'https', + authDomain: 'fake-auth-domain', + sdkClientVersion: expectedSdkClientVersion, + tokenApiHost: 'securetoken.googleapis.com' + }); + expect(auth._getPersistence()).to.eq('NONE'); + }); + + it('should set persistence', async () => { + const auth = initializeAuth(fakeApp, { + persistence: fakeSessionPersistence + }) as Auth; + await auth._initializationPromise; + + expect(auth._getPersistence()).to.eq('SESSION'); + }); + + it('should set persistence with fallback', async () => { + const auth = initializeAuth(fakeApp, { + persistence: [fakeSessionPersistence, inMemoryPersistence] + }) as Auth; + await auth._initializationPromise; + + expect(auth._getPersistence()).to.eq('SESSION'); + }); + + it('should set resolver', async () => { + const auth = initializeAuth(fakeApp, { + popupRedirectResolver: fakePopupRedirectResolver + }) as Auth; + await auth._initializationPromise; + + expect(auth._popupRedirectResolver).to.be.instanceof( + FakePopupRedirectResolver + ); + }); + + it('should abort initialization if deleted synchronously', async () => { + const auth = initializeAuth(fakeApp, { + popupRedirectResolver: fakePopupRedirectResolver + }) as Auth; + await ((auth as unknown) as _FirebaseService)._delete(); + await auth._initializationPromise; + + expect(auth._isInitialized).to.be.false; + }); + }); +}); From 7d916d905ba16816ac8ac7c8748c83831ff614ce Mon Sep 17 00:00:00 2001 From: Feiyang Date: Mon, 19 Oct 2020 09:25:55 -0700 Subject: [PATCH 014/624] Move template data under a new `customData` field (#3946) * Move template data under a new `customData` field * Create stupid-dots-grab.md * fix tests * fix installations * fix analytics * fix rc * fix auth-exp * fix auth-exp again --- .changeset/stupid-dots-grab.md | 5 +++ packages-exp/auth-exp/src/api/index.test.ts | 12 ++++--- packages-exp/auth-exp/src/api/index.ts | 4 ++- .../src/core/providers/facebook.test.ts | 2 +- .../auth-exp/src/core/providers/facebook.ts | 2 +- .../src/core/providers/github.test.ts | 2 +- .../auth-exp/src/core/providers/github.ts | 2 +- .../src/core/providers/google.test.ts | 2 +- .../auth-exp/src/core/providers/google.ts | 2 +- .../src/core/providers/twitter.test.ts | 2 +- .../auth-exp/src/core/providers/twitter.ts | 2 +- packages-exp/auth-exp/src/mfa/mfa_error.ts | 5 +-- .../src/helpers/get-installation-entry.ts | 2 +- .../src/helpers/refresh-auth-token.ts | 5 ++- .../installations-exp/src/util/errors.ts | 2 +- packages/analytics/src/get-config.ts | 10 +++--- .../src/helpers/get-installation-entry.ts | 2 +- .../src/helpers/refresh-auth-token.ts | 5 ++- packages/installations/src/util/errors.ts | 2 +- .../src/client/retrying_client.ts | 7 ++-- .../test/client/rest_client.test.ts | 14 +++++--- packages/util/src/errors.ts | 36 ++++--------------- packages/util/test/errors.test.ts | 25 +------------ 23 files changed, 66 insertions(+), 86 deletions(-) create mode 100644 .changeset/stupid-dots-grab.md diff --git a/.changeset/stupid-dots-grab.md b/.changeset/stupid-dots-grab.md new file mode 100644 index 00000000000..85608f35687 --- /dev/null +++ b/.changeset/stupid-dots-grab.md @@ -0,0 +1,5 @@ +--- +"@firebase/util": patch +--- + +Write template data to a new `customData` field in` FirebaseError` instead of writing to the error object itself to avoid overwriting existing fields. diff --git a/packages-exp/auth-exp/src/api/index.test.ts b/packages-exp/auth-exp/src/api/index.test.ts index 99caaca6d14..846db20884c 100644 --- a/packages-exp/auth-exp/src/api/index.test.ts +++ b/packages-exp/auth-exp/src/api/index.test.ts @@ -284,7 +284,7 @@ describe('api/_performApiRequest', () => { assert.fail('Call should have failed'); } catch (e) { expect(e.code).to.eq(`auth/${AuthErrorCode.NEED_CONFIRMATION}`); - expect(e._tokenResponse).to.eql({ + expect((e as FirebaseError).customData!._tokenResponse).to.eql({ needConfirmation: true, idToken: 'id-token' }); @@ -314,7 +314,9 @@ describe('api/_performApiRequest', () => { assert.fail('Call should have failed'); } catch (e) { expect(e.code).to.eq(`auth/${AuthErrorCode.CREDENTIAL_ALREADY_IN_USE}`); - expect(e._tokenResponse).to.eql(response); + expect((e as FirebaseError).customData!._tokenResponse).to.eql( + response + ); } }); @@ -343,8 +345,10 @@ describe('api/_performApiRequest', () => { assert.fail('Call should have failed'); } catch (e) { expect(e.code).to.eq(`auth/${AuthErrorCode.EMAIL_EXISTS}`); - expect(e.email).to.eq('email@test.com'); - expect(e.phoneNumber).to.eq('+1555-this-is-a-number'); + expect((e as FirebaseError).customData!.email).to.eq('email@test.com'); + expect((e as FirebaseError).customData!.phoneNumber).to.eq( + '+1555-this-is-a-number' + ); } }); }); diff --git a/packages-exp/auth-exp/src/api/index.ts b/packages-exp/auth-exp/src/api/index.ts index 8b10a4a7ba7..2fee70291bd 100644 --- a/packages-exp/auth-exp/src/api/index.ts +++ b/packages-exp/auth-exp/src/api/index.ts @@ -251,6 +251,8 @@ function makeTaggedError( } const error = AUTH_ERROR_FACTORY.create(code, errorParams); - (error as TaggedWithTokenResponse)._tokenResponse = response; + + // We know customData is defined on error because errorParams is defined + (error.customData! as TaggedWithTokenResponse)._tokenResponse = response; return error; } diff --git a/packages-exp/auth-exp/src/core/providers/facebook.test.ts b/packages-exp/auth-exp/src/core/providers/facebook.test.ts index dab3fedce31..ed2d5dc9f99 100644 --- a/packages-exp/auth-exp/src/core/providers/facebook.test.ts +++ b/packages-exp/auth-exp/src/core/providers/facebook.test.ts @@ -59,7 +59,7 @@ describe('src/core/providers/facebook', () => { const error = AUTH_ERROR_FACTORY.create(AuthErrorCode.NEED_CONFIRMATION, { appName: 'foo' }); - (error as TaggedWithTokenResponse)._tokenResponse = { + (error.customData! as TaggedWithTokenResponse)._tokenResponse = { ...TEST_ID_TOKEN_RESPONSE, oauthAccessToken: 'access-token' }; diff --git a/packages-exp/auth-exp/src/core/providers/facebook.ts b/packages-exp/auth-exp/src/core/providers/facebook.ts index d35e79dfdf7..94717aa0cb0 100644 --- a/packages-exp/auth-exp/src/core/providers/facebook.ts +++ b/packages-exp/auth-exp/src/core/providers/facebook.ts @@ -48,7 +48,7 @@ export class FacebookAuthProvider extends OAuthProvider { error: FirebaseError ): externs.OAuthCredential | null { return FacebookAuthProvider.credentialFromTaggedObject( - error as TaggedWithTokenResponse + (error.customData || {}) as TaggedWithTokenResponse ); } diff --git a/packages-exp/auth-exp/src/core/providers/github.test.ts b/packages-exp/auth-exp/src/core/providers/github.test.ts index ecacbeb299e..1ab22f23567 100644 --- a/packages-exp/auth-exp/src/core/providers/github.test.ts +++ b/packages-exp/auth-exp/src/core/providers/github.test.ts @@ -59,7 +59,7 @@ describe('src/core/providers/github', () => { const error = AUTH_ERROR_FACTORY.create(AuthErrorCode.NEED_CONFIRMATION, { appName: 'foo' }); - (error as TaggedWithTokenResponse)._tokenResponse = { + (error.customData! as TaggedWithTokenResponse)._tokenResponse = { ...TEST_ID_TOKEN_RESPONSE, oauthAccessToken: 'access-token' }; diff --git a/packages-exp/auth-exp/src/core/providers/github.ts b/packages-exp/auth-exp/src/core/providers/github.ts index 4735f02041c..2e50e37dc95 100644 --- a/packages-exp/auth-exp/src/core/providers/github.ts +++ b/packages-exp/auth-exp/src/core/providers/github.ts @@ -48,7 +48,7 @@ export class GithubAuthProvider extends OAuthProvider { error: FirebaseError ): externs.OAuthCredential | null { return GithubAuthProvider.credentialFromTaggedObject( - error as TaggedWithTokenResponse + (error.customData || {}) as TaggedWithTokenResponse ); } diff --git a/packages-exp/auth-exp/src/core/providers/google.test.ts b/packages-exp/auth-exp/src/core/providers/google.test.ts index 5ae62384522..1a5a982f5fa 100644 --- a/packages-exp/auth-exp/src/core/providers/google.test.ts +++ b/packages-exp/auth-exp/src/core/providers/google.test.ts @@ -62,7 +62,7 @@ describe('src/core/providers/google', () => { const error = AUTH_ERROR_FACTORY.create(AuthErrorCode.NEED_CONFIRMATION, { appName: 'foo' }); - (error as TaggedWithTokenResponse)._tokenResponse = { + (error.customData! as TaggedWithTokenResponse)._tokenResponse = { ...TEST_ID_TOKEN_RESPONSE, oauthAccessToken: 'access-token', oauthIdToken: 'id-token' diff --git a/packages-exp/auth-exp/src/core/providers/google.ts b/packages-exp/auth-exp/src/core/providers/google.ts index 27fe7d3abf2..778fd7e847e 100644 --- a/packages-exp/auth-exp/src/core/providers/google.ts +++ b/packages-exp/auth-exp/src/core/providers/google.ts @@ -53,7 +53,7 @@ export class GoogleAuthProvider extends OAuthProvider { error: FirebaseError ): externs.OAuthCredential | null { return GoogleAuthProvider.credentialFromTaggedObject( - error as TaggedWithTokenResponse + (error.customData || {}) as TaggedWithTokenResponse ); } diff --git a/packages-exp/auth-exp/src/core/providers/twitter.test.ts b/packages-exp/auth-exp/src/core/providers/twitter.test.ts index 8d1c42edc04..51ef349f1e7 100644 --- a/packages-exp/auth-exp/src/core/providers/twitter.test.ts +++ b/packages-exp/auth-exp/src/core/providers/twitter.test.ts @@ -79,7 +79,7 @@ describe('src/core/providers/twitter', () => { const error = AUTH_ERROR_FACTORY.create(AuthErrorCode.NEED_CONFIRMATION, { appName: 'foo' }); - (error as TaggedWithTokenResponse)._tokenResponse = { + (error.customData! as TaggedWithTokenResponse)._tokenResponse = { ...TEST_ID_TOKEN_RESPONSE, oauthAccessToken: 'access-token', oauthTokenSecret: 'token-secret' diff --git a/packages-exp/auth-exp/src/core/providers/twitter.ts b/packages-exp/auth-exp/src/core/providers/twitter.ts index 8e9e456b828..305fcf03769 100644 --- a/packages-exp/auth-exp/src/core/providers/twitter.ts +++ b/packages-exp/auth-exp/src/core/providers/twitter.ts @@ -67,7 +67,7 @@ export class TwitterAuthProvider extends OAuthProvider { error: FirebaseError ): externs.OAuthCredential | null { return TwitterAuthProvider.credentialFromTaggedObject( - error as TaggedWithTokenResponse + (error.customData || {}) as TaggedWithTokenResponse ); } diff --git a/packages-exp/auth-exp/src/mfa/mfa_error.ts b/packages-exp/auth-exp/src/mfa/mfa_error.ts index 6fbc5985060..12a3f755ca4 100644 --- a/packages-exp/auth-exp/src/mfa/mfa_error.ts +++ b/packages-exp/auth-exp/src/mfa/mfa_error.ts @@ -46,8 +46,9 @@ export class MultiFactorError Object.setPrototypeOf(this, MultiFactorError.prototype); this.appName = auth.name; this.code = error.code; - this.tenantid = auth.tenantId; - this.serverResponse = error.serverResponse as IdTokenMfaResponse; + this.tenantId = auth.tenantId ?? undefined; + this.serverResponse = error.customData! + .serverResponse as IdTokenMfaResponse; } static _fromErrorAndCredential( diff --git a/packages-exp/installations-exp/src/helpers/get-installation-entry.ts b/packages-exp/installations-exp/src/helpers/get-installation-entry.ts index a0e1cc425ce..6b57563eb80 100644 --- a/packages-exp/installations-exp/src/helpers/get-installation-entry.ts +++ b/packages-exp/installations-exp/src/helpers/get-installation-entry.ts @@ -138,7 +138,7 @@ async function registerInstallation( ); return set(appConfig, registeredInstallationEntry); } catch (e) { - if (isServerError(e) && e.serverCode === 409) { + if (isServerError(e) && e.customData.serverCode === 409) { // Server returned a "FID can not be used" error. // Generate a new ID next time. await remove(appConfig); diff --git a/packages-exp/installations-exp/src/helpers/refresh-auth-token.ts b/packages-exp/installations-exp/src/helpers/refresh-auth-token.ts index 1ad5dc5da50..ac2a0ffc02d 100644 --- a/packages-exp/installations-exp/src/helpers/refresh-auth-token.ts +++ b/packages-exp/installations-exp/src/helpers/refresh-auth-token.ts @@ -150,7 +150,10 @@ async function fetchAuthTokenFromServer( await set(installations.appConfig, updatedInstallationEntry); return authToken; } catch (e) { - if (isServerError(e) && (e.serverCode === 401 || e.serverCode === 404)) { + if ( + isServerError(e) && + (e.customData.serverCode === 401 || e.customData.serverCode === 404) + ) { // Server returned a "FID not found" or a "Invalid authentication" error. // Generate a new ID next time. await remove(installations.appConfig); diff --git a/packages-exp/installations-exp/src/util/errors.ts b/packages-exp/installations-exp/src/util/errors.ts index 6332ff65901..25cc69b1ff0 100644 --- a/packages-exp/installations-exp/src/util/errors.ts +++ b/packages-exp/installations-exp/src/util/errors.ts @@ -61,7 +61,7 @@ export interface ServerErrorData { serverStatus: string; } -export type ServerError = FirebaseError & ServerErrorData; +export type ServerError = FirebaseError & { customData: ServerErrorData }; /** Returns true if error is a FirebaseError that is based on an error from the server. */ export function isServerError(error: unknown): error is ServerError { diff --git a/packages/analytics/src/get-config.ts b/packages/analytics/src/get-config.ts index 9a9024d058b..6be89ce4876 100644 --- a/packages/analytics/src/get-config.ts +++ b/packages/analytics/src/get-config.ts @@ -222,7 +222,7 @@ async function attemptFetchDynamicConfigWithRetry( } const backoffMillis = - Number(e.httpStatus) === 503 + Number(e.customData.httpStatus) === 503 ? calculateBackoffMillis( backoffCount, retryData.intervalMillis, @@ -284,16 +284,18 @@ function setAbortableTimeout( }); } +type RetriableError = FirebaseError & { customData: { httpStatus: string } }; + /** * Returns true if the {@link Error} indicates a fetch request may succeed later. */ -function isRetriableError(e: Error): boolean { - if (!(e instanceof FirebaseError)) { +function isRetriableError(e: Error): e is RetriableError { + if (!(e instanceof FirebaseError) || !e.customData) { return false; } // Uses string index defined by ErrorData, which FirebaseError implements. - const httpStatus = Number(e['httpStatus']); + const httpStatus = Number(e.customData['httpStatus']); return ( httpStatus === 429 || diff --git a/packages/installations/src/helpers/get-installation-entry.ts b/packages/installations/src/helpers/get-installation-entry.ts index 0edcf8e8b94..43cb443c533 100644 --- a/packages/installations/src/helpers/get-installation-entry.ts +++ b/packages/installations/src/helpers/get-installation-entry.ts @@ -138,7 +138,7 @@ async function registerInstallation( ); return set(appConfig, registeredInstallationEntry); } catch (e) { - if (isServerError(e) && e.serverCode === 409) { + if (isServerError(e) && e.customData.serverCode === 409) { // Server returned a "FID can not be used" error. // Generate a new ID next time. await remove(appConfig); diff --git a/packages/installations/src/helpers/refresh-auth-token.ts b/packages/installations/src/helpers/refresh-auth-token.ts index fa980597342..8c763f9820d 100644 --- a/packages/installations/src/helpers/refresh-auth-token.ts +++ b/packages/installations/src/helpers/refresh-auth-token.ts @@ -148,7 +148,10 @@ async function fetchAuthTokenFromServer( await set(dependencies.appConfig, updatedInstallationEntry); return authToken; } catch (e) { - if (isServerError(e) && (e.serverCode === 401 || e.serverCode === 404)) { + if ( + isServerError(e) && + (e.customData.serverCode === 401 || e.customData.serverCode === 404) + ) { // Server returned a "FID not found" or a "Invalid authentication" error. // Generate a new ID next time. await remove(dependencies.appConfig); diff --git a/packages/installations/src/util/errors.ts b/packages/installations/src/util/errors.ts index 6332ff65901..25cc69b1ff0 100644 --- a/packages/installations/src/util/errors.ts +++ b/packages/installations/src/util/errors.ts @@ -61,7 +61,7 @@ export interface ServerErrorData { serverStatus: string; } -export type ServerError = FirebaseError & ServerErrorData; +export type ServerError = FirebaseError & { customData: ServerErrorData }; /** Returns true if error is a FirebaseError that is based on an error from the server. */ export function isServerError(error: unknown): error is ServerError { diff --git a/packages/remote-config/src/client/retrying_client.ts b/packages/remote-config/src/client/retrying_client.ts index 0364d2db1c2..fe1737023df 100644 --- a/packages/remote-config/src/client/retrying_client.ts +++ b/packages/remote-config/src/client/retrying_client.ts @@ -61,16 +61,17 @@ export function setAbortableTimeout( }); } +type RetriableError = FirebaseError & { customData: { httpStatus: string } }; /** * Returns true if the {@link Error} indicates a fetch request may succeed later. */ -function isRetriableError(e: Error): boolean { - if (!(e instanceof FirebaseError)) { +function isRetriableError(e: Error): e is RetriableError { + if (!(e instanceof FirebaseError) || !e.customData) { return false; } // Uses string index defined by ErrorData, which FirebaseError implements. - const httpStatus = Number(e['httpStatus']); + const httpStatus = Number(e.customData['httpStatus']); return ( httpStatus === 429 || diff --git a/packages/remote-config/test/client/rest_client.test.ts b/packages/remote-config/test/client/rest_client.test.ts index 9219e13d503..89b745dacca 100644 --- a/packages/remote-config/test/client/rest_client.test.ts +++ b/packages/remote-config/test/client/rest_client.test.ts @@ -134,7 +134,10 @@ describe('RestClient', () => { await expect(fetchPromise) .to.eventually.be.rejectedWith(FirebaseError, firebaseError.message) - .with.property('originalErrorMessage', 'Network request failed'); + .with.nested.property( + 'customData.originalErrorMessage', + 'Network request failed' + ); }); it('throws on JSON parse failure', async () => { @@ -154,7 +157,10 @@ describe('RestClient', () => { await expect(fetchPromise) .to.eventually.be.rejectedWith(FirebaseError, firebaseError.message) - .with.property('originalErrorMessage', 'Unexpected end of input'); + .with.nested.property( + 'customData.originalErrorMessage', + 'Unexpected end of input' + ); }); it('handles 304 status code and empty body', async () => { @@ -200,7 +206,7 @@ describe('RestClient', () => { await expect(fetchPromise) .to.eventually.be.rejectedWith(FirebaseError, error.message) - .with.property('httpStatus', 500); + .with.nested.property('customData.httpStatus', 500); }); it('normalizes NO_CHANGE state to 304 status', async () => { @@ -257,7 +263,7 @@ describe('RestClient', () => { await expect(fetchPromise) .to.eventually.be.rejectedWith(FirebaseError, error.message) - .with.property('httpStatus', status); + .with.nested.property('customData.httpStatus', status); } }); }); diff --git a/packages/util/src/errors.ts b/packages/util/src/errors.ts index c55b9c87389..97384e78cca 100644 --- a/packages/util/src/errors.ts +++ b/packages/util/src/errors.ts @@ -69,26 +69,16 @@ export interface ErrorData { [key: string]: unknown; } -export interface FirebaseError extends Error, ErrorData { - // Unique code for error - format is service/error-code-string. - readonly code: string; - - // Developer-friendly error message. - readonly message: string; - - // Always 'FirebaseError'. - readonly name: typeof ERROR_NAME; - - // Where available - stack backtrace in a string. - readonly stack?: string; -} - // Based on code from: // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error#Custom_Error_Types export class FirebaseError extends Error { readonly name = ERROR_NAME; - constructor(readonly code: string, message: string) { + constructor( + readonly code: string, + message: string, + public customData?: Record + ) { super(message); // Fix For ES5 @@ -125,21 +115,7 @@ export class ErrorFactory< // Service Name: Error message (service/code). const fullMessage = `${this.serviceName}: ${message} (${fullCode}).`; - const error = new FirebaseError(fullCode, fullMessage); - - // Keys with an underscore at the end of their name are not included in - // error.data for some reason. - // TODO: Replace with Object.entries when lib is updated to es2017. - for (const key of Object.keys(customData)) { - if (key.slice(-1) !== '_') { - if (key in error) { - console.warn( - `Overwriting FirebaseError base field "${key}" can cause unexpected behavior.` - ); - } - error[key] = customData[key]; - } - } + const error = new FirebaseError(fullCode, fullMessage, customData); return error; } diff --git a/packages/util/test/errors.test.ts b/packages/util/test/errors.test.ts index 012b7762fd7..f570e096a5d 100644 --- a/packages/util/test/errors.test.ts +++ b/packages/util/test/errors.test.ts @@ -15,7 +15,6 @@ * limitations under the License. */ import { assert } from 'chai'; -import { stub } from 'sinon'; import { ErrorFactory, ErrorMap, FirebaseError } from '../src/errors'; type ErrorCode = @@ -60,14 +59,7 @@ describe('FirebaseError', () => { e.message, "Fake: Could not find file: 'foo.txt' (fake/file-not-found)." ); - assert.equal(e.file, 'foo.txt'); - }); - - it('anonymously replaces template values with data', () => { - const e = ERROR_FACTORY.create('anon-replace', { repl_: 'world' }); - assert.equal(e.code, 'fake/anon-replace'); - assert.equal(e.message, 'Fake: Hello, world! (fake/anon-replace).'); - assert.isUndefined(e.repl_); + assert.equal(e.customData!.file, 'foo.txt'); }); it('uses "Error" as template when template is missing', () => { @@ -88,21 +80,6 @@ describe('FirebaseError', () => { ); }); - it('warns if overwriting a base error field with custom data', () => { - const warnStub = stub(console, 'warn'); - const e = ERROR_FACTORY.create('overwrite-field', { - code: 'overwritten code' - }); - assert.equal(e.code, 'overwritten code'); - // TODO: use sinon-chai for this. - assert.ok( - warnStub.calledOnceWith( - 'Overwriting FirebaseError base field "code" can cause unexpected behavior.' - ) - ); - warnStub.restore(); - }); - it('has stack', () => { const e = ERROR_FACTORY.create('generic-error'); From 49378bf581ce4218f444b77a9bace57c8b339305 Mon Sep 17 00:00:00 2001 From: Sebastian Schmidt Date: Mon, 19 Oct 2020 10:01:52 -0700 Subject: [PATCH 015/624] Fix unit test build (#3963) --- packages/firestore/test/unit/specs/spec_test_components.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/firestore/test/unit/specs/spec_test_components.ts b/packages/firestore/test/unit/specs/spec_test_components.ts index 1066b98da3d..701945ff5a0 100644 --- a/packages/firestore/test/unit/specs/spec_test_components.ts +++ b/packages/firestore/test/unit/specs/spec_test_components.ts @@ -143,7 +143,7 @@ export class MockMultiTabOfflineComponentProvider extends MultiTabOfflineCompone private readonly document: FakeDocument, onlineComponentProvider: OnlineComponentProvider ) { - super(onlineComponentProvider); + super(onlineComponentProvider, /* cacheSizeBytes= */ undefined); } createGarbageCollectionScheduler( From 2fce62a9545a140541e3a2fd6a7ce12f65f3c0ee Mon Sep 17 00:00:00 2001 From: Nik Gorylenko Date: Mon, 19 Oct 2020 19:59:40 +0200 Subject: [PATCH 016/624] `lerna` field is deprecated since v3 (#3924) Remove deprecated field. Anyway, currenly project uses learna v3.22.1, not 3.10.x --- lerna.json | 1 - 1 file changed, 1 deletion(-) diff --git a/lerna.json b/lerna.json index 09a5ad04362..9192331da41 100644 --- a/lerna.json +++ b/lerna.json @@ -1,5 +1,4 @@ { - "lerna": "3.10.5", "version": "independent", "npmClient": "yarn", "packages": [ From 0204abfd41f9cc56f14d16cb83a6644363d64c9f Mon Sep 17 00:00:00 2001 From: Alex Volkovitsky Date: Mon, 19 Oct 2020 11:48:28 -0700 Subject: [PATCH 017/624] Add extra asserts around action code settings (auth-next) (#3911) * Add extra asserts around action code settings (auth-next) * PR feedback --- .../strategies/action_code_settings.test.ts | 96 +++++++++++++++++++ .../core/strategies/action_code_settings.ts | 37 ++++++- .../auth-exp/src/core/strategies/email.ts | 6 +- .../src/core/strategies/email_and_password.ts | 4 +- .../src/core/strategies/email_link.ts | 4 +- 5 files changed, 138 insertions(+), 9 deletions(-) create mode 100644 packages-exp/auth-exp/src/core/strategies/action_code_settings.test.ts diff --git a/packages-exp/auth-exp/src/core/strategies/action_code_settings.test.ts b/packages-exp/auth-exp/src/core/strategies/action_code_settings.test.ts new file mode 100644 index 00000000000..36784151156 --- /dev/null +++ b/packages-exp/auth-exp/src/core/strategies/action_code_settings.test.ts @@ -0,0 +1,96 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { FirebaseError } from '@firebase/util'; +import { expect } from 'chai'; + +import { testAuth, TestAuth } from '../../../test/helpers/mock_auth'; +import { GetOobCodeRequest } from '../../api/authentication/email_and_password'; +import { _setActionCodeSettingsOnRequest } from './action_code_settings'; + +describe('core/strategies/action_code_settings', () => { + let auth: TestAuth; + const request: GetOobCodeRequest = {}; + + beforeEach(async () => { + auth = await testAuth(); + }); + + it('should require a non empty continue URL', () => { + expect(() => + _setActionCodeSettingsOnRequest(auth, request, { + handleCodeInApp: true, + iOS: { + bundleId: 'my-bundle' + }, + url: '', + dynamicLinkDomain: 'fdl-domain' + }) + ).to.throw(FirebaseError, '(auth/invalid-continue-uri)'); + }); + + it('should allow undefined dynamic link URL', () => { + expect(() => + _setActionCodeSettingsOnRequest(auth, request, { + handleCodeInApp: true, + iOS: { + bundleId: 'my-´bundle' + }, + url: 'my-url' + }) + ).to.not.throw(); + }); + + it('should require a non empty dynamic link URL', () => { + expect(() => + _setActionCodeSettingsOnRequest(auth, request, { + handleCodeInApp: true, + iOS: { + bundleId: 'my-´bundle' + }, + url: 'my-url', + dynamicLinkDomain: '' + }) + ).to.throw(FirebaseError, '(auth/invalid-dynamic-link-domain)'); + }); + + it('should require a non-empty bundle ID', () => { + expect(() => + _setActionCodeSettingsOnRequest(auth, request, { + handleCodeInApp: true, + iOS: { + bundleId: '' + }, + url: 'my-url', + dynamicLinkDomain: 'fdl-domain' + }) + ).to.throw(FirebaseError, '(auth/missing-ios-bundle-id)'); + }); + + it('should require a non-empty package name', () => { + expect(() => + _setActionCodeSettingsOnRequest(auth, request, { + handleCodeInApp: true, + android: { + packageName: '' + }, + url: 'my-url', + dynamicLinkDomain: 'fdl-domain' + }) + ).to.throw(FirebaseError, '(auth/missing-android-pkg-name)'); + }); +}); diff --git a/packages-exp/auth-exp/src/core/strategies/action_code_settings.ts b/packages-exp/auth-exp/src/core/strategies/action_code_settings.ts index b5c120b9fe7..4985099df5d 100644 --- a/packages-exp/auth-exp/src/core/strategies/action_code_settings.ts +++ b/packages-exp/auth-exp/src/core/strategies/action_code_settings.ts @@ -15,23 +15,56 @@ * limitations under the License. */ -import { ActionCodeSettings } from '@firebase/auth-types-exp'; +import { ActionCodeSettings, Auth } from '@firebase/auth-types-exp'; import { GetOobCodeRequest } from '../../api/authentication/email_and_password'; +import { AuthErrorCode } from '../errors'; +import { assert } from '../util/assert'; -export function setActionCodeSettingsOnRequest( +export function _setActionCodeSettingsOnRequest( + auth: Auth, request: GetOobCodeRequest, actionCodeSettings: ActionCodeSettings ): void { + assert( + actionCodeSettings.url.length > 0, + AuthErrorCode.INVALID_CONTINUE_URI, + { + appName: auth.name + } + ); + assert( + typeof actionCodeSettings.dynamicLinkDomain === 'undefined' || + actionCodeSettings.dynamicLinkDomain.length > 0, + AuthErrorCode.INVALID_DYNAMIC_LINK_DOMAIN, + { + appName: auth.name + } + ); + request.continueUrl = actionCodeSettings.url; request.dynamicLinkDomain = actionCodeSettings.dynamicLinkDomain; request.canHandleCodeInApp = actionCodeSettings.handleCodeInApp; if (actionCodeSettings.iOS) { + assert( + actionCodeSettings.iOS.bundleId.length > 0, + AuthErrorCode.MISSING_IOS_BUNDLE_ID, + { + appName: auth.name + } + ); request.iosBundleId = actionCodeSettings.iOS.bundleId; } if (actionCodeSettings.android) { + assert( + actionCodeSettings.android.packageName.length > 0, + AuthErrorCode.MISSING_ANDROID_PACKAGE_NAME, + { + appName: auth.name + } + ); request.androidInstallApp = actionCodeSettings.android.installApp; request.androidMinimumVersionCode = actionCodeSettings.android.minimumVersion; diff --git a/packages-exp/auth-exp/src/core/strategies/email.ts b/packages-exp/auth-exp/src/core/strategies/email.ts index db129a8128f..b8b7afe6cb0 100644 --- a/packages-exp/auth-exp/src/core/strategies/email.ts +++ b/packages-exp/auth-exp/src/core/strategies/email.ts @@ -24,7 +24,7 @@ import { import * as api from '../../api/authentication/email_and_password'; import { User } from '../../model/user'; import { _getCurrentUrl, _isHttpOrHttps } from '../util/location'; -import { setActionCodeSettingsOnRequest } from './action_code_settings'; +import { _setActionCodeSettingsOnRequest } from './action_code_settings'; import { _castAuth } from '../auth/auth_impl'; export async function fetchSignInMethodsForEmail( @@ -56,7 +56,7 @@ export async function sendEmailVerification( idToken }; if (actionCodeSettings) { - setActionCodeSettingsOnRequest(request, actionCodeSettings); + _setActionCodeSettingsOnRequest(user.auth, request, actionCodeSettings); } const { email } = await api.sendEmailVerification(user.auth, request); @@ -79,7 +79,7 @@ export async function verifyBeforeUpdateEmail( newEmail }; if (actionCodeSettings) { - setActionCodeSettingsOnRequest(request, actionCodeSettings); + _setActionCodeSettingsOnRequest(user.auth, request, actionCodeSettings); } const { email } = await api.verifyAndChangeEmail(user.auth, request); diff --git a/packages-exp/auth-exp/src/core/strategies/email_and_password.ts b/packages-exp/auth-exp/src/core/strategies/email_and_password.ts index d0b71cd9e0d..1662add44ac 100644 --- a/packages-exp/auth-exp/src/core/strategies/email_and_password.ts +++ b/packages-exp/auth-exp/src/core/strategies/email_and_password.ts @@ -24,7 +24,7 @@ import { MultiFactorInfo } from '../../mfa/mfa_info'; import { EmailAuthProvider } from '../providers/email'; import { UserCredentialImpl } from '../user/user_credential_impl'; import { assert } from '../util/assert'; -import { setActionCodeSettingsOnRequest } from './action_code_settings'; +import { _setActionCodeSettingsOnRequest } from './action_code_settings'; import { signInWithCredential } from './credential'; import { _castAuth } from '../auth/auth_impl'; import { AuthErrorCode } from '../errors'; @@ -39,7 +39,7 @@ export async function sendPasswordResetEmail( email }; if (actionCodeSettings) { - setActionCodeSettingsOnRequest(request, actionCodeSettings); + _setActionCodeSettingsOnRequest(auth, request, actionCodeSettings); } await authentication.sendPasswordResetEmail(auth, request); diff --git a/packages-exp/auth-exp/src/core/strategies/email_link.ts b/packages-exp/auth-exp/src/core/strategies/email_link.ts index fe5e397bd50..697df0d5882 100644 --- a/packages-exp/auth-exp/src/core/strategies/email_link.ts +++ b/packages-exp/auth-exp/src/core/strategies/email_link.ts @@ -21,7 +21,7 @@ import * as api from '../../api/authentication/email_and_password'; import { ActionCodeURL } from '../action_code_url'; import { EmailAuthProvider } from '../providers/email'; import { _getCurrentUrl } from '../util/location'; -import { setActionCodeSettingsOnRequest } from './action_code_settings'; +import { _setActionCodeSettingsOnRequest } from './action_code_settings'; import { signInWithCredential } from './credential'; import { AuthErrorCode } from '../errors'; import { assert } from '../util/assert'; @@ -36,7 +36,7 @@ export async function sendSignInLinkToEmail( email }; if (actionCodeSettings) { - setActionCodeSettingsOnRequest(request, actionCodeSettings); + _setActionCodeSettingsOnRequest(auth, request, actionCodeSettings); } await api.sendSignInLinkToEmail(auth, request); From b6a9bf0a187f4dceb713264ca4bbcd6a8e68b332 Mon Sep 17 00:00:00 2001 From: Feiyang Date: Mon, 19 Oct 2020 16:42:28 -0700 Subject: [PATCH 018/624] Expand the size analysis cli to support bundle size analysis (#3873) * add entry point to bundle analysis * define bundle definition format and handle input validation * add mode * save progress * implement rollup analysis * implement local mode * implement webpack npm mode * support webpack local mode * rearrange files * move files to folder * create a single temp project for both rollup and webpack analysis * fix lint errors * update yarn.lock * fix lint errors * fix failing tests * debug bundle * fix bugs * update lock file * address comments --- package.json | 2 +- .../auth-exp/src/core/action_code_url.ts | 12 +- .../platform_browser/iframe/gapi.iframes.ts | 6 +- packages/auth/demo/public/sample-config.js | 2 +- packages/auth/demo/public/script.js | 2 +- packages/auth/demo/public/service-worker.js | 2 +- packages/auth/src/autheventmanager.js | 2 +- packages/auth/src/authuser.js | 2 +- packages/auth/src/cordovahandler.js | 2 +- packages/auth/src/defines.js | 2 +- packages/auth/src/exports_auth.js | 2 +- packages/auth/src/iframeclient/ifchandler.js | 2 +- packages/auth/src/rpchandler.js | 2 +- packages/auth/src/storageusermanager.js | 2 +- packages/auth/test/auth_test.js | 2 +- packages/auth/test/autheventmanager_test.js | 2 +- packages/auth/test/authuser_test.js | 2 +- packages/auth/test/cordovahandler_test.js | 2 +- .../auth/test/iframeclient/ifchandler_test.js | 2 +- packages/auth/test/rpchandler_test.js | 2 +- packages/auth/test/storageusermanager_test.js | 2 +- packages/util/index.node.ts | 1 + packages/util/index.ts | 1 + packages/util/src/formatters.ts | 45 ++ repo-scripts/size-analysis/bundle-analysis.ts | 433 ++++++++++++++++++ .../bundle-definition-1.json | 23 + repo-scripts/size-analysis/bundle/minify.ts | 30 ++ repo-scripts/size-analysis/bundle/rollup.ts | 59 +++ repo-scripts/size-analysis/bundle/webpack.ts | 85 ++++ repo-scripts/size-analysis/cli.ts | 93 ++++ .../{analysis.ts => package-analysis.ts} | 44 +- repo-scripts/size-analysis/package.json | 9 +- .../size-analysis/test/size-analysis.test.ts | 2 +- .../size-analysis/test/test-inputs/far.ts | 2 +- .../size-analysis/test/test-inputs/index.ts | 2 +- repo-scripts/size-analysis/tsconfig.json | 3 +- repo-scripts/size-analysis/util.ts | 34 ++ yarn.lock | 77 +++- 38 files changed, 931 insertions(+), 68 deletions(-) create mode 100644 packages/util/src/formatters.ts create mode 100644 repo-scripts/size-analysis/bundle-analysis.ts create mode 100644 repo-scripts/size-analysis/bundle-definition-examples/bundle-definition-1.json create mode 100644 repo-scripts/size-analysis/bundle/minify.ts create mode 100644 repo-scripts/size-analysis/bundle/rollup.ts create mode 100644 repo-scripts/size-analysis/bundle/webpack.ts create mode 100644 repo-scripts/size-analysis/cli.ts rename repo-scripts/size-analysis/{analysis.ts => package-analysis.ts} (80%) create mode 100644 repo-scripts/size-analysis/util.ts diff --git a/package.json b/package.json index 41af396fd89..04a3cd7223c 100644 --- a/package.json +++ b/package.json @@ -52,7 +52,7 @@ "api-report": "lerna run --scope @firebase/*-exp api-report", "docgen:exp": "ts-node-script scripts/exp/docgen.ts", "postinstall": "yarn --cwd repo-scripts/changelog-generator build", - "sa": "ts-node-script repo-scripts/size-analysis/analysis.ts" + "sa": "ts-node-script repo-scripts/size-analysis/cli.ts" }, "repository": { "type": "git", diff --git a/packages-exp/auth-exp/src/core/action_code_url.ts b/packages-exp/auth-exp/src/core/action_code_url.ts index 38fb4c977eb..1703dc35524 100644 --- a/packages-exp/auth-exp/src/core/action_code_url.ts +++ b/packages-exp/auth-exp/src/core/action_code_url.ts @@ -76,9 +76,9 @@ function parseDeepLink(url: string): string { return iOSDoubleDeepLink || iOSDeepLink || doubleDeepLink || link || url; } -/** - * {@inheritDoc @firebase/auth-types-exp#ActionCodeURL} - * +/** + * {@inheritDoc @firebase/auth-types-exp#ActionCodeURL} + * * @public */ export class ActionCodeURL implements externs.ActionCodeURL { @@ -129,9 +129,9 @@ export class ActionCodeURL implements externs.ActionCodeURL { } } -/** - * {@inheritDoc @firebase/auth-types-exp#ActionCodeURL.parseLink} - * +/** + * {@inheritDoc @firebase/auth-types-exp#ActionCodeURL.parseLink} + * * @public */ export function parseActionCodeURL(link: string): externs.ActionCodeURL | null { diff --git a/packages-exp/auth-exp/src/platform_browser/iframe/gapi.iframes.ts b/packages-exp/auth-exp/src/platform_browser/iframe/gapi.iframes.ts index 45027432be8..c312e7a6596 100644 --- a/packages-exp/auth-exp/src/platform_browser/iframe/gapi.iframes.ts +++ b/packages-exp/auth-exp/src/platform_browser/iframe/gapi.iframes.ts @@ -15,9 +15,9 @@ * limitations under the License. */ - // For some reason, the linter doesn't recognize that these are used elsewhere - // in the SDK - /* eslint-disable @typescript-eslint/no-unused-vars */ +// For some reason, the linter doesn't recognize that these are used elsewhere +// in the SDK +/* eslint-disable @typescript-eslint/no-unused-vars */ declare namespace gapi { type LoadCallback = () => void; diff --git a/packages/auth/demo/public/sample-config.js b/packages/auth/demo/public/sample-config.js index 3b21d36701a..24269faf4dc 100644 --- a/packages/auth/demo/public/sample-config.js +++ b/packages/auth/demo/public/sample-config.js @@ -1,6 +1,6 @@ /* * @license - * Copyright 2017 Google Inc. All Rights Reserved. + * Copyright 2017 Google LLC All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except * in compliance with the License. You may obtain a copy of the License at diff --git a/packages/auth/demo/public/script.js b/packages/auth/demo/public/script.js index be8d424d63d..99ba50cd730 100644 --- a/packages/auth/demo/public/script.js +++ b/packages/auth/demo/public/script.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2017 Google Inc. + * Copyright 2017 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/packages/auth/demo/public/service-worker.js b/packages/auth/demo/public/service-worker.js index 34848b0ccd8..3518e50888c 100644 --- a/packages/auth/demo/public/service-worker.js +++ b/packages/auth/demo/public/service-worker.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2017 Google Inc. + * Copyright 2017 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/packages/auth/src/autheventmanager.js b/packages/auth/src/autheventmanager.js index a6bb62df6af..b2fb107c60d 100644 --- a/packages/auth/src/autheventmanager.js +++ b/packages/auth/src/autheventmanager.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2017 Google Inc. + * Copyright 2017 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/packages/auth/src/authuser.js b/packages/auth/src/authuser.js index 96ff1fd3379..37638bd763d 100644 --- a/packages/auth/src/authuser.js +++ b/packages/auth/src/authuser.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2017 Google Inc. + * Copyright 2017 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/packages/auth/src/cordovahandler.js b/packages/auth/src/cordovahandler.js index 6646d2da821..20e09ba75fa 100644 --- a/packages/auth/src/cordovahandler.js +++ b/packages/auth/src/cordovahandler.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2017 Google Inc. + * Copyright 2017 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/packages/auth/src/defines.js b/packages/auth/src/defines.js index d7bc309fc56..be41f997312 100644 --- a/packages/auth/src/defines.js +++ b/packages/auth/src/defines.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2017 Google Inc. + * Copyright 2017 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/packages/auth/src/exports_auth.js b/packages/auth/src/exports_auth.js index 9b52bbe96a7..047dd5ba8c8 100644 --- a/packages/auth/src/exports_auth.js +++ b/packages/auth/src/exports_auth.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2017 Google Inc. + * Copyright 2017 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/packages/auth/src/iframeclient/ifchandler.js b/packages/auth/src/iframeclient/ifchandler.js index 9bf7a29a4e5..98459ea844f 100644 --- a/packages/auth/src/iframeclient/ifchandler.js +++ b/packages/auth/src/iframeclient/ifchandler.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2017 Google Inc. + * Copyright 2017 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/packages/auth/src/rpchandler.js b/packages/auth/src/rpchandler.js index df1e287f9ce..363648349a0 100644 --- a/packages/auth/src/rpchandler.js +++ b/packages/auth/src/rpchandler.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2017 Google Inc. + * Copyright 2017 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/packages/auth/src/storageusermanager.js b/packages/auth/src/storageusermanager.js index c3d3b28d1eb..a3bd0559a6b 100644 --- a/packages/auth/src/storageusermanager.js +++ b/packages/auth/src/storageusermanager.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2017 Google Inc. + * Copyright 2017 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/packages/auth/test/auth_test.js b/packages/auth/test/auth_test.js index 71a924733a0..74998a69d65 100644 --- a/packages/auth/test/auth_test.js +++ b/packages/auth/test/auth_test.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2017 Google Inc. + * Copyright 2017 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/packages/auth/test/autheventmanager_test.js b/packages/auth/test/autheventmanager_test.js index 3613aa3a2cd..a1ed5270d5e 100644 --- a/packages/auth/test/autheventmanager_test.js +++ b/packages/auth/test/autheventmanager_test.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2017 Google Inc. + * Copyright 2017 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/packages/auth/test/authuser_test.js b/packages/auth/test/authuser_test.js index 33c4dbc0064..a47a0234d05 100644 --- a/packages/auth/test/authuser_test.js +++ b/packages/auth/test/authuser_test.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2017 Google Inc. + * Copyright 2017 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/packages/auth/test/cordovahandler_test.js b/packages/auth/test/cordovahandler_test.js index e002d434c4c..67d98f5888d 100644 --- a/packages/auth/test/cordovahandler_test.js +++ b/packages/auth/test/cordovahandler_test.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2017 Google Inc. + * Copyright 2017 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/packages/auth/test/iframeclient/ifchandler_test.js b/packages/auth/test/iframeclient/ifchandler_test.js index 55ff6c49dfa..0822fa70387 100644 --- a/packages/auth/test/iframeclient/ifchandler_test.js +++ b/packages/auth/test/iframeclient/ifchandler_test.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2017 Google Inc. + * Copyright 2017 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/packages/auth/test/rpchandler_test.js b/packages/auth/test/rpchandler_test.js index 916ded8a37f..e48f2f27eb1 100644 --- a/packages/auth/test/rpchandler_test.js +++ b/packages/auth/test/rpchandler_test.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2017 Google Inc. + * Copyright 2017 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/packages/auth/test/storageusermanager_test.js b/packages/auth/test/storageusermanager_test.js index 991755b8d83..f0601cd2437 100644 --- a/packages/auth/test/storageusermanager_test.js +++ b/packages/auth/test/storageusermanager_test.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2017 Google Inc. + * Copyright 2017 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/packages/util/index.node.ts b/packages/util/index.node.ts index 27a66023d75..2c4916b9ed8 100644 --- a/packages/util/index.node.ts +++ b/packages/util/index.node.ts @@ -36,3 +36,4 @@ export * from './src/subscribe'; export * from './src/validation'; export * from './src/utf8'; export * from './src/exponential_backoff'; +export * from './src/formatters'; diff --git a/packages/util/index.ts b/packages/util/index.ts index 0ca3fed2725..e0001274f51 100644 --- a/packages/util/index.ts +++ b/packages/util/index.ts @@ -31,3 +31,4 @@ export * from './src/subscribe'; export * from './src/validation'; export * from './src/utf8'; export * from './src/exponential_backoff'; +export * from './src/formatters'; diff --git a/packages/util/src/formatters.ts b/packages/util/src/formatters.ts new file mode 100644 index 00000000000..748ad58fe4c --- /dev/null +++ b/packages/util/src/formatters.ts @@ -0,0 +1,45 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Provide English ordinal letters after a number + */ +export function ordinal(i: number): string { + if (!Number.isFinite(i)) { + return `${i}`; + } + return i + indicator(i); +} + +function indicator(i: number): string { + i = Math.abs(i); + const cent = i % 100; + if (cent >= 10 && cent <= 20) { + return 'th'; + } + const dec = i % 10; + if (dec === 1) { + return 'st'; + } + if (dec === 2) { + return 'nd'; + } + if (dec === 3) { + return 'rd'; + } + return 'th'; +} diff --git a/repo-scripts/size-analysis/bundle-analysis.ts b/repo-scripts/size-analysis/bundle-analysis.ts new file mode 100644 index 00000000000..e54ef8aa45c --- /dev/null +++ b/repo-scripts/size-analysis/bundle-analysis.ts @@ -0,0 +1,433 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +import * as tmp from 'tmp'; +import { + existsSync, + lstatSync, + readFileSync, + writeFile, + writeFileSync +} from 'fs'; +import { spawn } from 'child-process-promise'; +import { ordinal } from '@firebase/util'; +import { bundleWithRollup } from './bundle/rollup'; +import { bundleWithWebpack } from './bundle/webpack'; +import { calculateContentSize } from './util'; +import { minify } from './bundle/minify'; +import { extractDeclarations, MemberList } from './analysis-helper'; + +interface BundleAnalysisArgs { + input: string; + bundler: 'webpack' | 'rollup' | 'both'; + mode: 'npm' | 'local'; + output: string; + debug: boolean; +} + +interface BundleAnalysisOptions { + bundleDefinitions: BundleDefinition[]; + bundler: Bundler; + mode: Mode; + output: string; + debug: boolean; +} + +interface DebugOptions { + output: string; // output folder for debug files +} + +interface BundleDefinition { + name: string; + dependencies: BundleDependency[]; +} + +interface BundleDependency { + packageName: string; + /** + * npm version or tag + */ + versionOrTag: string; + imports: string | SubModuleImport[]; +} + +interface SubModuleImport { + path: string; + imports: string[]; +} + +enum Bundler { + Rollup = 'rollup', + Webpack = 'webpack', + Both = 'both' +} + +enum Mode { + Npm = 'npm', + Local = 'local' +} + +export async function run({ + input, + bundler, + mode, + output, + debug +}: BundleAnalysisArgs): Promise { + const options = { + bundleDefinitions: loadBundleDefinitions(input), + bundler: toBundlerEnum(bundler), + mode: toModeEnum(mode), + output, + debug + }; + + return analyze(options); +} + +function loadBundleDefinitions(path: string): BundleDefinition[] { + if (!existsSync(path)) { + throw new Error( + `${path} doesn't exist. Please provide a valid path to the bundle defintion file.` + ); + } + + if (lstatSync(path).isDirectory()) { + throw new Error( + `Expecting a file, but ${path} is a directory. Please provide a valid path to the bundle definition file.` + ); + } + + const def = parseBundleDefinition(readFileSync(path, { encoding: 'utf-8' })); + + return def; +} + +function toBundlerEnum(bundler: 'webpack' | 'rollup' | 'both'): Bundler { + switch (bundler) { + case 'rollup': + return Bundler.Rollup; + case 'webpack': + return Bundler.Webpack; + case 'both': + return Bundler.Both; + default: + throw new Error('impossible!'); + } +} + +function toModeEnum(mode: 'npm' | 'local'): Mode { + switch (mode) { + case 'npm': + return Mode.Npm; + case 'local': + return Mode.Local; + default: + throw new Error('impossible'); + } +} + +/** + * + * @param input + * @returns - an array of error messages. Empty if the bundle definition is valid + */ +function parseBundleDefinition(input: string): BundleDefinition[] { + const bundleDefinitions: BundleDefinition[] = JSON.parse(input); + + const errorMessages = []; + if (!Array.isArray(bundleDefinitions)) { + throw new Error('Bundle definition must be defined in an array'); + } + + for (let i = 0; i < bundleDefinitions.length; i++) { + const bundleDefinition = bundleDefinitions[i]; + if (!bundleDefinition.name) { + errorMessages.push( + `Missing field 'name' in the ${ordinal(i + 1)} bundle definition` + ); + } + + if (!bundleDefinition.dependencies) { + errorMessages.push( + `Missing field 'dependencies' in the ${ordinal( + i + 1 + )} bundle definition` + ); + } + + if (!Array.isArray(bundleDefinition.dependencies)) { + errorMessages.push( + `Expecting an array for field 'dependencies', but it is not an array in the ${ordinal( + i + 1 + )} bundle definition` + ); + } + + for (let j = 0; j < bundleDefinition.dependencies.length; j++) { + const dependency = bundleDefinition.dependencies[j]; + + if (!dependency.packageName) { + errorMessages.push( + `Missing field 'packageName' in the ${ordinal( + j + 1 + )} dependency of the ${ordinal(i + 1)} bundle definition` + ); + } + + if (!dependency.imports) { + errorMessages.push( + `Missing field 'imports' in the ${ordinal( + j + 1 + )} dependency of the ${ordinal(i + 1)} bundle definition` + ); + } + + if (!Array.isArray(dependency.imports)) { + errorMessages.push( + `Expecting an array for field 'imports', but it is not an array in the ${ordinal( + j + 1 + )} dependency of the ${ordinal(i + 1)} bundle definition` + ); + } + + if (!dependency.versionOrTag) { + dependency.versionOrTag = 'latest'; + } + } + } + + if (errorMessages.length > 0) { + throw new Error(errorMessages.join('\n')); + } + + return bundleDefinitions; +} + +async function analyze({ + bundleDefinitions, + bundler, + output, + mode, + debug +}: BundleAnalysisOptions): Promise { + const analyses: BundleAnalysis[] = []; + + let debugOptions: DebugOptions | undefined; + if (debug) { + const tmpDir = tmp.dirSync(); + debugOptions = { + output: tmpDir.name + }; + } + + for (const bundleDefinition of bundleDefinitions) { + analyses.push( + await analyzeBundle(bundleDefinition, bundler, mode, debugOptions) + ); + } + + writeFileSync(output, JSON.stringify(analyses, null, 2), { + encoding: 'utf-8' + }); +} + +async function analyzeBundle( + bundleDefinition: BundleDefinition, + bundler: Bundler, + mode: Mode, + debugOptions?: DebugOptions +): Promise { + const analysis: BundleAnalysis = { + name: bundleDefinition.name, + results: [] + }; + + let moduleDirectory: string | undefined; + let tmpDir: tmp.DirResult | undefined; + if (mode === Mode.Npm) { + tmpDir = await setupTempProject(bundleDefinition); + moduleDirectory = `${tmpDir.name}/node_modules`; + } + + const entryFileContent = createEntryFileContent(bundleDefinition); + + switch (bundler) { + case Bundler.Rollup: + case Bundler.Webpack: + analysis.results.push( + await analyzeBundleWithBundler( + bundleDefinition.name, + entryFileContent, + bundler, + moduleDirectory, + debugOptions + ) + ); + break; + case Bundler.Both: + analysis.results.push( + await analyzeBundleWithBundler( + bundleDefinition.name, + entryFileContent, + Bundler.Rollup, + moduleDirectory, + debugOptions + ) + ); + analysis.results.push( + await analyzeBundleWithBundler( + bundleDefinition.name, + entryFileContent, + Bundler.Webpack, + moduleDirectory, + debugOptions + ) + ); + break; + default: + throw new Error('impossible!'); + } + + if (tmpDir) { + tmpDir.removeCallback(); + } + + return analysis; +} + +/** + * Create a temp project and install dependencies the bundleDefinition defines + * @returns - the path to the temp project + */ +async function setupTempProject( + bundleDefinition: BundleDefinition +): Promise { + /// set up a temporary project to install dependencies + const tmpDir = tmp.dirSync({ unsafeCleanup: true }); + console.log(tmpDir.name); + // create package.json + const pkgJson: { + name: string; + version: string; + dependencies: Record; + } = { + name: 'size-analysis', + version: '0.0.0', + dependencies: {} + }; + + for (const dep of bundleDefinition.dependencies) { + pkgJson.dependencies[dep.packageName] = dep.versionOrTag; + } + + writeFileSync( + `${tmpDir.name}/package.json`, + `${JSON.stringify(pkgJson, null, 2)}\n`, + { encoding: 'utf-8' } + ); + + // install dependencies + await spawn('npm', ['install'], { + cwd: tmpDir.name, + stdio: 'inherit' + }); + + return tmpDir; +} + +async function analyzeBundleWithBundler( + bundleName: string, + entryFileContent: string, + bundler: Exclude, + moduleDirectory?: string, + debugOptions?: DebugOptions +): Promise { + let bundledContent = ''; + + // bundle using bundlers + if (bundler === Bundler.Rollup) { + bundledContent = await bundleWithRollup(entryFileContent, moduleDirectory); + } else { + bundledContent = await bundleWithWebpack(entryFileContent, moduleDirectory); + } + + const minifiedBundle = await minify(bundledContent); + const { size, gzipSize } = calculateContentSize(minifiedBundle); + + const analysisResult: BundleAnalysisResult = { + bundler, + size, + gzipSize + }; + + if (debugOptions) { + const bundleFilePath = `${debugOptions.output}/${bundleName.replace( + / +/g, + '-' + )}.${bundler}.js`; + const minifiedBundleFilePath = `${debugOptions.output}/${bundleName.replace( + / +/g, + '-' + )}.${bundler}.minified.js`; + writeFileSync(bundleFilePath, bundledContent, { encoding: 'utf8' }); + writeFileSync(minifiedBundleFilePath, minifiedBundle, { encoding: 'utf8' }); + + analysisResult.debugInfo = { + pathToBundle: bundleFilePath, + pathToMinifiedBundle: minifiedBundleFilePath, + dependencies: extractDeclarations(bundleFilePath) + }; + } + + return analysisResult; +} + +function createEntryFileContent(bundleDefinition: BundleDefinition): string { + const contentArray = []; + for (const dep of bundleDefinition.dependencies) { + for (const imp of dep.imports) { + if (typeof imp === 'string') { + contentArray.push(`export {${imp}} from '${dep.packageName}';`); + } else { + // Import object + for (const subImp of imp.imports) { + contentArray.push( + `export {${subImp}} from '${dep.packageName}/${imp.path}';` + ); + } + } + } + } + + return contentArray.join('\n'); +} + +interface BundleAnalysis { + name: string; // the bundle name defined in the bundle definition + results: BundleAnalysisResult[]; +} + +interface BundleAnalysisResult { + bundler: 'rollup' | 'webpack'; + size: number; + gzipSize: number; + debugInfo?: { + pathToBundle?: string; + pathToMinifiedBundle?: string; + dependencies?: MemberList; + }; +} diff --git a/repo-scripts/size-analysis/bundle-definition-examples/bundle-definition-1.json b/repo-scripts/size-analysis/bundle-definition-examples/bundle-definition-1.json new file mode 100644 index 00000000000..50fadadc232 --- /dev/null +++ b/repo-scripts/size-analysis/bundle-definition-examples/bundle-definition-1.json @@ -0,0 +1,23 @@ +[ + { + "name": "test", + "dependencies": [ + { + "packageName": "@firebase/app", + "versionOrTag": "exp", + "imports": [ + "initializeApp" + ] + }, + { + "packageName": "@firebase/firestore", + "versionOrTag": "exp", + "imports": [ + "getFirestore", + "doc", + "getDoc" + ] + } + ] + } +] \ No newline at end of file diff --git a/repo-scripts/size-analysis/bundle/minify.ts b/repo-scripts/size-analysis/bundle/minify.ts new file mode 100644 index 00000000000..60597001a5e --- /dev/null +++ b/repo-scripts/size-analysis/bundle/minify.ts @@ -0,0 +1,30 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import * as terser from 'terser'; + +export async function minify(content: string): Promise { + const minified = await terser.minify(content, { + format: { + comments: false + }, + mangle: { toplevel: true }, + compress: false + }); + + return minified.code ?? ''; +} diff --git a/repo-scripts/size-analysis/bundle/rollup.ts b/repo-scripts/size-analysis/bundle/rollup.ts new file mode 100644 index 00000000000..d95aef97066 --- /dev/null +++ b/repo-scripts/size-analysis/bundle/rollup.ts @@ -0,0 +1,59 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import * as rollup from 'rollup'; +import resolve, { Options } from 'rollup-plugin-node-resolve'; +import commonjs from 'rollup-plugin-commonjs'; +// @ts-ignore +import virtual from '@rollup/plugin-virtual'; + +/** + * + * @param fileContent + * @param moduleDirectory - the path to the node_modules folder of the temporary project in npm mode. + * undefined in local mode + */ +export async function bundleWithRollup( + fileContent: string, + moduleDirectory?: string +): Promise { + const resolveOptions: Options = { + mainFields: ['esm2017', 'module', 'main'] + }; + + if (moduleDirectory) { + resolveOptions.customResolveOptions = { + moduleDirectory + }; + } + + const bundle = await rollup.rollup({ + input: 'entry', + plugins: [ + virtual({ + entry: fileContent + }), + resolve(resolveOptions), + commonjs() + ] + }); + + const { output } = await bundle.generate({ + format: 'es' + }); + return output[0].code; +} diff --git a/repo-scripts/size-analysis/bundle/webpack.ts b/repo-scripts/size-analysis/bundle/webpack.ts new file mode 100644 index 00000000000..306a797d604 --- /dev/null +++ b/repo-scripts/size-analysis/bundle/webpack.ts @@ -0,0 +1,85 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import webpack from 'webpack'; +// @ts-ignore +import virtualModulesPlugin from 'webpack-virtual-modules'; +import { createFsFromVolume, Volume } from 'memfs'; +import path from 'path'; +import { projectRoot } from '../util'; + +/** + * + * @param fileContent + * @param moduleDirectory - the path to the node_modules folder of the temporary project in npm mode. + * undefined in local mode + */ +export async function bundleWithWebpack( + fileContent: string, + moduleDirectory?: string +): Promise { + const entryFileName = '/virtual_path_to_in_memory_file/index.js'; + const outputFileName = 'o.js'; + + const resolveConfig: webpack.Resolve = { + mainFields: ['esm2017', 'module', 'main'] + }; + + if (moduleDirectory) { + resolveConfig.modules = [moduleDirectory]; + } else { + // local mode + resolveConfig.modules = [`${projectRoot}/node_modules`]; + } + + const compiler = webpack({ + entry: entryFileName, + output: { + filename: outputFileName + }, + resolve: resolveConfig, + plugins: [ + new virtualModulesPlugin({ + [entryFileName]: fileContent + }) + ], + mode: 'production' + }); + + // use virtual file system for output to avoid I/O + compiler.outputFileSystem = getMemoryFileSystem(); + + return new Promise((res, rej) => { + compiler.run((err, stats) => { + if (err) { + rej(err); + return; + } + + // Hack to get string output without reading the output file using an internal API from webpack + res(stats.compilation.assets[outputFileName]._value); + }); + }); +} + +function getMemoryFileSystem(): webpack.OutputFileSystem { + const fs = createFsFromVolume(new Volume()); + // eslint-disable-next-line @typescript-eslint/no-explicit-any + (fs as any).join = path.join.bind(path); + + return (fs as unknown) as webpack.OutputFileSystem; +} diff --git a/repo-scripts/size-analysis/cli.ts b/repo-scripts/size-analysis/cli.ts new file mode 100644 index 00000000000..87987315f45 --- /dev/null +++ b/repo-scripts/size-analysis/cli.ts @@ -0,0 +1,93 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import * as yargs from 'yargs'; +import { run as runBundleAnalysis } from './bundle-analysis'; +import { analyzePackageSize } from './package-analysis'; + +// eslint-disable-next-line no-unused-expressions +yargs + .command( + '$0', + 'Analyze the size of individual exports from packages', + { + inputModule: { + type: 'array', + alias: 'im', + desc: + 'The name of the module(s) to be analyzed. example: --inputModule "@firebase/functions-exp" "firebase/auth-exp"' + }, + inputDtsFile: { + type: 'string', + alias: 'if', + desc: 'support for adhoc analysis. requires a path to a d.ts file' + }, + inputBundleFile: { + type: 'string', + alias: 'ib', + desc: 'support for adhoc analysis. requires a path to a bundle file' + }, + output: { + type: 'string', + alias: 'o', + required: true, + desc: + 'The location where report(s) will be generated, a directory path if module(s) are analyzed; a file path if ad hoc analysis is to be performed' + } + }, + // eslint-disable-next-line @typescript-eslint/no-explicit-any + args => analyzePackageSize(args as any).catch(e => console.log(e)) + ) + .command( + 'bundle', + 'Analyze bundle size', + { + input: { + type: 'string', + alias: 'i', + required: true, + desc: 'Path to the JSON file that describes the bundles to be analyzed' + }, + mode: { + choices: ['npm', 'local'], + alias: 'm', + default: 'npm', + desc: 'Use Firebase packages from npm or the local repo' + }, + bundler: { + choices: ['rollup', 'webpack', 'both'], + alias: 'b', + default: 'rollup', + desc: 'The bundler(s) to be used' + }, + output: { + type: 'string', + alias: 'o', + default: './size-analysis-bundles.json', + desc: 'The output location' + }, + debug: { + type: 'boolean', + alias: 'd', + default: false, + desc: 'debug mode' + } + }, + // eslint-disable-next-line @typescript-eslint/no-explicit-any + argv => runBundleAnalysis(argv as any) + ) + .help().argv; diff --git a/repo-scripts/size-analysis/analysis.ts b/repo-scripts/size-analysis/package-analysis.ts similarity index 80% rename from repo-scripts/size-analysis/analysis.ts rename to repo-scripts/size-analysis/package-analysis.ts index 8ef8d4b0376..a2e67b58105 100644 --- a/repo-scripts/size-analysis/analysis.ts +++ b/repo-scripts/size-analysis/package-analysis.ts @@ -26,7 +26,6 @@ import { } from './analysis-helper'; import { mapWorkspaceToPackages } from '../../scripts/release/utils/workspace'; import { projectRoot } from '../../scripts/utils'; -import * as yargs from 'yargs'; import * as fs from 'fs'; /** @@ -44,41 +43,21 @@ import * as fs from 'fs'; * specify a file path if ad hoc analysis is to be performed * */ -const argv = yargs - .options({ - inputModule: { - type: 'array', - alias: 'im', - desc: - 'The name of the module(s) to be analyzed. example: --inputModule "@firebase/functions-exp" "firebase/auth-exp"' - }, - inputDtsFile: { - type: 'string', - alias: 'if', - desc: 'support for adhoc analysis. requires a path to dts file' - }, - inputBundleFile: { - type: 'string', - alias: 'ib', - desc: 'support for adhoc analysis. requires a path to a bundle file' - }, - output: { - type: 'string', - alias: 'o', - required: true, - desc: - 'The location where report(s) will be generated, a directory path if module(s) are analyzed; a file path if ad hoc analysis is to be performed' - } - }) - .help().argv; - +interface PackageAnalysisOptions { + inputModule: string[]; + inputDtsFile: string; + inputBundleFile: string; + output: string; +} /** * Entry Point of the Tool. * The function first checks if it's an adhoc run (by checking whether --inputDtsFile and --inputBundle are both enabled) * The function then checks whether --inputModule flag is specified; Run analysis on all modules if not, run analysis on selected modules if enabled. * Throw INVALID_FLAG_COMBINATION error if neither case fulfill. */ -async function main(): Promise { +export async function analyzePackageSize( + argv: PackageAnalysisOptions +): Promise { // check if it's an adhoc run // adhoc run report can only be redirected to files if (argv.inputDtsFile && argv.inputBundleFile && argv.output) { @@ -90,6 +69,7 @@ async function main(): Promise { writeReportToFile(jsonReport, resolve(argv.output)); } else if (!argv.inputDtsFile && !argv.inputBundleFile) { // retrieve All Module Names + // TODO: update the workspace once exp packages are officially released let allModulesLocation = await mapWorkspaceToPackages([ `${projectRoot}/packages-exp/*` ]); @@ -132,7 +112,3 @@ async function main(): Promise { throw new Error(ErrorCode.INVALID_FLAG_COMBINATION); } } - -main().catch(error => { - console.log(error); -}); diff --git a/repo-scripts/size-analysis/package.json b/repo-scripts/size-analysis/package.json index e52f0028497..74453c02ce5 100644 --- a/repo-scripts/size-analysis/package.json +++ b/repo-scripts/size-analysis/package.json @@ -22,11 +22,18 @@ "@rollup/plugin-node-resolve": "9.0.0", "rollup-plugin-replace": "2.2.0", "rollup-plugin-typescript2": "0.27.3", + "@rollup/plugin-virtual": "2.0.3", + "webpack": "4.44.2", + "@types/webpack": "4.41.22", + "webpack-virtual-modules": "0.3.1", + "child-process-promise": "2.2.1", + "memfs": "3.2.0", "tmp": "0.2.1", "typescript": "4.0.2", "terser": "5.3.5", "yargs": "16.0.3", - "@firebase/util": "0.3.2" + "@firebase/util": "0.3.2", + "gzip-size": "5.1.1" }, "license": "Apache-2.0", "devDependencies": { diff --git a/repo-scripts/size-analysis/test/size-analysis.test.ts b/repo-scripts/size-analysis/test/size-analysis.test.ts index 55326752cbf..574296010fb 100644 --- a/repo-scripts/size-analysis/test/size-analysis.test.ts +++ b/repo-scripts/size-analysis/test/size-analysis.test.ts @@ -454,7 +454,7 @@ describe('test writeReportToDirectory helper function', () => { fs.mkdirSync(aDir, { recursive: true }); const aFile = `a-file`; const aPathToFile = `${aDir}/${aFile}`; - fs.writeFileSync(aPathToFile, fileContent); + fs.writeFileSync(aPathToFile, JSON.stringify(fileContent)); expect(() => writeReportToDirectory(fileContent, aFile, aPathToFile) ).to.throw(ErrorCode.OUTPUT_DIRECTORY_REQUIRED); diff --git a/repo-scripts/size-analysis/test/test-inputs/far.ts b/repo-scripts/size-analysis/test/test-inputs/far.ts index 2c766f8c4fd..7688eef785c 100644 --- a/repo-scripts/size-analysis/test/test-inputs/far.ts +++ b/repo-scripts/size-analysis/test/test-inputs/far.ts @@ -71,7 +71,7 @@ export function basicUniqueFuncFar( return pickedCard; } // Otherwise just let them pick the card - else if (typeof x === 'number') { + else { return { suit: 'a', card: x % 13 }; } } diff --git a/repo-scripts/size-analysis/test/test-inputs/index.ts b/repo-scripts/size-analysis/test/test-inputs/index.ts index 6b357bd0325..3a478abf165 100644 --- a/repo-scripts/size-analysis/test/test-inputs/index.ts +++ b/repo-scripts/size-analysis/test/test-inputs/index.ts @@ -90,7 +90,7 @@ export function basicUniqueFunc( return pickedCard; } // Otherwise just let them pick the card - else if (typeof x === 'number') { + else { return { suit: 'a', card: x % 13 }; } } diff --git a/repo-scripts/size-analysis/tsconfig.json b/repo-scripts/size-analysis/tsconfig.json index b92b160eef6..01d19282ef7 100644 --- a/repo-scripts/size-analysis/tsconfig.json +++ b/repo-scripts/size-analysis/tsconfig.json @@ -7,7 +7,8 @@ "resolveJsonModule": true, "target": "es5", "esModuleInterop": true, - "declaration": true + "declaration": true, + "strict": true }, "exclude": [ "dist/**/*" diff --git a/repo-scripts/size-analysis/util.ts b/repo-scripts/size-analysis/util.ts new file mode 100644 index 00000000000..bd56e98a6e7 --- /dev/null +++ b/repo-scripts/size-analysis/util.ts @@ -0,0 +1,34 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +import calculateGzipSize from 'gzip-size'; +import { dirname, resolve } from 'path'; + +interface ContentSize { + size: number; + gzipSize: number; +} + +export function calculateContentSize(content: string): ContentSize { + const size = Buffer.byteLength(content, 'utf-8'); + const gzipSize = calculateGzipSize.sync(content); + return { + size, + gzipSize + }; +} + +export const projectRoot = dirname(resolve(__dirname, '../../package.json')); diff --git a/yarn.lock b/yarn.lock index faea693ff22..88ea7796953 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2353,6 +2353,11 @@ estree-walker "^1.0.1" magic-string "^0.25.5" +"@rollup/plugin-virtual@2.0.3": + version "2.0.3" + resolved "https://registry.npmjs.org/@rollup/plugin-virtual/-/plugin-virtual-2.0.3.tgz#0afc88d75c1e1378ab290b8e9898d4edb5be0d74" + integrity sha512-pw6ziJcyjZtntQ//bkad9qXaBx665SgEL8C8KI5wO8G5iU5MPxvdWrQyVaAvjojGm9tJoS8M9Z/EEepbqieYmw== + "@rollup/pluginutils@^3.0.4", "@rollup/pluginutils@^3.0.8", "@rollup/pluginutils@^3.0.9", "@rollup/pluginutils@^3.1.0": version "3.1.0" resolved "https://registry.npmjs.org/@rollup/pluginutils/-/pluginutils-3.1.0.tgz#706b4524ee6dc8b103b3c995533e5ad680c02b9b" @@ -2470,6 +2475,11 @@ resolved "https://registry.npmjs.org/@tootallnate/once/-/once-1.1.2.tgz#ccb91445360179a04e7fe6aff78c00ffc1eeaf82" integrity sha512-RbzJvlNzmRq5c3O09UipeuXno4tA1FE6ikOjxZK0tuxVv3412l64l5t1W5pj4+rJq9vpkm/kwiR07aZXnsKPxw== +"@types/anymatch@*": + version "1.3.1" + resolved "https://registry.npmjs.org/@types/anymatch/-/anymatch-1.3.1.tgz#336badc1beecb9dacc38bea2cf32adf627a8421a" + integrity sha512-/+CRPXpBDpo2RK9C68N3b2cOvO0Cf5B9aPijHsoDQTHivnGSObdOF2BRQOYjojWTDy6nQvMjmqRXIxH55VjxxA== + "@types/argparse@1.0.38": version "1.0.38" resolved "https://registry.npmjs.org/@types/argparse/-/argparse-1.0.38.tgz#a81fd8606d481f873a3800c6ebae4f1d768a56a9" @@ -2767,6 +2777,16 @@ resolved "https://registry.npmjs.org/@types/sinonjs__fake-timers/-/sinonjs__fake-timers-6.0.2.tgz#3a84cf5ec3249439015e14049bd3161419bf9eae" integrity sha512-dIPoZ3g5gcx9zZEszaxLSVTvMReD3xxyyDnQUjA6IYDG9Ba2AV0otMPs+77sG9ojB4Qr2N2Vk5RnKeuA0X/0bg== +"@types/source-list-map@*": + version "0.1.2" + resolved "https://registry.npmjs.org/@types/source-list-map/-/source-list-map-0.1.2.tgz#0078836063ffaf17412349bba364087e0ac02ec9" + integrity sha512-K5K+yml8LTo9bWJI/rECfIPrGgxdpeNbj+d53lwN4QjW1MCwlkhUms+gtdzigTeUyBr09+u8BwOIY3MXvHdcsA== + +"@types/tapable@*": + version "1.0.6" + resolved "https://registry.npmjs.org/@types/tapable/-/tapable-1.0.6.tgz#a9ca4b70a18b270ccb2bc0aaafefd1d486b7ea74" + integrity sha512-W+bw9ds02rAQaMvaLYxAbJ6cvguW/iJXNT6lTssS1ps6QdrMKttqEAMEG/b5CR8TZl3/L7/lH0ZV5nNR1LXikA== + "@types/through@*": version "0.0.30" resolved "https://registry.npmjs.org/@types/through/-/through-0.0.30.tgz#e0e42ce77e897bd6aead6f6ea62aeb135b8a3895" @@ -2784,6 +2804,34 @@ resolved "https://registry.npmjs.org/@types/tough-cookie/-/tough-cookie-4.0.0.tgz#fef1904e4668b6e5ecee60c52cc6a078ffa6697d" integrity sha512-I99sngh224D0M7XgW1s120zxCt3VYQ3IQsuw3P3jbq5GG4yc79+ZjyKznyOGIQrflfylLgcfekeZW/vk0yng6A== +"@types/uglify-js@*": + version "3.11.0" + resolved "https://registry.npmjs.org/@types/uglify-js/-/uglify-js-3.11.0.tgz#2868d405cc45cd9dc3069179052103032c33afbc" + integrity sha512-I0Yd8TUELTbgRHq2K65j8rnDPAzAP+DiaF/syLem7yXwYLsHZhPd+AM2iXsWmf9P2F2NlFCgl5erZPQx9IbM9Q== + dependencies: + source-map "^0.6.1" + +"@types/webpack-sources@*": + version "2.0.0" + resolved "https://registry.npmjs.org/@types/webpack-sources/-/webpack-sources-2.0.0.tgz#08216ab9be2be2e1499beaebc4d469cec81e82a7" + integrity sha512-a5kPx98CNFRKQ+wqawroFunvFqv7GHm/3KOI52NY9xWADgc8smu4R6prt4EU/M4QfVjvgBkMqU4fBhw3QfMVkg== + dependencies: + "@types/node" "*" + "@types/source-list-map" "*" + source-map "^0.7.3" + +"@types/webpack@4.41.22": + version "4.41.22" + resolved "https://registry.npmjs.org/@types/webpack/-/webpack-4.41.22.tgz#ff9758a17c6bd499e459b91e78539848c32d0731" + integrity sha512-JQDJK6pj8OMV9gWOnN1dcLCyU9Hzs6lux0wBO4lr1+gyEhIBR9U3FMrz12t2GPkg110XAxEAw2WHF6g7nZIbRQ== + dependencies: + "@types/anymatch" "*" + "@types/node" "*" + "@types/tapable" "*" + "@types/uglify-js" "*" + "@types/webpack-sources" "*" + source-map "^0.6.0" + "@types/yargs-parser@*": version "15.0.0" resolved "https://registry.npmjs.org/@types/yargs-parser/-/yargs-parser-15.0.0.tgz#cb3f9f741869e20cce330ffbeb9271590483882d" @@ -5574,7 +5622,7 @@ debug@3.1.0, debug@=3.1.0, debug@~3.1.0: dependencies: ms "2.0.0" -debug@3.2.6, debug@3.X, debug@^3.1.0, debug@^3.1.1, debug@^3.2.6: +debug@3.2.6, debug@3.X, debug@^3.0.0, debug@^3.1.0, debug@^3.1.1, debug@^3.2.6: version "3.2.6" resolved "https://registry.npmjs.org/debug/-/debug-3.2.6.tgz#e83d17de16d8a7efb7717edbe5fb10135eee629b" integrity sha512-mel+jf7nrtEl5Pn1Qx46zARXKDpBbvzezse7p7LqINmdoIk8PYP5SySaxEmYv6TZ0JyEKA1hsCId6DIhgITtWQ== @@ -7339,6 +7387,11 @@ fs-mkdirp-stream@^1.0.0: graceful-fs "^4.1.11" through2 "^2.0.3" +fs-monkey@1.0.1: + version "1.0.1" + resolved "https://registry.npmjs.org/fs-monkey/-/fs-monkey-1.0.1.tgz#4a82f36944365e619f4454d9fff106553067b781" + integrity sha512-fcSa+wyTqZa46iWweI7/ZiUfegOZl0SG8+dltIwFXo7+zYU9J9kpS3NB6pZcSlJdhvIwp81Adx2XhZorncxiaA== + fs-write-stream-atomic@^1.0.8: version "1.0.10" resolved "https://registry.npmjs.org/fs-write-stream-atomic/-/fs-write-stream-atomic-1.0.10.tgz#b47df53493ef911df75731e70a9ded0189db40c9" @@ -8150,6 +8203,14 @@ gulplog@^1.0.0: dependencies: glogg "^1.0.0" +gzip-size@5.1.1: + version "5.1.1" + resolved "https://registry.npmjs.org/gzip-size/-/gzip-size-5.1.1.tgz#cb9bee692f87c0612b232840a873904e4c135274" + integrity sha512-FNHi6mmoHvs1mxZAds4PpdCS6QG8B4C1krxJsMutgxl5t3+GlRTzzI3NEkifXx2pVsOvJdOGSmIgDhQ55FwdPA== + dependencies: + duplexer "^0.1.1" + pify "^4.0.1" + handlebars@^4.7.2, handlebars@^4.7.6: version "4.7.6" resolved "https://registry.npmjs.org/handlebars/-/handlebars-4.7.6.tgz#d4c05c1baf90e9945f77aa68a7a219aa4a7df74e" @@ -10699,6 +10760,13 @@ media-typer@0.3.0: resolved "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748" integrity sha1-hxDXrwqmJvj/+hzgAWhUUmMlV0g= +memfs@3.2.0: + version "3.2.0" + resolved "https://registry.npmjs.org/memfs/-/memfs-3.2.0.tgz#f9438e622b5acd1daa8a4ae160c496fdd1325b26" + integrity sha512-f/xxz2TpdKv6uDn6GtHee8ivFyxwxmPuXatBb1FBwxYNuVpbM3k/Y1Z+vC0mH/dIXXrukYfe3qe5J32Dfjg93A== + dependencies: + fs-monkey "1.0.1" + memoizee@0.4.X, memoizee@^0.4.14: version "0.4.14" resolved "https://registry.npmjs.org/memoizee/-/memoizee-0.4.14.tgz#07a00f204699f9a95c2d9e77218271c7cd610d57" @@ -15789,6 +15857,13 @@ webpack-stream@6.1.0: vinyl "^2.1.0" webpack "^4.26.1" +webpack-virtual-modules@0.3.1: + version "0.3.1" + resolved "https://registry.npmjs.org/webpack-virtual-modules/-/webpack-virtual-modules-0.3.1.tgz#78cbf1a41a699890a706e789a682dd1120558bf4" + integrity sha512-C9Zbb9rny/SaZJ7gTgJjyB2Qt4G4dbT5rVZywYpyk3L6qyf006RepODREXC4rcQCiTPdZnqnebRq5Chsxg+SgQ== + dependencies: + debug "^3.0.0" + webpack@4.44.2, webpack@^4.26.1: version "4.44.2" resolved "https://registry.npmjs.org/webpack/-/webpack-4.44.2.tgz#6bfe2b0af055c8b2d1e90ed2cd9363f841266b72" From eded218270ae8c504ad8e7e8cd96933b6c2e4925 Mon Sep 17 00:00:00 2001 From: Feiyang Date: Mon, 19 Oct 2020 21:05:52 -0700 Subject: [PATCH 019/624] use api-extractor fork that supports multiple entries (#3738) * use api-extractor fork that supports multiple entries * update lock file --- package.json | 4 +- packages/firestore/src/api/database.ts | 5 +- yarn.lock | 117 ++++++++++--------------- 3 files changed, 50 insertions(+), 76 deletions(-) diff --git a/package.json b/package.json index 04a3cd7223c..e30a6916b6a 100644 --- a/package.json +++ b/package.json @@ -67,8 +67,8 @@ "devDependencies": { "@changesets/changelog-github": "0.2.7", "@changesets/cli": "2.11.0", - "@microsoft/api-documenter": "7.9.10", - "@microsoft/api-extractor": "7.10.4", + "api-documenter-me": "0.1.0", + "api-extractor-me": "0.1.0", "@types/chai": "4.2.13", "@types/chai-as-promised": "7.1.3", "@types/child-process-promise": "2.2.1", diff --git a/packages/firestore/src/api/database.ts b/packages/firestore/src/api/database.ts index bf64f8970e9..61e4f35977f 100644 --- a/packages/firestore/src/api/database.ts +++ b/packages/firestore/src/api/database.ts @@ -111,10 +111,7 @@ import { valueDescription, validateIsNotUsedTogether } from '../util/input_validation'; -import { - setLogLevel as setClientLogLevel, - logWarn -} from '../util/log'; +import { setLogLevel as setClientLogLevel, logWarn } from '../util/log'; import { AutoId } from '../util/misc'; import { Deferred } from '../util/promise'; import { FieldPath as ExternalFieldPath } from './field_path'; diff --git a/yarn.lock b/yarn.lock index 88ea7796953..b8cd43a30a9 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2066,44 +2066,6 @@ globby "^11.0.0" read-yaml-file "^1.1.0" -"@microsoft/api-documenter@7.9.10": - version "7.9.10" - resolved "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.9.10.tgz#405d28a48803b6aeb5a284b0375b5d468e1b2f27" - integrity sha512-Zabla5EelV1HY7+f8S+DyGEZ3IsYzr0PJgoGuZNfp8MX4HQUEM9jRQpuxcnFbdFJWmAHAbQu7gN3yT6GrxgoMg== - dependencies: - "@microsoft/api-extractor-model" "7.10.3" - "@microsoft/tsdoc" "0.12.19" - "@rushstack/node-core-library" "3.34.3" - "@rushstack/ts-command-line" "4.7.3" - colors "~1.2.1" - js-yaml "~3.13.1" - resolve "~1.17.0" - -"@microsoft/api-extractor-model@7.10.3": - version "7.10.3" - resolved "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.10.3.tgz#f687f324e940bd71e3e73b5b262a54594b0ea61c" - integrity sha512-etP4NbZpj+zPCuO3YYigIYXkXq5zYhfE3vo/hrCj1OOd/159HDbSHnEQrNWRVy5TR79RAzHvkYAwtLYKeYP8Ag== - dependencies: - "@microsoft/tsdoc" "0.12.19" - "@rushstack/node-core-library" "3.34.3" - -"@microsoft/api-extractor@7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.10.4.tgz#9055fab0a702d2d74eba05ff369c50012cf41176" - integrity sha512-vod9Y8IHhBtB3hcKiOe4OLi/hNeWtgRh/mxGrye5SeHaJpu5urAAA9CxLxBT8fDe+pyr1ipzlaiM/eMm2vXKgw== - dependencies: - "@microsoft/api-extractor-model" "7.10.3" - "@microsoft/tsdoc" "0.12.19" - "@rushstack/node-core-library" "3.34.3" - "@rushstack/rig-package" "0.2.4" - "@rushstack/ts-command-line" "4.7.3" - colors "~1.2.1" - lodash "~4.17.15" - resolve "~1.17.0" - semver "~7.3.0" - source-map "~0.6.1" - typescript "~3.9.7" - "@microsoft/tsdoc@0.12.19": version "0.12.19" resolved "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.12.19.tgz#2173ccb92469aaf62031fa9499d21b16d07f9b57" @@ -2367,39 +2329,27 @@ estree-walker "^1.0.1" picomatch "^2.2.2" -"@rushstack/node-core-library@3.34.3": - version "3.34.3" - resolved "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.34.3.tgz#a59a1e452dcc79bd4e5f0840b4e9603551668f85" - integrity sha512-WNXHEk5/uoZsbrKzGpYUzDDymJvZarRkByab4uS1fbEcTSDFSVB9e0rREzCkU9yDAQlRutbFwiTXLu3LVR5F6w== +"@rushstack/node-core-library@3.25.0": + version "3.25.0" + resolved "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.25.0.tgz#ba40bc1b188ab5d31f5705999cd2b3b56b8a32cf" + integrity sha512-e2NCFtAu/eu14b8nlzRX6ZrE9Sb3J2wVt+pninQmTn/IgfnRLAtM0D4PzUO4+ktZwF9fCnpqrOGokLzw6RSVNw== dependencies: "@types/node" "10.17.13" colors "~1.2.1" fs-extra "~7.0.1" - import-lazy "~4.0.0" jju "~1.4.0" - resolve "~1.17.0" semver "~7.3.0" timsort "~0.3.0" z-schema "~3.18.3" -"@rushstack/rig-package@0.2.4": - version "0.2.4" - resolved "https://registry.npmjs.org/@rushstack/rig-package/-/rig-package-0.2.4.tgz#259feb6637bedbfdc130d3a188ce85370e048743" - integrity sha512-/UXb6N0m0l+5kU4mLmRxyw3we+/w1fesgvfg96xllty5LyQxKDvkscmjlvCU/Yx55WO1tVxN4/7YlNEB2DcHyA== - dependencies: - "@types/node" "10.17.13" - resolve "~1.17.0" - strip-json-comments "~3.1.1" - -"@rushstack/ts-command-line@4.7.3": - version "4.7.3" - resolved "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.7.3.tgz#fa72c637d70aa29c201f8f016f7db626f2d23a2c" - integrity sha512-8FNrUSbMgKLgRVcsg1STsIC2xAdyes7qJtVwg36hSnBAMZgCCIM+Z36nnxyrnYTS/6qwiXv7fwVaUxXH+SyiAQ== +"@rushstack/ts-command-line@4.4.6": + version "4.4.6" + resolved "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.4.6.tgz#7818f19e444274e68564a756ef62a2b4e0ced0f8" + integrity sha512-ue3p2m773Yea/s4Ef2Q3gEyLd9T0NDjXCl+PlodGTrJHgxoiRwbROSWHAdYJL/LceGWa6Biqizu9qxUDEWFweQ== dependencies: "@types/argparse" "1.0.38" argparse "~1.0.9" colors "~1.2.1" - string-argv "~0.3.1" "@samverschueren/stream-to-observable@^0.3.0": version "0.3.1" @@ -3373,6 +3323,43 @@ anymatch@~3.1.1: normalize-path "^3.0.0" picomatch "^2.0.4" +api-documenter-me@0.1.0: + version "0.1.0" + resolved "https://registry.npmjs.org/api-documenter-me/-/api-documenter-me-0.1.0.tgz#a11890220449042b781b88e0f9a2e2896a11f987" + integrity sha512-VuiQCwHvH4qjotDvF/Ox0UI+EX6X9HiHnNcjJGLgkcFRNVJi2wuMO4whFJQ6t5k1KjAm2oedFMPtdT60zJRWGQ== + dependencies: + "@microsoft/tsdoc" "0.12.19" + "@rushstack/node-core-library" "3.25.0" + "@rushstack/ts-command-line" "4.4.6" + api-extractor-model-me "0.1.0" + colors "~1.2.1" + js-yaml "~3.13.1" + resolve "~1.17.0" + +api-extractor-me@0.1.0: + version "0.1.0" + resolved "https://registry.npmjs.org/api-extractor-me/-/api-extractor-me-0.1.0.tgz#2c26880ed38d01005c458c80e70f135609cfaac5" + integrity sha512-Nq/07XbwxymfCKDpap5AyCWTKM4w1Gvz/WVKc2coJH4TSUkxFJimbvXiQSUCGtpKNGGyy0+R0QITqZD5yRDBsg== + dependencies: + "@microsoft/tsdoc" "0.12.19" + "@rushstack/node-core-library" "3.25.0" + "@rushstack/ts-command-line" "4.4.6" + api-extractor-model-me "0.1.0" + colors "~1.2.1" + lodash "~4.17.15" + resolve "~1.17.0" + semver "~7.3.0" + source-map "~0.6.1" + typescript "~3.9.5" + +api-extractor-model-me@0.1.0: + version "0.1.0" + resolved "https://registry.npmjs.org/api-extractor-model-me/-/api-extractor-model-me-0.1.0.tgz#d194630b261546f075d5fab25822e6603581527c" + integrity sha512-XKoDHa8guAHxnjVsV9vP5BDH3SjDTQT8KFD0jIbx+UUga7LjD2I8UW+n1hAmAUQNvtR7Xo98PXjr7l8iIBkJiQ== + dependencies: + "@microsoft/tsdoc" "0.12.19" + "@rushstack/node-core-library" "3.25.0" + append-buffer@^1.0.2: version "1.0.2" resolved "https://registry.npmjs.org/append-buffer/-/append-buffer-1.0.2.tgz#d8220cf466081525efea50614f3de6514dfa58f1" @@ -8613,11 +8600,6 @@ import-lazy@^2.1.0: resolved "https://registry.npmjs.org/import-lazy/-/import-lazy-2.1.0.tgz#05698e3d45c88e8d7e9d92cb0584e77f096f3e43" integrity sha1-BWmOPUXIjo1+nZLLBYTnfwlvPkM= -import-lazy@~4.0.0: - version "4.0.0" - resolved "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz#e8eb627483a0a43da3c03f3e35548be5cb0cc153" - integrity sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw== - import-local@^2.0.0: version "2.0.0" resolved "https://registry.npmjs.org/import-local/-/import-local-2.0.0.tgz#55070be38a5993cf18ef6db7e961f5bee5c5a09d" @@ -14315,11 +14297,6 @@ streamsearch@0.1.2: resolved "https://registry.npmjs.org/streamsearch/-/streamsearch-0.1.2.tgz#808b9d0e56fc273d809ba57338e929919a1a9f1a" integrity sha1-gIudDlb8Jz2Am6VzOOkpkZoanxo= -string-argv@~0.3.1: - version "0.3.1" - resolved "https://registry.npmjs.org/string-argv/-/string-argv-0.3.1.tgz#95e2fbec0427ae19184935f816d74aaa4c5c19da" - integrity sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg== - string-length@^1.0.0: version "1.0.1" resolved "https://registry.npmjs.org/string-length/-/string-length-1.0.1.tgz#56970fb1c38558e9e70b728bf3de269ac45adfac" @@ -14484,7 +14461,7 @@ strip-json-comments@2.0.1, strip-json-comments@~2.0.1: resolved "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz#3c531942e908c2697c0ec344858c286c7ca0a60a" integrity sha1-PFMZQukIwml8DsNEhYwobHygpgo= -strip-json-comments@^3.1.0, strip-json-comments@^3.1.1, strip-json-comments@~3.1.1: +strip-json-comments@^3.1.0, strip-json-comments@^3.1.1: version "3.1.1" resolved "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz#31f1281b3832630434831c310c01cccda8cbe006" integrity sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig== @@ -15278,7 +15255,7 @@ typescript@4.0.2: resolved "https://registry.npmjs.org/typescript/-/typescript-4.0.2.tgz#7ea7c88777c723c681e33bf7988be5d008d05ac2" integrity sha512-e4ERvRV2wb+rRZ/IQeb3jm2VxBsirQLpQhdxplZ2MEzGvDkkMmPglecnNDfSUBivMjP93vRbngYYDQqQ/78bcQ== -typescript@~3.9.7: +typescript@~3.9.5: version "3.9.7" resolved "https://registry.npmjs.org/typescript/-/typescript-3.9.7.tgz#98d600a5ebdc38f40cb277522f12dc800e9e25fa" integrity sha512-BLbiRkiBzAwsjut4x/dsibSTB6yWpwT5qWmC2OfuCg3GgVQCSgMs4vEctYPhsaGtd0AeuuHMkjZ2h2WG8MSzRw== From a5768b0aa7d7ce732279931aa436e988c9f36487 Mon Sep 17 00:00:00 2001 From: Feiyang Date: Tue, 20 Oct 2020 09:39:53 -0700 Subject: [PATCH 020/624] Point browser field to esm build (#3932) * point browser field to esm build * address comments * Create funny-ties-ring.md * fix build error in component * change from namespace export to default export * update changeset * fix firebase imports in rxfire * fix import for rules-unit-testing * fix testing * compile firebase pkgs to cjs so they can be stubbed in tests --- .changeset/funny-ties-ring.md | 25 +++++ config/webpack.test.js | 21 ++++- integration/firebase/package.json | 2 - integration/firebase/test/namespace.test.ts | 2 +- package.json | 3 + packages/app/package.json | 2 +- packages/app/rollup.config.js | 5 +- packages/auth/package.json | 2 +- packages/component/package.json | 2 +- packages/component/rollup.config.js | 4 +- packages/database/package.json | 2 +- packages/database/rollup.config.js | 5 +- packages/firebase/app/package.json | 2 +- packages/firebase/index.d.ts | 2 +- packages/firebase/package.json | 2 +- packages/firebase/rollup.config.js | 5 +- packages/firestore/memory/package.json | 2 +- packages/firestore/package.json | 2 +- packages/firestore/rollup.config.browser.js | 9 -- .../firestore/rollup.config.browser.memory.js | 13 --- packages/functions/package.json | 2 +- packages/functions/rollup.config.js | 5 +- packages/performance/package.json | 2 +- packages/remote-config/package.json | 2 +- packages/remote-config/rollup.config.js | 2 +- packages/rules-unit-testing/src/api/index.ts | 5 +- packages/rxfire/auth/index.ts | 11 ++- packages/rxfire/database/fromRef.ts | 4 +- packages/rxfire/database/interfaces.ts | 4 +- packages/rxfire/database/list/audit-trail.ts | 10 +- packages/rxfire/database/list/index.ts | 15 ++- packages/rxfire/database/object/index.ts | 10 +- packages/rxfire/firestore/collection/index.ts | 72 +++++++------- packages/rxfire/firestore/document/index.ts | 16 ++-- packages/rxfire/firestore/fromRef.ts | 30 +++--- packages/rxfire/functions/index.ts | 4 +- packages/rxfire/package.json | 4 - packages/rxfire/storage/index.ts | 39 ++++---- packages/rxfire/test/database.test.ts | 14 +-- packages/rxfire/test/firestore.test.ts | 16 ++-- packages/template/package.json | 2 +- packages/template/rollup.config.js | 7 +- packages/util/package.json | 2 +- packages/util/rollup.config.js | 7 +- yarn.lock | 94 +++++++++++++++++++ 45 files changed, 294 insertions(+), 197 deletions(-) create mode 100644 .changeset/funny-ties-ring.md diff --git a/.changeset/funny-ties-ring.md b/.changeset/funny-ties-ring.md new file mode 100644 index 00000000000..e7066ce4b91 --- /dev/null +++ b/.changeset/funny-ties-ring.md @@ -0,0 +1,25 @@ +--- +"@firebase/app": patch +"@firebase/auth": patch +"@firebase/component": patch +"@firebase/database": patch +"firebase": major +"@firebase/firestore": patch +"@firebase/functions": patch +"@firebase/performance": patch +"@firebase/remote-config": patch +"rxfire": patch +"@firebase/util": patch +--- + +Point browser field to esm build. Now you need to use default import instead of namespace import to import firebase. + +Before this change +``` +import * as firebase from 'firebase/app'; +``` + +After this change +``` +import firebase from 'firebase/app'; +``` diff --git a/config/webpack.test.js b/config/webpack.test.js index 5da3c423b29..c437b49365e 100644 --- a/config/webpack.test.js +++ b/config/webpack.test.js @@ -74,13 +74,30 @@ module.exports = { ] } } + }, + { + test: /\.js$/, + include: function (modulePath) { + const match = /node_modules\/@firebase.*/.test(modulePath); + if (match) { + console.log('modulePath', modulePath, match); + } + return match; + }, + use: { + loader: 'babel-loader', + options: { + plugins: ['@babel/plugin-transform-modules-commonjs'] + } + } } ] }, resolve: { modules: ['node_modules', path.resolve(__dirname, '../../node_modules')], - mainFields: ['browser', 'main', 'module'], - extensions: ['.js', '.ts'] + mainFields: ['browser', 'module', 'main'], + extensions: ['.js', '.ts'], + symlinks: false }, plugins: [ new webpack.NormalModuleReplacementPlugin( diff --git a/integration/firebase/package.json b/integration/firebase/package.json index b40ff02e341..89d082b91fa 100644 --- a/integration/firebase/package.json +++ b/integration/firebase/package.json @@ -8,8 +8,6 @@ }, "devDependencies": { "firebase": "7.24.0", - "@babel/core": "7.11.6", - "@babel/preset-env": "7.11.5", "@types/chai": "4.2.13", "@types/mocha": "7.0.2", "chai": "4.2.0", diff --git a/integration/firebase/test/namespace.test.ts b/integration/firebase/test/namespace.test.ts index ef6dce22e4b..42d4eec6390 100644 --- a/integration/firebase/test/namespace.test.ts +++ b/integration/firebase/test/namespace.test.ts @@ -15,7 +15,7 @@ * limitations under the License. */ -import * as firebase from 'firebase'; +import firebase from 'firebase'; import * as namespaceDefinition from './namespaceDefinition.json'; import validateNamespace from './validator'; diff --git a/package.json b/package.json index e30a6916b6a..d8b33834a3b 100644 --- a/package.json +++ b/package.json @@ -87,6 +87,9 @@ "@typescript-eslint/eslint-plugin-tslint": "4.4.1", "@typescript-eslint/parser": "4.4.1", "babel-loader": "8.1.0", + "@babel/core": "7.11.6", + "@babel/preset-env": "7.11.5", + "@babel/plugin-transform-modules-commonjs": "7.12.1", "chai": "4.2.0", "chai-as-promised": "7.1.1", "chalk": "4.1.0", diff --git a/packages/app/package.json b/packages/app/package.json index 20614338819..f880b91307a 100644 --- a/packages/app/package.json +++ b/packages/app/package.json @@ -4,7 +4,7 @@ "description": "The primary entrypoint to the Firebase JS SDK", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.node.cjs.js", - "browser": "dist/index.cjs.js", + "browser": "dist/index.esm.js", "module": "dist/index.esm.js", "react-native": "dist/index.rn.cjs.js", "esm2017": "dist/index.esm2017.js", diff --git a/packages/app/rollup.config.js b/packages/app/rollup.config.js index 31f577f2310..ad81062fee2 100644 --- a/packages/app/rollup.config.js +++ b/packages/app/rollup.config.js @@ -37,10 +37,7 @@ const es5BuildPlugins = [ const es5Builds = [ { input: 'index.ts', - output: [ - { file: pkg.browser, format: 'cjs', sourcemap: true }, - { file: pkg.module, format: 'es', sourcemap: true } - ], + output: [{ file: pkg.module, format: 'es', sourcemap: true }], plugins: es5BuildPlugins, external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)) }, diff --git a/packages/auth/package.json b/packages/auth/package.json index d79c43ef1ea..cf6e93083c0 100644 --- a/packages/auth/package.json +++ b/packages/auth/package.json @@ -2,7 +2,7 @@ "name": "@firebase/auth", "version": "0.15.0", "main": "dist/auth.js", - "browser": "dist/auth.js", + "browser": "dist/auth.esm.js", "module": "dist/auth.esm.js", "description": "Javascript library for Firebase Auth SDK", "author": "Firebase (https://firebase.google.com/)", diff --git a/packages/component/package.json b/packages/component/package.json index 2e439671014..88f60ccedae 100644 --- a/packages/component/package.json +++ b/packages/component/package.json @@ -4,7 +4,7 @@ "description": "Firebase Component Platform", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.cjs.js", - "browser": "dist/index.cjs.js", + "browser": "dist/index.esm.js", "module": "dist/index.esm.js", "esm2017": "dist/index.esm2017.js", "files": ["dist"], diff --git a/packages/component/rollup.config.js b/packages/component/rollup.config.js index 8cfe95d6751..b97d6542ad8 100644 --- a/packages/component/rollup.config.js +++ b/packages/component/rollup.config.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2018 Google Inc. + * Copyright 2018 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -39,7 +39,7 @@ const es5Builds = [ { input: 'index.ts', output: [ - { file: pkg.browser, format: 'cjs', sourcemap: true }, + { file: pkg.main, format: 'cjs', sourcemap: true }, { file: pkg.module, format: 'es', sourcemap: true } ], plugins: es5BuildPlugins, diff --git a/packages/database/package.json b/packages/database/package.json index 599ef6807d9..8ed372271cf 100644 --- a/packages/database/package.json +++ b/packages/database/package.json @@ -4,7 +4,7 @@ "description": "", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.node.cjs.js", - "browser": "dist/index.cjs.js", + "browser": "dist/index.esm.js", "module": "dist/index.esm.js", "esm2017": "dist/index.esm2017.js", "files": ["dist"], diff --git a/packages/database/rollup.config.js b/packages/database/rollup.config.js index 668640e67ad..56a04103404 100644 --- a/packages/database/rollup.config.js +++ b/packages/database/rollup.config.js @@ -49,10 +49,7 @@ const es5Builds = [ */ { input: 'index.ts', - output: [ - { file: pkg.browser, format: 'cjs', sourcemap: true }, - { file: pkg.module, format: 'es', sourcemap: true } - ], + output: [{ file: pkg.module, format: 'es', sourcemap: true }], plugins: es5BuildPlugins, external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)) } diff --git a/packages/firebase/app/package.json b/packages/firebase/app/package.json index 57c2a83692c..06f2e67a295 100644 --- a/packages/firebase/app/package.json +++ b/packages/firebase/app/package.json @@ -1,7 +1,7 @@ { "name": "firebase/app", "main": "dist/index.cjs.js", - "browser": "dist/index.cjs.js", + "browser": "dist/index.esm.js", "module": "dist/index.esm.js", "typings": "../index.d.ts" } diff --git a/packages/firebase/index.d.ts b/packages/firebase/index.d.ts index c0d71742d59..179a2e66d0e 100644 --- a/packages/firebase/index.d.ts +++ b/packages/firebase/index.d.ts @@ -9684,5 +9684,5 @@ declare namespace firebase.firestore { } } -export = firebase; +export default firebase; export as namespace firebase; diff --git a/packages/firebase/package.json b/packages/firebase/package.json index deb2991c0c5..9473206d414 100644 --- a/packages/firebase/package.json +++ b/packages/firebase/package.json @@ -41,7 +41,7 @@ "test:ci": "echo 'No test suite for firebase wrapper'" }, "main": "dist/index.node.cjs.js", - "browser": "dist/index.cjs.js", + "browser": "dist/index.esm.js", "module": "dist/index.esm.js", "react-native": "dist/index.rn.cjs.js", "dependencies": { diff --git a/packages/firebase/rollup.config.js b/packages/firebase/rollup.config.js index 8bcb0195afa..41e03b1751f 100644 --- a/packages/firebase/rollup.config.js +++ b/packages/firebase/rollup.config.js @@ -184,10 +184,7 @@ const completeBuilds = [ */ { input: 'src/index.ts', - output: [ - { file: pkg.browser, format: 'cjs', sourcemap: true }, - { file: pkg.module, format: 'es', sourcemap: true } - ], + output: [{ file: pkg.module, format: 'es', sourcemap: true }], plugins, external }, diff --git a/packages/firestore/memory/package.json b/packages/firestore/memory/package.json index 04a27eb839a..52decb62926 100644 --- a/packages/firestore/memory/package.json +++ b/packages/firestore/memory/package.json @@ -4,7 +4,7 @@ "main": "../dist/index.memory.node.cjs.js", "main-esm2017": "../dist/index.memory.node.esm2017.js", "react-native": "../dist/index.memory.rn.esm2017.js", - "browser": "../dist/index.memory.cjs.js", + "browser": "../dist/index.memory.esm.js", "module": "../dist/index.memory.esm.js", "esm2017": "../dist/index.memory.esm2017.js", "typings": "../dist/index.d.ts" diff --git a/packages/firestore/package.json b/packages/firestore/package.json index e74b0f402b2..90ee054b940 100644 --- a/packages/firestore/package.json +++ b/packages/firestore/package.json @@ -51,7 +51,7 @@ "main": "dist/index.node.cjs.js", "main-esm2017": "dist/index.node.esm2017.js", "react-native": "dist/index.rn.esm2017.js", - "browser": "dist/index.cjs.js", + "browser": "dist/index.esm.js", "module": "dist/index.esm.js", "esm2017": "dist/index.esm2017.js", "license": "Apache-2.0", diff --git a/packages/firestore/rollup.config.browser.js b/packages/firestore/rollup.config.browser.js index c3c947b56d6..6f3d2582a5f 100644 --- a/packages/firestore/rollup.config.browser.js +++ b/packages/firestore/rollup.config.browser.js @@ -41,14 +41,5 @@ export default [ treeshake: { moduleSideEffects: false } - }, - { - input: pkg.esm2017, - output: { file: pkg.browser, format: 'cjs', sourcemap: true }, - plugins: util.es2017ToEs5Plugins(/* mangled= */ true), - external: util.resolveBrowserExterns, - treeshake: { - moduleSideEffects: false - } } ]; diff --git a/packages/firestore/rollup.config.browser.memory.js b/packages/firestore/rollup.config.browser.memory.js index 036703eac5d..d97ae948c71 100644 --- a/packages/firestore/rollup.config.browser.memory.js +++ b/packages/firestore/rollup.config.browser.memory.js @@ -46,18 +46,5 @@ export default [ treeshake: { moduleSideEffects: false } - }, - { - input: path.resolve('./memory', memoryPkg['esm2017']), - output: { - file: path.resolve('./memory', memoryPkg.browser), - format: 'cjs', - sourcemap: true - }, - plugins: util.es2017ToEs5Plugins(/* mangled= */ true), - external: util.resolveBrowserExterns, - treeshake: { - moduleSideEffects: false - } } ]; diff --git a/packages/functions/package.json b/packages/functions/package.json index 60164e78625..8fb3d79f8ab 100644 --- a/packages/functions/package.json +++ b/packages/functions/package.json @@ -4,7 +4,7 @@ "description": "", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.node.cjs.js", - "browser": "dist/index.cjs.js", + "browser": "dist/index.esm.js", "module": "dist/index.esm.js", "esm2017": "dist/index.esm2017.js", "files": ["dist"], diff --git a/packages/functions/rollup.config.js b/packages/functions/rollup.config.js index 653177a72a1..700cea6c025 100644 --- a/packages/functions/rollup.config.js +++ b/packages/functions/rollup.config.js @@ -40,10 +40,7 @@ const es5Builds = [ */ { input: 'index.ts', - output: [ - { file: pkg.browser, format: 'cjs', sourcemap: true }, - { file: pkg.module, format: 'es', sourcemap: true } - ], + output: [{ file: pkg.module, format: 'es', sourcemap: true }], plugins: es5BuildPlugins, external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)) }, diff --git a/packages/performance/package.json b/packages/performance/package.json index 78d9db93ca6..181efe8bd9d 100644 --- a/packages/performance/package.json +++ b/packages/performance/package.json @@ -4,7 +4,7 @@ "description": "Firebase performance for web", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.cjs.js", - "browser": "dist/index.cjs.js", + "browser": "dist/index.esm.js", "module": "dist/index.esm.js", "esm2017": "dist/index.esm2017.js", "files": ["dist"], diff --git a/packages/remote-config/package.json b/packages/remote-config/package.json index 774730888aa..83ae132d614 100644 --- a/packages/remote-config/package.json +++ b/packages/remote-config/package.json @@ -4,7 +4,7 @@ "description": "The Remote Config package of the Firebase JS SDK", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.cjs.js", - "browser": "dist/index.cjs.js", + "browser": "dist/index.esm.js", "module": "dist/index.esm.js", "esm2017": "dist/index.esm2017.js", "files": ["dist"], diff --git a/packages/remote-config/rollup.config.js b/packages/remote-config/rollup.config.js index 85934294724..b0a656084d5 100644 --- a/packages/remote-config/rollup.config.js +++ b/packages/remote-config/rollup.config.js @@ -41,7 +41,7 @@ const es5Builds = [ { input: 'index.ts', output: [ - { file: pkg.browser, format: 'cjs', sourcemap: true }, + { file: pkg.main, format: 'cjs', sourcemap: true }, { file: pkg.module, format: 'es', sourcemap: true } ], plugins: es5BuildPlugins, diff --git a/packages/rules-unit-testing/src/api/index.ts b/packages/rules-unit-testing/src/api/index.ts index 655e4174197..75d07908de3 100644 --- a/packages/rules-unit-testing/src/api/index.ts +++ b/packages/rules-unit-testing/src/api/index.ts @@ -15,7 +15,7 @@ * limitations under the License. */ -import * as firebase from 'firebase'; +import firebase from 'firebase'; import { _FirebaseApp } from '@firebase/app-types/private'; import { FirebaseAuthInternal } from '@firebase/auth-interop-types'; import * as request from 'request'; @@ -23,7 +23,8 @@ import { base64 } from '@firebase/util'; import { setLogLevel, LogLevel } from '@firebase/logger'; import { Component, ComponentType } from '@firebase/component'; -export { database, firestore } from 'firebase'; +const { firestore, database } = firebase; +export { firestore, database }; /** If this environment variable is set, use it for the database emulator's address. */ const DATABASE_ADDRESS_ENV: string = 'FIREBASE_DATABASE_EMULATOR_HOST'; diff --git a/packages/rxfire/auth/index.ts b/packages/rxfire/auth/index.ts index 1effdff9d22..10310647a61 100644 --- a/packages/rxfire/auth/index.ts +++ b/packages/rxfire/auth/index.ts @@ -17,16 +17,19 @@ // auth is used as a namespace to access types // eslint-disable-next-line @typescript-eslint/no-unused-vars -import { auth, User } from 'firebase'; +import firebase from 'firebase'; import { Observable, from, of } from 'rxjs'; import { switchMap } from 'rxjs/operators'; +type Auth = firebase.auth.Auth; +type User = firebase.User; + /** * Create an observable of authentication state. The observer is only * triggered on sign-in or sign-out. * @param auth firebase.auth.Auth */ -export function authState(auth: auth.Auth): Observable { +export function authState(auth: Auth): Observable { return new Observable(subscriber => { const unsubscribe = auth.onAuthStateChanged(subscriber); return { unsubscribe }; @@ -38,7 +41,7 @@ export function authState(auth: auth.Auth): Observable { * sign-out, and token refresh events * @param auth firebase.auth.Auth */ -export function user(auth: auth.Auth): Observable { +export function user(auth: Auth): Observable { return new Observable(subscriber => { const unsubscribe = auth.onIdTokenChanged(subscriber); return { unsubscribe }; @@ -50,7 +53,7 @@ export function user(auth: auth.Auth): Observable { * sign-out, and token refresh events * @param auth firebase.auth.Auth */ -export function idToken(auth: auth.Auth): Observable { +export function idToken(auth: Auth): Observable { return user(auth).pipe( switchMap(user => (user ? from(user.getIdToken()) : of(null))) ); diff --git a/packages/rxfire/database/fromRef.ts b/packages/rxfire/database/fromRef.ts index bc1099d6aa3..888015eda41 100644 --- a/packages/rxfire/database/fromRef.ts +++ b/packages/rxfire/database/fromRef.ts @@ -15,7 +15,7 @@ * limitations under the License. */ -import { database } from 'firebase'; +import firebase from 'firebase'; import { Observable } from 'rxjs'; import { delay } from 'rxjs/operators'; import { ListenEvent, QueryChange } from './interfaces'; @@ -26,7 +26,7 @@ import { ListenEvent, QueryChange } from './interfaces'; * @param event Listen event type ('value', 'added', 'changed', 'removed', 'moved') */ export function fromRef( - ref: database.Query, + ref: firebase.database.Query, event: ListenEvent ): Observable { return new Observable(subscriber => { diff --git a/packages/rxfire/database/interfaces.ts b/packages/rxfire/database/interfaces.ts index 76ad573f04d..6c77bb6fbe8 100644 --- a/packages/rxfire/database/interfaces.ts +++ b/packages/rxfire/database/interfaces.ts @@ -15,7 +15,7 @@ * limitations under the License. */ -import { database } from 'firebase'; +import firebase from 'firebase'; export enum ListenEvent { added = 'child_added', @@ -26,7 +26,7 @@ export enum ListenEvent { } export interface QueryChange { - snapshot: database.DataSnapshot; + snapshot: firebase.database.DataSnapshot; prevKey: string | null | undefined; event: ListenEvent; } diff --git a/packages/rxfire/database/list/audit-trail.ts b/packages/rxfire/database/list/audit-trail.ts index 8e037da6790..75e7c83221b 100644 --- a/packages/rxfire/database/list/audit-trail.ts +++ b/packages/rxfire/database/list/audit-trail.ts @@ -15,20 +15,22 @@ * limitations under the License. */ -import { database } from 'firebase'; +import firebase from 'firebase'; import { Observable } from 'rxjs'; import { QueryChange, ListenEvent } from '../interfaces'; import { fromRef } from '../fromRef'; import { map, withLatestFrom, scan, skipWhile } from 'rxjs/operators'; import { stateChanges } from './index'; +type Query = firebase.database.Query; + interface LoadedMetadata { data: QueryChange; lastKeyToLoad: unknown; } export function auditTrail( - query: database.Query, + query: Query, events?: ListenEvent[] ): Observable { const auditTrail$ = stateChanges(query, events).pipe( @@ -40,7 +42,7 @@ export function auditTrail( return waitForLoaded(query, auditTrail$); } -function loadedData(query: database.Query): Observable { +function loadedData(query: Query): Observable { // Create an observable of loaded values to retrieve the // known dataset. This will allow us to know what key to // emit the "whole" array at when listening for child events. @@ -60,7 +62,7 @@ function loadedData(query: database.Query): Observable { } function waitForLoaded( - query: database.Query, + query: Query, snap$: Observable ): Observable { const loaded$ = loadedData(query); diff --git a/packages/rxfire/database/list/index.ts b/packages/rxfire/database/list/index.ts index 8fffa70f33c..2a0c0876681 100644 --- a/packages/rxfire/database/list/index.ts +++ b/packages/rxfire/database/list/index.ts @@ -15,7 +15,7 @@ * limitations under the License. */ -import { database } from 'firebase'; +import firebase from 'firebase'; import { QueryChange, ListenEvent } from '../interfaces'; import { Observable, of, merge, from } from 'rxjs'; import { validateEventsArray } from '../utils'; @@ -23,8 +23,10 @@ import { fromRef } from '../fromRef'; import { switchMap, scan, distinctUntilChanged, map } from 'rxjs/operators'; import { changeToData } from '../object'; +type Query = firebase.database.Query; + export function stateChanges( - query: database.Query, + query: Query, events?: ListenEvent[] ): Observable { events = validateEventsArray(events); @@ -32,7 +34,7 @@ export function stateChanges( return merge(...childEvent$); } -function fromOnce(query: database.Query): Observable { +function fromOnce(query: Query): Observable { return from(query.once(ListenEvent.value)).pipe( map(snapshot => { const event = ListenEvent.value; @@ -42,7 +44,7 @@ function fromOnce(query: database.Query): Observable { } export function list( - query: database.Query, + query: Query, events?: ListenEvent[] ): Observable { const eventsList = validateEventsArray(events); @@ -63,10 +65,7 @@ export function list( * @param query object ref or query * @param keyField map the object key to a specific field */ -export function listVal( - query: database.Query, - keyField?: string -): Observable { +export function listVal(query: Query, keyField?: string): Observable { return list(query).pipe( map(arr => arr.map(change => changeToData(change, keyField) as T)) ); diff --git a/packages/rxfire/database/object/index.ts b/packages/rxfire/database/object/index.ts index ed66147b867..13fde88c152 100644 --- a/packages/rxfire/database/object/index.ts +++ b/packages/rxfire/database/object/index.ts @@ -15,17 +15,18 @@ * limitations under the License. */ -import { database } from 'firebase'; +import firebase from 'firebase'; import { QueryChange, ListenEvent } from '../interfaces'; import { fromRef } from '../fromRef'; import { Observable } from 'rxjs'; import { map } from 'rxjs/operators'; +type Query = firebase.database.Query; /** * Get the snapshot changes of an object * @param query */ -export function object(query: database.Query): Observable { +export function object(query: Query): Observable { return fromRef(query, ListenEvent.value); } @@ -34,10 +35,7 @@ export function object(query: database.Query): Observable { * @param query object ref or query * @param keyField map the object key to a specific field */ -export function objectVal( - query: database.Query, - keyField?: string -): Observable { +export function objectVal(query: Query, keyField?: string): Observable { return fromRef(query, ListenEvent.value).pipe( map(change => changeToData(change, keyField) as T) ); diff --git a/packages/rxfire/firestore/collection/index.ts b/packages/rxfire/firestore/collection/index.ts index 614c15cddeb..8c57889b6ae 100644 --- a/packages/rxfire/firestore/collection/index.ts +++ b/packages/rxfire/firestore/collection/index.ts @@ -15,17 +15,18 @@ * limitations under the License. */ -import { firestore } from 'firebase/app'; +import firebase from 'firebase/app'; import { fromCollectionRef } from '../fromRef'; import { Observable, MonoTypeOperatorFunction } from 'rxjs'; import { map, filter, scan, distinctUntilChanged } from 'rxjs/operators'; import { snapToData } from '../document'; -const ALL_EVENTS: firestore.DocumentChangeType[] = [ - 'added', - 'modified', - 'removed' -]; +type DocumentChangeType = firebase.firestore.DocumentChangeType; +type DocumentChange = firebase.firestore.DocumentChange; +type Query = firebase.firestore.Query; +type QueryDocumentSnapshot = firebase.firestore.QueryDocumentSnapshot; + +const ALL_EVENTS: DocumentChangeType[] = ['added', 'modified', 'removed']; /** * Create an operator that determines if a the stream of document changes @@ -33,9 +34,9 @@ const ALL_EVENTS: firestore.DocumentChangeType[] = [ * in specified events array, it will not be emitted. */ const filterEvents = ( - events?: firestore.DocumentChangeType[] -): MonoTypeOperatorFunction => - filter((changes: firestore.DocumentChange[]) => { + events?: DocumentChangeType[] +): MonoTypeOperatorFunction => + filter((changes: DocumentChange[]) => { let hasChange = false; for (let i = 0; i < changes.length; i++) { const change = changes[i]; @@ -52,9 +53,7 @@ const filterEvents = ( * ability to filter on events, which means all changes can be filtered out. * This creates an empty array and would be incorrect to emit. */ -const filterEmpty = filter( - (changes: firestore.DocumentChange[]) => changes.length > 0 -); +const filterEmpty = filter((changes: DocumentChange[]) => changes.length > 0); /** * Splice arguments on top of a sliced array, to break top-level === @@ -77,9 +76,9 @@ function sliceAndSplice( * @param change */ function processIndividualChange( - combined: firestore.DocumentChange[], - change: firestore.DocumentChange -): firestore.DocumentChange[] { + combined: DocumentChange[], + change: DocumentChange +): DocumentChange[] { switch (change.type) { case 'added': if ( @@ -130,10 +129,10 @@ function processIndividualChange( * @param events */ function processDocumentChanges( - current: firestore.DocumentChange[], - changes: firestore.DocumentChange[], - events: firestore.DocumentChangeType[] = ALL_EVENTS -): firestore.DocumentChange[] { + current: DocumentChange[], + changes: DocumentChange[], + events: DocumentChangeType[] = ALL_EVENTS +): DocumentChange[] { changes.forEach(change => { // skip unwanted change types if (events.indexOf(change.type) > -1) { @@ -149,9 +148,9 @@ function processDocumentChanges( * @param query */ export function collectionChanges( - query: firestore.Query, - events: firestore.DocumentChangeType[] = ALL_EVENTS -): Observable { + query: Query, + events: DocumentChangeType[] = ALL_EVENTS +): Observable { return fromCollectionRef(query).pipe( map(snapshot => snapshot.docChanges()), filterEvents(events), @@ -163,9 +162,7 @@ export function collectionChanges( * Return a stream of document snapshots on a query. These results are in sort order. * @param query */ -export function collection( - query: firestore.Query -): Observable { +export function collection(query: Query): Observable { return fromCollectionRef(query).pipe(map(changes => changes.docs)); } @@ -174,15 +171,13 @@ export function collection( * @param query */ export function sortedChanges( - query: firestore.Query, - events?: firestore.DocumentChangeType[] -): Observable { + query: Query, + events?: DocumentChangeType[] +): Observable { return collectionChanges(query, events).pipe( scan( - ( - current: firestore.DocumentChange[], - changes: firestore.DocumentChange[] - ) => processDocumentChanges(current, changes, events), + (current: DocumentChange[], changes: DocumentChange[]) => + processDocumentChanges(current, changes, events), [] ), distinctUntilChanged() @@ -194,14 +189,11 @@ export function sortedChanges( * to docChanges() but it collects each event in an array over time. */ export function auditTrail( - query: firestore.Query, - events?: firestore.DocumentChangeType[] -): Observable { + query: Query, + events?: DocumentChangeType[] +): Observable { return collectionChanges(query, events).pipe( - scan( - (current, action) => [...current, ...action], - [] as firestore.DocumentChange[] - ) + scan((current, action) => [...current, ...action], [] as DocumentChange[]) ); } @@ -210,7 +202,7 @@ export function auditTrail( * @param query */ export function collectionData( - query: firestore.Query, + query: Query, idField?: string ): Observable { return collection(query).pipe( diff --git a/packages/rxfire/firestore/document/index.ts b/packages/rxfire/firestore/document/index.ts index a3e91b28190..e908af29735 100644 --- a/packages/rxfire/firestore/document/index.ts +++ b/packages/rxfire/firestore/document/index.ts @@ -15,14 +15,15 @@ * limitations under the License. */ -import { firestore } from 'firebase/app'; +import firebase from 'firebase/app'; import { fromDocRef } from '../fromRef'; import { map } from 'rxjs/operators'; import { Observable } from 'rxjs'; -export function doc( - ref: firestore.DocumentReference -): Observable { +type DocumentReference = firebase.firestore.DocumentReference; +type DocumentSnapshot = firebase.firestore.DocumentSnapshot; + +export function doc(ref: DocumentReference): Observable { return fromDocRef(ref); } @@ -31,16 +32,13 @@ export function doc( * @param query */ export function docData( - ref: firestore.DocumentReference, + ref: DocumentReference, idField?: string ): Observable { return doc(ref).pipe(map(snap => snapToData(snap, idField) as T)); } -export function snapToData( - snapshot: firestore.DocumentSnapshot, - idField?: string -): {} { +export function snapToData(snapshot: DocumentSnapshot, idField?: string): {} { return { ...snapshot.data(), ...(idField ? { [idField]: snapshot.id } : null) diff --git a/packages/rxfire/firestore/fromRef.ts b/packages/rxfire/firestore/fromRef.ts index a5a78f8c4c2..bcd50ebfc46 100644 --- a/packages/rxfire/firestore/fromRef.ts +++ b/packages/rxfire/firestore/fromRef.ts @@ -15,13 +15,19 @@ * limitations under the License. */ -import { firestore } from 'firebase/app'; +import firebase from 'firebase/app'; import { Observable } from 'rxjs'; +type DocumentReference = firebase.firestore.DocumentReference; +type SnapshotListenOptions = firebase.firestore.SnapshotListenOptions; +type Query = firebase.firestore.Query; +type DocumentSnapshot = firebase.firestore.DocumentSnapshot; +type QuerySnapshot = firebase.firestore.QuerySnapshot; + /* eslint-disable @typescript-eslint/no-explicit-any */ function _fromRef( ref: any, - options: firestore.SnapshotListenOptions | undefined + options: SnapshotListenOptions | undefined ): Observable { /* eslint-enable @typescript-eslint/no-explicit-any */ return new Observable(subscriber => { @@ -31,22 +37,22 @@ function _fromRef( } export function fromRef( - ref: firestore.DocumentReference | firestore.Query, - options?: firestore.SnapshotListenOptions + ref: DocumentReference | Query, + options?: SnapshotListenOptions ): Observable<{}> { return _fromRef(ref, options); } export function fromDocRef( - ref: firestore.DocumentReference, - options?: firestore.SnapshotListenOptions -): Observable { - return fromRef(ref, options) as Observable; + ref: DocumentReference, + options?: SnapshotListenOptions +): Observable { + return fromRef(ref, options) as Observable; } export function fromCollectionRef( - ref: firestore.Query, - options?: firestore.SnapshotListenOptions -): Observable { - return fromRef(ref, options) as Observable; + ref: Query, + options?: SnapshotListenOptions +): Observable { + return fromRef(ref, options) as Observable; } diff --git a/packages/rxfire/functions/index.ts b/packages/rxfire/functions/index.ts index b13e5ec3aae..8b633767f34 100644 --- a/packages/rxfire/functions/index.ts +++ b/packages/rxfire/functions/index.ts @@ -17,12 +17,12 @@ // function is used as a namespace to access types // eslint-disable-next-line @typescript-eslint/no-unused-vars -import { functions } from 'firebase/app'; +import firebase from 'firebase/app'; import { from, Observable } from 'rxjs'; import { map } from 'rxjs/operators'; export function httpsCallable( - functions: functions.Functions, + functions: firebase.functions.Functions, name: string ): (data: T) => Observable { const callable = functions.httpsCallable(name); diff --git a/packages/rxfire/package.json b/packages/rxfire/package.json index 2e5e22a6677..8703120d0de 100644 --- a/packages/rxfire/package.json +++ b/packages/rxfire/package.json @@ -32,9 +32,6 @@ "test:browser": "karma start --single-run", "test:browser:debug": "karma start --browsers=Chrome --auto-watch" }, - "main": "dist/index.node.cjs.js", - "browser": "dist/index.cjs.js", - "module": "dist/index.esm.js", "dependencies": { "tslib": "^1.11.1" }, @@ -51,7 +48,6 @@ "rollup-plugin-uglify": "6.0.4", "typescript": "4.0.2" }, - "typings": "dist/index.d.ts", "files": [ "/auth/package.json", "/auth/dist", diff --git a/packages/rxfire/storage/index.ts b/packages/rxfire/storage/index.ts index d9221d3f724..deae52ebc8f 100644 --- a/packages/rxfire/storage/index.ts +++ b/packages/rxfire/storage/index.ts @@ -15,16 +15,21 @@ * limitations under the License. */ -import { storage } from 'firebase/app'; +import firebase from 'firebase/app'; import { Observable, from } from 'rxjs'; import { map } from 'rxjs/operators'; +type UploadTaskSnapshot = firebase.storage.UploadTaskSnapshot; +type Reference = firebase.storage.Reference; +type UploadMetadata = firebase.storage.UploadMetadata; +type StringFormat = firebase.storage.StringFormat; +type UploadTask = firebase.storage.UploadTask; + export function fromTask( - task: storage.UploadTask -): Observable { - return new Observable(subscriber => { - const progress = (snap: storage.UploadTaskSnapshot): void => - subscriber.next(snap); + task: firebase.storage.UploadTask +): Observable { + return new Observable(subscriber => { + const progress = (snap: UploadTaskSnapshot): void => subscriber.next(snap); const error = (e: Error): void => subscriber.error(e); const complete = (): void => subscriber.complete(); task.on('state_changed', progress, error, complete); @@ -32,39 +37,39 @@ export function fromTask( }); } -export function getDownloadURL(ref: storage.Reference): Observable { +export function getDownloadURL(ref: Reference): Observable { return from(ref.getDownloadURL()); } // TODO: fix storage typing in firebase, then apply the same fix here // eslint-disable-next-line @typescript-eslint/no-explicit-any -export function getMetadata(ref: storage.Reference): Observable { +export function getMetadata(ref: Reference): Observable { return from(ref.getMetadata()); } export function put( - ref: storage.Reference, + ref: Reference, // eslint-disable-next-line @typescript-eslint/no-explicit-any data: any, - metadata?: storage.UploadMetadata -): Observable { + metadata?: UploadMetadata +): Observable { return fromTask(ref.put(data, metadata)); } export function putString( - ref: storage.Reference, + ref: Reference, data: string, - format?: storage.StringFormat, - metadata?: storage.UploadMetadata -): Observable { + format?: StringFormat, + metadata?: UploadMetadata +): Observable { return fromTask(ref.putString(data, format, metadata)); } export function percentage( - task: storage.UploadTask + task: UploadTask ): Observable<{ progress: number; - snapshot: storage.UploadTaskSnapshot; + snapshot: UploadTaskSnapshot; }> { return fromTask(task).pipe( map(s => ({ diff --git a/packages/rxfire/test/database.test.ts b/packages/rxfire/test/database.test.ts index 8aed6c78fc1..b7eb0f10a7d 100644 --- a/packages/rxfire/test/database.test.ts +++ b/packages/rxfire/test/database.test.ts @@ -20,7 +20,7 @@ import { expect } from 'chai'; // app/database is used as namespaces to access types // eslint-disable-next-line @typescript-eslint/no-unused-vars -import { initializeApp, database, app } from 'firebase'; +import firebase from 'firebase'; import { fromRef } from '../database/fromRef'; import { list, @@ -50,9 +50,9 @@ const batch = ( }; describe('RxFire Database', () => { - let app: app.App; - let database: database.Database; - const ref = (path: string): database.Reference => { + let app: firebase.app.App; + let database: firebase.database.Database; + const ref = (path: string): firebase.database.Reference => { app!.database().goOffline(); return app!.database().ref(path); }; @@ -61,7 +61,7 @@ describe('RxFire Database', () => { opts: { events?: ListenEvent[]; skipnumber: number } = { skipnumber: 0 } ): { snapChanges: Observable; - ref: database.Reference; + ref: firebase.database.Reference; } { const { events, skipnumber } = opts; const aref = ref(rando()); @@ -88,7 +88,7 @@ describe('RxFire Database', () => { * account for this. */ beforeEach(() => { - app = initializeApp({ + app = firebase.initializeApp({ apiKey: TEST_PROJECT.apiKey, projectId: TEST_PROJECT.projectId, databaseURL: TEST_PROJECT.databaseURL @@ -610,7 +610,7 @@ describe('RxFire Database', () => { opts: { events?: ListenEvent[]; skipnumber: number } = { skipnumber: 0 } ): { changes: Observable; - ref: database.Reference; + ref: firebase.database.Reference; } { const { events, skipnumber } = opts; const aref = ref(rando()); diff --git a/packages/rxfire/test/firestore.test.ts b/packages/rxfire/test/firestore.test.ts index 31085dfe179..535823a90c6 100644 --- a/packages/rxfire/test/firestore.test.ts +++ b/packages/rxfire/test/firestore.test.ts @@ -20,7 +20,7 @@ import { expect } from 'chai'; // app is used as namespaces to access types // eslint-disable-next-line @typescript-eslint/no-unused-vars -import { initializeApp, firestore, app } from 'firebase/app'; +import firebase from 'firebase/app'; import 'firebase/firestore'; import { collection, @@ -42,13 +42,13 @@ const createId = (): string => Math.random().toString(36).substring(5); * makes sure tests don't interfere with each other as they run. */ const createRandomCol = ( - firestore: firestore.Firestore -): firestore.CollectionReference => firestore.collection(createId()); + firestore: firebase.firestore.Firestore +): firebase.firestore.CollectionReference => firestore.collection(createId()); /** * Unwrap a snapshot but add the type property to the data object. */ -const unwrapChange = map((changes: firestore.DocumentChange[]) => { +const unwrapChange = map((changes: firebase.firestore.DocumentChange[]) => { return changes.map(c => ({ type: c.type, ...c.doc.data() })); }); @@ -56,7 +56,7 @@ const unwrapChange = map((changes: firestore.DocumentChange[]) => { * Create an environment for the tests to run in. The information is returned * from the function for use within the test. */ -const seedTest = (firestore: firestore.Firestore): any => { +const seedTest = (firestore: firebase.firestore.Firestore): any => { const colRef = createRandomCol(firestore); const davidDoc = colRef.doc('david'); davidDoc.set({ name: 'David' }); @@ -71,8 +71,8 @@ const seedTest = (firestore: firestore.Firestore): any => { }; describe('RxFire Firestore', () => { - let app: app.App; - let firestore: firestore.Firestore; + let app: firebase.app.App; + let firestore: firebase.firestore.Firestore; /** * Each test runs inside it's own app instance and the app @@ -86,7 +86,7 @@ describe('RxFire Firestore', () => { * offline. */ beforeEach(() => { - app = initializeApp({ projectId: TEST_PROJECT.projectId }); + app = firebase.initializeApp({ projectId: TEST_PROJECT.projectId }); firestore = app.firestore(); firestore.disableNetwork(); }); diff --git a/packages/template/package.json b/packages/template/package.json index 8e33593b52f..353c2b23bb9 100644 --- a/packages/template/package.json +++ b/packages/template/package.json @@ -5,7 +5,7 @@ "description": "A template package for new firebase packages", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.node.cjs.js", - "browser": "dist/index.cjs.js", + "browser": "dist/index.esm.js", "module": "dist/index.esm.js", "esm2017": "dist/index.esm2017.js", "files": ["dist"], diff --git a/packages/template/rollup.config.js b/packages/template/rollup.config.js index b7c34e85a6d..2539715af91 100644 --- a/packages/template/rollup.config.js +++ b/packages/template/rollup.config.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2019 Google Inc. + * Copyright 2019 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -38,10 +38,7 @@ const es5Builds = [ */ { input: 'index.ts', - output: [ - { file: pkg.browser, format: 'cjs', sourcemap: true }, - { file: pkg.module, format: 'es', sourcemap: true } - ], + output: [{ file: pkg.module, format: 'es', sourcemap: true }], plugins: es5BuildPlugins, external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)) }, diff --git a/packages/util/package.json b/packages/util/package.json index c865e210d2c..f3fdfb6a5bc 100644 --- a/packages/util/package.json +++ b/packages/util/package.json @@ -4,7 +4,7 @@ "description": "", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.node.cjs.js", - "browser": "dist/index.cjs.js", + "browser": "dist/index.esm.js", "module": "dist/index.esm.js", "esm2017": "dist/index.esm2017.js", "files": ["dist"], diff --git a/packages/util/rollup.config.js b/packages/util/rollup.config.js index bfdd6985437..0ae738eebf1 100644 --- a/packages/util/rollup.config.js +++ b/packages/util/rollup.config.js @@ -1,6 +1,6 @@ /** * @license - * Copyright 2018 Google Inc. + * Copyright 2018 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -39,10 +39,7 @@ const es5Builds = [ */ { input: 'index.ts', - output: [ - { file: pkg.browser, format: 'cjs', sourcemap: true }, - { file: pkg.module, format: 'es', sourcemap: true } - ], + output: [{ file: pkg.module, format: 'es', sourcemap: true }], plugins: es5BuildPlugins, external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)) }, diff --git a/yarn.lock b/yarn.lock index b8cd43a30a9..c7bc8819b9c 100644 --- a/yarn.lock +++ b/yarn.lock @@ -58,6 +58,15 @@ jsesc "^2.5.1" source-map "^0.5.0" +"@babel/generator@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/generator/-/generator-7.12.1.tgz#0d70be32bdaa03d7c51c8597dda76e0df1f15468" + integrity sha512-DB+6rafIdc9o72Yc3/Ph5h+6hUjeOp66pF0naQBgUFFuPqzQwIlPTm3xZR7YNvduIMtkDIj2t21LSQwnbCrXvg== + dependencies: + "@babel/types" "^7.12.1" + jsesc "^2.5.1" + source-map "^0.5.0" + "@babel/helper-annotate-as-pure@^7.10.4": version "7.10.4" resolved "https://registry.npmjs.org/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.10.4.tgz#5bf0d495a3f757ac3bda48b5bf3b3ba309c72ba3" @@ -151,6 +160,13 @@ dependencies: "@babel/types" "^7.11.0" +"@babel/helper-member-expression-to-functions@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.12.1.tgz#fba0f2fcff3fba00e6ecb664bb5e6e26e2d6165c" + integrity sha512-k0CIe3tXUKTRSoEx1LQEPFU9vRQfqHtl+kf8eNnDqb4AUJEy5pz6aIiog+YWtVm2jpggjS1laH68bPsR+KWWPQ== + dependencies: + "@babel/types" "^7.12.1" + "@babel/helper-module-imports@^7.10.4": version "7.10.4" resolved "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.10.4.tgz#4c5c54be04bd31670a7382797d75b9fa2e5b5620" @@ -158,6 +174,13 @@ dependencies: "@babel/types" "^7.10.4" +"@babel/helper-module-imports@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.12.1.tgz#1644c01591a15a2f084dd6d092d9430eb1d1216c" + integrity sha512-ZeC1TlMSvikvJNy1v/wPIazCu3NdOwgYZLIkmIyAsGhqkNpiDoQQRmaCK8YP4Pq3GPTLPV9WXaPCJKvx06JxKA== + dependencies: + "@babel/types" "^7.12.1" + "@babel/helper-module-transforms@^7.10.4", "@babel/helper-module-transforms@^7.10.5", "@babel/helper-module-transforms@^7.11.0": version "7.11.0" resolved "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.11.0.tgz#b16f250229e47211abdd84b34b64737c2ab2d359" @@ -171,6 +194,21 @@ "@babel/types" "^7.11.0" lodash "^4.17.19" +"@babel/helper-module-transforms@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.12.1.tgz#7954fec71f5b32c48e4b303b437c34453fd7247c" + integrity sha512-QQzehgFAZ2bbISiCpmVGfiGux8YVFXQ0abBic2Envhej22DVXV9nCFaS5hIQbkyo1AdGb+gNME2TSh3hYJVV/w== + dependencies: + "@babel/helper-module-imports" "^7.12.1" + "@babel/helper-replace-supers" "^7.12.1" + "@babel/helper-simple-access" "^7.12.1" + "@babel/helper-split-export-declaration" "^7.11.0" + "@babel/helper-validator-identifier" "^7.10.4" + "@babel/template" "^7.10.4" + "@babel/traverse" "^7.12.1" + "@babel/types" "^7.12.1" + lodash "^4.17.19" + "@babel/helper-optimise-call-expression@^7.10.4": version "7.10.4" resolved "https://registry.npmjs.org/@babel/helper-optimise-call-expression/-/helper-optimise-call-expression-7.10.4.tgz#50dc96413d594f995a77905905b05893cd779673" @@ -210,6 +248,16 @@ "@babel/traverse" "^7.10.4" "@babel/types" "^7.10.4" +"@babel/helper-replace-supers@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/helper-replace-supers/-/helper-replace-supers-7.12.1.tgz#f15c9cc897439281891e11d5ce12562ac0cf3fa9" + integrity sha512-zJjTvtNJnCFsCXVi5rUInstLd/EIVNmIKA1Q9ynESmMBWPWd+7sdR+G4/wdu+Mppfep0XLyG2m7EBPvjCeFyrw== + dependencies: + "@babel/helper-member-expression-to-functions" "^7.12.1" + "@babel/helper-optimise-call-expression" "^7.10.4" + "@babel/traverse" "^7.12.1" + "@babel/types" "^7.12.1" + "@babel/helper-simple-access@^7.10.4": version "7.10.4" resolved "https://registry.npmjs.org/@babel/helper-simple-access/-/helper-simple-access-7.10.4.tgz#0f5ccda2945277a2a7a2d3a821e15395edcf3461" @@ -218,6 +266,13 @@ "@babel/template" "^7.10.4" "@babel/types" "^7.10.4" +"@babel/helper-simple-access@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/helper-simple-access/-/helper-simple-access-7.12.1.tgz#32427e5aa61547d38eb1e6eaf5fd1426fdad9136" + integrity sha512-OxBp7pMrjVewSSC8fXDFrHrBcJATOOFssZwv16F3/6Xtc138GHybBfPbm9kfiqQHKhYQrlamWILwlDCeyMFEaA== + dependencies: + "@babel/types" "^7.12.1" + "@babel/helper-skip-transparent-expression-wrappers@^7.11.0": version "7.11.0" resolved "https://registry.npmjs.org/@babel/helper-skip-transparent-expression-wrappers/-/helper-skip-transparent-expression-wrappers-7.11.0.tgz#eec162f112c2f58d3af0af125e3bb57665146729" @@ -270,6 +325,11 @@ resolved "https://registry.npmjs.org/@babel/parser/-/parser-7.11.5.tgz#c7ff6303df71080ec7a4f5b8c003c58f1cf51037" integrity sha512-X9rD8qqm695vgmeaQ4fvz/o3+Wk4ZzQvSHkDBgpYKxpD4qTAUm88ZKtHkVqIOsYFFbIQ6wQYhC6q7pjqVK0E0Q== +"@babel/parser@^7.12.1": + version "7.12.3" + resolved "https://registry.npmjs.org/@babel/parser/-/parser-7.12.3.tgz#a305415ebe7a6c7023b40b5122a0662d928334cd" + integrity sha512-kFsOS0IbsuhO5ojF8Hc8z/8vEIOkylVBrjiZUbLTE3XFe0Qi+uu6HjzQixkFaqr0ZPAMZcBVxEwmsnsLPZ2Xsw== + "@babel/plugin-proposal-async-generator-functions@^7.10.4": version "7.10.5" resolved "https://registry.npmjs.org/@babel/plugin-proposal-async-generator-functions/-/plugin-proposal-async-generator-functions-7.10.5.tgz#3491cabf2f7c179ab820606cec27fed15e0e8558" @@ -580,6 +640,16 @@ "@babel/helper-plugin-utils" "^7.10.4" babel-plugin-dynamic-import-node "^2.3.3" +"@babel/plugin-transform-modules-commonjs@7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.12.1.tgz#fa403124542636c786cf9b460a0ffbb48a86e648" + integrity sha512-dY789wq6l0uLY8py9c1B48V8mVL5gZh/+PQ5ZPrylPYsnAvnEMjqsUXkuoDVPeVK+0VyGar+D08107LzDQ6pag== + dependencies: + "@babel/helper-module-transforms" "^7.12.1" + "@babel/helper-plugin-utils" "^7.10.4" + "@babel/helper-simple-access" "^7.12.1" + babel-plugin-dynamic-import-node "^2.3.3" + "@babel/plugin-transform-modules-commonjs@^7.10.4": version "7.10.4" resolved "https://registry.npmjs.org/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.10.4.tgz#66667c3eeda1ebf7896d41f1f16b17105a2fbca0" @@ -828,6 +898,21 @@ globals "^11.1.0" lodash "^4.17.19" +"@babel/traverse@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/traverse/-/traverse-7.12.1.tgz#941395e0c5cc86d5d3e75caa095d3924526f0c1e" + integrity sha512-MA3WPoRt1ZHo2ZmoGKNqi20YnPt0B1S0GTZEPhhd+hw2KGUzBlHuVunj6K4sNuK+reEvyiPwtp0cpaqLzJDmAw== + dependencies: + "@babel/code-frame" "^7.10.4" + "@babel/generator" "^7.12.1" + "@babel/helper-function-name" "^7.10.4" + "@babel/helper-split-export-declaration" "^7.11.0" + "@babel/parser" "^7.12.1" + "@babel/types" "^7.12.1" + debug "^4.1.0" + globals "^11.1.0" + lodash "^4.17.19" + "@babel/types@^7.10.4", "@babel/types@^7.10.5", "@babel/types@^7.11.0", "@babel/types@^7.11.5", "@babel/types@^7.4.0", "@babel/types@^7.4.4": version "7.11.5" resolved "https://registry.npmjs.org/@babel/types/-/types-7.11.5.tgz#d9de577d01252d77c6800cee039ee64faf75662d" @@ -837,6 +922,15 @@ lodash "^4.17.19" to-fast-properties "^2.0.0" +"@babel/types@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/types/-/types-7.12.1.tgz#e109d9ab99a8de735be287ee3d6a9947a190c4ae" + integrity sha512-BzSY3NJBKM4kyatSOWh3D/JJ2O3CVzBybHWxtgxnggaxEuaSTTDqeiSb/xk9lrkw2Tbqyivw5ZU4rT+EfznQsA== + dependencies: + "@babel/helper-validator-identifier" "^7.10.4" + lodash "^4.17.19" + to-fast-properties "^2.0.0" + "@changesets/apply-release-plan@^4.0.0": version "4.0.0" resolved "https://registry.npmjs.org/@changesets/apply-release-plan/-/apply-release-plan-4.0.0.tgz#e78efb56a4e459a8dab814ba43045f2ace0f27c9" From 4b540f91dbad217e8ec04b382b4c724308cb3df1 Mon Sep 17 00:00:00 2001 From: Sebastian Schmidt Date: Tue, 20 Oct 2020 10:57:01 -0700 Subject: [PATCH 021/624] Remove JS Input Validation (#3939) --- .changeset/silver-dolls-wave.md | 6 + packages/firestore/exp/src/api/reference.ts | 2 +- packages/firestore/exp/test/shim.ts | 8 +- .../firestore/lite/src/api/field_value.ts | 3 - packages/firestore/lite/src/api/reference.ts | 24 +- packages/firestore/lite/src/api/util.ts | 46 -- packages/firestore/src/api/blob.ts | 13 - packages/firestore/src/api/database.ts | 346 ++------------- packages/firestore/src/api/field_path.ts | 15 +- packages/firestore/src/api/geo_point.ts | 7 - packages/firestore/src/compat/field_value.ts | 12 - .../firestore/src/util/input_validation.ts | 420 ++---------------- .../test/integration/api/validation.test.ts | 274 +----------- 13 files changed, 114 insertions(+), 1062 deletions(-) create mode 100644 .changeset/silver-dolls-wave.md delete mode 100644 packages/firestore/lite/src/api/util.ts diff --git a/.changeset/silver-dolls-wave.md b/.changeset/silver-dolls-wave.md new file mode 100644 index 00000000000..48e605ee641 --- /dev/null +++ b/.changeset/silver-dolls-wave.md @@ -0,0 +1,6 @@ +--- +"firebase": major +"@firebase/firestore": major +--- + +This releases removes all input validation. Please use our TypeScript types to validate API usage. diff --git a/packages/firestore/exp/src/api/reference.ts b/packages/firestore/exp/src/api/reference.ts index 79865a79293..e211ff9f5e6 100644 --- a/packages/firestore/exp/src/api/reference.ts +++ b/packages/firestore/exp/src/api/reference.ts @@ -24,7 +24,7 @@ import { parseUpdateVarargs } from '../../../src/api/user_data_reader'; import { debugAssert } from '../../../src/util/assert'; -import { cast } from '../../../lite/src/api/util'; +import { cast } from '../../../src/util/input_validation'; import { DocumentSnapshot, QuerySnapshot } from './snapshot'; import { applyFirestoreDataConverter, diff --git a/packages/firestore/exp/test/shim.ts b/packages/firestore/exp/test/shim.ts index 400e84a8e03..66a1c08c127 100644 --- a/packages/firestore/exp/test/shim.ts +++ b/packages/firestore/exp/test/shim.ts @@ -65,7 +65,10 @@ import { } from '../../exp/index'; import { UntypedFirestoreDataConverter } from '../../src/api/user_data_reader'; import { isPartialObserver, PartialObserver } from '../../src/api/observer'; -import { isPlainObject } from '../../src/util/input_validation'; +import { + isPlainObject, + validateSetOptions +} from '../../src/util/input_validation'; import { Compat } from '../../src/compat/compat'; export { GeoPoint, Timestamp } from '../index'; @@ -193,6 +196,7 @@ export class Transaction options?: legacy.SetOptions ): Transaction { if (options) { + validateSetOptions('Transaction.set', options); this._delegate.set(documentRef._delegate, unwrap(data), options); } else { this._delegate.set(documentRef._delegate, unwrap(data)); @@ -245,6 +249,7 @@ export class WriteBatch options?: legacy.SetOptions ): WriteBatch { if (options) { + validateSetOptions('WriteBatch.set', options); this._delegate.set(documentRef._delegate, unwrap(data), options); } else { this._delegate.set(documentRef._delegate, unwrap(data)); @@ -324,6 +329,7 @@ export class DocumentReference set(data: Partial, options?: legacy.SetOptions): Promise { if (options) { + validateSetOptions('DocumentReference.set', options); return setDoc(this._delegate, unwrap(data), options); } else { return setDoc(this._delegate, unwrap(data)); diff --git a/packages/firestore/lite/src/api/field_value.ts b/packages/firestore/lite/src/api/field_value.ts index 505d3d3d9a1..63a02c909ad 100644 --- a/packages/firestore/lite/src/api/field_value.ts +++ b/packages/firestore/lite/src/api/field_value.ts @@ -15,7 +15,6 @@ * limitations under the License. */ -import { validateAtLeastNumberOfArgs } from '../../../src/util/input_validation'; import { ArrayRemoveFieldValueImpl, ArrayUnionFieldValueImpl, @@ -69,7 +68,6 @@ export function serverTimestamp(): FieldValue { * `updateDoc()`. */ export function arrayUnion(...elements: unknown[]): FieldValue { - validateAtLeastNumberOfArgs('arrayUnion()', arguments, 1); // NOTE: We don't actually parse the data until it's used in set() or // update() since we'd need the Firestore instance to do this. return new ArrayUnionFieldValueImpl('arrayUnion', elements); @@ -87,7 +85,6 @@ export function arrayUnion(...elements: unknown[]): FieldValue { * `updateDoc()` */ export function arrayRemove(...elements: unknown[]): FieldValue { - validateAtLeastNumberOfArgs('arrayRemove()', arguments, 1); // NOTE: We don't actually parse the data until it's used in set() or // update() since we'd need the Firestore instance to do this. return new ArrayRemoveFieldValueImpl('arrayRemove', elements); diff --git a/packages/firestore/lite/src/api/reference.ts b/packages/firestore/lite/src/api/reference.ts index a19d46654cd..87bb7b4cc52 100644 --- a/packages/firestore/lite/src/api/reference.ts +++ b/packages/firestore/lite/src/api/reference.ts @@ -73,7 +73,7 @@ import { FieldPath } from './field_path'; import { validateCollectionPath, validateDocumentPath, - validateExactNumberOfArgs, + validateNonEmptyArgument, validatePositiveNumber } from '../../../src/util/input_validation'; import { newSerializer } from '../../../src/platform/serializer'; @@ -335,8 +335,6 @@ export function where( opStr: WhereFilterOp, value: unknown ): QueryConstraint { - // TODO(firestorelite): Consider validating the enum strings (note that - // TypeScript does not support passing invalid values). const op = opStr as Operator; const field = fieldPathFromArgument('where', fieldPath); return new QueryFilterConstraint(field, op, value); @@ -381,8 +379,6 @@ export function orderBy( fieldPath: string | FieldPath, directionStr: OrderByDirection = 'asc' ): QueryConstraint { - // TODO(firestorelite): Consider validating the enum strings (note that - // TypeScript does not support passing invalid values). const direction = directionStr as Direction; const path = fieldPathFromArgument('orderBy', fieldPath); return new QueryOrderByConstraint(path, direction); @@ -413,7 +409,7 @@ class QueryLimitConstraint extends QueryConstraint { * @return The created `Query`. */ export function limit(limit: number): QueryConstraint { - validatePositiveNumber('limit', 1, limit); + validatePositiveNumber('limit', limit); return new QueryLimitConstraint('limit', limit, LimitType.First); } @@ -427,7 +423,7 @@ export function limit(limit: number): QueryConstraint { * @return The created `Query`. */ export function limitToLast(limit: number): QueryConstraint { - validatePositiveNumber('limitToLast', 1, limit); + validatePositiveNumber('limitToLast', limit); return new QueryLimitConstraint('limitToLast', limit, LimitType.Last); } @@ -597,7 +593,6 @@ function newQueryBoundFromDocOrFields( before: boolean ): Bound { if (docOrFields[0] instanceof DocumentSnapshot) { - validateExactNumberOfArgs(methodName, docOrFields, 1); return newQueryBoundFromDocument( query._query, query.firestore._databaseId, @@ -1234,16 +1229,3 @@ export function newUserDataReader( serializer ); } - -function validateNonEmptyArgument( - functionName: string, - argumentName: string, - argument?: string -): asserts argument is string { - if (!argument) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - `Function ${functionName}() cannot be called with an empty ${argumentName}.` - ); - } -} diff --git a/packages/firestore/lite/src/api/util.ts b/packages/firestore/lite/src/api/util.ts deleted file mode 100644 index 8ea83ae9593..00000000000 --- a/packages/firestore/lite/src/api/util.ts +++ /dev/null @@ -1,46 +0,0 @@ -/** - * @license - * Copyright 2020 Google LLC - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -import { Code, FirestoreError } from '../../../src/util/error'; - -/** - * Casts `obj` to `T`. Throws if `obj` is not an instance of `T`. - * - * This cast is used in the Lite and Full SDK to verify instance types for - * arguments passed to the public API. - */ -export function cast( - obj: object, - // eslint-disable-next-line @typescript-eslint/no-explicit-any - constructor: { new (...args: any[]): T } -): T | never { - if (!(obj instanceof constructor)) { - if (constructor.name === obj.constructor.name) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - 'Type does not match the expected instance. Did you pass a ' + - `reference from a different Firestore SDK?` - ); - } else { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - `Expected type '${constructor.name}', but was '${obj.constructor.name}'` - ); - } - } - return obj as T; -} diff --git a/packages/firestore/src/api/blob.ts b/packages/firestore/src/api/blob.ts index 119a07217e6..067b3e350aa 100644 --- a/packages/firestore/src/api/blob.ts +++ b/packages/firestore/src/api/blob.ts @@ -17,11 +17,6 @@ import { isBase64Available } from '../platform/base64'; import { Code, FirestoreError } from '../util/error'; -import { - invalidClassError, - validateArgType, - validateExactNumberOfArgs -} from '../util/input_validation'; import { ByteString } from '../util/byte_string'; import { Bytes } from '../../lite/src/api/bytes'; @@ -57,8 +52,6 @@ function assertBase64Available(): void { */ export class Blob extends Bytes { static fromBase64String(base64: string): Blob { - validateExactNumberOfArgs('Blob.fromBase64String', arguments, 1); - validateArgType('Blob.fromBase64String', 'string', 1, base64); assertBase64Available(); try { return new Blob(ByteString.fromBase64String(base64)); @@ -71,22 +64,16 @@ export class Blob extends Bytes { } static fromUint8Array(array: Uint8Array): Blob { - validateExactNumberOfArgs('Blob.fromUint8Array', arguments, 1); assertUint8ArrayAvailable(); - if (!(array instanceof Uint8Array)) { - throw invalidClassError('Blob.fromUint8Array', 'Uint8Array', 1, array); - } return new Blob(ByteString.fromUint8Array(array)); } toBase64(): string { - validateExactNumberOfArgs('Blob.toBase64', arguments, 0); assertBase64Available(); return super.toBase64(); } toUint8Array(): Uint8Array { - validateExactNumberOfArgs('Blob.toUint8Array', arguments, 0); assertUint8ArrayAvailable(); return super.toUint8Array(); } diff --git a/packages/firestore/src/api/database.ts b/packages/firestore/src/api/database.ts index 61e4f35977f..0288762bdf7 100644 --- a/packages/firestore/src/api/database.ts +++ b/packages/firestore/src/api/database.ts @@ -64,6 +64,7 @@ import { findFilterOperator, getFirstOrderByField, getInequalityFilterField, + hasLimitToLast, isCollectionGroupQuery, LimitType, newQueryComparator, @@ -78,8 +79,7 @@ import { queryWithAddedOrderBy, queryWithEndAt, queryWithLimit, - queryWithStartAt, - hasLimitToLast + queryWithStartAt } from '../core/query'; import { Transaction as InternalTransaction } from '../core/transaction'; import { ChangeType, ViewSnapshot } from '../core/view_snapshot'; @@ -94,22 +94,12 @@ import { debugAssert, fail } from '../util/assert'; import { AsyncQueue } from '../util/async_queue'; import { Code, FirestoreError } from '../util/error'; import { - invalidClassError, - validateArgType, - validateAtLeastNumberOfArgs, - validateBetweenNumberOfArgs, - validateDefined, - validateExactNumberOfArgs, - validateNamedOptionalPropertyEquals, - validateNamedOptionalType, - validateNamedType, - validateOptionalArgType, - validateOptionalArrayElements, - validateOptionNames, + cast, + validateIsNotUsedTogether, + validateNonEmptyArgument, validatePositiveNumber, - validateStringEnum, - valueDescription, - validateIsNotUsedTogether + validateSetOptions, + valueDescription } from '../util/input_validation'; import { setLogLevel as setClientLogLevel, logWarn } from '../util/log'; import { AutoId } from '../util/misc'; @@ -151,9 +141,6 @@ import { // settings() defaults: const DEFAULT_HOST = 'firestore.googleapis.com'; const DEFAULT_SSL = true; -const DEFAULT_FORCE_LONG_POLLING = false; -const DEFAULT_FORCE_AUTO_DETECT_LONG_POLLING = false; -const DEFAULT_IGNORE_UNDEFINED_PROPERTIES = false; /** * Constant used to indicate the LRU garbage collection should be disabled. @@ -162,10 +149,6 @@ const DEFAULT_IGNORE_UNDEFINED_PROPERTIES = false; */ export const CACHE_SIZE_UNLIMITED = LruParams.COLLECTION_DISABLED; -// enablePersistence() defaults: -const DEFAULT_SYNCHRONIZE_TABS = false; -const DEFAULT_FORCE_OWNING_TAB = false; - /** Undocumented, private additional settings not exposed in our public API. */ interface PrivateSettings extends PublicSettings { // Can be a google-auth-library or gapi client. @@ -216,46 +199,13 @@ class FirestoreSettings { this.host = DEFAULT_HOST; this.ssl = DEFAULT_SSL; } else { - validateNamedType('settings', 'non-empty string', 'host', settings.host); this.host = settings.host; - - validateNamedOptionalType('settings', 'boolean', 'ssl', settings.ssl); this.ssl = settings.ssl ?? DEFAULT_SSL; } - validateOptionNames('settings', settings, [ - 'host', - 'ssl', - 'credentials', - 'cacheSizeBytes', - 'experimentalForceLongPolling', - 'experimentalAutoDetectLongPolling', - 'ignoreUndefinedProperties' - ]); - validateNamedOptionalType( - 'settings', - 'object', - 'credentials', - settings.credentials - ); this.credentials = settings.credentials; + this.ignoreUndefinedProperties = !!settings.ignoreUndefinedProperties; - validateNamedOptionalType( - 'settings', - 'boolean', - 'ignoreUndefinedProperties', - settings.ignoreUndefinedProperties - ); - - this.ignoreUndefinedProperties = - settings.ignoreUndefinedProperties ?? DEFAULT_IGNORE_UNDEFINED_PROPERTIES; - - validateNamedOptionalType( - 'settings', - 'number', - 'cacheSizeBytes', - settings.cacheSizeBytes - ); if (settings.cacheSizeBytes === undefined) { this.cacheSizeBytes = LruParams.DEFAULT_CACHE_SIZE_BYTES; } else { @@ -272,24 +222,8 @@ class FirestoreSettings { } } - validateNamedOptionalType( - 'settings', - 'boolean', - 'experimentalForceLongPolling', - settings.experimentalForceLongPolling - ); - this.experimentalForceLongPolling = - settings.experimentalForceLongPolling ?? DEFAULT_FORCE_LONG_POLLING; - - validateNamedOptionalType( - 'settings', - 'boolean', - 'experimentalAutoDetectLongPolling', - settings.experimentalAutoDetectLongPolling - ); - this.experimentalAutoDetectLongPolling = - settings.experimentalAutoDetectLongPolling ?? - DEFAULT_FORCE_AUTO_DETECT_LONG_POLLING; + this.experimentalForceLongPolling = !!settings.experimentalForceLongPolling; + this.experimentalAutoDetectLongPolling = !!settings.experimentalAutoDetectLongPolling; validateIsNotUsedTogether( 'experimentalForceLongPolling', @@ -489,9 +423,6 @@ export class Firestore implements PublicFirestore, FirebaseService { } settings(settingsLiteral: PublicSettings): void { - validateExactNumberOfArgs('Firestore.settings', arguments, 1); - validateArgType('Firestore.settings', 'object', 1, settingsLiteral); - if (settingsLiteral.merge) { settingsLiteral = { ...this._settings, ...settingsLiteral }; // Remove the property from the settings once the merge is completed @@ -515,10 +446,6 @@ export class Firestore implements PublicFirestore, FirebaseService { } useEmulator(host: string, port: number): void { - validateExactNumberOfArgs('Firestore.useEmulator', arguments, 2); - validateArgType('Firestore.useEmulator', 'string', 1, host); - validateArgType('Firestore.useEmulator', 'number', 2, port); - if (this._settings.host !== DEFAULT_HOST) { logWarn( 'Host has been set in both settings() and useEmulator(), emulator host will be used' @@ -556,9 +483,8 @@ export class Firestore implements PublicFirestore, FirebaseService { let experimentalForceOwningTab = false; if (settings) { - synchronizeTabs = settings.synchronizeTabs ?? DEFAULT_SYNCHRONIZE_TABS; - experimentalForceOwningTab = - settings.experimentalForceOwningTab ?? DEFAULT_FORCE_OWNING_TAB; + synchronizeTabs = !!settings.synchronizeTabs; + experimentalForceOwningTab = !!settings.experimentalForceOwningTab; validateIsNotUsedTogether( 'synchronizeTabs', @@ -615,7 +541,6 @@ export class Firestore implements PublicFirestore, FirebaseService { arg as PartialObserver ); } else { - validateArgType('Firestore.onSnapshotsInSync', 'function', 1, arg); const observer: PartialObserver = { next: arg as () => void }; @@ -708,8 +633,7 @@ export class Firestore implements PublicFirestore, FirebaseService { }; collection(pathString: string): PublicCollectionReference { - validateExactNumberOfArgs('Firestore.collection', arguments, 1); - validateArgType('Firestore.collection', 'non-empty string', 1, pathString); + validateNonEmptyArgument('Firestore.collection', 'path', pathString); this.ensureClientConfigured(); return new CollectionReference( ResourcePath.fromString(pathString), @@ -719,8 +643,7 @@ export class Firestore implements PublicFirestore, FirebaseService { } doc(pathString: string): PublicDocumentReference { - validateExactNumberOfArgs('Firestore.doc', arguments, 1); - validateArgType('Firestore.doc', 'non-empty string', 1, pathString); + validateNonEmptyArgument('Firestore.doc', 'path', pathString); this.ensureClientConfigured(); return DocumentReference.forPath( ResourcePath.fromString(pathString), @@ -730,11 +653,9 @@ export class Firestore implements PublicFirestore, FirebaseService { } collectionGroup(collectionId: string): PublicQuery { - validateExactNumberOfArgs('Firestore.collectionGroup', arguments, 1); - validateArgType( + validateNonEmptyArgument( 'Firestore.collectionGroup', - 'non-empty string', - 1, + 'collectionId', collectionId ); if (collectionId.indexOf('/') >= 0) { @@ -755,8 +676,6 @@ export class Firestore implements PublicFirestore, FirebaseService { runTransaction( updateFunction: (transaction: PublicTransaction) => Promise ): Promise { - validateExactNumberOfArgs('Firestore.runTransaction', arguments, 1); - validateArgType('Firestore.runTransaction', 'function', 1, updateFunction); return this.ensureClientConfigured().transaction( (transaction: InternalTransaction) => { return updateFunction(new Transaction(this, transaction)); @@ -777,13 +696,6 @@ export class Firestore implements PublicFirestore, FirebaseService { } export function setLogLevel(level: PublicLogLevel): void { - validateExactNumberOfArgs('Firestore.setLogLevel', arguments, 1); - validateStringEnum( - 'setLogLevel', - ['debug', 'error', 'silent', 'warn', 'info', 'verbose'], - 1, - level - ); setClientLogLevel(level); } @@ -799,7 +711,6 @@ export class Transaction implements PublicTransaction { get( documentRef: PublicDocumentReference ): Promise> { - validateExactNumberOfArgs('Transaction.get', arguments, 1); const ref = validateReference( 'Transaction.get', documentRef, @@ -849,7 +760,6 @@ export class Transaction implements PublicTransaction { value: T | Partial, options?: SetOptions ): Transaction { - validateBetweenNumberOfArgs('Transaction.set', arguments, 2, 3); const ref = validateReference( 'Transaction.set', documentRef, @@ -896,7 +806,6 @@ export class Transaction implements PublicTransaction { typeof fieldOrUpdateData === 'string' || fieldOrUpdateData instanceof ExternalFieldPath ) { - validateAtLeastNumberOfArgs('Transaction.update', arguments, 3); ref = validateReference( 'Transaction.update', documentRef, @@ -911,7 +820,6 @@ export class Transaction implements PublicTransaction { moreFieldsAndValues ); } else { - validateExactNumberOfArgs('Transaction.update', arguments, 2); ref = validateReference( 'Transaction.update', documentRef, @@ -930,7 +838,6 @@ export class Transaction implements PublicTransaction { } delete(documentRef: PublicDocumentReference): Transaction { - validateExactNumberOfArgs('Transaction.delete', arguments, 1); const ref = validateReference( 'Transaction.delete', documentRef, @@ -958,7 +865,6 @@ export class WriteBatch implements PublicWriteBatch { value: T | Partial, options?: SetOptions ): WriteBatch { - validateBetweenNumberOfArgs('WriteBatch.set', arguments, 2, 3); this.verifyNotCommitted(); const ref = validateReference( 'WriteBatch.set', @@ -1010,7 +916,6 @@ export class WriteBatch implements PublicWriteBatch { typeof fieldOrUpdateData === 'string' || fieldOrUpdateData instanceof ExternalFieldPath ) { - validateAtLeastNumberOfArgs('WriteBatch.update', arguments, 3); ref = validateReference( 'WriteBatch.update', documentRef, @@ -1025,7 +930,6 @@ export class WriteBatch implements PublicWriteBatch { moreFieldsAndValues ); } else { - validateExactNumberOfArgs('WriteBatch.update', arguments, 2); ref = validateReference( 'WriteBatch.update', documentRef, @@ -1046,7 +950,6 @@ export class WriteBatch implements PublicWriteBatch { } delete(documentRef: PublicDocumentReference): WriteBatch { - validateExactNumberOfArgs('WriteBatch.delete', arguments, 1); this.verifyNotCommitted(); const ref = validateReference( 'WriteBatch.delete', @@ -1130,11 +1033,9 @@ export class DocumentReference } collection(pathString: string): PublicCollectionReference { - validateExactNumberOfArgs('DocumentReference.collection', arguments, 1); - validateArgType( + validateNonEmptyArgument( 'DocumentReference.collection', - 'non-empty string', - 1, + 'path', pathString ); if (!pathString) { @@ -1153,7 +1054,7 @@ export class DocumentReference isEqual(other: PublicDocumentReference): boolean { if (!(other instanceof DocumentReference)) { - throw invalidClassError('isEqual', 'DocumentReference', 1, other); + return false; } return ( this.firestore === other.firestore && @@ -1165,7 +1066,6 @@ export class DocumentReference set(value: Partial, options: SetOptions): Promise; set(value: T): Promise; set(value: T | Partial, options?: SetOptions): Promise { - validateBetweenNumberOfArgs('DocumentReference.set', arguments, 1, 2); options = validateSetOptions('DocumentReference.set', options); const convertedValue = applyFirestoreDataConverter( this._converter, @@ -1202,7 +1102,6 @@ export class DocumentReference typeof fieldOrUpdateData === 'string' || fieldOrUpdateData instanceof ExternalFieldPath ) { - validateAtLeastNumberOfArgs('DocumentReference.update', arguments, 2); parsed = parseUpdateVarargs( this.firestore._dataReader, 'DocumentReference.update', @@ -1212,7 +1111,6 @@ export class DocumentReference moreFieldsAndValues ); } else { - validateExactNumberOfArgs('DocumentReference.update', arguments, 1); parsed = parseUpdateData( this.firestore._dataReader, 'DocumentReference.update', @@ -1227,7 +1125,6 @@ export class DocumentReference } delete(): Promise { - validateExactNumberOfArgs('DocumentReference.delete', arguments, 0); return this._firestoreClient.write([ new DeleteMutation(this._key, Precondition.none()) ]); @@ -1251,12 +1148,6 @@ export class DocumentReference ): Unsubscribe; onSnapshot(...args: unknown[]): Unsubscribe { - validateBetweenNumberOfArgs( - 'DocumentReference.onSnapshot', - arguments, - 1, - 4 - ); let options: ListenOptions = { includeMetadataChanges: false }; @@ -1266,15 +1157,6 @@ export class DocumentReference !isPartialObserver(args[currArg]) ) { options = args[currArg] as SnapshotListenOptions; - validateOptionNames('DocumentReference.onSnapshot', options, [ - 'includeMetadataChanges' - ]); - validateNamedOptionalType( - 'DocumentReference.onSnapshot', - 'boolean', - 'includeMetadataChanges', - options.includeMetadataChanges - ); currArg++; } @@ -1289,25 +1171,6 @@ export class DocumentReference args[currArg] = userObserver.next?.bind(userObserver); args[currArg + 1] = userObserver.error?.bind(userObserver); args[currArg + 2] = userObserver.complete?.bind(userObserver); - } else { - validateArgType( - 'DocumentReference.onSnapshot', - 'function', - currArg, - args[currArg] - ); - validateOptionalArgType( - 'DocumentReference.onSnapshot', - 'function', - currArg + 1, - args[currArg + 1] - ); - validateOptionalArgType( - 'DocumentReference.onSnapshot', - 'function', - currArg + 2, - args[currArg + 2] - ); } const observer: PartialObserver = { @@ -1330,9 +1193,6 @@ export class DocumentReference } get(options?: GetOptions): Promise> { - validateBetweenNumberOfArgs('DocumentReference.get', arguments, 0, 1); - validateGetOptions('DocumentReference.get', options); - const firestoreClient = this.firestore.ensureClientConfigured(); if (options && options.source === 'cache') { return firestoreClient @@ -1442,9 +1302,7 @@ export class DocumentSnapshot private readonly _converter: FirestoreDataConverter | null ) {} - data(options?: PublicSnapshotOptions): T | undefined { - validateBetweenNumberOfArgs('DocumentSnapshot.data', arguments, 0, 1); - options = validateSnapshotOptions('DocumentSnapshot.data', options); + data(options: PublicSnapshotOptions = {}): T | undefined { if (!this._document) { return undefined; } else { @@ -1475,10 +1333,8 @@ export class DocumentSnapshot get( fieldPath: string | ExternalFieldPath, - options?: PublicSnapshotOptions + options: PublicSnapshotOptions = {} ): unknown { - validateBetweenNumberOfArgs('DocumentSnapshot.get', arguments, 1, 2); - options = validateSnapshotOptions('DocumentSnapshot.get', options); if (this._document) { const value = this._document .data() @@ -1520,7 +1376,7 @@ export class DocumentSnapshot isEqual(other: PublicDocumentSnapshot): boolean { if (!(other instanceof DocumentSnapshot)) { - throw invalidClassError('isEqual', 'DocumentSnapshot', 1, other); + return false; } return ( this._firestore === other._firestore && @@ -1968,24 +1824,6 @@ export class Query implements PublicQuery { opStr: WhereFilterOp, value: unknown ): PublicQuery { - validateExactNumberOfArgs('Query.where', arguments, 3); - validateDefined('Query.where', 3, value); - - // Enumerated from the WhereFilterOp type in index.d.ts. - const whereFilterOpEnums = [ - Operator.LESS_THAN, - Operator.LESS_THAN_OR_EQUAL, - Operator.EQUAL, - Operator.NOT_EQUAL, - Operator.GREATER_THAN_OR_EQUAL, - Operator.GREATER_THAN, - Operator.ARRAY_CONTAINS, - Operator.IN, - Operator.ARRAY_CONTAINS_ANY, - Operator.NOT_IN - ]; - const op = validateStringEnum('Query.where', whereFilterOpEnums, 2, opStr); - const fieldPath = fieldPathFromArgument('Query.where', field); const filter = newQueryFilter( this._query, @@ -1993,7 +1831,7 @@ export class Query implements PublicQuery { this.firestore._dataReader, this.firestore._databaseId, fieldPath, - op, + opStr as Operator, value ); return new Query( @@ -2007,13 +1845,6 @@ export class Query implements PublicQuery { field: string | ExternalFieldPath, directionStr?: OrderByDirection ): PublicQuery { - validateBetweenNumberOfArgs('Query.orderBy', arguments, 1, 2); - validateOptionalArgType( - 'Query.orderBy', - 'non-empty string', - 2, - directionStr - ); let direction: Direction; if (directionStr === undefined || directionStr === 'asc') { direction = Direction.ASCENDING; @@ -2036,9 +1867,7 @@ export class Query implements PublicQuery { } limit(n: number): PublicQuery { - validateExactNumberOfArgs('Query.limit', arguments, 1); - validateArgType('Query.limit', 'number', 1, n); - validatePositiveNumber('Query.limit', 1, n); + validatePositiveNumber('Query.limit', n); return new Query( queryWithLimit(this._query, n, LimitType.First), this.firestore, @@ -2047,9 +1876,7 @@ export class Query implements PublicQuery { } limitToLast(n: number): PublicQuery { - validateExactNumberOfArgs('Query.limitToLast', arguments, 1); - validateArgType('Query.limitToLast', 'number', 1, n); - validatePositiveNumber('Query.limitToLast', 1, n); + validatePositiveNumber('Query.limitToLast', n); return new Query( queryWithLimit(this._query, n, LimitType.Last), this.firestore, @@ -2061,7 +1888,6 @@ export class Query implements PublicQuery { docOrField: unknown | PublicDocumentSnapshot, ...fields: unknown[] ): PublicQuery { - validateAtLeastNumberOfArgs('Query.startAt', arguments, 1); const bound = this.boundFromDocOrFields( 'Query.startAt', docOrField, @@ -2079,7 +1905,6 @@ export class Query implements PublicQuery { docOrField: unknown | PublicDocumentSnapshot, ...fields: unknown[] ): PublicQuery { - validateAtLeastNumberOfArgs('Query.startAfter', arguments, 1); const bound = this.boundFromDocOrFields( 'Query.startAfter', docOrField, @@ -2097,7 +1922,6 @@ export class Query implements PublicQuery { docOrField: unknown | PublicDocumentSnapshot, ...fields: unknown[] ): PublicQuery { - validateAtLeastNumberOfArgs('Query.endBefore', arguments, 1); const bound = this.boundFromDocOrFields( 'Query.endBefore', docOrField, @@ -2115,7 +1939,6 @@ export class Query implements PublicQuery { docOrField: unknown | PublicDocumentSnapshot, ...fields: unknown[] ): PublicQuery { - validateAtLeastNumberOfArgs('Query.endAt', arguments, 1); const bound = this.boundFromDocOrFields( 'Query.endAt', docOrField, @@ -2131,7 +1954,7 @@ export class Query implements PublicQuery { isEqual(other: PublicQuery): boolean { if (!(other instanceof Query)) { - throw invalidClassError('isEqual', 'Query', 1, other); + return false; } return ( this.firestore === other.firestore && @@ -2151,9 +1974,7 @@ export class Query implements PublicQuery { fields: unknown[], before: boolean ): Bound { - validateDefined(methodName, 1, docOrField); if (docOrField instanceof DocumentSnapshot) { - validateExactNumberOfArgs(methodName, [docOrField, ...fields], 1); return newQueryBoundFromDocument( this._query, this.firestore._databaseId, @@ -2192,7 +2013,6 @@ export class Query implements PublicQuery { ): Unsubscribe; onSnapshot(...args: unknown[]): Unsubscribe { - validateBetweenNumberOfArgs('Query.onSnapshot', arguments, 1, 4); let options: ListenOptions = {}; let currArg = 0; if ( @@ -2200,15 +2020,6 @@ export class Query implements PublicQuery { !isPartialObserver(args[currArg]) ) { options = args[currArg] as SnapshotListenOptions; - validateOptionNames('Query.onSnapshot', options, [ - 'includeMetadataChanges' - ]); - validateNamedOptionalType( - 'Query.onSnapshot', - 'boolean', - 'includeMetadataChanges', - options.includeMetadataChanges - ); currArg++; } @@ -2220,19 +2031,6 @@ export class Query implements PublicQuery { args[currArg + 1] = userObserver.error?.bind(userObserver); args[currArg + 2] = userObserver.complete?.bind(userObserver); } else { - validateArgType('Query.onSnapshot', 'function', currArg, args[currArg]); - validateOptionalArgType( - 'Query.onSnapshot', - 'function', - currArg + 1, - args[currArg + 1] - ); - validateOptionalArgType( - 'Query.onSnapshot', - 'function', - currArg + 2, - args[currArg + 2] - ); } const observer: PartialObserver = { @@ -2258,7 +2056,6 @@ export class Query implements PublicQuery { } get(options?: GetOptions): Promise> { - validateBetweenNumberOfArgs('Query.get', arguments, 0, 1); validateGetOptions('Query.get', options); validateHasExplicitOrderByForLimitToLast(this._query); @@ -2309,8 +2106,6 @@ export class QuerySnapshot implements PublicQuerySnapshot { callback: (result: PublicQueryDocumentSnapshot) => void, thisArg?: unknown ): void { - validateBetweenNumberOfArgs('QuerySnapshot.forEach', arguments, 1, 2); - validateArgType('QuerySnapshot.forEach', 'function', 1, callback); this._snapshot.docs.forEach(doc => { callback.call( thisArg, @@ -2329,15 +2124,6 @@ export class QuerySnapshot implements PublicQuerySnapshot { docChanges(options?: SnapshotListenOptions): Array> { if (options) { - validateOptionNames('QuerySnapshot.docChanges', options, [ - 'includeMetadataChanges' - ]); - validateNamedOptionalType( - 'QuerySnapshot.docChanges', - 'boolean', - 'includeMetadataChanges', - options.includeMetadataChanges - ); } const includeMetadataChanges = !!( @@ -2370,7 +2156,7 @@ export class QuerySnapshot implements PublicQuerySnapshot { /** Check the equality. The call can be very expensive. */ isEqual(other: PublicQuerySnapshot): boolean { if (!(other instanceof QuerySnapshot)) { - throw invalidClassError('isEqual', 'QuerySnapshot', 1, other); + return false; } return ( @@ -2438,18 +2224,12 @@ export class CollectionReference } doc(pathString?: string): PublicDocumentReference { - validateBetweenNumberOfArgs('CollectionReference.doc', arguments, 0, 1); // We allow omission of 'pathString' but explicitly prohibit passing in both // 'undefined' and 'null'. if (arguments.length === 0) { pathString = AutoId.newId(); } - validateArgType( - 'CollectionReference.doc', - 'non-empty string', - 1, - pathString - ); + validateNonEmptyArgument('CollectionReference.doc', 'path', pathString); const path = ResourcePath.fromString(pathString!); return DocumentReference.forPath( this._query.path.child(path), @@ -2459,12 +2239,9 @@ export class CollectionReference } add(value: T): Promise> { - validateExactNumberOfArgs('CollectionReference.add', arguments, 1); const convertedValue = this._converter ? this._converter.toFirestore(value) : value; - validateArgType('CollectionReference.add', 'object', 1, convertedValue); - const docRef = this.doc(); // Call set() with the converted value directly to avoid calling toFirestore() a second time. @@ -2484,71 +2261,11 @@ export class CollectionReference } } -function validateSetOptions( - methodName: string, - options: SetOptions | undefined -): SetOptions { - if (options === undefined) { - return { - merge: false - }; - } - - validateOptionNames(methodName, options, ['merge', 'mergeFields']); - validateNamedOptionalType(methodName, 'boolean', 'merge', options.merge); - validateOptionalArrayElements( - methodName, - 'mergeFields', - 'a string or a FieldPath', - options.mergeFields, - element => - typeof element === 'string' || element instanceof ExternalFieldPath - ); - - if (options.mergeFields !== undefined && options.merge !== undefined) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - `Invalid options passed to function ${methodName}(): You cannot specify both "merge" ` + - `and "mergeFields".` - ); - } - - return options; -} - -function validateSnapshotOptions( - methodName: string, - options: PublicSnapshotOptions | undefined -): PublicSnapshotOptions { - if (options === undefined) { - return {}; - } - - validateOptionNames(methodName, options, ['serverTimestamps']); - validateNamedOptionalPropertyEquals( - methodName, - 'options', - 'serverTimestamps', - options.serverTimestamps, - ['estimate', 'previous', 'none'] - ); - return options; -} - function validateGetOptions( methodName: string, options: GetOptions | undefined ): void { - validateOptionalArgType(methodName, 'object', 1, options); if (options) { - validateOptionNames(methodName, options, ['source']); - validateNamedOptionalPropertyEquals( - methodName, - 'options', - 'source', - options.source, - ['default', 'server', 'cache'] - ); } } @@ -2557,15 +2274,14 @@ function validateReference( documentRef: PublicDocumentReference, firestore: Firestore ): _DocumentKeyReference { - if (!(documentRef instanceof _DocumentKeyReference)) { - throw invalidClassError(methodName, 'DocumentReference', 1, documentRef); - } else if (documentRef.firestore !== firestore) { + const reference = cast>(documentRef, DocumentReference); + if (reference.firestore !== firestore) { throw new FirestoreError( Code.INVALID_ARGUMENT, 'Provided document reference is from a different Firestore instance.' ); } else { - return documentRef; + return reference; } } diff --git a/packages/firestore/src/api/field_path.ts b/packages/firestore/src/api/field_path.ts index b0017a9d7e4..4008a9936c1 100644 --- a/packages/firestore/src/api/field_path.ts +++ b/packages/firestore/src/api/field_path.ts @@ -19,11 +19,6 @@ import { FieldPath as PublicFieldPath } from '@firebase/firestore-types'; import { FieldPath as InternalFieldPath } from '../model/path'; import { Code, FirestoreError } from '../util/error'; -import { - invalidClassError, - validateArgType, - validateNamedArrayAtLeastNumberOfElements -} from '../util/input_validation'; // The objects that are a part of this API are exposed to third-parties as // compiled javascript so we want to flag our private members with a leading @@ -40,15 +35,7 @@ export abstract class _BaseFieldPath { readonly _internalPath: InternalFieldPath; constructor(fieldNames: string[]) { - validateNamedArrayAtLeastNumberOfElements( - 'FieldPath', - fieldNames, - 'fieldNames', - 1 - ); - for (let i = 0; i < fieldNames.length; ++i) { - validateArgType('FieldPath', 'string', i, fieldNames[i]); if (fieldNames[i].length === 0) { throw new FirestoreError( Code.INVALID_ARGUMENT, @@ -90,7 +77,7 @@ export class FieldPath extends _BaseFieldPath implements PublicFieldPath { isEqual(other: PublicFieldPath): boolean { if (!(other instanceof FieldPath)) { - throw invalidClassError('isEqual', 'FieldPath', 1, other); + return false; } return this._internalPath.isEqual(other._internalPath); } diff --git a/packages/firestore/src/api/geo_point.ts b/packages/firestore/src/api/geo_point.ts index 18b3ff08c01..fd60b454490 100644 --- a/packages/firestore/src/api/geo_point.ts +++ b/packages/firestore/src/api/geo_point.ts @@ -16,10 +16,6 @@ */ import { Code, FirestoreError } from '../util/error'; -import { - validateArgType, - validateExactNumberOfArgs -} from '../util/input_validation'; import { primitiveComparator } from '../util/misc'; /** @@ -42,9 +38,6 @@ export class GeoPoint { * @param longitude The longitude as number between -180 and 180. */ constructor(latitude: number, longitude: number) { - validateExactNumberOfArgs('GeoPoint', arguments, 2); - validateArgType('GeoPoint', 'number', 1, latitude); - validateArgType('GeoPoint', 'number', 2, longitude); if (!isFinite(latitude) || latitude < -90 || latitude > 90) { throw new FirestoreError( Code.INVALID_ARGUMENT, diff --git a/packages/firestore/src/compat/field_value.ts b/packages/firestore/src/compat/field_value.ts index 94951b20fad..54ed982743e 100644 --- a/packages/firestore/src/compat/field_value.ts +++ b/packages/firestore/src/compat/field_value.ts @@ -24,48 +24,36 @@ import { increment } from '../../exp/index'; import * as legacy from '@firebase/firestore-types'; -import { - validateArgType, - validateAtLeastNumberOfArgs, - validateExactNumberOfArgs, - validateNoArgs -} from '../util/input_validation'; import { Compat } from './compat'; export class FieldValue extends Compat implements legacy.FieldValue { static serverTimestamp(): FieldValue { - validateNoArgs('FieldValue.serverTimestamp', arguments); const delegate = serverTimestamp(); delegate._methodName = 'FieldValue.serverTimestamp'; return new FieldValue(delegate); } static delete(): FieldValue { - validateNoArgs('FieldValue.delete', arguments); const delegate = deleteField(); delegate._methodName = 'FieldValue.delete'; return new FieldValue(delegate); } static arrayUnion(...elements: unknown[]): FieldValue { - validateAtLeastNumberOfArgs('FieldValue.arrayUnion', arguments, 1); const delegate = arrayUnion(...elements); delegate._methodName = 'FieldValue.arrayUnion'; return new FieldValue(delegate); } static arrayRemove(...elements: unknown[]): FieldValue { - validateAtLeastNumberOfArgs('FieldValue.arrayRemove', arguments, 1); const delegate = arrayRemove(...elements); delegate._methodName = 'FieldValue.arrayRemove'; return new FieldValue(delegate); } static increment(n: number): FieldValue { - validateArgType('FieldValue.increment', 'number', 1, n); - validateExactNumberOfArgs('FieldValue.increment', arguments, 1); const delegate = increment(n); delegate._methodName = 'FieldValue.increment'; return new FieldValue(delegate); diff --git a/packages/firestore/src/util/input_validation.ts b/packages/firestore/src/util/input_validation.ts index 4f97a13f8e7..4d3402904d9 100644 --- a/packages/firestore/src/util/input_validation.ts +++ b/packages/firestore/src/util/input_validation.ts @@ -14,9 +14,10 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +import { SetOptions } from '@firebase/firestore-types'; import { fail } from './assert'; import { Code, FirestoreError } from './error'; -import { Dict, forEach } from './obj'; import { DocumentKey } from '../model/document_key'; import { ResourcePath } from '../model/path'; @@ -30,173 +31,38 @@ export type ValidationType = | 'string' | 'non-empty string'; -/** - * Validates that no arguments were passed in the invocation of functionName. - * - * Forward the magic "arguments" variable as second parameter on which the - * parameter validation is performed: - * validateNoArgs('myFunction', arguments); - */ -export function validateNoArgs(functionName: string, args: IArguments): void { - if (args.length !== 0) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - `Function ${functionName}() does not support arguments, ` + - 'but was called with ' + - formatPlural(args.length, 'argument') + - '.' - ); - } -} - -/** - * Validates the invocation of functionName has the exact number of arguments. - * - * Forward the magic "arguments" variable as second parameter on which the - * parameter validation is performed: - * validateExactNumberOfArgs('myFunction', arguments, 2); - */ -export function validateExactNumberOfArgs( +export function validateNonEmptyArgument( functionName: string, - args: ArrayLike, - numberOfArgs: number -): void { - if (args.length !== numberOfArgs) { + argumentName: string, + argument?: string +): asserts argument is string { + if (!argument) { throw new FirestoreError( Code.INVALID_ARGUMENT, - `Function ${functionName}() requires ` + - formatPlural(numberOfArgs, 'argument') + - ', but was called with ' + - formatPlural(args.length, 'argument') + - '.' + `Function ${functionName}() cannot be called with an empty ${argumentName}.` ); } } -/** - * Validates the invocation of functionName has at least the provided number of - * arguments (but can have many more). - * - * Forward the magic "arguments" variable as second parameter on which the - * parameter validation is performed: - * validateAtLeastNumberOfArgs('myFunction', arguments, 2); - */ -export function validateAtLeastNumberOfArgs( - functionName: string, - args: IArguments, - minNumberOfArgs: number -): void { - if (args.length < minNumberOfArgs) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - `Function ${functionName}() requires at least ` + - formatPlural(minNumberOfArgs, 'argument') + - ', but was called with ' + - formatPlural(args.length, 'argument') + - '.' - ); +export function validateSetOptions( + methodName: string, + options: SetOptions | undefined +): SetOptions { + if (options === undefined) { + return { + merge: false + }; } -} -/** - * Validates the invocation of functionName has number of arguments between - * the values provided. - * - * Forward the magic "arguments" variable as second parameter on which the - * parameter validation is performed: - * validateBetweenNumberOfArgs('myFunction', arguments, 2, 3); - */ -export function validateBetweenNumberOfArgs( - functionName: string, - args: IArguments, - minNumberOfArgs: number, - maxNumberOfArgs: number -): void { - if (args.length < minNumberOfArgs || args.length > maxNumberOfArgs) { + if (options.mergeFields !== undefined && options.merge !== undefined) { throw new FirestoreError( Code.INVALID_ARGUMENT, - `Function ${functionName}() requires between ${minNumberOfArgs} and ` + - `${maxNumberOfArgs} arguments, but was called with ` + - formatPlural(args.length, 'argument') + - '.' + `Invalid options passed to function ${methodName}(): You cannot ` + + 'specify both "merge" and "mergeFields".' ); } -} - -/** - * Validates the provided argument is an array and has as least the expected - * number of elements. - */ -export function validateNamedArrayAtLeastNumberOfElements( - functionName: string, - value: T[], - name: string, - minNumberOfElements: number -): void { - if (!(value instanceof Array) || value.length < minNumberOfElements) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - `Function ${functionName}() requires its ${name} argument to be an ` + - 'array with at least ' + - `${formatPlural(minNumberOfElements, 'element')}.` - ); - } -} - -/** - * Validates the provided positional argument has the native JavaScript type - * using typeof checks. - */ -export function validateArgType( - functionName: string, - type: ValidationType, - position: number, - argument: unknown -): void { - validateType(functionName, type, `${ordinal(position)} argument`, argument); -} - -/** - * Validates the provided argument has the native JavaScript type using - * typeof checks or is undefined. - */ -export function validateOptionalArgType( - functionName: string, - type: ValidationType, - position: number, - argument: unknown -): void { - if (argument !== undefined) { - validateArgType(functionName, type, position, argument); - } -} -/** - * Validates the provided named option has the native JavaScript type using - * typeof checks. - */ -export function validateNamedType( - functionName: string, - type: ValidationType, - optionName: string, - argument: unknown -): void { - validateType(functionName, type, `${optionName} option`, argument); -} - -/** - * Validates the provided named option has the native JavaScript type using - * typeof checks or is undefined. - */ -export function validateNamedOptionalType( - functionName: string, - type: ValidationType, - optionName: string, - argument: unknown -): void { - if (argument !== undefined) { - validateNamedType(functionName, type, optionName, argument); - } + return options; } /** @@ -216,126 +82,6 @@ export function validateIsNotUsedTogether( } } -export function validateArrayElements( - functionName: string, - optionName: string, - typeDescription: string, - argument: T[], - validator: (arg0: T) => boolean -): void { - if (!(argument instanceof Array)) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - `Function ${functionName}() requires its ${optionName} ` + - `option to be an array, but it was: ${valueDescription(argument)}` - ); - } - - for (let i = 0; i < argument.length; ++i) { - if (!validator(argument[i])) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - `Function ${functionName}() requires all ${optionName} ` + - `elements to be ${typeDescription}, but the value at index ${i} ` + - `was: ${valueDescription(argument[i])}` - ); - } - } -} - -export function validateOptionalArrayElements( - functionName: string, - optionName: string, - typeDescription: string, - argument: T[] | undefined, - validator: (arg0: T) => boolean -): void { - if (argument !== undefined) { - validateArrayElements( - functionName, - optionName, - typeDescription, - argument, - validator - ); - } -} - -/** - * Validates that the provided named option equals one of the expected values. - */ -export function validateNamedPropertyEquals( - functionName: string, - inputName: string, - optionName: string, - input: T, - expected: T[] -): void { - const expectedDescription: string[] = []; - - for (const val of expected) { - if (val === input) { - return; - } - expectedDescription.push(valueDescription(val)); - } - - const actualDescription = valueDescription(input); - throw new FirestoreError( - Code.INVALID_ARGUMENT, - `Invalid value ${actualDescription} provided to function ${functionName}() for option ` + - `"${optionName}". Acceptable values: ${expectedDescription.join(', ')}` - ); -} - -/** - * Validates that the provided named option equals one of the expected values or - * is undefined. - */ -export function validateNamedOptionalPropertyEquals( - functionName: string, - inputName: string, - optionName: string, - input: T, - expected: T[] -): void { - if (input !== undefined) { - validateNamedPropertyEquals( - functionName, - inputName, - optionName, - input, - expected - ); - } -} - -/** - * Validates that the provided argument is a valid enum. - * - * @param functionName Function making the validation call. - * @param enums Array containing all possible values for the enum. - * @param position Position of the argument in `functionName`. - * @param argument Argument to validate. - * @return The value as T if the argument can be converted. - */ -export function validateStringEnum( - functionName: string, - enums: T[], - position: number, - argument: unknown -): T { - if (!enums.some(element => element === argument)) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - `Invalid value ${valueDescription(argument)} provided to function ` + - `${functionName}() for its ${ordinal(position)} argument. Acceptable ` + - `values: ${enums.join(', ')}` - ); - } - return argument as T; -} - /** * Validates that `path` refers to a document (indicated by the fact it contains * an even numbers of segments). @@ -362,32 +108,6 @@ export function validateCollectionPath(path: ResourcePath): void { } } -/** Helper to validate the type of a provided input. */ -function validateType( - functionName: string, - type: ValidationType, - inputName: string, - input: unknown -): void { - let valid = false; - if (type === 'object') { - valid = isPlainObject(input); - } else if (type === 'non-empty string') { - valid = typeof input === 'string' && input !== ''; - } else { - valid = typeof input === type; - } - - if (!valid) { - const description = valueDescription(input); - throw new FirestoreError( - Code.INVALID_ARGUMENT, - `Function ${functionName}() requires its ${inputName} ` + - `to be of type ${type}, but it was: ${description}` - ); - } -} - /** * Returns true if it's a non-null object without a custom prototype * (i.e. excludes Array, Date, etc.). @@ -444,92 +164,40 @@ export function tryGetCustomObjectType(input: object): string | null { return null; } -/** Validates the provided argument is defined. */ -export function validateDefined( - functionName: string, - position: number, - argument: unknown -): void { - if (argument === undefined) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - `Function ${functionName}() requires a valid ${ordinal(position)} ` + - `argument, but it was undefined.` - ); - } -} - /** - * Validates the provided positional argument is an object, and its keys and - * values match the expected keys and types provided in optionTypes. - */ -export function validateOptionNames( - functionName: string, - options: object, - optionNames: string[] -): void { - forEach(options as Dict, (key, _) => { - if (optionNames.indexOf(key) < 0) { + * Casts `obj` to `T`. Throws if `obj` is not an instance of `T`. + * + * This cast is used in the Lite and Full SDK to verify instance types for + * arguments passed to the public API. + */ +export function cast( + obj: object, + // eslint-disable-next-line @typescript-eslint/no-explicit-any + constructor: { new (...args: any[]): T } +): T | never { + if (!(obj instanceof constructor)) { + if (constructor.name === obj.constructor.name) { + throw new FirestoreError( + Code.INVALID_ARGUMENT, + 'Type does not match the expected instance. Did you pass a ' + + `reference from a different Firestore SDK?` + ); + } else { + const description = valueDescription(obj); throw new FirestoreError( Code.INVALID_ARGUMENT, - `Unknown option '${key}' passed to function ${functionName}(). ` + - 'Available options: ' + - optionNames.join(', ') + `Expected type '${constructor.name}', but it was: ${description}` ); } - }); -} - -/** - * Helper method to throw an error that the provided argument did not pass - * an instanceof check. - */ -export function invalidClassError( - functionName: string, - type: string, - position: number, - argument: unknown -): Error { - const description = valueDescription(argument); - return new FirestoreError( - Code.INVALID_ARGUMENT, - `Function ${functionName}() requires its ${ordinal(position)} ` + - `argument to be a ${type}, but it was: ${description}` - ); + } + return obj as T; } -export function validatePositiveNumber( - functionName: string, - position: number, - n: number -): void { +export function validatePositiveNumber(functionName: string, n: number): void { if (n <= 0) { throw new FirestoreError( Code.INVALID_ARGUMENT, - `Function ${functionName}() requires its ${ordinal( - position - )} argument to be a positive number, but it was: ${n}.` + `Function ${functionName}() requires a positive number, but it was: ${n}.` ); } } - -/** Converts a number to its english word representation */ -function ordinal(num: number): string { - switch (num) { - case 1: - return 'first'; - case 2: - return 'second'; - case 3: - return 'third'; - default: - return num + 'th'; - } -} - -/** - * Formats the given word as plural conditionally given the preceding number. - */ -function formatPlural(num: number, str: string): string { - return `${num} ${str}` + (num === 1 ? '' : 's'); -} diff --git a/packages/firestore/test/integration/api/validation.test.ts b/packages/firestore/test/integration/api/validation.test.ts index 223081dad95..e747ce97a02 100644 --- a/packages/firestore/test/integration/api/validation.test.ts +++ b/packages/firestore/test/integration/api/validation.test.ts @@ -103,13 +103,6 @@ class TestClass { constructor(readonly property: string) {} } -// NOTE: The JS SDK does extensive validation of argument counts, types, etc. -// since it is an untyped language. These tests are not exhaustive as that would -// be extremely tedious, but we do try to hit every error template at least -// once. Where applicable, some tests are ignored for the modular API, as we -// assume that most users will use TypeScript to catch invalid input. -const validatesJsInput = !usesFunctionalApi(); - apiDescribe('Validation:', (persistence: boolean) => { describe('FirestoreSettings', () => { // Enabling persistence counts as a use of the firestore instance, meaning @@ -120,31 +113,6 @@ apiDescribe('Validation:', (persistence: boolean) => { return; } - (validatesJsInput ? validationIt : validationIt.skip)( - persistence, - 'validates options', - db => { - // NOTE: 'credentials' is an undocumented API so ideally we wouldn't - // show it in the error, but I don't think it's worth the trouble of - // hiding it. - expect(() => db.settings({ invalid: true } as any)).to.throw( - "Unknown option 'invalid' passed to function settings(). " + - 'Available options: host, ssl, credentials' - ); - - expect(() => - db.settings({ - ssl: true - }) - ).to.throw("Can't provide ssl option if host option is not set"); - - expect(() => db.settings({ host: null as any })).to.throw( - 'Function settings() requires its host option to be of type ' + - 'non-empty string, but it was: null' - ); - } - ); - validationIt( persistence, 'disallows changing settings after use', @@ -224,17 +192,6 @@ apiDescribe('Validation:', (persistence: boolean) => { } ); - (validatesJsInput ? validationIt : validationIt.skip)( - persistence, - 'throws for invalid transaction functions.', - db => { - expect(() => db.runTransaction(null as any)).to.throw( - 'Function Firestore.runTransaction() requires its first ' + - 'argument to be of type function, but it was: null' - ); - } - ); - it("fails transaction if function doesn't return a Promise.", () => { return withTestDb(persistence, db => { return db @@ -264,24 +221,11 @@ apiDescribe('Validation:', (persistence: boolean) => { ); } else { expect(() => db.collection('')).to.throw( - 'Function Firestore.collection() requires its first ' + - 'argument to be of type non-empty string, but it was: ""' + 'Function Firestore.collection() cannot be called with an empty path.' ); expect(() => baseDocRef.collection('')).to.throw( - 'Function DocumentReference.collection() requires its first ' + - 'argument to be of type non-empty string, but it was: ""' - ); - expect(() => db.collection(null as any)).to.throw( - 'Function Firestore.collection() requires its first argument ' + - 'to be of type non-empty string, but it was: null' - ); - expect(() => baseDocRef.collection(null as any)).to.throw( - 'Function DocumentReference.collection() requires its first ' + - 'argument to be of type non-empty string, but it was: null' - ); - expect(() => (baseDocRef.collection as any)('foo', 'bar')).to.throw( - 'Function DocumentReference.collection() requires 1 argument, ' + - 'but was called with 2 arguments.' + 'Function DocumentReference.collection() cannot be called with an ' + + 'empty path.' ); } }); @@ -336,28 +280,11 @@ apiDescribe('Validation:', (persistence: boolean) => { ); } else { expect(() => db.doc('')).to.throw( - 'Function Firestore.doc() requires its first ' + - 'argument to be of type non-empty string, but it was: ""' + 'Function Firestore.doc() cannot be called with an empty path.' ); expect(() => baseCollectionRef.doc('')).to.throw( - 'Function CollectionReference.doc() requires its first ' + - 'argument to be of type non-empty string, but it was: ""' - ); - expect(() => db.doc(null as any)).to.throw( - 'Function Firestore.doc() requires its first argument to be ' + - 'of type non-empty string, but it was: null' - ); - expect(() => baseCollectionRef.doc(null as any)).to.throw( - 'Function CollectionReference.doc() requires its first ' + - 'argument to be of type non-empty string, but it was: null' - ); - expect(() => baseCollectionRef.doc(undefined as any)).to.throw( - 'Function CollectionReference.doc() requires its first ' + - 'argument to be of type non-empty string, but it was: undefined' - ); - expect(() => (baseCollectionRef.doc as any)('foo', 'bar')).to.throw( - 'Function CollectionReference.doc() requires between 0 and ' + - '1 arguments, but was called with 2 arguments.' + 'Function CollectionReference.doc() cannot be called with an empty ' + + 'path.' ); } }); @@ -381,115 +308,18 @@ apiDescribe('Validation:', (persistence: boolean) => { }); }); - (validatesJsInput ? validationIt : validationIt.skip)( - persistence, - 'Listen options are validated', - db => { - const collection = db.collection('test'); - const fn = (): void => {}; - - const doc = collection.doc(); - expect(() => doc.onSnapshot({ bad: true } as any, fn)).to.throw( - `Unknown option 'bad' passed to function ` + - `DocumentReference.onSnapshot(). Available options: ` + - `includeMetadataChanges` - ); - - expect(() => collection.onSnapshot({ bad: true } as any, fn)).to.throw( - `Unknown option 'bad' passed to function ` + - `Query.onSnapshot(). Available options: includeMetadataChanges` - ); - - expect(() => db.onSnapshotsInSync('bad' as any)).to.throw( - `Function Firestore.onSnapshotsInSync() requires its first ` + - `argument to be of type function, but it was: "bad"` - ); - } - ); - - (validatesJsInput ? validationIt : validationIt.skip)( - persistence, - 'get options are validated', - db => { - const collection = db.collection('test'); - const doc = collection.doc(); - const fn = (): void => {}; - - expect(() => doc.get(fn as any)).to.throw( - 'Function DocumentReference.get() requires its first argument to be of type object, ' + - 'but it was: a function' - ); - expect(() => doc.get({ abc: 'cache' } as any)).to.throw( - `Unknown option 'abc' passed to function DocumentReference.get(). Available options: source` - ); - - expect(() => collection.get(fn as any)).to.throw( - 'Function Query.get() requires its first argument to be of type object, but it was: ' + - 'a function' - ); - expect(() => collection.get({ abc: 'cache' } as any)).to.throw( - `Unknown option 'abc' passed to function Query.get(). Available options: source` - ); - } - ); - - (validatesJsInput ? validationIt : validationIt.skip)( - persistence, - 'Snapshot options are validated', - db => { - const docRef = db.collection('test').doc(); - - return docRef - .set({ test: 1 }) - .then(() => { - return docRef.get(); - }) - .then(snapshot => { - expect(() => snapshot.get('test', { bad: true } as any)).to.throw( - `Unknown option 'bad' passed to function ` + - `DocumentSnapshot.get(). Available options: ` + - `serverTimestamps` - ); - expect(() => - snapshot.data({ serverTimestamps: 'foo' } as any) - ).to.throw( - `Invalid value "foo" provided to function DocumentSnapshot.data() for option ` + - `"serverTimestamps". Acceptable values: "estimate", "previous", "none"` - ); - }); - } - ); - - (validatesJsInput ? validationIt : validationIt.skip)( - persistence, - 'Merge options are validated', - db => { - const docRef = db.collection('test').doc(); + validationIt(persistence, 'Merge options are validated', db => { + const docRef = db.collection('test').doc(); - expect(() => docRef.set({}, { merge: true, mergeFields: [] })).to.throw( - 'Invalid options passed to function DocumentReference.set(): You cannot specify both ' + - '"merge" and "mergeFields".' - ); - expect(() => docRef.set({}, { merge: false, mergeFields: [] })).to.throw( - 'Invalid options passed to function DocumentReference.set(): You cannot specify both ' + - '"merge" and "mergeFields".' - ); - expect(() => docRef.set({}, { merge: 'foo' as any })).to.throw( - 'Function DocumentReference.set() requires its merge option to be of type boolean, but it ' + - 'was: "foo"' - ); - expect(() => docRef.set({}, { mergeFields: 'foo' as any })).to.throw( - 'Function DocumentReference.set() requires its mergeFields option to be an array, but it ' + - 'was: "foo"' - ); - expect(() => - docRef.set({}, { mergeFields: ['foo', false as any] }) - ).to.throw( - 'Function DocumentReference.set() requires all mergeFields elements to be a string or a ' + - 'FieldPath, but the value at index 1 was: false' - ); - } - ); + expect(() => docRef.set({}, { merge: true, mergeFields: [] })).to.throw( + 'Invalid options passed to function DocumentReference.set(): You cannot specify both ' + + '"merge" and "mergeFields".' + ); + expect(() => docRef.set({}, { merge: false, mergeFields: [] })).to.throw( + 'Invalid options passed to function DocumentReference.set(): You cannot specify both ' + + '"merge" and "mergeFields".' + ); + }); describe('Writes', () => { validationIt(persistence, 'must be objects.', db => { @@ -852,22 +682,6 @@ apiDescribe('Validation:', (persistence: boolean) => { }); }); - describe('Server timestamps transforms', () => { - (validatesJsInput ? validationIt : validationIt.skip)( - persistence, - 'reject any arguments', - db => { - const doc = db.collection('test').doc(); - expect(() => - doc.set({ x: (FieldValue as any).serverTimestamp('foo') }) - ).to.throw( - 'Function FieldValue.serverTimestamp() does not support ' + - 'arguments, but was called with 1 argument.' - ); - } - ); - }); - describe('Numeric transforms', () => { validationIt(persistence, 'fail in queries', db => { const collection = db.collection('test'); @@ -880,40 +694,6 @@ apiDescribe('Validation:', (persistence: boolean) => { 'used with update() and set() (found in field test)' ); }); - - (validatesJsInput ? validationIt : validationIt.skip)( - persistence, - 'reject invalid operands', - db => { - const doc = db.collection('test').doc(); - expect(() => - doc.set({ x: FieldValue.increment('foo' as any) }) - ).to.throw( - 'Function FieldValue.increment() requires its first argument to ' + - 'be of type number, but it was: "foo"' - ); - expect(() => - doc.set({ x: FieldValue.increment(undefined as any) }) - ).to.throw( - 'Function FieldValue.increment() requires its first argument to ' + - 'be of type number, but it was: undefined' - ); - } - ); - - (validatesJsInput ? validationIt : validationIt.skip)( - persistence, - 'reject more than one argument', - db => { - const doc = db.collection('test').doc(); - expect(() => - doc.set({ x: (FieldValue as any).increment(1337, 'leet') }) - ).to.throw( - 'Function FieldValue.increment() requires 1 argument, but was ' + - 'called with 2 arguments.' - ); - } - ); }); describe('Queries', () => { @@ -922,27 +702,15 @@ apiDescribe('Validation:', (persistence: boolean) => { expect(() => collection.limit(0)).to.throw( `Function ${ usesFunctionalApi() ? 'limit' : 'Query.limit' - }() requires its first argument to be a positive number, but it was: 0.` + }() requires a positive number, but it was: 0.` ); expect(() => collection.limitToLast(-1)).to.throw( `Function ${ usesFunctionalApi() ? 'limitToLast' : 'Query.limitToLast' - }() requires its first argument to be a positive number, but it was: -1.` + }() requires a positive number, but it was: -1.` ); }); - (validatesJsInput ? validationIt : validationIt.skip)( - persistence, - 'enum', - db => { - const collection = db.collection('test') as any; - expect(() => collection.where('a', 'foo' as any, 'b')).to.throw( - 'Invalid value "foo" provided to function Query.where() for its second argument. ' + - 'Acceptable values: <, <=, ==, !=, >=, >, array-contains, in, array-contains-any, not-in' - ); - } - ); - validationIt( persistence, 'with null or NaN non-equality filters fail', @@ -1628,10 +1396,10 @@ apiDescribe('Validation:', (persistence: boolean) => { ); } else { expect(() => collection.where('foo', '==', undefined)).to.throw( - 'Function Query.where() requires a valid third argument, but it was undefined.' + 'Function Query.where() called with invalid data. Unsupported field value: undefined' ); expect(() => collection.orderBy('foo').startAt(undefined)).to.throw( - 'Function Query.startAt() requires a valid first argument, but it was undefined.' + 'Function Query.startAt() called with invalid data. Unsupported field value: undefined' ); } }); From ef33328f7cb7d585a1304ed39649f5b69a111b3c Mon Sep 17 00:00:00 2001 From: Sam Stern Date: Tue, 20 Oct 2020 14:44:20 -0400 Subject: [PATCH 022/624] Implement useEmulator for Database (#3904) --- .changeset/bright-ducks-jump.md | 7 ++ packages/database-types/index.d.ts | 2 + packages/database/src/api/Database.ts | 89 +++++++++++++++-------- packages/database/src/core/Repo.ts | 28 ++++--- packages/database/src/core/RepoManager.ts | 23 +++++- packages/database/test/database.test.ts | 30 +++++++- packages/firebase/index.d.ts | 9 +++ 7 files changed, 144 insertions(+), 44 deletions(-) create mode 100644 .changeset/bright-ducks-jump.md diff --git a/.changeset/bright-ducks-jump.md b/.changeset/bright-ducks-jump.md new file mode 100644 index 00000000000..c864dd3a086 --- /dev/null +++ b/.changeset/bright-ducks-jump.md @@ -0,0 +1,7 @@ +--- +'firebase': minor +'@firebase/database': minor +'@firebase/database-types': minor +--- + +Add a useEmulator(host, port) method to Realtime Database diff --git a/packages/database-types/index.d.ts b/packages/database-types/index.d.ts index 134688d31cf..15538ce1213 100644 --- a/packages/database-types/index.d.ts +++ b/packages/database-types/index.d.ts @@ -34,6 +34,7 @@ export interface DataSnapshot { export interface Database { app: FirebaseApp; + useEmulator(host: string, port: number): void; goOffline(): void; goOnline(): void; ref(path?: string | Reference): Reference; @@ -43,6 +44,7 @@ export interface Database { export class FirebaseDatabase implements Database { private constructor(); app: FirebaseApp; + useEmulator(host: string, port: number): void; goOffline(): void; goOnline(): void; ref(path?: string | Reference): Reference; diff --git a/packages/database/src/api/Database.ts b/packages/database/src/api/Database.ts index 59cc873d3d1..b75e09cdced 100644 --- a/packages/database/src/api/Database.ts +++ b/packages/database/src/api/Database.ts @@ -33,8 +33,11 @@ import { FirebaseDatabase } from '@firebase/database-types'; * @implements {FirebaseService} */ export class Database implements FirebaseService { - INTERNAL: DatabaseInternals; - private root_: Reference; + /** Track if the instance has been used (root or repo accessed) */ + private instanceStarted_: boolean = false; + + /** Backing state for root_ */ + private rootInternal_?: Reference; static readonly ServerValue = { TIMESTAMP: { @@ -51,25 +54,70 @@ export class Database implements FirebaseService { /** * The constructor should not be called by users of our public API. - * @param {!Repo} repo_ + * @param {!Repo} repoInternal_ */ - constructor(private repo_: Repo) { - if (!(repo_ instanceof Repo)) { + constructor(private repoInternal_: Repo) { + if (!(repoInternal_ instanceof Repo)) { fatal( "Don't call new Database() directly - please use firebase.database()." ); } + } - /** @type {Reference} */ - this.root_ = new Reference(repo_, Path.Empty); + INTERNAL = { + delete: async () => { + this.checkDeleted_('delete'); + RepoManager.getInstance().deleteRepo(this.repo_); + this.repoInternal_ = null; + this.rootInternal_ = null; + } + }; - this.INTERNAL = new DatabaseInternals(this); + private get repo_(): Repo { + if (!this.instanceStarted_) { + this.repoInternal_.start(); + this.instanceStarted_ = true; + } + return this.repoInternal_; + } + + get root_(): Reference { + if (!this.rootInternal_) { + this.rootInternal_ = new Reference(this.repo_, Path.Empty); + } + + return this.rootInternal_; } get app(): FirebaseApp { return this.repo_.app; } + /** + * Modify this instance to communicate with the Realtime Database emulator. + * + *

Note: This method must be called before performing any other operation. + * + * @param host the emulator host (ex: localhost) + * @param port the emulator port (ex: 8080) + */ + useEmulator(host: string, port: number): void { + this.checkDeleted_('useEmulator'); + if (this.instanceStarted_) { + fatal( + 'Cannot call useEmulator() after instance has already been initialized.' + ); + return; + } + + // Modify the repo to apply emulator settings + RepoManager.getInstance().applyEmulatorSettings( + this.repoInternal_, + host, + port + ); + } + /** * Returns a reference to the root or to the path specified in the provided * argument. @@ -109,14 +157,14 @@ export class Database implements FirebaseService { validateUrl(apiName, 1, parsedURL); const repoInfo = parsedURL.repoInfo; - if (repoInfo.host !== this.repo_.repoInfo_.host) { + if (!repoInfo.isCustomHost() && repoInfo.host !== this.repo_.repoInfo_.host) { fatal( apiName + ': Host name does not match the current database: ' + '(found ' + repoInfo.host + ' but expected ' + - (this.repo_.repoInfo_ as RepoInfo).host + + this.repo_.repoInfo_.host+ ')' ); } @@ -128,7 +176,7 @@ export class Database implements FirebaseService { * @param {string} apiName */ private checkDeleted_(apiName: string) { - if (this.repo_ === null) { + if (this.repoInternal_ === null) { fatal('Cannot call ' + apiName + ' on a deleted database.'); } } @@ -146,22 +194,3 @@ export class Database implements FirebaseService { this.repo_.resume(); } } - -export class DatabaseInternals { - /** @param {!Database} database */ - constructor(public database: Database) {} - - /** @return {Promise} */ - async delete(): Promise { - // eslint-disable-next-line @typescript-eslint/no-explicit-any - (this.database as any).checkDeleted_('delete'); - // eslint-disable-next-line @typescript-eslint/no-explicit-any - RepoManager.getInstance().deleteRepo((this.database as any).repo_ as Repo); - // eslint-disable-next-line @typescript-eslint/no-explicit-any - (this.database as any).repo_ = null; - // eslint-disable-next-line @typescript-eslint/no-explicit-any - (this.database as any).root_ = null; - this.database.INTERNAL = null; - this.database = null; - } -} diff --git a/packages/database/src/core/Repo.ts b/packages/database/src/core/Repo.ts index 95a96954626..0c105e7abd6 100644 --- a/packages/database/src/core/Repo.ts +++ b/packages/database/src/core/Repo.ts @@ -54,6 +54,9 @@ const INTERRUPT_REASON = 'repo_interrupt'; * A connection to a single data repository. */ export class Repo { + /** Key for uniquely identifying this repo, used in RepoManager */ + readonly key: string; + dataUpdateCount = 0; private infoSyncTree_: SyncTree; private serverSyncTree_: SyncTree; @@ -81,23 +84,28 @@ export class Repo { constructor( public repoInfo_: RepoInfo, - forceRestClient: boolean, + private forceRestClient_: boolean, public app: FirebaseApp, - authTokenProvider: AuthTokenProvider + public authTokenProvider_: AuthTokenProvider ) { - this.stats_ = StatsManager.getCollection(repoInfo_); + // This key is intentionally not updated if RepoInfo is later changed or replaced + this.key = this.repoInfo_.toURLString(); + } + + start(): void { + this.stats_ = StatsManager.getCollection(this.repoInfo_); - if (forceRestClient || beingCrawled()) { + if (this.forceRestClient_ || beingCrawled()) { this.server_ = new ReadonlyRestClient( this.repoInfo_, this.onDataUpdate_.bind(this), - authTokenProvider + this.authTokenProvider_ ); // Minor hack: Fire onConnect immediately, since there's no actual connection. setTimeout(this.onConnectStatus_.bind(this, true), 0); } else { - const authOverride = app.options['databaseAuthVariableOverride']; + const authOverride = this.app.options['databaseAuthVariableOverride']; // Validate authOverride if (typeof authOverride !== 'undefined' && authOverride !== null) { if (typeof authOverride !== 'object') { @@ -114,25 +122,25 @@ export class Repo { this.persistentConnection_ = new PersistentConnection( this.repoInfo_, - app.options.appId, + this.app.options.appId, this.onDataUpdate_.bind(this), this.onConnectStatus_.bind(this), this.onServerInfoUpdate_.bind(this), - authTokenProvider, + this.authTokenProvider_, authOverride ); this.server_ = this.persistentConnection_; } - authTokenProvider.addTokenChangeListener(token => { + this.authTokenProvider_.addTokenChangeListener(token => { this.server_.refreshAuthToken(token); }); // In the case of multiple Repos for the same repoInfo (i.e. there are multiple Firebase.Contexts being used), // we only want to create one StatsReporter. As such, we'll report stats over the first Repo created. this.statsReporter_ = StatsManager.getOrCreateReporter( - repoInfo_, + this.repoInfo_, () => new StatsReporter(this.stats_, this.server_) ); diff --git a/packages/database/src/core/RepoManager.ts b/packages/database/src/core/RepoManager.ts index 7e06519864d..d670940e6ff 100644 --- a/packages/database/src/core/RepoManager.ts +++ b/packages/database/src/core/RepoManager.ts @@ -87,6 +87,25 @@ export class RepoManager { } } + /** + * Update an existing repo in place to point to a new host/port. + */ + applyEmulatorSettings(repo: Repo, host: string, port: number): void { + repo.repoInfo_ = new RepoInfo( + `${host}:${port}`, + /* secure= */ false, + repo.repoInfo_.namespace, + repo.repoInfo_.webSocketOnly, + repo.repoInfo_.nodeAdmin, + repo.repoInfo_.persistenceKey, + repo.repoInfo_.includeNamespaceInQueryParams + ); + + if (repo.repoInfo_.nodeAdmin) { + repo.authTokenProvider_ = new EmulatorAdminTokenProvider(); + } + } + /** * This function should only ever be called to CREATE a new database instance. * @@ -157,13 +176,13 @@ export class RepoManager { deleteRepo(repo: Repo) { const appRepos = safeGet(this.repos_, repo.app.name); // This should never happen... - if (!appRepos || safeGet(appRepos, repo.repoInfo_.toURLString()) !== repo) { + if (!appRepos || safeGet(appRepos, repo.key) !== repo) { fatal( `Database ${repo.app.name}(${repo.repoInfo_}) has already been deleted.` ); } repo.interrupt(); - delete appRepos[repo.repoInfo_.toURLString()]; + delete appRepos[repo.key]; } /** diff --git a/packages/database/test/database.test.ts b/packages/database/test/database.test.ts index 67dc3653462..719d4e3abd3 100644 --- a/packages/database/test/database.test.ts +++ b/packages/database/test/database.test.ts @@ -229,8 +229,8 @@ describe('Database Tests', () => { }); it('ref() validates project', () => { - const db1 = defaultApp.database('http://bar.foo.com'); - const db2 = defaultApp.database('http://foo.bar.com'); + const db1 = defaultApp.database('http://bar.firebaseio.com'); + const db2 = defaultApp.database('http://foo.firebaseio.com'); const ref1 = db1.ref('child'); @@ -260,4 +260,30 @@ describe('Database Tests', () => { const ref = (db as any).refFromURL(); }).to.throw(/Expects at least 1/); }); + + it('can call useEmulator before use', () => { + const db = (firebase as any).database(); + db.useEmulator('localhost', 1234); + expect(db.ref().toString()).to.equal('http://localhost:1234/'); + }); + + it('cannot call useEmulator after use', () => { + const db = (firebase as any).database(); + + db.ref().set({ + hello: 'world' + }); + + expect(() => { + db.useEmulator('localhost', 1234); + }).to.throw(/Cannot call useEmulator/); + }); + + it('refFromURL returns an emulated ref with useEmulator', () => { + const db = (firebase as any).database(); + db.useEmulator('localhost', 1234); + + const ref = db.refFromURL(DATABASE_ADDRESS + '/path/to/data'); + expect(ref.toString()).to.equal(`http://localhost:1234/path/to/data`); + }); }); diff --git a/packages/firebase/index.d.ts b/packages/firebase/index.d.ts index 179a2e66d0e..695121e7224 100644 --- a/packages/firebase/index.d.ts +++ b/packages/firebase/index.d.ts @@ -5667,6 +5667,15 @@ declare namespace firebase.database { * ``` */ app: firebase.app.App; + /** + * Modify this instance to communicate with the Realtime Database emulator. + * + *

Note: This method must be called before performing any other operation. + * + * @param host the emulator host (ex: localhost) + * @param port the emulator port (ex: 8080) + */ + useEmulator(host: string, port: number): void; /** * Disconnects from the server (all Database operations will be completed * offline). From ca04eda4076a33a3bd35def0e172bfa0248794c1 Mon Sep 17 00:00:00 2001 From: Sam Horlbeck Olsen Date: Tue, 20 Oct 2020 12:13:53 -0700 Subject: [PATCH 023/624] Fix idp provider constructor signatures in auth (#3958) * Fix the standard idp providers * Formatting, test fix * Auth docs update --- common/api-review/auth-exp.api.md | 12 ++++-------- docs-exp/auth.facebookauthprovider._constructor_.md | 13 +++++++++++++ docs-exp/auth.facebookauthprovider.md | 7 ++++++- docs-exp/auth.githubauthprovider._constructor_.md | 13 +++++++++++++ docs-exp/auth.githubauthprovider.md | 7 ++++++- docs-exp/auth.googleauthprovider._constructor_.md | 13 +++++++++++++ docs-exp/auth.googleauthprovider.md | 7 ++++++- docs-exp/auth.twitterauthprovider._constructor_.md | 13 +++++++++++++ docs-exp/auth.twitterauthprovider.md | 7 ++++++- packages-exp/auth-compat-exp/src/auth.test.ts | 2 +- .../auth-exp/src/core/providers/facebook.ts | 5 ++++- packages-exp/auth-exp/src/core/providers/github.ts | 5 ++++- packages-exp/auth-exp/src/core/providers/google.ts | 5 ++++- packages-exp/auth-exp/src/core/providers/twitter.ts | 5 ++++- 14 files changed, 97 insertions(+), 17 deletions(-) create mode 100644 docs-exp/auth.facebookauthprovider._constructor_.md create mode 100644 docs-exp/auth.githubauthprovider._constructor_.md create mode 100644 docs-exp/auth.googleauthprovider._constructor_.md create mode 100644 docs-exp/auth.twitterauthprovider._constructor_.md diff --git a/common/api-review/auth-exp.api.md b/common/api-review/auth-exp.api.md index c96d59265f1..283f0788137 100644 --- a/common/api-review/auth-exp.api.md +++ b/common/api-review/auth-exp.api.md @@ -123,6 +123,7 @@ export class EmailAuthProvider implements externs.EmailAuthProvider { // @public (undocumented) export class FacebookAuthProvider extends OAuthProvider { + constructor(); // (undocumented) static credential(accessToken: string): externs.OAuthCredential; // (undocumented) @@ -133,8 +134,6 @@ export class FacebookAuthProvider extends OAuthProvider { static readonly FACEBOOK_SIGN_IN_METHOD = externs.SignInMethod.FACEBOOK; // (undocumented) static readonly PROVIDER_ID = externs.ProviderId.FACEBOOK; - // (undocumented) - readonly providerId = externs.ProviderId.FACEBOOK; } // @public (undocumented) @@ -160,6 +159,7 @@ export function getRedirectResult(authExtern: externs.Auth, resolverExtern?: ext // @public (undocumented) export class GithubAuthProvider extends OAuthProvider { + constructor(); // (undocumented) static credential(accessToken: string): externs.OAuthCredential; // (undocumented) @@ -170,12 +170,11 @@ export class GithubAuthProvider extends OAuthProvider { static readonly GITHUB_SIGN_IN_METHOD = externs.SignInMethod.GITHUB; // (undocumented) static readonly PROVIDER_ID = externs.ProviderId.GITHUB; - // (undocumented) - readonly providerId = externs.ProviderId.GITHUB; } // @public (undocumented) export class GoogleAuthProvider extends OAuthProvider { + constructor(); // (undocumented) static credential(idToken?: string | null, accessToken?: string | null): externs.OAuthCredential; // (undocumented) @@ -186,8 +185,6 @@ export class GoogleAuthProvider extends OAuthProvider { static readonly GOOGLE_SIGN_IN_METHOD = externs.SignInMethod.GOOGLE; // (undocumented) static readonly PROVIDER_ID = externs.ProviderId.GOOGLE; - // (undocumented) - readonly providerId = externs.ProviderId.GOOGLE; } // @public (undocumented) @@ -404,6 +401,7 @@ export function signOut(auth: externs.Auth): Promise; // @public (undocumented) export class TwitterAuthProvider extends OAuthProvider { + constructor(); // (undocumented) static credential(token: string, secret: string): externs.OAuthCredential; // (undocumented) @@ -413,8 +411,6 @@ export class TwitterAuthProvider extends OAuthProvider { // (undocumented) static readonly PROVIDER_ID = externs.ProviderId.TWITTER; // (undocumented) - readonly providerId = externs.ProviderId.TWITTER; - // (undocumented) static readonly TWITTER_SIGN_IN_METHOD = externs.SignInMethod.TWITTER; } diff --git a/docs-exp/auth.facebookauthprovider._constructor_.md b/docs-exp/auth.facebookauthprovider._constructor_.md new file mode 100644 index 00000000000..09dcbcadea7 --- /dev/null +++ b/docs-exp/auth.facebookauthprovider._constructor_.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [FacebookAuthProvider](./auth.facebookauthprovider.md) > [(constructor)](./auth.facebookauthprovider._constructor_.md) + +## FacebookAuthProvider.(constructor) + +Constructs a new instance of the `FacebookAuthProvider` class + +Signature: + +```typescript +constructor(); +``` diff --git a/docs-exp/auth.facebookauthprovider.md b/docs-exp/auth.facebookauthprovider.md index 79b717981d7..18ab266365a 100644 --- a/docs-exp/auth.facebookauthprovider.md +++ b/docs-exp/auth.facebookauthprovider.md @@ -11,13 +11,18 @@ export declare class FacebookAuthProvider extends OAuthProvider ``` Extends: [OAuthProvider](./auth.oauthprovider.md) +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)()](./auth.facebookauthprovider._constructor_.md) | | Constructs a new instance of the FacebookAuthProvider class | + ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [FACEBOOK\_SIGN\_IN\_METHOD](./auth.facebookauthprovider.facebook_sign_in_method.md) | static | (not declared) | | | [PROVIDER\_ID](./auth.facebookauthprovider.provider_id.md) | static | (not declared) | | -| [providerId](./auth.facebookauthprovider.providerid.md) | | (not declared) | | ## Methods diff --git a/docs-exp/auth.githubauthprovider._constructor_.md b/docs-exp/auth.githubauthprovider._constructor_.md new file mode 100644 index 00000000000..2cab7817c97 --- /dev/null +++ b/docs-exp/auth.githubauthprovider._constructor_.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [GithubAuthProvider](./auth.githubauthprovider.md) > [(constructor)](./auth.githubauthprovider._constructor_.md) + +## GithubAuthProvider.(constructor) + +Constructs a new instance of the `GithubAuthProvider` class + +Signature: + +```typescript +constructor(); +``` diff --git a/docs-exp/auth.githubauthprovider.md b/docs-exp/auth.githubauthprovider.md index 137d327bfef..8a19d9676ba 100644 --- a/docs-exp/auth.githubauthprovider.md +++ b/docs-exp/auth.githubauthprovider.md @@ -11,13 +11,18 @@ export declare class GithubAuthProvider extends OAuthProvider ``` Extends: [OAuthProvider](./auth.oauthprovider.md) +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)()](./auth.githubauthprovider._constructor_.md) | | Constructs a new instance of the GithubAuthProvider class | + ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [GITHUB\_SIGN\_IN\_METHOD](./auth.githubauthprovider.github_sign_in_method.md) | static | (not declared) | | | [PROVIDER\_ID](./auth.githubauthprovider.provider_id.md) | static | (not declared) | | -| [providerId](./auth.githubauthprovider.providerid.md) | | (not declared) | | ## Methods diff --git a/docs-exp/auth.googleauthprovider._constructor_.md b/docs-exp/auth.googleauthprovider._constructor_.md new file mode 100644 index 00000000000..a6ca2e01749 --- /dev/null +++ b/docs-exp/auth.googleauthprovider._constructor_.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [GoogleAuthProvider](./auth.googleauthprovider.md) > [(constructor)](./auth.googleauthprovider._constructor_.md) + +## GoogleAuthProvider.(constructor) + +Constructs a new instance of the `GoogleAuthProvider` class + +Signature: + +```typescript +constructor(); +``` diff --git a/docs-exp/auth.googleauthprovider.md b/docs-exp/auth.googleauthprovider.md index 008400579d8..daca19904b4 100644 --- a/docs-exp/auth.googleauthprovider.md +++ b/docs-exp/auth.googleauthprovider.md @@ -11,13 +11,18 @@ export declare class GoogleAuthProvider extends OAuthProvider ``` Extends: [OAuthProvider](./auth.oauthprovider.md) +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)()](./auth.googleauthprovider._constructor_.md) | | Constructs a new instance of the GoogleAuthProvider class | + ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [GOOGLE\_SIGN\_IN\_METHOD](./auth.googleauthprovider.google_sign_in_method.md) | static | (not declared) | | | [PROVIDER\_ID](./auth.googleauthprovider.provider_id.md) | static | (not declared) | | -| [providerId](./auth.googleauthprovider.providerid.md) | | (not declared) | | ## Methods diff --git a/docs-exp/auth.twitterauthprovider._constructor_.md b/docs-exp/auth.twitterauthprovider._constructor_.md new file mode 100644 index 00000000000..cba7b785425 --- /dev/null +++ b/docs-exp/auth.twitterauthprovider._constructor_.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [TwitterAuthProvider](./auth.twitterauthprovider.md) > [(constructor)](./auth.twitterauthprovider._constructor_.md) + +## TwitterAuthProvider.(constructor) + +Constructs a new instance of the `TwitterAuthProvider` class + +Signature: + +```typescript +constructor(); +``` diff --git a/docs-exp/auth.twitterauthprovider.md b/docs-exp/auth.twitterauthprovider.md index 82878bcb9e3..e7a1177a995 100644 --- a/docs-exp/auth.twitterauthprovider.md +++ b/docs-exp/auth.twitterauthprovider.md @@ -11,12 +11,17 @@ export declare class TwitterAuthProvider extends OAuthProvider ``` Extends: [OAuthProvider](./auth.oauthprovider.md) +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)()](./auth.twitterauthprovider._constructor_.md) | | Constructs a new instance of the TwitterAuthProvider class | + ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [PROVIDER\_ID](./auth.twitterauthprovider.provider_id.md) | static | (not declared) | | -| [providerId](./auth.twitterauthprovider.providerid.md) | | (not declared) | | | [TWITTER\_SIGN\_IN\_METHOD](./auth.twitterauthprovider.twitter_sign_in_method.md) | static | (not declared) | | ## Methods diff --git a/packages-exp/auth-compat-exp/src/auth.test.ts b/packages-exp/auth-compat-exp/src/auth.test.ts index 7df82ad21b8..d7f50cd86a0 100644 --- a/packages-exp/auth-compat-exp/src/auth.test.ts +++ b/packages-exp/auth-compat-exp/src/auth.test.ts @@ -48,7 +48,7 @@ describe('auth compat', () => { if (typeof self !== 'undefined') { sinon.stub(underlyingAuth, '_getPersistence').returns('TEST'); // eslint-disable-next-line @typescript-eslint/no-floating-promises - authCompat.signInWithRedirect(new impl.GoogleAuthProvider('google')); + authCompat.signInWithRedirect(new impl.GoogleAuthProvider()); expect( sessionStorage.getItem('firebase:persistence:api-key:undefined') ).to.eq('TEST'); diff --git a/packages-exp/auth-exp/src/core/providers/facebook.ts b/packages-exp/auth-exp/src/core/providers/facebook.ts index 94717aa0cb0..3fb7adf6215 100644 --- a/packages-exp/auth-exp/src/core/providers/facebook.ts +++ b/packages-exp/auth-exp/src/core/providers/facebook.ts @@ -26,7 +26,10 @@ import { OAuthProvider } from './oauth'; export class FacebookAuthProvider extends OAuthProvider { static readonly FACEBOOK_SIGN_IN_METHOD = externs.SignInMethod.FACEBOOK; static readonly PROVIDER_ID = externs.ProviderId.FACEBOOK; - readonly providerId = FacebookAuthProvider.PROVIDER_ID; + + constructor() { + super(externs.ProviderId.FACEBOOK); + } static credential(accessToken: string): externs.OAuthCredential { return OAuthCredential._fromParams({ diff --git a/packages-exp/auth-exp/src/core/providers/github.ts b/packages-exp/auth-exp/src/core/providers/github.ts index 2e50e37dc95..3f8f4dfa10e 100644 --- a/packages-exp/auth-exp/src/core/providers/github.ts +++ b/packages-exp/auth-exp/src/core/providers/github.ts @@ -26,7 +26,10 @@ import { OAuthProvider } from './oauth'; export class GithubAuthProvider extends OAuthProvider { static readonly GITHUB_SIGN_IN_METHOD = externs.SignInMethod.GITHUB; static readonly PROVIDER_ID = externs.ProviderId.GITHUB; - readonly providerId = GithubAuthProvider.PROVIDER_ID; + + constructor() { + super(externs.ProviderId.GITHUB); + } static credential(accessToken: string): externs.OAuthCredential { return OAuthCredential._fromParams({ diff --git a/packages-exp/auth-exp/src/core/providers/google.ts b/packages-exp/auth-exp/src/core/providers/google.ts index 778fd7e847e..d70a0aba55d 100644 --- a/packages-exp/auth-exp/src/core/providers/google.ts +++ b/packages-exp/auth-exp/src/core/providers/google.ts @@ -27,7 +27,10 @@ import { OAuthProvider } from './oauth'; export class GoogleAuthProvider extends OAuthProvider { static readonly GOOGLE_SIGN_IN_METHOD = externs.SignInMethod.GOOGLE; static readonly PROVIDER_ID = externs.ProviderId.GOOGLE; - readonly providerId = GoogleAuthProvider.PROVIDER_ID; + + constructor() { + super(externs.ProviderId.GOOGLE); + } static credential( idToken?: string | null, diff --git a/packages-exp/auth-exp/src/core/providers/twitter.ts b/packages-exp/auth-exp/src/core/providers/twitter.ts index 305fcf03769..cb0e150c652 100644 --- a/packages-exp/auth-exp/src/core/providers/twitter.ts +++ b/packages-exp/auth-exp/src/core/providers/twitter.ts @@ -44,7 +44,10 @@ import { OAuthProvider } from './oauth'; export class TwitterAuthProvider extends OAuthProvider { static readonly TWITTER_SIGN_IN_METHOD = externs.SignInMethod.TWITTER; static readonly PROVIDER_ID = externs.ProviderId.TWITTER; - readonly providerId = TwitterAuthProvider.PROVIDER_ID; + + constructor() { + super(externs.ProviderId.TWITTER); + } static credential(token: string, secret: string): externs.OAuthCredential { return OAuthCredential._fromParams({ From 2b06694da69915352c24cb26f570a129fc04868b Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Tue, 20 Oct 2020 12:50:44 -0700 Subject: [PATCH 024/624] Fix storage-types (#3945) --- packages/firebase/index.d.ts | 29 ++++++++--- packages/storage-types/index.d.ts | 28 +++++++---- packages/storage/src/implementation/error.ts | 50 ++++++------------- .../storage/src/implementation/request.ts | 2 +- .../storage/src/implementation/requests.ts | 4 +- 5 files changed, 60 insertions(+), 53 deletions(-) diff --git a/packages/firebase/index.d.ts b/packages/firebase/index.d.ts index 695121e7224..35a7d5549e6 100644 --- a/packages/firebase/index.d.ts +++ b/packages/firebase/index.d.ts @@ -7626,6 +7626,19 @@ declare namespace firebase.storage { md5Hash?: string | null; } + /** + * An error returned by the Firebase Storage SDK. + */ + interface FirebaseStorageError extends FirebaseError { + serverResponse: string | null; + } + + interface StorageObserver { + next?: NextFn | null; + error?: (error: FirebaseStorageError) => void | null; + complete?: CompleteFn | null; + } + /** * Represents the process of uploading an object. Allows you to monitor and * manage the upload. @@ -7639,7 +7652,7 @@ declare namespace firebase.storage { /** * Equivalent to calling `then(null, onRejected)`. */ - catch(onRejected: (a: Error) => any): Promise; + catch(onRejected: (error: FirebaseStorageError) => any): Promise; /** * Listens for events on this task. * @@ -7739,7 +7752,7 @@ declare namespace firebase.storage { * The `next` function, which gets called for each item in * the event stream, or an observer object with some or all of these three * properties (`next`, `error`, `complete`). - * @param error A function that gets called with an Error + * @param error A function that gets called with a `FirebaseStorageError` * if the event stream ends due to an error. * @param complete A function that gets called if the * event stream ends normally. @@ -7752,10 +7765,10 @@ declare namespace firebase.storage { on( event: firebase.storage.TaskEvent, nextOrObserver?: - | Partial> + | StorageObserver | null - | ((a: UploadTaskSnapshot) => any), - error?: ((a: Error) => any) | null, + | ((snapshot: UploadTaskSnapshot) => any), + error?: ((error: FirebaseStorageError) => any) | null, complete?: firebase.Unsubscribe | null ): Function; /** @@ -7780,8 +7793,10 @@ declare namespace firebase.storage { * @param onRejected The rejection callback. */ then( - onFulfilled?: ((a: firebase.storage.UploadTaskSnapshot) => any) | null, - onRejected?: ((a: Error) => any) | null + onFulfilled?: + | ((snapshot: firebase.storage.UploadTaskSnapshot) => any) + | null, + onRejected?: ((error: FirebaseStorageError) => any) | null ): Promise; } diff --git a/packages/storage-types/index.d.ts b/packages/storage-types/index.d.ts index 902461581cc..5bd2b98dc05 100644 --- a/packages/storage-types/index.d.ts +++ b/packages/storage-types/index.d.ts @@ -15,8 +15,8 @@ * limitations under the License. */ -import { FirebaseApp, FirebaseNamespace } from '@firebase/app-types'; -import { Observer, Unsubscribe } from '@firebase/util'; +import { FirebaseApp } from '@firebase/app-types'; +import { CompleteFn, FirebaseError, NextFn, Unsubscribe } from '@firebase/util'; export interface FullMetadata extends UploadMetadata { bucket: string; @@ -48,7 +48,7 @@ export interface Reference { metadata?: UploadMetadata ): UploadTask; root: Reference; - storage: Storage; + storage: FirebaseStorage; toString(): string; updateMetadata(metadata: SettableMetadata): Promise; listAll(): Promise; @@ -85,24 +85,34 @@ export interface UploadMetadata extends SettableMetadata { md5Hash?: string | null; } +interface FirebaseStorageError extends FirebaseError { + serverResponse: string | null; +} + +export interface StorageObserver { + next?: NextFn | null; + error?: (error: FirebaseStorageError) => void | null; + complete?: CompleteFn | null; +} + export interface UploadTask { cancel(): boolean; - catch(onRejected: (a: Error) => any): Promise; + catch(onRejected: (error: FirebaseStorageError) => any): Promise; on( event: TaskEvent, nextOrObserver?: - | Partial> + | StorageObserver | null - | ((a: UploadTaskSnapshot) => any), - error?: ((a: Error) => any) | null, + | ((snapshot: UploadTaskSnapshot) => any), + error?: ((a: FirebaseStorageError) => any) | null, complete?: Unsubscribe | null ): Function; pause(): boolean; resume(): boolean; snapshot: UploadTaskSnapshot; then( - onFulfilled?: ((a: UploadTaskSnapshot) => any) | null, - onRejected?: ((a: Error) => any) | null + onFulfilled?: ((snapshot: UploadTaskSnapshot) => any) | null, + onRejected?: ((error: FirebaseStorageError) => any) | null ): Promise; } diff --git a/packages/storage/src/implementation/error.ts b/packages/storage/src/implementation/error.ts index 98341b71922..47780c177af 100644 --- a/packages/storage/src/implementation/error.ts +++ b/packages/storage/src/implementation/error.ts @@ -1,3 +1,4 @@ +import { FirebaseError } from '@firebase/util'; /** * @license * Copyright 2017 Google LLC @@ -16,53 +17,34 @@ */ import { CONFIG_STORAGE_BUCKET_KEY } from './constants'; -export class FirebaseStorageError implements Error { - private code_: string; - private message_: string; - private serverResponse_: string | null; - private name_: string; +export class FirebaseStorageError extends FirebaseError { + customData: { serverResponse: string | null } = { serverResponse: null }; constructor(code: Code, message: string) { - this.code_ = prependCode(code); - this.message_ = 'Firebase Storage: ' + message; - this.serverResponse_ = null; - this.name_ = 'FirebaseError'; - } - - codeProp(): string { - return this.code; + super(prependCode(code), 'Firebase Storage: ' + message); + // Without this, `instanceof FirebaseStorageError`, in tests for example, + // returns false. + Object.setPrototypeOf(this, FirebaseStorageError.prototype); } codeEquals(code: Code): boolean { - return prependCode(code) === this.codeProp(); - } - - serverResponseProp(): string | null { - return this.serverResponse_; - } - - setServerResponseProp(serverResponse: string | null): void { - this.serverResponse_ = serverResponse; - } - - get name(): string { - return this.name_; - } - - get code(): string { - return this.code_; + return prependCode(code) === this.code; } get message(): string { - if (this.serverResponse_) { - return this.message_ + '\n' + this.serverResponse_; + if (this.customData.serverResponse) { + return this.message + '\n' + this.customData.serverResponse; } else { - return this.message_; + return this.message; } } get serverResponse(): null | string { - return this.serverResponse_; + return this.customData.serverResponse; + } + + set serverResponse(serverResponse: string | null) { + this.customData.serverResponse = serverResponse; } } diff --git a/packages/storage/src/implementation/request.ts b/packages/storage/src/implementation/request.ts index 90868eb6a55..5b553ad3af8 100644 --- a/packages/storage/src/implementation/request.ts +++ b/packages/storage/src/implementation/request.ts @@ -188,7 +188,7 @@ class NetworkRequest implements Request { } else { if (xhr !== null) { const err = unknown(); - err.setServerResponseProp(xhr.getResponseText()); + err.serverResponse = xhr.getResponseText(); if (self.errorCallback_) { reject(self.errorCallback_(xhr, err)); } else { diff --git a/packages/storage/src/implementation/requests.ts b/packages/storage/src/implementation/requests.ts index 6eeb75de161..8b1fe288e25 100644 --- a/packages/storage/src/implementation/requests.ts +++ b/packages/storage/src/implementation/requests.ts @@ -114,7 +114,7 @@ export function sharedErrorHandler( } } } - newErr.setServerResponseProp(err.serverResponseProp()); + newErr.serverResponse = err.serverResponse; return newErr; } return errorHandler; @@ -133,7 +133,7 @@ export function objectErrorHandler( if (xhr.getStatus() === 404) { newErr = objectNotFound(location.path); } - newErr.setServerResponseProp(err.serverResponseProp()); + newErr.serverResponse = err.serverResponse; return newErr; } return errorHandler; From b247ffa760aec1636de6cfc78851f97a840181ae Mon Sep 17 00:00:00 2001 From: Sebastian Schmidt Date: Tue, 20 Oct 2020 14:16:29 -0700 Subject: [PATCH 025/624] Remove JS input validation for Storage (#3967) --- .changeset/tiny-hounds-rest.md | 6 + packages/storage/src/implementation/args.ts | 165 ------------- packages/storage/src/implementation/list.ts | 29 --- .../storage/src/implementation/metadata.ts | 20 -- packages/storage/src/implementation/string.ts | 22 -- packages/storage/src/implementation/type.ts | 40 ++-- packages/storage/src/reference.ts | 45 ++-- packages/storage/src/service.ts | 62 ++--- packages/storage/src/task.ts | 102 +------- packages/storage/test/unit/reference.test.ts | 224 ------------------ packages/storage/test/unit/service.test.ts | 83 +------ packages/storage/test/unit/task.test.ts | 103 +------- 12 files changed, 86 insertions(+), 815 deletions(-) create mode 100644 .changeset/tiny-hounds-rest.md delete mode 100644 packages/storage/src/implementation/args.ts diff --git a/.changeset/tiny-hounds-rest.md b/.changeset/tiny-hounds-rest.md new file mode 100644 index 00000000000..c1587fdd110 --- /dev/null +++ b/.changeset/tiny-hounds-rest.md @@ -0,0 +1,6 @@ +--- +"firebase: major +"@firebase/storage": major +--- + +This releases removes all input validation. Please use our TypeScript types to validate API usage. diff --git a/packages/storage/src/implementation/args.ts b/packages/storage/src/implementation/args.ts deleted file mode 100644 index 3d36071cba8..00000000000 --- a/packages/storage/src/implementation/args.ts +++ /dev/null @@ -1,165 +0,0 @@ -/** - * @license - * Copyright 2017 Google LLC - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -import * as errorsExports from './error'; -import * as MetadataUtils from './metadata'; -import * as ListOptionsUtils from './list'; -import * as type from './type'; - -/** - * @param name Name of the function. - * @param specs Argument specs. - * @param passed The actual arguments passed to the function. - * @throws {fbs.Error} If the arguments are invalid. - */ -export function validate( - name: string, - specs: ArgSpec[], - passed: IArguments -): void { - let minArgs = specs.length; - const maxArgs = specs.length; - for (let i = 0; i < specs.length; i++) { - if (specs[i].optional) { - minArgs = i; - break; - } - } - const validLength = minArgs <= passed.length && passed.length <= maxArgs; - if (!validLength) { - throw errorsExports.invalidArgumentCount( - minArgs, - maxArgs, - name, - passed.length - ); - } - for (let i = 0; i < passed.length; i++) { - try { - specs[i].validator(passed[i]); - } catch (e) { - if (e instanceof Error) { - throw errorsExports.invalidArgument(i, name, e.message); - } else { - throw errorsExports.invalidArgument(i, name, e); - } - } - } -} - -/** - * @struct - */ -export class ArgSpec { - validator: (p1: unknown) => void; - optional: boolean; - - constructor(validator: (p1: unknown) => void, optional?: boolean) { - const self = this; - this.validator = function (p: unknown) { - if (self.optional && !type.isJustDef(p)) { - return; - } - validator(p); - }; - this.optional = !!optional; - } -} - -export function and_( - v1: (p1: unknown) => void, - v2: (p1: unknown) => void -): (p1: unknown) => void { - return function (p) { - v1(p); - v2(p); - }; -} - -export function stringSpec( - validator?: (p1: unknown) => void | null, - optional?: boolean -): ArgSpec { - function stringValidator(p: unknown): void { - if (!type.isString(p)) { - throw 'Expected string.'; - } - } - let chainedValidator; - if (validator) { - chainedValidator = and_(stringValidator, validator); - } else { - chainedValidator = stringValidator; - } - return new ArgSpec(chainedValidator, optional); -} - -export function uploadDataSpec(): ArgSpec { - function validator(p: unknown): void { - const valid = - p instanceof Uint8Array || - p instanceof ArrayBuffer || - (type.isNativeBlobDefined() && p instanceof Blob); - if (!valid) { - throw 'Expected Blob or File.'; - } - } - return new ArgSpec(validator); -} - -export function metadataSpec(optional?: boolean): ArgSpec { - return new ArgSpec(MetadataUtils.metadataValidator, optional); -} - -export function listOptionSpec(optional?: boolean): ArgSpec { - return new ArgSpec(ListOptionsUtils.listOptionsValidator, optional); -} - -export function nonNegativeNumberSpec(): ArgSpec { - function validator(p: unknown): void { - const valid = type.isNumber(p) && p >= 0; - if (!valid) { - throw 'Expected a number 0 or greater.'; - } - } - return new ArgSpec(validator); -} - -export function looseObjectSpec( - validator?: ((p1: unknown) => void) | null, - optional?: boolean -): ArgSpec { - function isLooseObjectValidator(p: unknown): void { - const isLooseObject = p === null || (type.isDef(p) && p instanceof Object); - if (!isLooseObject) { - throw 'Expected an Object.'; - } - if (validator !== undefined && validator !== null) { - validator(p); - } - } - return new ArgSpec(isLooseObjectValidator, optional); -} - -export function nullFunctionSpec(optional?: boolean): ArgSpec { - function validator(p: unknown): void { - const valid = p === null || type.isFunction(p); - if (!valid) { - throw 'Expected a Function.'; - } - } - return new ArgSpec(validator, optional); -} diff --git a/packages/storage/src/implementation/list.ts b/packages/storage/src/implementation/list.ts index 45769644751..4f634836728 100644 --- a/packages/storage/src/implementation/list.ts +++ b/packages/storage/src/implementation/list.ts @@ -20,7 +20,6 @@ */ import { Location } from './location'; import * as json from './json'; -import * as type from './type'; import { ListResult } from '../list'; import { StorageService } from '../service'; @@ -43,9 +42,6 @@ interface ListResultResponse { nextPageToken?: string; } -const MAX_RESULTS_KEY = 'maxResults'; -const MAX_MAX_RESULTS = 1000; -const PAGE_TOKEN_KEY = 'pageToken'; const PREFIXES_KEY = 'prefixes'; const ITEMS_KEY = 'items'; @@ -92,28 +88,3 @@ export function fromResponseString( const resource = (obj as unknown) as ListResultResponse; return fromBackendResponse(service, bucket, resource); } - -export function listOptionsValidator(p: unknown): void { - if (!type.isObject(p) || !p) { - throw 'Expected ListOptions object.'; - } - for (const key in p) { - if (key === MAX_RESULTS_KEY) { - if ( - !type.isInteger(p[MAX_RESULTS_KEY]) || - (p[MAX_RESULTS_KEY] as number) <= 0 - ) { - throw 'Expected maxResults to be a positive number.'; - } - if ((p[MAX_RESULTS_KEY] as number) > 1000) { - throw `Expected maxResults to be less than or equal to ${MAX_MAX_RESULTS}.`; - } - } else if (key === PAGE_TOKEN_KEY) { - if (p[PAGE_TOKEN_KEY] && !type.isString(p[PAGE_TOKEN_KEY])) { - throw 'Expected pageToken to be string.'; - } - } else { - throw 'Unknown option: ' + key; - } - } -} diff --git a/packages/storage/src/implementation/metadata.ts b/packages/storage/src/implementation/metadata.ts index b1cf2ad257f..2ce6dc35783 100644 --- a/packages/storage/src/implementation/metadata.ts +++ b/packages/storage/src/implementation/metadata.ts @@ -205,23 +205,3 @@ export function toResourceString( } return JSON.stringify(resource); } - -export function metadataValidator(p: unknown): void { - if (!type.isObject(p) || !p) { - throw 'Expected Metadata object.'; - } - for (const key in p) { - if (p.hasOwnProperty(key)) { - const val = p[key]; - if (key === 'customMetadata') { - if (!type.isObject(val)) { - throw "Expected object for 'customMetadata' mapping."; - } - } else { - if (type.isNonNullObject(val)) { - throw "Mapping for '" + key + "' cannot be an object."; - } - } - } - } -} diff --git a/packages/storage/src/implementation/string.ts b/packages/storage/src/implementation/string.ts index 1b49adbb528..3018d88c1a4 100644 --- a/packages/storage/src/implementation/string.ts +++ b/packages/storage/src/implementation/string.ts @@ -27,28 +27,6 @@ export const StringFormat = { DATA_URL: 'data_url' }; -export function formatValidator(stringFormat: unknown): void { - switch (stringFormat) { - case StringFormat.RAW: - case StringFormat.BASE64: - case StringFormat.BASE64URL: - case StringFormat.DATA_URL: - return; - default: - throw ( - 'Expected one of the event types: [' + - StringFormat.RAW + - ', ' + - StringFormat.BASE64 + - ', ' + - StringFormat.BASE64URL + - ', ' + - StringFormat.DATA_URL + - '].' - ); - } -} - /** * @struct */ diff --git a/packages/storage/src/implementation/type.ts b/packages/storage/src/implementation/type.ts index 41f033a9cde..f9287b96b7c 100644 --- a/packages/storage/src/implementation/type.ts +++ b/packages/storage/src/implementation/type.ts @@ -15,6 +15,8 @@ * limitations under the License. */ +import { Code, FirebaseStorageError } from './error'; + /** * @return False if the object is undefined or null, true otherwise. */ @@ -31,30 +33,14 @@ export function isFunction(p: unknown): p is Function { return typeof p === 'function'; } -export function isObject(p: unknown): p is { [key: string]: unknown } | null { - return typeof p === 'object'; -} - -export function isNonNullObject(p: unknown): p is object { - return isObject(p) && p !== null; -} - export function isNonArrayObject(p: unknown): boolean { - return isObject(p) && !Array.isArray(p); + return typeof p === 'object' && !Array.isArray(p); } export function isString(p: unknown): p is string { return typeof p === 'string' || p instanceof String; } -export function isInteger(p: unknown): p is number { - return isNumber(p) && Number.isInteger(p); -} - -export function isNumber(p: unknown): p is number { - return typeof p === 'number' || p instanceof Number; -} - export function isNativeBlob(p: unknown): p is Blob { return isNativeBlobDefined() && p instanceof Blob; } @@ -62,3 +48,23 @@ export function isNativeBlob(p: unknown): p is Blob { export function isNativeBlobDefined(): boolean { return typeof Blob !== 'undefined'; } + +export function validateNumber( + argument: string, + minValue: number, + maxValue: number, + value: number +): void { + if (value < minValue) { + throw new FirebaseStorageError( + Code.INVALID_ARGUMENT, + `Invalid value for '${argument}'. Expected ${minValue} or greater.` + ); + } + if (value > maxValue) { + throw new FirebaseStorageError( + Code.INVALID_ARGUMENT, + `Invalid value for '${argument}'. Expected ${maxValue} or less.` + ); + } +} diff --git a/packages/storage/src/reference.ts b/packages/storage/src/reference.ts index 7b5bbd4be22..2d66d889508 100644 --- a/packages/storage/src/reference.ts +++ b/packages/storage/src/reference.ts @@ -24,23 +24,13 @@ import { Location } from './implementation/location'; import * as metadata from './implementation/metadata'; import * as path from './implementation/path'; import * as requests from './implementation/requests'; -import { - StringFormat, - formatValidator, - dataFromString -} from './implementation/string'; +import { dataFromString, StringFormat } from './implementation/string'; import * as type from './implementation/type'; +import { validateNumber } from './implementation/type'; import { Metadata } from './metadata'; import { StorageService } from './service'; import { UploadTask } from './task'; import { ListOptions, ListResult } from './list'; -import { - listOptionSpec, - stringSpec, - validate, - metadataSpec, - uploadDataSpec -} from './implementation/args'; /** * Provides methods to interact with a bucket in the Firebase Storage service. @@ -70,7 +60,6 @@ export class Reference { * @override */ toString(): string { - validate('toString', [], arguments); return 'gs://' + this.location.bucket + '/' + this.location.path; } @@ -88,7 +77,6 @@ export class Reference { * slashes. */ child(childPath: string): Reference { - validate('child', [stringSpec()], arguments); const newPath = path.child(this.location.path, childPath); const location = new Location(this.location.bucket, newPath); return this.newRef(this.service, location); @@ -142,7 +130,6 @@ export class Reference { data: Blob | Uint8Array | ArrayBuffer, metadata: Metadata | null = null ): UploadTask { - validate('put', [uploadDataSpec(), metadataSpec(true)], arguments); this.throwIfRoot_('put'); return new UploadTask( this, @@ -166,11 +153,6 @@ export class Reference { format: StringFormat = StringFormat.RAW, metadata?: Metadata ): UploadTask { - validate( - 'putString', - [stringSpec(), stringSpec(formatValidator, true), metadataSpec(true)], - arguments - ); this.throwIfRoot_('putString'); const data = dataFromString(format, value); const metadataClone = Object.assign({}, metadata); @@ -195,7 +177,6 @@ export class Reference { * @return A promise that resolves if the deletion succeeds. */ delete(): Promise { - validate('delete', [], arguments); this.throwIfRoot_('delete'); return this.service.getAuthToken().then(authToken => { const requestInfo = requests.deleteObject(this.service, this.location); @@ -221,7 +202,6 @@ export class Reference { * folder. `nextPageToken` is never returned. */ listAll(): Promise { - validate('listAll', [], arguments); const accumulator = { prefixes: [], items: [] @@ -266,18 +246,24 @@ export class Reference { * can be used to get the rest of the results. */ list(options?: ListOptions | null): Promise { - validate('list', [listOptionSpec(true)], arguments); - const self = this; + const op = options || {}; + if (typeof op.maxResults === 'number') { + validateNumber( + 'options.maxResults', + /* minValue= */ 1, + /* maxValue= */ 1000, + op.maxResults + ); + } return this.service.getAuthToken().then(authToken => { - const op = options || {}; const requestInfo = requests.list( - self.service, - self.location, + this.service, + this.location, /*delimiter= */ '/', op.pageToken, op.maxResults ); - return self.service.makeRequest(requestInfo, authToken).getPromise(); + return this.service.makeRequest(requestInfo, authToken).getPromise(); }); } @@ -287,7 +273,6 @@ export class Reference { * rejected. */ getMetadata(): Promise { - validate('getMetadata', [], arguments); this.throwIfRoot_('getMetadata'); return this.service.getAuthToken().then(authToken => { const requestInfo = requests.getMetadata( @@ -309,7 +294,6 @@ export class Reference { * @see firebaseStorage.Reference.prototype.getMetadata */ updateMetadata(metadata: Metadata): Promise { - validate('updateMetadata', [metadataSpec()], arguments); this.throwIfRoot_('updateMetadata'); return this.service.getAuthToken().then(authToken => { const requestInfo = requests.updateMetadata( @@ -327,7 +311,6 @@ export class Reference { * URL for this object. */ getDownloadURL(): Promise { - validate('getDownloadURL', [], arguments); this.throwIfRoot_('getDownloadURL'); return this.service.getAuthToken().then(authToken => { const requestInfo = requests.getDownloadUrl( diff --git a/packages/storage/src/service.ts b/packages/storage/src/service.ts index 12fb5c6ea2d..54377f7b2fa 100644 --- a/packages/storage/src/service.ts +++ b/packages/storage/src/service.ts @@ -16,7 +16,6 @@ */ import { FirebaseApp } from '@firebase/app-types'; -import * as args from './implementation/args'; import { Location } from './implementation/location'; import { FailRequest } from './implementation/failrequest'; import { Request, makeRequest } from './implementation/request'; @@ -28,6 +27,8 @@ import { FirebaseAuthInternalName } from '@firebase/auth-interop-types'; import { FirebaseOptions } from '@firebase/app-types-exp'; import * as constants from '../src/implementation/constants'; import * as errorsExports from './implementation/error'; +import { Code, FirebaseStorageError } from './implementation/error'; +import { validateNumber } from './implementation/type'; /** * A service that provides firebaseStorage.Reference instances. @@ -134,15 +135,13 @@ export class StorageService { * bucket. */ ref(path?: string): Reference { - function validator(path: unknown): void { - if (typeof path !== 'string') { - throw 'Path is not a string.'; - } - if (/^[A-Za-z]+:\/\//.test(path as string)) { - throw 'Expected child path but got a URL, use refFromURL instead.'; - } + if (/^[A-Za-z]+:\/\//.test(path as string)) { + throw new FirebaseStorageError( + Code.INVALID_ARGUMENT, + 'Expected child path but got a URL, use refFromURL instead.' + ); } - args.validate('ref', [args.stringSpec(validator, true)], arguments); + if (this.bucket_ == null) { throw new Error('No Storage Bucket defined in Firebase Options.'); } @@ -160,20 +159,21 @@ export class StorageService { * which must be a gs:// or http[s]:// URL. */ refFromURL(url: string): Reference { - function validator(p: unknown): void { - if (typeof p !== 'string') { - throw 'Path is not a string.'; - } - if (!/^[A-Za-z]+:\/\//.test(p as string)) { - throw 'Expected full URL but got a child path, use ref instead.'; - } - try { - Location.makeFromUrl(p as string); - } catch (e) { - throw 'Expected valid full URL but got an invalid one.'; - } + if (!/^[A-Za-z]+:\/\//.test(url)) { + throw new FirebaseStorageError( + Code.INVALID_ARGUMENT, + 'Expected full URL but got a child path, use ref instead.' + ); } - args.validate('refFromURL', [args.stringSpec(validator, false)], arguments); + try { + Location.makeFromUrl(url); + } catch (e) { + throw new FirebaseStorageError( + Code.INVALID_ARGUMENT, + 'Expected valid full URL but got an invalid one.' + ); + } + return new Reference(this, url); } @@ -182,10 +182,11 @@ export class StorageService { } setMaxUploadRetryTime(time: number): void { - args.validate( - 'setMaxUploadRetryTime', - [args.nonNegativeNumberSpec()], - arguments + validateNumber( + 'time', + /* minValue=*/ 0, + /* maxValue= */ Number.POSITIVE_INFINITY, + time ); this.maxUploadRetryTime_ = time; } @@ -195,10 +196,11 @@ export class StorageService { } setMaxOperationRetryTime(time: number): void { - args.validate( - 'setMaxOperationRetryTime', - [args.nonNegativeNumberSpec()], - arguments + validateNumber( + 'time', + /* minValue=*/ 0, + /* maxValue= */ Number.POSITIVE_INFINITY, + time ); this.maxOperationRetryTime_ = time; } diff --git a/packages/storage/src/task.ts b/packages/storage/src/task.ts index cd9bb7e3fd5..0d330d9a5db 100644 --- a/packages/storage/src/task.ts +++ b/packages/storage/src/task.ts @@ -19,7 +19,7 @@ */ import { FbsBlob } from './implementation/blob'; -import { FirebaseStorageError, Code, canceled } from './implementation/error'; +import { canceled, Code, FirebaseStorageError } from './implementation/error'; import { InternalTaskState, TaskEvent, @@ -38,18 +38,10 @@ import { } from './implementation/observer'; import { Request } from './implementation/request'; import { UploadTaskSnapshot } from './tasksnapshot'; -import { - ArgSpec, - nullFunctionSpec, - looseObjectSpec, - stringSpec, - validate -} from './implementation/args'; import { async as fbsAsync } from './implementation/async'; import { Location } from './implementation/location'; import * as fbsMetadata from './implementation/metadata'; import * as fbsRequests from './implementation/requests'; -import * as typeUtils from './implementation/type'; import { Reference } from './reference'; import { StorageService } from './service'; @@ -451,90 +443,11 @@ export class UploadTask { error?: ErrorFn | null, completed?: CompleteFn | null ): Unsubscribe | Subscribe { - function typeValidator(): void { - if (type !== TaskEvent.STATE_CHANGED) { - throw `Expected one of the event types: [${TaskEvent.STATE_CHANGED}].`; - } - } - const nextOrObserverMessage = - 'Expected a function or an Object with one of ' + - '`next`, `error`, `complete` properties.'; - const nextValidator = nullFunctionSpec(true).validator; - const observerValidator = looseObjectSpec(null, true).validator; - - // eslint-disable-next-line @typescript-eslint/no-explicit-any - function nextOrObserverValidator(p: any): void { - try { - nextValidator(p); - return; - } catch (e) {} - try { - observerValidator(p); - const anyDefined = - typeUtils.isJustDef(p['next']) || - typeUtils.isJustDef(p['error']) || - typeUtils.isJustDef(p['complete']); - if (!anyDefined) { - throw ''; - } - return; - } catch (e) { - throw nextOrObserverMessage; - } - } - const specs = [ - stringSpec(typeValidator), - looseObjectSpec(nextOrObserverValidator, true), - nullFunctionSpec(true), - nullFunctionSpec(true) - ]; - validate('on', specs, arguments); - const self = this; - - function makeBinder( - specs: ArgSpec[] | null - ): Subscribe { - function binder( - nextOrObserver?: - | NextFn - | StorageObserver - | null, - error?: ErrorFn | null, - complete?: CompleteFn | null - ): () => void { - if (specs !== null) { - validate('on', specs, arguments); - } - const observer = new Observer(nextOrObserver, error, completed); - self.addObserver_(observer); - return () => { - self.removeObserver_(observer); - }; - } - return binder; - } - - function binderNextOrObserverValidator(p: unknown): void { - if (p === null) { - throw nextOrObserverMessage; - } - nextOrObserverValidator(p); - } - const binderSpecs = [ - looseObjectSpec(binderNextOrObserverValidator), - nullFunctionSpec(true), - nullFunctionSpec(true) - ]; - const typeOnly = !( - typeUtils.isJustDef(nextOrObserver) || - typeUtils.isJustDef(error) || - typeUtils.isJustDef(completed) - ); - if (typeOnly) { - return makeBinder(binderSpecs); - } else { - return makeBinder(null)(nextOrObserver, error, completed); - } + const observer = new Observer(nextOrObserver, error, completed); + this.addObserver_(observer); + return () => { + this.removeObserver_(observer); + }; } /** @@ -644,7 +557,6 @@ export class UploadTask { * @return True if the operation took effect, false if ignored. */ resume(): boolean { - validate('resume', [], arguments); const valid = this.state_ === InternalTaskState.PAUSED || this.state_ === InternalTaskState.PAUSING; @@ -659,7 +571,6 @@ export class UploadTask { * @return True if the operation took effect, false if ignored. */ pause(): boolean { - validate('pause', [], arguments); const valid = this.state_ === InternalTaskState.RUNNING; if (valid) { this.transition_(InternalTaskState.PAUSING); @@ -673,7 +584,6 @@ export class UploadTask { * @return True if the operation took effect, false if ignored. */ cancel(): boolean { - validate('cancel', [], arguments); const valid = this.state_ === InternalTaskState.RUNNING || this.state_ === InternalTaskState.PAUSING; diff --git a/packages/storage/test/unit/reference.test.ts b/packages/storage/test/unit/reference.test.ts index 7c536f35397..d1955500a2a 100644 --- a/packages/storage/test/unit/reference.test.ts +++ b/packages/storage/test/unit/reference.test.ts @@ -248,195 +248,7 @@ describe('Firebase Storage > Reference', () => { }); describe('Argument verification', () => { - describe('child', () => { - it('throws on no args', () => { - testShared.assertThrows( - testShared.bind(root.child, root), - 'storage/invalid-argument-count' - ); - }); - it('throws on null instead of path', () => { - testShared.assertThrows( - testShared.bind(root.child, root, null), - 'storage/invalid-argument' - ); - }); - it('throws on number instead of path', () => { - testShared.assertThrows( - testShared.bind(root.child, root, 3), - 'storage/invalid-argument' - ); - }); - }); - - describe('toString', () => { - it('throws on number arg', () => { - testShared.assertThrows( - testShared.bind(root.toString, root, 3), - 'storage/invalid-argument-count' - ); - }); - }); - - describe('put', () => { - const blob = new Blob(['a']); - it('throws on no arguments', () => { - testShared.assertThrows( - testShared.bind(child.put, child), - 'storage/invalid-argument-count' - ); - }); - it('throws on number instead of metadata', () => { - testShared.assertThrows( - testShared.bind(child.put, child, new Blob([]), 3), - 'storage/invalid-argument' - ); - }); - it('throws on number instead of data', () => { - testShared.assertThrows( - testShared.bind(child.put, child, 3), - 'storage/invalid-argument' - ); - }); - it('throws null instead of data', () => { - testShared.assertThrows( - testShared.bind(child.put, child, null), - 'storage/invalid-argument' - ); - }); - it("doesn't throw on good metadata", () => { - const goodMetadata = { - md5Hash: 'a', - cacheControl: 'done', - contentDisposition: 'legit', - contentEncoding: 'identity', - contentLanguage: 'en', - contentType: 'text/legit' - }; - assert.doesNotThrow(() => { - const task = child.put(blob, goodMetadata as Metadata); - task.cancel(); - }); - }); - it('throws when customMetadata is a string instead of an object', () => { - const badCustomMetadata = { - md5Hash: 'a', - cacheControl: 'done', - contentDisposition: 'legit', - contentEncoding: 'identity', - contentLanguage: 'en', - contentType: 'text/legit', - customMetadata: 'yo' - }; - testShared.assertThrows( - testShared.bind(child.put, child, blob, badCustomMetadata), - 'storage/invalid-argument' - ); - }); - it('throws when object is supplied instead of string', () => { - const objectInsteadOfStringInMetadata = { - md5Hash: { real: 'hash' }, - cacheControl: 'done', - contentDisposition: 'legit', - contentEncoding: 'identity', - contentLanguage: 'en', - contentType: 'text/legit' - }; - testShared.assertThrows( - testShared.bind( - child.put, - child, - blob, - objectInsteadOfStringInMetadata - ), - 'storage/invalid-argument' - ); - }); - }); - - describe('putString', () => { - it('throws on no arguments', () => { - testShared.assertThrows( - testShared.bind(child.putString, child), - 'storage/invalid-argument-count' - ); - }); - it('throws on invalid format', () => { - testShared.assertThrows( - testShared.bind(child.putString, child, 'raw', 'notaformat'), - 'storage/invalid-argument' - ); - }); - it('throws on number instead of string', () => { - testShared.assertThrows( - testShared.bind(child.putString, child, 3, StringFormat.RAW), - 'storage/invalid-argument' - ); - }); - it('throws on invalid metadata', () => { - testShared.assertThrows( - testShared.bind(child.putString, child, 'raw', StringFormat.RAW, 3), - 'storage/invalid-argument' - ); - }); - }); - - describe('delete', () => { - it('throws on a number arg', () => { - testShared.assertThrows( - testShared.bind(child.delete, child, 3), - 'storage/invalid-argument-count' - ); - }); - }); - - describe('getMetadata', () => { - it('throws on a number arg', () => { - testShared.assertThrows( - testShared.bind(child.getMetadata, child, 3), - 'storage/invalid-argument-count' - ); - }); - }); - - describe('listAll', () => { - it('throws on number arg', () => { - testShared.assertThrows( - testShared.bind(child.listAll, child, 1), - 'storage/invalid-argument-count' - ); - }); - }); - describe('list', () => { - it('throws on invalid option', () => { - testShared.assertThrows( - testShared.bind(child.list, child, 'invalid-option'), - 'storage/invalid-argument' - ); - }); - it('throws on number arg', () => { - testShared.assertThrows( - testShared.bind(child.list, child, 1, 2), - 'storage/invalid-argument-count' - ); - }); - it('throws on non-string pageToken', () => { - testShared.assertThrows( - testShared.bind(child.list, child, { pageToken: { x: 1 } }), - 'storage/invalid-argument' - ); - }); - it('throws on non-int maxResults', () => { - testShared.assertThrows( - testShared.bind(child.list, child, { maxResults: '4' }), - 'storage/invalid-argument' - ); - testShared.assertThrows( - testShared.bind(child.list, child, { maxResults: 1.2 }), - 'storage/invalid-argument' - ); - }); it('throws on invalid maxResults', () => { testShared.assertThrows( testShared.bind(child.list, child, { maxResults: 0 }), @@ -451,42 +263,6 @@ describe('Firebase Storage > Reference', () => { 'storage/invalid-argument' ); }); - it('throws on unkonw option', () => { - testShared.assertThrows( - testShared.bind(child.list, child, { unknown: 'ok' }), - 'storage/invalid-argument' - ); - }); - }); - - describe('updateMetadata', () => { - it('throws on no args', () => { - testShared.assertThrows( - testShared.bind(child.updateMetadata, child), - 'storage/invalid-argument-count' - ); - }); - it('throws on number arg', () => { - testShared.assertThrows( - testShared.bind(child.updateMetadata, child, 3), - 'storage/invalid-argument' - ); - }); - it('throws on null arg', () => { - testShared.assertThrows( - testShared.bind(child.updateMetadata, child, null), - 'storage/invalid-argument' - ); - }); - }); - - describe('getDownloadURL', () => { - it('throws on number arg', () => { - testShared.assertThrows( - testShared.bind(child.getDownloadURL, child, 3), - 'storage/invalid-argument-count' - ); - }); }); }); diff --git a/packages/storage/test/unit/service.test.ts b/packages/storage/test/unit/service.test.ts index b0660707537..595add06579 100644 --- a/packages/storage/test/unit/service.test.ts +++ b/packages/storage/test/unit/service.test.ts @@ -166,7 +166,10 @@ describe('Firebase Storage > Service', () => { const error = testShared.assertThrows(() => { service.refFromURL('path/to/child'); }, 'storage/invalid-argument'); - assert.match(error.message, /invalid/i); + assert.match( + error.message, + /Expected full URL but got a child path, use ref instead/i + ); }); it('Works with gs:// URLs', () => { const ref = service.refFromURL('gs://mybucket/child/path/image.png'); @@ -219,56 +222,14 @@ GOOG4-RSA-SHA256` xhrIoPool ); describe('ref', () => { - it('Throws with two args', () => { - testShared.assertThrows( - testShared.bind(service.ref, service, 1, 2), - 'storage/invalid-argument-count' - ); - }); it('Throws on gs:// argument', () => { testShared.assertThrows( testShared.bind(service.ref, service, 'gs://yo'), 'storage/invalid-argument' ); }); - it('Throws on number argument', () => { - testShared.assertThrows( - testShared.bind(service.ref, service, 3), - 'storage/invalid-argument' - ); - }); - it('Throws on null argument', () => { - testShared.assertThrows( - testShared.bind(service.ref, service, null), - 'storage/invalid-argument' - ); - }); }); describe('refFromURL', () => { - it('Throws with no args', () => { - testShared.assertThrows( - testShared.bind(service.refFromURL, service), - 'storage/invalid-argument-count' - ); - }); - it('Throws with two args', () => { - testShared.assertThrows( - testShared.bind(service.refFromURL, service, 'a', 'b'), - 'storage/invalid-argument-count' - ); - }); - it('Throws with a non-URL string arg', () => { - testShared.assertThrows( - testShared.bind(service.refFromURL, service, 'child'), - 'storage/invalid-argument' - ); - }); - it('Throws with a null arg', () => { - testShared.assertThrows( - testShared.bind(service.refFromURL, service, null), - 'storage/invalid-argument' - ); - }); it('Throws with an invalid URL arg', () => { testShared.assertThrows( testShared.bind(service.refFromURL, service, 'notlegit://url'), @@ -277,24 +238,6 @@ GOOG4-RSA-SHA256` }); }); describe('setMaxUploadRetryTime', () => { - it('Throws on no args', () => { - testShared.assertThrows( - testShared.bind(service.setMaxUploadRetryTime, service), - 'storage/invalid-argument-count' - ); - }); - it('Throws on two args', () => { - testShared.assertThrows( - testShared.bind(service.setMaxUploadRetryTime, service, 1, 2), - 'storage/invalid-argument-count' - ); - }); - it('Throws on string arg', () => { - testShared.assertThrows( - testShared.bind(service.setMaxUploadRetryTime, service, 'a'), - 'storage/invalid-argument' - ); - }); it('Throws on negative arg', () => { testShared.assertThrows( testShared.bind(service.setMaxUploadRetryTime, service, -10), @@ -303,24 +246,6 @@ GOOG4-RSA-SHA256` }); }); describe('setMaxOperationRetryTime', () => { - it('Throws on no args', () => { - testShared.assertThrows( - testShared.bind(service.setMaxOperationRetryTime, service), - 'storage/invalid-argument-count' - ); - }); - it('Throws on two args', () => { - testShared.assertThrows( - testShared.bind(service.setMaxOperationRetryTime, service, 1, 2), - 'storage/invalid-argument-count' - ); - }); - it('Throws on string arg', () => { - testShared.assertThrows( - testShared.bind(service.setMaxOperationRetryTime, service, 'a'), - 'storage/invalid-argument' - ); - }); it('Throws on negative arg', () => { testShared.assertThrows( testShared.bind(service.setMaxOperationRetryTime, service, -10), diff --git a/packages/storage/test/unit/task.test.ts b/packages/storage/test/unit/task.test.ts index 862b17798e7..d4cd24f8a6d 100644 --- a/packages/storage/test/unit/task.test.ts +++ b/packages/storage/test/unit/task.test.ts @@ -24,12 +24,7 @@ import { Headers } from '../../src/implementation/xhrio'; import { Reference } from '../../src/reference'; import { StorageService } from '../../src/service'; import { UploadTask } from '../../src/task'; -import { - assertThrows, - bind as fbsBind, - makePool, - emptyAuthProvider -} from './testshared'; +import { makePool, emptyAuthProvider } from './testshared'; import { StringHeaders, TestingXhrIo } from './xhrio'; const testLocation = new Location('bucket', 'object'); @@ -496,100 +491,4 @@ describe('Firebase Storage > Upload Task', () => { it('Calls callback sequences for big uploads correctly', () => { return runNormalUploadTest(bigBlob); }); - - describe('Argument verification', () => { - const storageService = storageServiceWithHandler(fakeServerHandler()); - const task = new UploadTask( - {} as Reference, - storageService, - testLocation, - mappings, - smallBlob - ); - describe('on', () => { - it('Throws on no args', () => { - assertThrows(fbsBind(task.on, task), 'storage/invalid-argument-count'); - }); - it('Throws on 5 args', () => { - assertThrows( - fbsBind(task.on, task, TaskEvent.STATE_CHANGED, null, null, null, 1), - 'storage/invalid-argument-count' - ); - }); - it('Throws on a single string arg', () => { - assertThrows(fbsBind(task.on, task, '3'), 'storage/invalid-argument'); - }); - it('Throws on a single null arg', () => { - assertThrows(fbsBind(task.on, task, null), 'storage/invalid-argument'); - }); - it('Throws on a number arg instead of a function', () => { - assertThrows( - fbsBind(task.on, task, TaskEvent.STATE_CHANGED, null, null, 3), - 'storage/invalid-argument' - ); - }); - it('Throws on an empty object arg', () => { - assertThrows( - fbsBind(task.on, task, TaskEvent.STATE_CHANGED, {}), - 'storage/invalid-argument' - ); - }); - }); - describe('subscribe returned from on', () => { - it('Throws on no args', () => { - assertThrows( - fbsBind(task.on(TaskEvent.STATE_CHANGED), null), - 'storage/invalid-argument-count' - ); - }); - it('Throws on 4 args', () => { - assertThrows( - fbsBind(task.on(TaskEvent.STATE_CHANGED), null, null, null, null, 1), - 'storage/invalid-argument-count' - ); - }); - it('Throws number arg instead of function', () => { - assertThrows( - fbsBind(task.on(TaskEvent.STATE_CHANGED), null, null, null, 3), - 'storage/invalid-argument' - ); - }); - it('Throws on an empty object arg', () => { - assertThrows( - fbsBind(task.on(TaskEvent.STATE_CHANGED), null, {}), - 'storage/invalid-argument' - ); - }); - it('Throws on a single null arg', () => { - assertThrows( - fbsBind(task.on(TaskEvent.STATE_CHANGED), null, null), - 'storage/invalid-argument' - ); - }); - }); - describe('resume', () => { - it('Throws on a number', () => { - assertThrows( - fbsBind(task.resume, task, 3), - 'storage/invalid-argument-count' - ); - }); - }); - describe('pause', () => { - it('Throws on a number', () => { - assertThrows( - fbsBind(task.pause, task, 3), - 'storage/invalid-argument-count' - ); - }); - }); - describe('cancel', () => { - it('Throws on a number', () => { - assertThrows( - fbsBind(task.cancel, task, 3), - 'storage/invalid-argument-count' - ); - }); - }); - }); }); From 9719635fe2ecbb5b981076ce4807d0df775b8332 Mon Sep 17 00:00:00 2001 From: Brian Chen Date: Tue, 20 Oct 2020 16:47:15 -0500 Subject: [PATCH 026/624] Remove null and NaN checks in filters (#3960) --- .changeset/wicked-cups-search.md | 5 ++ packages/firestore/src/api/database.ts | 16 ---- packages/firestore/src/core/query.ts | 19 ----- .../test/integration/api/query.test.ts | 63 +++++++++++++++- .../test/integration/api/validation.test.ts | 73 ------------------- 5 files changed, 65 insertions(+), 111 deletions(-) create mode 100644 .changeset/wicked-cups-search.md diff --git a/.changeset/wicked-cups-search.md b/.changeset/wicked-cups-search.md new file mode 100644 index 00000000000..abfaf518003 --- /dev/null +++ b/.changeset/wicked-cups-search.md @@ -0,0 +1,5 @@ +--- +'@firebase/firestore': minor +--- + +Removed excess validation of null and NaN values in query filters. This more closely aligns the SDK with the Firestore backend, which has always accepted null and NaN for all operators, even though this isn't necessarily useful. diff --git a/packages/firestore/src/api/database.ts b/packages/firestore/src/api/database.ts index 0288762bdf7..5d682599ef4 100644 --- a/packages/firestore/src/api/database.ts +++ b/packages/firestore/src/api/database.ts @@ -1672,22 +1672,6 @@ function validateDisjunctiveFilterElements( 'maximum of 10 elements in the value array.' ); } - if (operator === Operator.IN || operator === Operator.ARRAY_CONTAINS_ANY) { - if (value.indexOf(null) >= 0) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - `Invalid Query. '${operator.toString()}' filters cannot contain 'null' ` + - 'in the value array.' - ); - } - if (value.filter(element => Number.isNaN(element)).length > 0) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - `Invalid Query. '${operator.toString()}' filters cannot contain 'NaN' ` + - 'in the value array.' - ); - } - } } /** diff --git a/packages/firestore/src/core/query.ts b/packages/firestore/src/core/query.ts index 8081fc74beb..2bb83e75699 100644 --- a/packages/firestore/src/core/query.ts +++ b/packages/firestore/src/core/query.ts @@ -23,8 +23,6 @@ import { arrayValueContains, canonicalId, isArray, - isNanValue, - isNullValue, isReferenceValue, typeOrder, valueCompare, @@ -32,7 +30,6 @@ import { } from '../model/values'; import { FieldPath, ResourcePath } from '../model/path'; import { debugAssert, debugCast, fail } from '../util/assert'; -import { Code, FirestoreError } from '../util/error'; import { isNullOrUndefined } from '../util/types'; import { canonifyTarget, @@ -603,22 +600,6 @@ export class FieldFilter extends Filter { ); return new KeyFieldFilter(field, op, value); } - } else if (isNullValue(value)) { - if (op !== Operator.EQUAL && op !== Operator.NOT_EQUAL) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - "Invalid query. Null only supports '==' and '!=' comparisons." - ); - } - return new FieldFilter(field, op, value); - } else if (isNanValue(value)) { - if (op !== Operator.EQUAL && op !== Operator.NOT_EQUAL) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - "Invalid query. NaN only supports '==' and '!=' comparisons." - ); - } - return new FieldFilter(field, op, value); } else if (op === Operator.ARRAY_CONTAINS) { return new ArrayContainsFilter(field, value); } else if (op === Operator.IN) { diff --git a/packages/firestore/test/integration/api/query.test.ts b/packages/firestore/test/integration/api/query.test.ts index 4e7a2c1543e..f8936e1fe32 100644 --- a/packages/firestore/test/integration/api/query.test.ts +++ b/packages/firestore/test/integration/api/query.test.ts @@ -759,7 +759,9 @@ apiDescribe('Queries', (persistence: boolean) => { a: { array: [42] }, b: { array: ['a', 42, 'c'] }, c: { array: [41.999, '42', { a: [42] }] }, - d: { array: [42], array2: ['bingo'] } + d: { array: [42], array2: ['bingo'] }, + e: { array: [null] }, + f: { array: [Number.NaN] } }; await withTestCollection(persistence, testDocs, async coll => { @@ -773,6 +775,15 @@ apiDescribe('Queries', (persistence: boolean) => { // NOTE: The backend doesn't currently support null, NaN, objects, or // arrays, so there isn't much of anything else interesting to test. + // With null. + const snapshot3 = await coll.where('zip', 'array-contains', null).get(); + expect(toDataArray(snapshot3)).to.deep.equal([]); + + // With NaN. + const snapshot4 = await coll + .where('zip', 'array-contains', Number.NaN) + .get(); + expect(toDataArray(snapshot4)).to.deep.equal([]); }); }); @@ -784,7 +795,9 @@ apiDescribe('Queries', (persistence: boolean) => { d: { zip: [98101] }, e: { zip: ['98101', { zip: 98101 }] }, f: { zip: { code: 500 } }, - g: { zip: [98101, 98102] } + g: { zip: [98101, 98102] }, + h: { zip: null }, + i: { zip: Number.NaN } }; await withTestCollection(persistence, testDocs, async coll => { @@ -800,6 +813,24 @@ apiDescribe('Queries', (persistence: boolean) => { // With objects. const snapshot2 = await coll.where('zip', 'in', [{ code: 500 }]).get(); expect(toDataArray(snapshot2)).to.deep.equal([{ zip: { code: 500 } }]); + + // With null. + const snapshot3 = await coll.where('zip', 'in', [null]).get(); + expect(toDataArray(snapshot3)).to.deep.equal([]); + + // With null and a value. + const snapshot4 = await coll.where('zip', 'in', [98101, null]).get(); + expect(toDataArray(snapshot4)).to.deep.equal([{ zip: 98101 }]); + + // With NaN. + const snapshot5 = await coll.where('zip', 'in', [Number.NaN]).get(); + expect(toDataArray(snapshot5)).to.deep.equal([]); + + // With NaN and a value. + const snapshot6 = await coll + .where('zip', 'in', [98101, Number.NaN]) + .get(); + expect(toDataArray(snapshot6)).to.deep.equal([{ zip: 98101 }]); }); }); @@ -913,7 +944,9 @@ apiDescribe('Queries', (persistence: boolean) => { d: { array: [42], array2: ['bingo'] }, e: { array: [43] }, f: { array: [{ a: 42 }] }, - g: { array: 42 } + g: { array: 42 }, + h: { array: [null] }, + i: { array: [Number.NaN] } }; await withTestCollection(persistence, testDocs, async coll => { @@ -932,6 +965,30 @@ apiDescribe('Queries', (persistence: boolean) => { .where('array', 'array-contains-any', [{ a: 42 }]) .get(); expect(toDataArray(snapshot2)).to.deep.equal([{ array: [{ a: 42 }] }]); + + // With null. + const snapshot3 = await coll + .where('array', 'array-contains-any', [null]) + .get(); + expect(toDataArray(snapshot3)).to.deep.equal([]); + + // With null and a value. + const snapshot4 = await coll + .where('array', 'array-contains-any', [43, null]) + .get(); + expect(toDataArray(snapshot4)).to.deep.equal([{ array: [43] }]); + + // With NaN. + const snapshot5 = await coll + .where('array', 'array-contains-any', [Number.NaN]) + .get(); + expect(toDataArray(snapshot5)).to.deep.equal([]); + + // With NaN and a value. + const snapshot6 = await coll + .where('array', 'array-contains-any', [43, Number.NaN]) + .get(); + expect(toDataArray(snapshot6)).to.deep.equal([{ array: [43] }]); }); }); diff --git a/packages/firestore/test/integration/api/validation.test.ts b/packages/firestore/test/integration/api/validation.test.ts index e747ce97a02..a5f7beff894 100644 --- a/packages/firestore/test/integration/api/validation.test.ts +++ b/packages/firestore/test/integration/api/validation.test.ts @@ -711,51 +711,6 @@ apiDescribe('Validation:', (persistence: boolean) => { ); }); - validationIt( - persistence, - 'with null or NaN non-equality filters fail', - db => { - const collection = db.collection('test'); - expect(() => collection.where('a', '>', null)).to.throw( - "Invalid query. Null only supports '==' and '!=' comparisons." - ); - expect(() => collection.where('a', 'array-contains', null)).to.throw( - "Invalid query. Null only supports '==' and '!=' comparisons." - ); - expect(() => collection.where('a', 'in', null)).to.throw( - "Invalid Query. A non-empty array is required for 'in' filters." - ); - expect(() => collection.where('a', 'not-in', null)).to.throw( - "Invalid Query. A non-empty array is required for 'not-in' filters." - ); - expect(() => - collection.where('a', 'array-contains-any', null) - ).to.throw( - "Invalid Query. A non-empty array is required for 'array-contains-any' filters." - ); - - expect(() => collection.where('a', '>', Number.NaN)).to.throw( - "Invalid query. NaN only supports '==' and '!=' comparisons." - ); - expect(() => - collection.where('a', 'array-contains', Number.NaN) - ).to.throw( - "Invalid query. NaN only supports '==' and '!=' comparisons." - ); - expect(() => collection.where('a', 'in', Number.NaN)).to.throw( - "Invalid Query. A non-empty array is required for 'in' filters." - ); - expect(() => collection.where('a', 'not-in', Number.NaN)).to.throw( - "Invalid Query. A non-empty array is required for 'not-in' filters." - ); - expect(() => - collection.where('a', 'array-contains-any', Number.NaN) - ).to.throw( - "Invalid Query. A non-empty array is required for 'array-contains-any' filters." - ); - } - ); - it('cannot be created from documents missing sort values', () => { const testDocs = { f: { k: 'f', nosort: 1 } // should not show up @@ -1246,34 +1201,6 @@ apiDescribe('Validation:', (persistence: boolean) => { 'Invalid Query. A non-empty array is required for ' + "'array-contains-any' filters." ); - - expect(() => - db.collection('test').where('foo', 'in', [3, null]) - ).to.throw( - "Invalid Query. 'in' filters cannot contain 'null' in the value array." - ); - - expect(() => - db.collection('test').where('foo', 'array-contains-any', [3, null]) - ).to.throw( - "Invalid Query. 'array-contains-any' filters cannot contain 'null' " + - 'in the value array.' - ); - - expect(() => - db.collection('test').where('foo', 'in', [2, Number.NaN]) - ).to.throw( - "Invalid Query. 'in' filters cannot contain 'NaN' in the value array." - ); - - expect(() => - db - .collection('test') - .where('foo', 'array-contains-any', [2, Number.NaN]) - ).to.throw( - "Invalid Query. 'array-contains-any' filters cannot contain 'NaN' " + - 'in the value array.' - ); } ); From 602ec18e92fd365a3a6432ff3a5f6a31013eb1f5 Mon Sep 17 00:00:00 2001 From: Feiyang Date: Tue, 20 Oct 2020 15:35:25 -0700 Subject: [PATCH 027/624] Fix a typing error in database-types (#3968) * push should return a ThenableReference * make thenable only implement then & catch * Create tame-knives-change.md * Update .changeset/tame-knives-change.md Co-authored-by: Sebastian Schmidt Co-authored-by: Sebastian Schmidt --- .changeset/tame-knives-change.md | 7 +++++++ packages/database-types/index.d.ts | 6 ++++-- packages/firebase/index.d.ts | 2 +- 3 files changed, 12 insertions(+), 3 deletions(-) create mode 100644 .changeset/tame-knives-change.md diff --git a/.changeset/tame-knives-change.md b/.changeset/tame-knives-change.md new file mode 100644 index 00000000000..d2d813fb735 --- /dev/null +++ b/.changeset/tame-knives-change.md @@ -0,0 +1,7 @@ +--- +"@firebase/database-types": patch +"@firebase/database": patch +"firebase": patch +--- + +Updated the type definition for `ThenableReference` to only implement `then` and `catch`, which matches the implementation. diff --git a/packages/database-types/index.d.ts b/packages/database-types/index.d.ts index 15538ce1213..fa377fb241d 100644 --- a/packages/database-types/index.d.ts +++ b/packages/database-types/index.d.ts @@ -108,7 +108,7 @@ export interface Reference extends Query { key: string | null; onDisconnect(): OnDisconnect; parent: Reference | null; - push(value?: any, onComplete?: (a: Error | null) => any): Reference; + push(value?: any, onComplete?: (a: Error | null) => any): ThenableReference; remove(onComplete?: (a: Error | null) => any): Promise; root: Reference; set(value: any, onComplete?: (a: Error | null) => any): Promise; @@ -134,7 +134,9 @@ export interface ServerValue { increment(delta: number): Object; } -export interface ThenableReference extends Reference, Promise {} +export interface ThenableReference + extends Reference, + Pick, 'then' | 'catch'> {} export function enableLogging( logger?: boolean | ((a: string) => any), diff --git a/packages/firebase/index.d.ts b/packages/firebase/index.d.ts index 35a7d5549e6..2cae198c74d 100644 --- a/packages/firebase/index.d.ts +++ b/packages/firebase/index.d.ts @@ -6902,7 +6902,7 @@ declare namespace firebase.database { interface ThenableReference extends firebase.database.Reference, - Promise {} + Pick, 'then' | 'catch'> {} /** * Logs debugging information to the console. From 7c15fb0a0a9efc9ca8bac4a95f2e8d47c08071cb Mon Sep 17 00:00:00 2001 From: Feiyang Date: Wed, 21 Oct 2020 15:05:25 -0700 Subject: [PATCH 028/624] update import syntax in readmes and messages (#3973) --- packages-exp/firebase-exp/compat/index.ts | 2 +- packages/firebase/README.md | 6 +++--- packages/firebase/src/index.ts | 2 +- packages/rxfire/README.md | 8 ++++---- packages/rxfire/docs/storage.md | 12 ++++++------ 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/packages-exp/firebase-exp/compat/index.ts b/packages-exp/firebase-exp/compat/index.ts index 89e4a793ebd..074d7223507 100644 --- a/packages-exp/firebase-exp/compat/index.ts +++ b/packages-exp/firebase-exp/compat/index.ts @@ -32,7 +32,7 @@ import firebase from 'firebase/app'; import 'firebase/'; Typescript: -import * as firebase from 'firebase/app'; +import firebase from 'firebase/app'; import 'firebase/'; `); diff --git a/packages/firebase/README.md b/packages/firebase/README.md index 7c20ddd7321..3fb84fa4fb1 100644 --- a/packages/firebase/README.md +++ b/packages/firebase/README.md @@ -92,7 +92,7 @@ var app = firebase.initializeApp({ ... }); If you are using ES6 imports or TypeScript: ```js -import * as firebase from 'firebase'; +import firebase from 'firebase'; var app = firebase.initializeApp({ ... }); ``` @@ -147,7 +147,7 @@ services you use: ```js // This import loads the firebase namespace along with all its type information. -import * as firebase from 'firebase/app'; +import firebase from 'firebase/app'; // These imports load individual services into the firebase namespace. import 'firebase/auth'; @@ -187,7 +187,7 @@ you should do: ```js // This import loads the firebase namespace. -import * as firebase from 'firebase/app'; +import firebase from 'firebase/app'; // These imports load individual services into the firebase namespace. import 'firebase/auth'; diff --git a/packages/firebase/src/index.ts b/packages/firebase/src/index.ts index ffaef50690e..113eef3a9fb 100644 --- a/packages/firebase/src/index.ts +++ b/packages/firebase/src/index.ts @@ -32,7 +32,7 @@ import firebase from 'firebase/app'; import 'firebase/'; Typescript: -import * as firebase from 'firebase/app'; +import firebase from 'firebase/app'; import 'firebase/'; `); diff --git a/packages/rxfire/README.md b/packages/rxfire/README.md index 9c12afdeb2e..c9e1e7010d9 100644 --- a/packages/rxfire/README.md +++ b/packages/rxfire/README.md @@ -26,7 +26,7 @@ Make sure to install Firebase and RxJS individually as they are peer dependencie ## Example use: ```ts -import * as firebase from 'firebase/app'; +import firebase from 'firebase/app'; import 'firebase/firestore'; import { collectionData } from 'rxfire/firestore'; import { tap } from 'rxjs/operators'; @@ -49,7 +49,7 @@ RxJS provides multiple operators and creation methods for combining observable s The example below streams a list of "cities" from Firestore and then retrieves their image from a Cloud Storage bucket. Both tasks are asynchronous but RxJS makes it easy to combine these tasks together. ```ts -import * as firebase from 'firebase/app'; +import firebase from 'firebase/app'; import 'firebase/firestore'; import 'firebase/storage'; import { collectionData } from 'rxfire/firestore'; @@ -79,7 +79,7 @@ collectionData(citiesRef, 'id') RxFire is a complementary library to Firebase. It is not meant to wrap the entire Firebase SDK. RxFire's purpose is to simplify async streams from Firebase. You need to import the Firebase SDK and initialize an app before using RxFire. ```ts -import * as firebase from 'firebase/app'; +import firebase from 'firebase/app'; import 'firebase/storage'; // import only the features needed import { getDownloadURL } from 'rxfire/storage'; @@ -104,7 +104,7 @@ import { } from 'rxfire/functions'; RxFire is a set of functions. Most functions create observables and from there you can use regular RxJS operators. Some functions are custom operators. But at the end of the day, it's all just functions. This is important for **tree shaking**. Any unused functions are stripped from your final build if you use a module bundler like Webpack or Rollup. ```ts -import * as firebase from 'firebase/app'; +import firebase from 'firebase/app'; import 'firebase/storage'; import { getDownloadURL, put /* not used! */ } 'rxfire/storage'; diff --git a/packages/rxfire/docs/storage.md b/packages/rxfire/docs/storage.md index 34cbdad84c5..ecd7342f076 100644 --- a/packages/rxfire/docs/storage.md +++ b/packages/rxfire/docs/storage.md @@ -15,7 +15,7 @@ The `fromTask()` function creates an observable that emits progress changes. #### TypeScript Example ```ts import { fromTask } from 'rxfire/storage'; -import * as firebase from 'firebase'; +import firebase from 'firebase'; import 'firebase/storage'; // Set up Firebase @@ -43,7 +43,7 @@ The `percentage()` function creates an observable that emits percentage of the u #### TypeScript Example ```ts import { percentage } from 'rxfire/storage'; -import * as firebase from 'firebase'; +import firebase from 'firebase'; import 'firebase/storage'; // Set up Firebase @@ -73,7 +73,7 @@ The `getDownloadURL()` function creates an observable that emits the URL of the #### TypeScript Example ```ts import { getDownloadURL } from 'rxfire/storage'; -import * as firebase from 'firebase'; +import firebase from 'firebase'; import 'firebase/storage'; // Set up Firebase @@ -100,7 +100,7 @@ The `getMetadata()` function creates an observable that emits the URL of the fil #### TypeScript Example ```ts import { getMetadata } from 'rxfire/storage'; -import * as firebase from 'firebase'; +import firebase from 'firebase'; import 'firebase/storage'; // Set up Firebase @@ -127,7 +127,7 @@ The `put()` function creates an observable that emits the upload progress of a f #### TypeScript Example ```ts import { put } from 'rxfire/storage'; -import * as firebase from 'firebase'; +import firebase from 'firebase'; import 'firebase/storage'; // Set up Firebase @@ -157,7 +157,7 @@ The `putString()` function creates an observable that emits the upload progress #### TypeScript Example ```ts import { putString } from 'rxfire/storage'; -import * as firebase from 'firebase'; +import firebase from 'firebase'; import 'firebase/storage'; // Set up Firebase From 3e7175da50a1a048c8b010cc29d8d9d5fd429b87 Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Thu, 22 Oct 2020 10:32:04 -0700 Subject: [PATCH 029/624] Fix changeset typo (#3978) --- .changeset/tiny-hounds-rest.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/tiny-hounds-rest.md b/.changeset/tiny-hounds-rest.md index c1587fdd110..a5271ae3492 100644 --- a/.changeset/tiny-hounds-rest.md +++ b/.changeset/tiny-hounds-rest.md @@ -1,5 +1,5 @@ --- -"firebase: major +"firebase": major "@firebase/storage": major --- From f4110cc5bd7eb81eafae7df632ac5bf03a7e0639 Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Thu, 22 Oct 2020 11:16:57 -0700 Subject: [PATCH 030/624] Remove ignored changeset. (#3979) --- .changeset/silver-books-reply.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.changeset/silver-books-reply.md b/.changeset/silver-books-reply.md index 7035ae9bcb6..13c7f6dad5c 100644 --- a/.changeset/silver-books-reply.md +++ b/.changeset/silver-books-reply.md @@ -1,6 +1,5 @@ --- 'firebase': minor -'@firebase/functions-exp': minor '@firebase/functions': minor '@firebase/functions-types': minor --- From 64c8d04c299869acf22ed7152962f8bccb582f40 Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Thu, 22 Oct 2020 12:54:03 -0700 Subject: [PATCH 031/624] Add compat to test commands (#3981) --- package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index d8b33834a3b..cf5dc36aa85 100644 --- a/package.json +++ b/package.json @@ -34,8 +34,8 @@ "pretest": "node tools/pretest.js", "test": "lerna run --concurrency 4 --stream test", "test:ci": "lerna run --concurrency 4 test:ci", - "test:release": "lerna run --concurrency 4 --ignore @firebase/*-exp --ignore firebase-exp test:ci", - "test:exp": "lerna run --concurrency 4 --scope @firebase/*-exp --scope firebase-exp --stream test", + "test:release": "lerna run --concurrency 4 --ignore @firebase/*-exp --ignore firebase-exp --ignore @firebase/*-compat test:ci", + "test:exp": "lerna run --concurrency 4 --scope @firebase/*-exp --scope firebase-exp --scope @firebase/*-compat --stream test", "pretest:coverage": "mkdirp coverage", "ci:coverage": "lcov-result-merger 'packages/**/lcov.info' 'lcov-all.info'", "test:coverage": "lcov-result-merger 'packages/**/lcov.info' | coveralls", From 3f4cbf761af2487e157a3b73ffb9e714e694a76a Mon Sep 17 00:00:00 2001 From: Sam Horlbeck Olsen Date: Thu, 22 Oct 2020 14:09:13 -0700 Subject: [PATCH 032/624] Fix anonymous auth relogin edge case with additionalUserInfo (#3961) * Handle anonymous auth re-login edge case * Formatting --- .../core/user/additional_user_info.test.ts | 96 ++++++++++++++++--- .../src/core/user/additional_user_info.ts | 15 ++- 2 files changed, 97 insertions(+), 14 deletions(-) diff --git a/packages-exp/auth-exp/src/core/user/additional_user_info.test.ts b/packages-exp/auth-exp/src/core/user/additional_user_info.test.ts index 0f98bb5f9e2..16107569707 100644 --- a/packages-exp/auth-exp/src/core/user/additional_user_info.test.ts +++ b/packages-exp/auth-exp/src/core/user/additional_user_info.test.ts @@ -17,23 +17,33 @@ import { expect } from 'chai'; -import { ProviderId, UserProfile } from '@firebase/auth-types-exp'; +import { + OperationType, + ProviderId, + UserProfile +} from '@firebase/auth-types-exp'; import { IdTokenResponse, IdTokenResponseKind } from '../../model/id_token'; -import { _fromIdTokenResponse } from './additional_user_info'; +import { + _fromIdTokenResponse, + getAdditionalUserInfo +} from './additional_user_info'; import { base64Encode } from '@firebase/util'; +import { UserCredentialImpl } from './user_credential_impl'; +import { Auth } from '../../model/auth'; +import { User, UserCredential } from '../../model/user'; +import { testAuth, testUser } from '../../../test/helpers/mock_auth'; describe('core/user/additional_user_info', () => { + const userProfileWithLogin: UserProfile = { + login: 'scott', + friends: [], + netWorth: 5.0 + }; + const rawUserInfoWithLogin = JSON.stringify(userProfileWithLogin); + const userProfileNoLogin: UserProfile = { sample: 'data' }; + const rawUserInfoNoLogin = JSON.stringify(userProfileNoLogin); describe('_fromIdTokenResponse', () => { - const userProfileWithLogin: UserProfile = { - login: 'scott', - friends: [], - netWorth: 5.0 - }; - const rawUserInfoWithLogin = JSON.stringify(userProfileWithLogin); - const userProfileNoLogin: UserProfile = { sample: 'data' }; - const rawUserInfoNoLogin = JSON.stringify(userProfileNoLogin); - describe('parses federated IDP response tokens', () => { it('for FacebookAdditionalUserInfo', () => { const idResponse = idTokenResponse({ @@ -211,6 +221,70 @@ describe('core/user/additional_user_info', () => { }); }); }); + + describe('getAdditionalUserInfo()', () => { + let auth: Auth; + let user: User; + let cred: UserCredential; + beforeEach(async () => { + auth = await testAuth(); + user = testUser(auth, 'uid'); + cred = new UserCredentialImpl({ + user, + providerId: null, + operationType: OperationType.SIGN_IN + }); + }); + + it('calls through to _fromIdTokenResponse', () => { + cred._tokenResponse = idTokenResponse({ + providerId: ProviderId.ANONYMOUS, + rawUserInfo: rawUserInfoWithLogin + }); + const { + isNewUser, + providerId, + username, + profile + } = getAdditionalUserInfo(cred)!; + expect(isNewUser).to.be.false; + expect(providerId).to.be.null; + expect(username).to.be.undefined; + expect(profile).to.eq(profile); + }); + + it('calls through to _fromIdTokenResponse preserving isNewUser', () => { + cred._tokenResponse = idTokenResponse({ + providerId: ProviderId.ANONYMOUS, + rawUserInfo: rawUserInfoWithLogin, + isNewUser: true + }); + const { + isNewUser, + providerId, + username, + profile + } = getAdditionalUserInfo(cred)!; + expect(isNewUser).to.be.true; + expect(providerId).to.be.null; + expect(username).to.be.undefined; + expect(profile).to.eq(profile); + }); + + it('returns bespoke info if existing anonymous user', () => { + // Note that _tokenResponse is not set on cred + ((user as unknown) as Record).isAnonymous = true; + const { isNewUser, providerId, profile } = getAdditionalUserInfo(cred)!; + expect(isNewUser).to.be.false; + expect(providerId).to.be.null; + expect(profile).to.eq(profile); + }); + + it('returns null if not anonymous', () => { + // Note that _tokenResponse is not set on cred + expect(getAdditionalUserInfo(cred)).to.be.null; + }); + }); }); function idTokenResponse(partial: Partial): IdTokenResponse { diff --git a/packages-exp/auth-exp/src/core/user/additional_user_info.ts b/packages-exp/auth-exp/src/core/user/additional_user_info.ts index 0e61f7c2a67..cd7faf432e1 100644 --- a/packages-exp/auth-exp/src/core/user/additional_user_info.ts +++ b/packages-exp/auth-exp/src/core/user/additional_user_info.ts @@ -129,7 +129,16 @@ class TwitterAdditionalUserInfo extends FederatedAdditionalUserInfoWithUsername export function getAdditionalUserInfo( userCredential: externs.UserCredential ): externs.AdditionalUserInfo | null { - return _fromIdTokenResponse( - (userCredential as UserCredential)._tokenResponse - ); + const { user, _tokenResponse } = userCredential as UserCredential; + if (user.isAnonymous && !_tokenResponse) { + // Handle the special case where signInAnonymously() gets called twice. + // No network call is made so there's nothing to actually fill this in + return { + providerId: null, + isNewUser: false, + profile: null + }; + } + + return _fromIdTokenResponse(_tokenResponse); } From 541944bf236017e353c5b1ac38c5956cfc8606dd Mon Sep 17 00:00:00 2001 From: Alex Volkovitsky Date: Thu, 22 Oct 2020 14:26:57 -0700 Subject: [PATCH 033/624] Use const enums for better inlining in auth-exp (#3984) --- .../auth-exp/src/api/account_management/account.ts | 2 +- .../src/api/account_management/email_and_password.ts | 2 +- packages-exp/auth-exp/src/api/account_management/mfa.ts | 2 +- .../auth-exp/src/api/account_management/profile.ts | 2 +- .../auth-exp/src/api/authentication/create_auth_uri.ts | 2 +- .../auth-exp/src/api/authentication/custom_token.ts | 2 +- .../auth-exp/src/api/authentication/email_and_password.ts | 2 +- .../auth-exp/src/api/authentication/email_link.ts | 2 +- packages-exp/auth-exp/src/api/authentication/idp.ts | 2 +- packages-exp/auth-exp/src/api/authentication/mfa.ts | 2 +- packages-exp/auth-exp/src/api/authentication/recaptcha.ts | 2 +- packages-exp/auth-exp/src/api/authentication/sign_up.ts | 2 +- packages-exp/auth-exp/src/api/authentication/sms.ts | 2 +- packages-exp/auth-exp/src/api/authentication/token.ts | 2 +- packages-exp/auth-exp/src/api/errors.ts | 2 +- packages-exp/auth-exp/src/api/index.ts | 6 +++--- .../auth-exp/src/api/project_config/get_project_config.ts | 2 +- packages-exp/auth-exp/src/core/persistence/index.ts | 2 +- packages-exp/auth-exp/src/core/util/browser.ts | 2 +- packages-exp/auth-exp/src/core/util/version.ts | 2 +- .../src/mfa/{assertions/index.ts => mfa_assertion.ts} | 8 ++++---- packages-exp/auth-exp/src/mfa/mfa_resolver.test.ts | 2 +- packages-exp/auth-exp/src/mfa/mfa_resolver.ts | 2 +- packages-exp/auth-exp/src/mfa/mfa_session.ts | 2 +- packages-exp/auth-exp/src/mfa/mfa_user.test.ts | 2 +- packages-exp/auth-exp/src/mfa/mfa_user.ts | 2 +- .../auth-exp/src/platform_browser/mfa/assertions/phone.ts | 2 +- 27 files changed, 32 insertions(+), 32 deletions(-) rename packages-exp/auth-exp/src/mfa/{assertions/index.ts => mfa_assertion.ts} (86%) diff --git a/packages-exp/auth-exp/src/api/account_management/account.ts b/packages-exp/auth-exp/src/api/account_management/account.ts index 004423c4bc0..4c2a13b9b97 100644 --- a/packages-exp/auth-exp/src/api/account_management/account.ts +++ b/packages-exp/auth-exp/src/api/account_management/account.ts @@ -15,7 +15,7 @@ * limitations under the License. */ -import { Endpoint, HttpMethod, _performApiRequest } from '../'; +import { Endpoint, HttpMethod, _performApiRequest } from '../index'; import { MfaEnrollment } from './mfa'; import { Auth } from '@firebase/auth-types-exp'; diff --git a/packages-exp/auth-exp/src/api/account_management/email_and_password.ts b/packages-exp/auth-exp/src/api/account_management/email_and_password.ts index 0c917f7afa4..be812f39efa 100644 --- a/packages-exp/auth-exp/src/api/account_management/email_and_password.ts +++ b/packages-exp/auth-exp/src/api/account_management/email_and_password.ts @@ -17,7 +17,7 @@ import { Operation, Auth } from '@firebase/auth-types-exp'; -import { Endpoint, HttpMethod, _performApiRequest } from '..'; +import { Endpoint, HttpMethod, _performApiRequest } from '../index'; import { IdTokenResponse } from '../../model/id_token'; import { MfaEnrollment } from './mfa'; diff --git a/packages-exp/auth-exp/src/api/account_management/mfa.ts b/packages-exp/auth-exp/src/api/account_management/mfa.ts index 7ab83f2aefb..7b9223f52eb 100644 --- a/packages-exp/auth-exp/src/api/account_management/mfa.ts +++ b/packages-exp/auth-exp/src/api/account_management/mfa.ts @@ -15,7 +15,7 @@ * limitations under the License. */ -import { Endpoint, HttpMethod, _performApiRequest } from '..'; +import { Endpoint, HttpMethod, _performApiRequest } from '../index'; import { SignInWithPhoneNumberRequest } from '../authentication/sms'; import { FinalizeMfaResponse } from '../authentication/mfa'; import { Auth } from '../../model/auth'; diff --git a/packages-exp/auth-exp/src/api/account_management/profile.ts b/packages-exp/auth-exp/src/api/account_management/profile.ts index 3441177a40c..658223e1960 100644 --- a/packages-exp/auth-exp/src/api/account_management/profile.ts +++ b/packages-exp/auth-exp/src/api/account_management/profile.ts @@ -15,7 +15,7 @@ * limitations under the License. */ -import { Endpoint, HttpMethod, _performApiRequest } from '..'; +import { Endpoint, HttpMethod, _performApiRequest } from '../index'; import { IdTokenResponse } from '../../model/id_token'; import { Auth } from '@firebase/auth-types-exp'; diff --git a/packages-exp/auth-exp/src/api/authentication/create_auth_uri.ts b/packages-exp/auth-exp/src/api/authentication/create_auth_uri.ts index 35ecb100896..97955adbc13 100644 --- a/packages-exp/auth-exp/src/api/authentication/create_auth_uri.ts +++ b/packages-exp/auth-exp/src/api/authentication/create_auth_uri.ts @@ -15,7 +15,7 @@ * limitations under the License. */ -import { Endpoint, HttpMethod, _performApiRequest } from '..'; +import { Endpoint, HttpMethod, _performApiRequest } from '../index'; import { Auth } from '@firebase/auth-types-exp'; export interface CreateAuthUriRequest { diff --git a/packages-exp/auth-exp/src/api/authentication/custom_token.ts b/packages-exp/auth-exp/src/api/authentication/custom_token.ts index d58a4e4ab8b..42646197fde 100644 --- a/packages-exp/auth-exp/src/api/authentication/custom_token.ts +++ b/packages-exp/auth-exp/src/api/authentication/custom_token.ts @@ -15,7 +15,7 @@ * limitations under the License. */ -import { Endpoint, HttpMethod, _performSignInRequest } from '..'; +import { Endpoint, HttpMethod, _performSignInRequest } from '../index'; import { IdTokenResponse } from '../../model/id_token'; import { Auth } from '@firebase/auth-types-exp'; diff --git a/packages-exp/auth-exp/src/api/authentication/email_and_password.ts b/packages-exp/auth-exp/src/api/authentication/email_and_password.ts index 4c225f3d3eb..241ab924097 100644 --- a/packages-exp/auth-exp/src/api/authentication/email_and_password.ts +++ b/packages-exp/auth-exp/src/api/authentication/email_and_password.ts @@ -22,7 +22,7 @@ import { HttpMethod, _performApiRequest, _performSignInRequest -} from '..'; +} from '../index'; import { IdToken, IdTokenResponse } from '../../model/id_token'; export interface SignInWithPasswordRequest { diff --git a/packages-exp/auth-exp/src/api/authentication/email_link.ts b/packages-exp/auth-exp/src/api/authentication/email_link.ts index ff26fefed13..4b70642cacd 100644 --- a/packages-exp/auth-exp/src/api/authentication/email_link.ts +++ b/packages-exp/auth-exp/src/api/authentication/email_link.ts @@ -15,7 +15,7 @@ * limitations under the License. */ -import { _performSignInRequest, Endpoint, HttpMethod } from '../'; +import { _performSignInRequest, Endpoint, HttpMethod } from '../index'; import { IdTokenResponse } from '../../model/id_token'; import { Auth } from '@firebase/auth-types-exp'; diff --git a/packages-exp/auth-exp/src/api/authentication/idp.ts b/packages-exp/auth-exp/src/api/authentication/idp.ts index 0e2bcc5a02a..59533d2b069 100644 --- a/packages-exp/auth-exp/src/api/authentication/idp.ts +++ b/packages-exp/auth-exp/src/api/authentication/idp.ts @@ -15,7 +15,7 @@ * limitations under the License. */ -import { Endpoint, HttpMethod, _performSignInRequest } from '..'; +import { Endpoint, HttpMethod, _performSignInRequest } from '../index'; import { IdToken, IdTokenResponse } from '../../model/id_token'; import { Auth } from '@firebase/auth-types-exp'; diff --git a/packages-exp/auth-exp/src/api/authentication/mfa.ts b/packages-exp/auth-exp/src/api/authentication/mfa.ts index 2dbc55823c5..a928af4b59a 100644 --- a/packages-exp/auth-exp/src/api/authentication/mfa.ts +++ b/packages-exp/auth-exp/src/api/authentication/mfa.ts @@ -15,7 +15,7 @@ * limitations under the License. */ -import { _performApiRequest, Endpoint, HttpMethod } from '../'; +import { _performApiRequest, Endpoint, HttpMethod } from '../index'; import { Auth } from '@firebase/auth-types-exp'; import { IdTokenResponse } from '../../model/id_token'; import { MfaEnrollment } from '../account_management/mfa'; diff --git a/packages-exp/auth-exp/src/api/authentication/recaptcha.ts b/packages-exp/auth-exp/src/api/authentication/recaptcha.ts index 01dc3c7e3cd..945c84cbfa1 100644 --- a/packages-exp/auth-exp/src/api/authentication/recaptcha.ts +++ b/packages-exp/auth-exp/src/api/authentication/recaptcha.ts @@ -15,7 +15,7 @@ * limitations under the License. */ -import { Endpoint, HttpMethod, _performApiRequest } from '..'; +import { Endpoint, HttpMethod, _performApiRequest } from '../index'; import { Auth } from '@firebase/auth-types-exp'; interface GetRecaptchaParamResponse { diff --git a/packages-exp/auth-exp/src/api/authentication/sign_up.ts b/packages-exp/auth-exp/src/api/authentication/sign_up.ts index 74ca71ea866..db5a60d1d37 100644 --- a/packages-exp/auth-exp/src/api/authentication/sign_up.ts +++ b/packages-exp/auth-exp/src/api/authentication/sign_up.ts @@ -15,7 +15,7 @@ * limitations under the License. */ -import { Endpoint, HttpMethod, _performSignInRequest } from '..'; +import { Endpoint, HttpMethod, _performSignInRequest } from '../index'; import { IdTokenResponse } from '../../model/id_token'; import { Auth } from '@firebase/auth-types-exp'; diff --git a/packages-exp/auth-exp/src/api/authentication/sms.ts b/packages-exp/auth-exp/src/api/authentication/sms.ts index 739f14eddca..bd892176427 100644 --- a/packages-exp/auth-exp/src/api/authentication/sms.ts +++ b/packages-exp/auth-exp/src/api/authentication/sms.ts @@ -20,7 +20,7 @@ import { HttpMethod, _performApiRequest, _performSignInRequest -} from '..'; +} from '../index'; import { AuthErrorCode } from '../../core/errors'; import { IdTokenResponse } from '../../model/id_token'; import { ServerError, ServerErrorMap } from '../errors'; diff --git a/packages-exp/auth-exp/src/api/authentication/token.ts b/packages-exp/auth-exp/src/api/authentication/token.ts index cc8243e2161..a464841761f 100644 --- a/packages-exp/auth-exp/src/api/authentication/token.ts +++ b/packages-exp/auth-exp/src/api/authentication/token.ts @@ -23,7 +23,7 @@ import { _getFinalTarget, _performFetchWithErrorHandling, HttpMethod -} from '../'; +} from '../index'; import { FetchProvider } from '../../core/util/fetch_provider'; import { Auth } from '@firebase/auth-types-exp'; diff --git a/packages-exp/auth-exp/src/api/errors.ts b/packages-exp/auth-exp/src/api/errors.ts index 9d0432c3387..342e4c7fc57 100644 --- a/packages-exp/auth-exp/src/api/errors.ts +++ b/packages-exp/auth-exp/src/api/errors.ts @@ -20,7 +20,7 @@ import { AuthErrorCode } from '../core/errors'; /** * Errors that can be returned by the backend */ -export enum ServerError { +export const enum ServerError { ADMIN_ONLY_OPERATION = 'ADMIN_ONLY_OPERATION', CAPTCHA_CHECK_FAILED = 'CAPTCHA_CHECK_FAILED', CORS_UNSUPPORTED = 'CORS_UNSUPPORTED', diff --git a/packages-exp/auth-exp/src/api/index.ts b/packages-exp/auth-exp/src/api/index.ts index 2fee70291bd..06cba677f10 100644 --- a/packages-exp/auth-exp/src/api/index.ts +++ b/packages-exp/auth-exp/src/api/index.ts @@ -32,18 +32,18 @@ import { IdTokenResponse, TaggedWithTokenResponse } from '../model/id_token'; import { IdTokenMfaResponse } from './authentication/mfa'; import { SERVER_ERROR_MAP, ServerError, ServerErrorMap } from './errors'; -export enum HttpMethod { +export const enum HttpMethod { POST = 'POST', GET = 'GET' } -export enum HttpHeader { +export const enum HttpHeader { CONTENT_TYPE = 'Content-Type', X_FIREBASE_LOCALE = 'X-Firebase-Locale', X_CLIENT_VERSION = 'X-Client-Version' } -export enum Endpoint { +export const enum Endpoint { CREATE_AUTH_URI = '/v1/accounts:createAuthUri', DELETE_ACCOUNT = '/v1/accounts:delete', RESET_PASSWORD = '/v1/accounts:resetPassword', diff --git a/packages-exp/auth-exp/src/api/project_config/get_project_config.ts b/packages-exp/auth-exp/src/api/project_config/get_project_config.ts index 178d2aa4f1f..b3869d3a24e 100644 --- a/packages-exp/auth-exp/src/api/project_config/get_project_config.ts +++ b/packages-exp/auth-exp/src/api/project_config/get_project_config.ts @@ -15,7 +15,7 @@ * limitations under the License. */ -import { _performApiRequest, Endpoint, HttpMethod } from '../'; +import { _performApiRequest, Endpoint, HttpMethod } from '../index'; import { Auth } from '@firebase/auth-types-exp'; export interface GetProjectConfigRequest {} diff --git a/packages-exp/auth-exp/src/core/persistence/index.ts b/packages-exp/auth-exp/src/core/persistence/index.ts index 78ce579739b..71f98470d3d 100644 --- a/packages-exp/auth-exp/src/core/persistence/index.ts +++ b/packages-exp/auth-exp/src/core/persistence/index.ts @@ -15,7 +15,7 @@ * limitations under the License. */ -export enum PersistenceType { +export const enum PersistenceType { SESSION = 'SESSION', LOCAL = 'LOCAL', NONE = 'NONE' diff --git a/packages-exp/auth-exp/src/core/util/browser.ts b/packages-exp/auth-exp/src/core/util/browser.ts index 2754269dcc7..a70bde6b189 100644 --- a/packages-exp/auth-exp/src/core/util/browser.ts +++ b/packages-exp/auth-exp/src/core/util/browser.ts @@ -28,7 +28,7 @@ interface Document { /** * Enums for Browser name. */ -export enum BrowserName { +export const enum BrowserName { ANDROID = 'Android', BLACKBERRY = 'Blackberry', EDGE = 'Edge', diff --git a/packages-exp/auth-exp/src/core/util/version.ts b/packages-exp/auth-exp/src/core/util/version.ts index ccd43b58094..2cb9eeab9da 100644 --- a/packages-exp/auth-exp/src/core/util/version.ts +++ b/packages-exp/auth-exp/src/core/util/version.ts @@ -21,7 +21,7 @@ import { getUA } from '@firebase/util'; const CLIENT_IMPLEMENTATION = 'JsCore'; -export enum ClientPlatform { +export const enum ClientPlatform { BROWSER = 'Browser', NODE = 'Node', REACT_NATIVE = 'ReactNative', diff --git a/packages-exp/auth-exp/src/mfa/assertions/index.ts b/packages-exp/auth-exp/src/mfa/mfa_assertion.ts similarity index 86% rename from packages-exp/auth-exp/src/mfa/assertions/index.ts rename to packages-exp/auth-exp/src/mfa/mfa_assertion.ts index 1e4ef24ea63..029706dd0d5 100644 --- a/packages-exp/auth-exp/src/mfa/assertions/index.ts +++ b/packages-exp/auth-exp/src/mfa/mfa_assertion.ts @@ -15,10 +15,10 @@ * limitations under the License. */ import * as externs from '@firebase/auth-types-exp'; -import { debugFail } from '../../core/util/assert'; -import { MultiFactorSession, MultiFactorSessionType } from '../mfa_session'; -import { FinalizeMfaResponse } from '../../api/authentication/mfa'; -import { Auth } from '../../model/auth'; +import { debugFail } from '../core/util/assert'; +import { MultiFactorSession, MultiFactorSessionType } from './mfa_session'; +import { FinalizeMfaResponse } from '../api/authentication/mfa'; +import { Auth } from '../model/auth'; export abstract class MultiFactorAssertion implements externs.MultiFactorAssertion { diff --git a/packages-exp/auth-exp/src/mfa/mfa_resolver.test.ts b/packages-exp/auth-exp/src/mfa/mfa_resolver.test.ts index 491faea6c5d..082409be02a 100644 --- a/packages-exp/auth-exp/src/mfa/mfa_resolver.test.ts +++ b/packages-exp/auth-exp/src/mfa/mfa_resolver.test.ts @@ -31,7 +31,7 @@ import { PhoneAuthCredential } from '../core/credentials/phone'; import { AUTH_ERROR_FACTORY, AuthErrorCode } from '../core/errors'; import { EmailAuthProvider } from '../core/providers/email'; import { User, UserCredential } from '../model/user'; -import { MultiFactorAssertion } from './assertions'; +import { MultiFactorAssertion } from './mfa_assertion'; import { PhoneMultiFactorAssertion } from '../platform_browser/mfa/assertions/phone'; import { MultiFactorError } from './mfa_error'; import { getMultiFactorResolver, MultiFactorResolver } from './mfa_resolver'; diff --git a/packages-exp/auth-exp/src/mfa/mfa_resolver.ts b/packages-exp/auth-exp/src/mfa/mfa_resolver.ts index c94fee919a3..9b2f1c28977 100644 --- a/packages-exp/auth-exp/src/mfa/mfa_resolver.ts +++ b/packages-exp/auth-exp/src/mfa/mfa_resolver.ts @@ -22,7 +22,7 @@ import { AuthErrorCode } from '../core/errors'; import { UserCredentialImpl } from '../core/user/user_credential_impl'; import { assert, fail } from '../core/util/assert'; import { UserCredential } from '../model/user'; -import { MultiFactorAssertion } from './assertions'; +import { MultiFactorAssertion } from './mfa_assertion'; import { MultiFactorError } from './mfa_error'; import { MultiFactorInfo } from './mfa_info'; import { MultiFactorSession } from './mfa_session'; diff --git a/packages-exp/auth-exp/src/mfa/mfa_session.ts b/packages-exp/auth-exp/src/mfa/mfa_session.ts index 7de06f8ff6d..4748efd4035 100644 --- a/packages-exp/auth-exp/src/mfa/mfa_session.ts +++ b/packages-exp/auth-exp/src/mfa/mfa_session.ts @@ -16,7 +16,7 @@ */ import * as externs from '@firebase/auth-types-exp'; -export enum MultiFactorSessionType { +export const enum MultiFactorSessionType { ENROLL = 'enroll', SIGN_IN = 'signin' } diff --git a/packages-exp/auth-exp/src/mfa/mfa_user.test.ts b/packages-exp/auth-exp/src/mfa/mfa_user.test.ts index d8ae82eb8be..5f3e1c648f1 100644 --- a/packages-exp/auth-exp/src/mfa/mfa_user.test.ts +++ b/packages-exp/auth-exp/src/mfa/mfa_user.test.ts @@ -31,7 +31,7 @@ import { User } from '../model/user'; import { MultiFactorInfo } from './mfa_info'; import { MultiFactorSession, MultiFactorSessionType } from './mfa_session'; import { multiFactor, MultiFactorUser } from './mfa_user'; -import { MultiFactorAssertion } from './assertions'; +import { MultiFactorAssertion } from './mfa_assertion'; import { Auth } from '../model/auth'; use(chaiAsPromised); diff --git a/packages-exp/auth-exp/src/mfa/mfa_user.ts b/packages-exp/auth-exp/src/mfa/mfa_user.ts index cc6a0a7f7f6..1cdbdf3ef71 100644 --- a/packages-exp/auth-exp/src/mfa/mfa_user.ts +++ b/packages-exp/auth-exp/src/mfa/mfa_user.ts @@ -20,7 +20,7 @@ import { withdrawMfa } from '../api/account_management/mfa'; import { AuthErrorCode } from '../core/errors'; import { _logoutIfInvalidated } from '../core/user/invalidation'; import { User } from '../model/user'; -import { MultiFactorAssertion } from './assertions'; +import { MultiFactorAssertion } from './mfa_assertion'; import { MultiFactorInfo } from './mfa_info'; import { MultiFactorSession } from './mfa_session'; diff --git a/packages-exp/auth-exp/src/platform_browser/mfa/assertions/phone.ts b/packages-exp/auth-exp/src/platform_browser/mfa/assertions/phone.ts index 4f7a7d5aa68..45aa3b54724 100644 --- a/packages-exp/auth-exp/src/platform_browser/mfa/assertions/phone.ts +++ b/packages-exp/auth-exp/src/platform_browser/mfa/assertions/phone.ts @@ -16,7 +16,7 @@ */ import * as externs from '@firebase/auth-types-exp'; -import { MultiFactorAssertion } from '../../../mfa/assertions'; +import { MultiFactorAssertion } from '../../../mfa/mfa_assertion'; import { Auth } from '../../../model/auth'; import { finalizeEnrollPhoneMfa } from '../../../api/account_management/mfa'; import { PhoneAuthCredential } from '../../../core/credentials/phone'; From 03e9070928bc4c9bfd3897e2843707165918f87d Mon Sep 17 00:00:00 2001 From: Feiyang Date: Mon, 26 Oct 2020 08:38:37 -0700 Subject: [PATCH 034/624] lower storage bump to minor (#3992) --- .changeset/tiny-hounds-rest.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/tiny-hounds-rest.md b/.changeset/tiny-hounds-rest.md index a5271ae3492..c7c5bc8f33f 100644 --- a/.changeset/tiny-hounds-rest.md +++ b/.changeset/tiny-hounds-rest.md @@ -1,6 +1,6 @@ --- "firebase": major -"@firebase/storage": major +"@firebase/storage": minor --- This releases removes all input validation. Please use our TypeScript types to validate API usage. From 904eaeac7e2926177d2e2eeb44011e1227a2cbef Mon Sep 17 00:00:00 2001 From: Google Open Source Bot <26440463+google-oss-bot@users.noreply.github.com> Date: Mon, 26 Oct 2020 10:33:52 -0700 Subject: [PATCH 035/624] Version Packages (#3982) Co-authored-by: github-actions[bot] --- .changeset/bright-ducks-jump.md | 7 --- .changeset/funny-ties-ring.md | 25 ---------- .changeset/great-rice-smash.md | 6 --- .changeset/short-icons-travel.md | 7 --- .changeset/shy-trees-divide.md | 6 --- .changeset/silver-books-reply.md | 7 --- .changeset/silver-dolls-wave.md | 6 --- .changeset/strange-rabbits-wait.md | 7 --- .changeset/stupid-dots-grab.md | 5 -- .changeset/tame-knives-change.md | 7 --- .changeset/tiny-hounds-rest.md | 6 --- .changeset/wicked-cups-search.md | 5 -- integration/firebase/package.json | 2 +- integration/firestore/package.json | 4 +- integration/messaging/package.json | 2 +- packages-exp/app-compat/package.json | 4 +- packages-exp/app-exp/package.json | 4 +- packages-exp/auth-compat-exp/package.json | 10 ++-- packages-exp/auth-exp/package.json | 8 ++- packages-exp/firebase-exp/package.json | 2 +- packages-exp/functions-exp/package.json | 4 +- packages-exp/installations-exp/package.json | 4 +- packages-exp/performance-exp/package.json | 4 +- packages/analytics/CHANGELOG.md | 9 ++++ packages/analytics/package.json | 10 ++-- packages/app/CHANGELOG.md | 22 +++++++++ packages/app/package.json | 6 +-- packages/auth/CHANGELOG.md | 18 +++++++ packages/auth/package.json | 2 +- packages/component/CHANGELOG.md | 21 ++++++++ packages/component/package.json | 4 +- packages/database-types/CHANGELOG.md | 13 ++++- packages/database-types/package.json | 2 +- packages/database/CHANGELOG.md | 29 +++++++++++ packages/database/package.json | 10 ++-- packages/firebase/CHANGELOG.md | 54 +++++++++++++++++++++ packages/firebase/package.json | 26 +++++----- packages/firestore-types/CHANGELOG.md | 10 ++++ packages/firestore-types/package.json | 2 +- packages/firestore/CHANGELOG.md | 39 +++++++++++++++ packages/firestore/package.json | 10 ++-- packages/functions-types/CHANGELOG.md | 8 +++ packages/functions-types/package.json | 2 +- packages/functions/CHANGELOG.md | 26 ++++++++++ packages/functions/package.json | 10 ++-- packages/installations/CHANGELOG.md | 8 +++ packages/installations/package.json | 8 +-- packages/messaging/CHANGELOG.md | 9 ++++ packages/messaging/package.json | 10 ++-- packages/performance/CHANGELOG.md | 23 +++++++++ packages/performance/package.json | 10 ++-- packages/remote-config/CHANGELOG.md | 23 +++++++++ packages/remote-config/package.json | 10 ++-- packages/rules-unit-testing/CHANGELOG.md | 8 +++ packages/rules-unit-testing/package.json | 6 +-- packages/rxfire/CHANGELOG.md | 20 ++++++++ packages/rxfire/package.json | 6 +-- packages/storage/CHANGELOG.md | 12 +++++ packages/storage/package.json | 10 ++-- packages/template/package.json | 2 +- packages/util/CHANGELOG.md | 20 ++++++++ packages/util/package.json | 2 +- repo-scripts/size-analysis/package.json | 4 +- 63 files changed, 468 insertions(+), 198 deletions(-) delete mode 100644 .changeset/bright-ducks-jump.md delete mode 100644 .changeset/funny-ties-ring.md delete mode 100644 .changeset/great-rice-smash.md delete mode 100644 .changeset/short-icons-travel.md delete mode 100644 .changeset/shy-trees-divide.md delete mode 100644 .changeset/silver-books-reply.md delete mode 100644 .changeset/silver-dolls-wave.md delete mode 100644 .changeset/strange-rabbits-wait.md delete mode 100644 .changeset/stupid-dots-grab.md delete mode 100644 .changeset/tame-knives-change.md delete mode 100644 .changeset/tiny-hounds-rest.md delete mode 100644 .changeset/wicked-cups-search.md create mode 100644 packages/functions-types/CHANGELOG.md create mode 100644 packages/rxfire/CHANGELOG.md diff --git a/.changeset/bright-ducks-jump.md b/.changeset/bright-ducks-jump.md deleted file mode 100644 index c864dd3a086..00000000000 --- a/.changeset/bright-ducks-jump.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'firebase': minor -'@firebase/database': minor -'@firebase/database-types': minor ---- - -Add a useEmulator(host, port) method to Realtime Database diff --git a/.changeset/funny-ties-ring.md b/.changeset/funny-ties-ring.md deleted file mode 100644 index e7066ce4b91..00000000000 --- a/.changeset/funny-ties-ring.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -"@firebase/app": patch -"@firebase/auth": patch -"@firebase/component": patch -"@firebase/database": patch -"firebase": major -"@firebase/firestore": patch -"@firebase/functions": patch -"@firebase/performance": patch -"@firebase/remote-config": patch -"rxfire": patch -"@firebase/util": patch ---- - -Point browser field to esm build. Now you need to use default import instead of namespace import to import firebase. - -Before this change -``` -import * as firebase from 'firebase/app'; -``` - -After this change -``` -import firebase from 'firebase/app'; -``` diff --git a/.changeset/great-rice-smash.md b/.changeset/great-rice-smash.md deleted file mode 100644 index e64535b5d33..00000000000 --- a/.changeset/great-rice-smash.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -"firebase": major -"@firebase/firestore": major ---- - -Removed the undocumented `Firestore.logLevel` property. diff --git a/.changeset/short-icons-travel.md b/.changeset/short-icons-travel.md deleted file mode 100644 index eca27d87bdc..00000000000 --- a/.changeset/short-icons-travel.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'firebase': minor -'@firebase/firestore': minor -'@firebase/firestore-types': minor ---- - -Add a useEmulator(host, port) method to Firestore diff --git a/.changeset/shy-trees-divide.md b/.changeset/shy-trees-divide.md deleted file mode 100644 index 8bc7b66e887..00000000000 --- a/.changeset/shy-trees-divide.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -"firebase": major -"@firebase/firestore": major ---- - -Removed depreacted `experimentalTabSynchronization` settings. To enable multi-tab sychronization, use `synchronizeTabs` instead. diff --git a/.changeset/silver-books-reply.md b/.changeset/silver-books-reply.md deleted file mode 100644 index 13c7f6dad5c..00000000000 --- a/.changeset/silver-books-reply.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'firebase': minor -'@firebase/functions': minor -'@firebase/functions-types': minor ---- - -Add a useEmulator(host, port) method to Cloud Functions diff --git a/.changeset/silver-dolls-wave.md b/.changeset/silver-dolls-wave.md deleted file mode 100644 index 48e605ee641..00000000000 --- a/.changeset/silver-dolls-wave.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -"firebase": major -"@firebase/firestore": major ---- - -This releases removes all input validation. Please use our TypeScript types to validate API usage. diff --git a/.changeset/strange-rabbits-wait.md b/.changeset/strange-rabbits-wait.md deleted file mode 100644 index abd7ac5b703..00000000000 --- a/.changeset/strange-rabbits-wait.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'firebase': major -'@firebase/firestore': major -'@firebase/firestore-types': major ---- - -Removed the `timestampsInSnapshots` option from `FirestoreSettings`. Now, Firestore always returns `Timestamp` values for all timestamp values. diff --git a/.changeset/stupid-dots-grab.md b/.changeset/stupid-dots-grab.md deleted file mode 100644 index 85608f35687..00000000000 --- a/.changeset/stupid-dots-grab.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@firebase/util": patch ---- - -Write template data to a new `customData` field in` FirebaseError` instead of writing to the error object itself to avoid overwriting existing fields. diff --git a/.changeset/tame-knives-change.md b/.changeset/tame-knives-change.md deleted file mode 100644 index d2d813fb735..00000000000 --- a/.changeset/tame-knives-change.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -"@firebase/database-types": patch -"@firebase/database": patch -"firebase": patch ---- - -Updated the type definition for `ThenableReference` to only implement `then` and `catch`, which matches the implementation. diff --git a/.changeset/tiny-hounds-rest.md b/.changeset/tiny-hounds-rest.md deleted file mode 100644 index c7c5bc8f33f..00000000000 --- a/.changeset/tiny-hounds-rest.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -"firebase": major -"@firebase/storage": minor ---- - -This releases removes all input validation. Please use our TypeScript types to validate API usage. diff --git a/.changeset/wicked-cups-search.md b/.changeset/wicked-cups-search.md deleted file mode 100644 index abfaf518003..00000000000 --- a/.changeset/wicked-cups-search.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@firebase/firestore': minor ---- - -Removed excess validation of null and NaN values in query filters. This more closely aligns the SDK with the Firestore backend, which has always accepted null and NaN for all operators, even though this isn't necessarily useful. diff --git a/integration/firebase/package.json b/integration/firebase/package.json index 89d082b91fa..d80e095e9f7 100644 --- a/integration/firebase/package.json +++ b/integration/firebase/package.json @@ -7,7 +7,7 @@ "test:ci": "node ../../scripts/run_tests_in_ci.js -s test" }, "devDependencies": { - "firebase": "7.24.0", + "firebase": "8.0.0", "@types/chai": "4.2.13", "@types/mocha": "7.0.2", "chai": "4.2.0", diff --git a/integration/firestore/package.json b/integration/firestore/package.json index 77fbf5701c6..a9846bbe475 100644 --- a/integration/firestore/package.json +++ b/integration/firestore/package.json @@ -14,8 +14,8 @@ "test:memory:debug": "yarn build:memory; karma start --auto-watch --browsers Chrome" }, "devDependencies": { - "@firebase/app": "0.6.11", - "@firebase/firestore": "1.18.0", + "@firebase/app": "0.6.12", + "@firebase/firestore": "2.0.0", "@types/mocha": "7.0.2", "gulp": "4.0.2", "gulp-filter": "6.0.0", diff --git a/integration/messaging/package.json b/integration/messaging/package.json index 68bf6dce297..6485e723a61 100644 --- a/integration/messaging/package.json +++ b/integration/messaging/package.json @@ -9,7 +9,7 @@ "test:manual": "mocha --exit" }, "devDependencies": { - "firebase": "7.24.0", + "firebase": "8.0.0", "chai": "4.2.0", "chromedriver": "86.0.0", "express": "4.17.1", diff --git a/packages-exp/app-compat/package.json b/packages-exp/app-compat/package.json index 61cbda1a788..3ca8c1df8e4 100644 --- a/packages-exp/app-compat/package.json +++ b/packages-exp/app-compat/package.json @@ -29,9 +29,9 @@ "license": "Apache-2.0", "dependencies": { "@firebase/app-exp": "0.0.800", - "@firebase/util": "0.3.2", + "@firebase/util": "0.3.3", "@firebase/logger": "0.2.6", - "@firebase/component": "0.1.19", + "@firebase/component": "0.1.20", "tslib": "^1.11.1", "dom-storage": "2.1.0", "xmlhttprequest": "1.8.0" diff --git a/packages-exp/app-exp/package.json b/packages-exp/app-exp/package.json index bb14b11cceb..974913b95f6 100644 --- a/packages-exp/app-exp/package.json +++ b/packages-exp/app-exp/package.json @@ -31,9 +31,9 @@ }, "dependencies": { "@firebase/app-types-exp": "0.0.800", - "@firebase/util": "0.3.2", + "@firebase/util": "0.3.3", "@firebase/logger": "0.2.6", - "@firebase/component": "0.1.19", + "@firebase/component": "0.1.20", "tslib": "^1.11.1" }, "license": "Apache-2.0", diff --git a/packages-exp/auth-compat-exp/package.json b/packages-exp/auth-compat-exp/package.json index 7b23c06071e..6578622b975 100644 --- a/packages-exp/auth-compat-exp/package.json +++ b/packages-exp/auth-compat-exp/package.json @@ -8,9 +8,7 @@ "browser": "dist/index.esm.js", "module": "dist/index.esm.js", "esm2017": "dist/index.esm2017.js", - "files": [ - "dist" - ], + "files": ["dist"], "scripts": { "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'", "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'", @@ -32,8 +30,8 @@ "@firebase/auth-types": "0.10.1", "@firebase/auth-exp": "0.0.800", "@firebase/auth-types-exp": "0.0.800", - "@firebase/component": "0.1.19", - "@firebase/util": "0.3.2", + "@firebase/component": "0.1.20", + "@firebase/util": "0.3.3", "tslib": "^1.11.1" }, "license": "Apache-2.0", @@ -60,4 +58,4 @@ ], "reportDir": "./coverage/node" } -} \ No newline at end of file +} diff --git a/packages-exp/auth-exp/package.json b/packages-exp/auth-exp/package.json index a0fd713d1ab..42be25277a6 100644 --- a/packages-exp/auth-exp/package.json +++ b/packages-exp/auth-exp/package.json @@ -10,9 +10,7 @@ "module": "dist/esm5/index.js", "esm2017": "dist/esm2017/index.js", "webworker": "dist/index.webworker.esm5.js", - "files": [ - "dist" - ], + "files": ["dist"], "scripts": { "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'", "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'", @@ -41,8 +39,8 @@ }, "dependencies": { "@firebase/logger": "0.2.6", - "@firebase/util": "0.3.2", - "@firebase/component": "0.1.19", + "@firebase/util": "0.3.3", + "@firebase/component": "0.1.20", "@firebase/auth-types-exp": "0.0.800", "node-fetch": "2.6.1", "tslib": "^1.11.1" diff --git a/packages-exp/firebase-exp/package.json b/packages-exp/firebase-exp/package.json index 4497de8be78..4445689e506 100644 --- a/packages-exp/firebase-exp/package.json +++ b/packages-exp/firebase-exp/package.json @@ -40,7 +40,7 @@ "@firebase/app-exp": "0.0.800", "@firebase/app-compat": "0.0.800", "@firebase/functions-exp": "0.0.800", - "@firebase/firestore": "1.18.0", + "@firebase/firestore": "2.0.0", "@firebase/performance-exp": "0.0.800" }, "devDependencies": { diff --git a/packages-exp/functions-exp/package.json b/packages-exp/functions-exp/package.json index b75cbd82c21..9b3bcfc6a1a 100644 --- a/packages-exp/functions-exp/package.json +++ b/packages-exp/functions-exp/package.json @@ -50,10 +50,10 @@ }, "typings": "dist/functions-exp-public.d.ts", "dependencies": { - "@firebase/component": "0.1.19", + "@firebase/component": "0.1.20", "@firebase/functions-types-exp": "0.0.800", "@firebase/messaging-types": "0.5.0", - "@firebase/util": "0.3.2", + "@firebase/util": "0.3.3", "node-fetch": "2.6.1", "tslib": "^1.11.1" }, diff --git a/packages-exp/installations-exp/package.json b/packages-exp/installations-exp/package.json index fdad30a789a..0e816aede9f 100644 --- a/packages-exp/installations-exp/package.json +++ b/packages-exp/installations-exp/package.json @@ -55,8 +55,8 @@ }, "dependencies": { "@firebase/installations-types-exp": "0.0.800", - "@firebase/util": "0.3.2", - "@firebase/component": "0.1.19", + "@firebase/util": "0.3.3", + "@firebase/component": "0.1.20", "idb": "3.0.2", "tslib": "^1.11.1" } diff --git a/packages-exp/performance-exp/package.json b/packages-exp/performance-exp/package.json index 3f991657b19..6c053eb6cad 100644 --- a/packages-exp/performance-exp/package.json +++ b/packages-exp/performance-exp/package.json @@ -34,9 +34,9 @@ "dependencies": { "@firebase/logger": "0.2.6", "@firebase/installations-exp": "0.0.800", - "@firebase/util": "0.3.2", + "@firebase/util": "0.3.3", "@firebase/performance-types-exp": "0.0.800", - "@firebase/component": "0.1.19", + "@firebase/component": "0.1.20", "tslib": "^1.11.1" }, "license": "Apache-2.0", diff --git a/packages/analytics/CHANGELOG.md b/packages/analytics/CHANGELOG.md index 5691673be40..639eb8890b5 100644 --- a/packages/analytics/CHANGELOG.md +++ b/packages/analytics/CHANGELOG.md @@ -1,5 +1,14 @@ # @firebase/analytics +## 0.6.1 + +### Patch Changes + +- Updated dependencies [[`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487), [`7d916d905`](https://github.com/firebase/firebase-js-sdk/commit/7d916d905ba16816ac8ac7c8748c83831ff614ce)]: + - @firebase/component@0.1.20 + - @firebase/util@0.3.3 + - @firebase/installations@0.4.18 + ## 0.6.0 ### Minor Changes diff --git a/packages/analytics/package.json b/packages/analytics/package.json index d32695edc49..e494d99f496 100644 --- a/packages/analytics/package.json +++ b/packages/analytics/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/analytics", - "version": "0.6.0", + "version": "0.6.1", "description": "A analytics package for new firebase packages", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.cjs.js", @@ -26,15 +26,15 @@ }, "dependencies": { "@firebase/analytics-types": "0.4.0", - "@firebase/installations": "0.4.17", + "@firebase/installations": "0.4.18", "@firebase/logger": "0.2.6", - "@firebase/util": "0.3.2", - "@firebase/component": "0.1.19", + "@firebase/util": "0.3.3", + "@firebase/component": "0.1.20", "tslib": "^1.11.1" }, "license": "Apache-2.0", "devDependencies": { - "@firebase/app": "0.6.11", + "@firebase/app": "0.6.12", "rollup": "2.29.0", "@rollup/plugin-commonjs": "15.1.0", "@rollup/plugin-json": "4.1.0", diff --git a/packages/app/CHANGELOG.md b/packages/app/CHANGELOG.md index b9c796028f8..2c78b864bb6 100644 --- a/packages/app/CHANGELOG.md +++ b/packages/app/CHANGELOG.md @@ -1,5 +1,27 @@ # @firebase/app +## 0.6.12 + +### Patch Changes + +- [`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487) [#3932](https://github.com/firebase/firebase-js-sdk/pull/3932) - Point browser field to esm build. Now you need to use default import instead of namespace import to import firebase. + + Before this change + + ``` + import * as firebase from 'firebase/app'; + ``` + + After this change + + ``` + import firebase from 'firebase/app'; + ``` + +- Updated dependencies [[`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487), [`7d916d905`](https://github.com/firebase/firebase-js-sdk/commit/7d916d905ba16816ac8ac7c8748c83831ff614ce)]: + - @firebase/component@0.1.20 + - @firebase/util@0.3.3 + ## 0.6.11 ### Patch Changes diff --git a/packages/app/package.json b/packages/app/package.json index f880b91307a..5f79a9fd77e 100644 --- a/packages/app/package.json +++ b/packages/app/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/app", - "version": "0.6.11", + "version": "0.6.12", "description": "The primary entrypoint to the Firebase JS SDK", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.node.cjs.js", @@ -28,9 +28,9 @@ "license": "Apache-2.0", "dependencies": { "@firebase/app-types": "0.6.1", - "@firebase/util": "0.3.2", + "@firebase/util": "0.3.3", "@firebase/logger": "0.2.6", - "@firebase/component": "0.1.19", + "@firebase/component": "0.1.20", "tslib": "^1.11.1", "dom-storage": "2.1.0", "xmlhttprequest": "1.8.0" diff --git a/packages/auth/CHANGELOG.md b/packages/auth/CHANGELOG.md index c3fef26d628..733dba0754f 100644 --- a/packages/auth/CHANGELOG.md +++ b/packages/auth/CHANGELOG.md @@ -1,5 +1,23 @@ # @firebase/auth +## 0.15.1 + +### Patch Changes + +- [`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487) [#3932](https://github.com/firebase/firebase-js-sdk/pull/3932) - Point browser field to esm build. Now you need to use default import instead of namespace import to import firebase. + + Before this change + + ``` + import * as firebase from 'firebase/app'; + ``` + + After this change + + ``` + import firebase from 'firebase/app'; + ``` + ## 0.15.0 ### Minor Changes diff --git a/packages/auth/package.json b/packages/auth/package.json index cf6e93083c0..ad4fb224672 100644 --- a/packages/auth/package.json +++ b/packages/auth/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/auth", - "version": "0.15.0", + "version": "0.15.1", "main": "dist/auth.js", "browser": "dist/auth.esm.js", "module": "dist/auth.esm.js", diff --git a/packages/component/CHANGELOG.md b/packages/component/CHANGELOG.md index 9de3629062c..4b2c6ceacec 100644 --- a/packages/component/CHANGELOG.md +++ b/packages/component/CHANGELOG.md @@ -1,5 +1,26 @@ # @firebase/component +## 0.1.20 + +### Patch Changes + +- [`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487) [#3932](https://github.com/firebase/firebase-js-sdk/pull/3932) - Point browser field to esm build. Now you need to use default import instead of namespace import to import firebase. + + Before this change + + ``` + import * as firebase from 'firebase/app'; + ``` + + After this change + + ``` + import firebase from 'firebase/app'; + ``` + +- Updated dependencies [[`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487), [`7d916d905`](https://github.com/firebase/firebase-js-sdk/commit/7d916d905ba16816ac8ac7c8748c83831ff614ce)]: + - @firebase/util@0.3.3 + ## 0.1.19 ### Patch Changes diff --git a/packages/component/package.json b/packages/component/package.json index 88f60ccedae..890f19dc2b8 100644 --- a/packages/component/package.json +++ b/packages/component/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/component", - "version": "0.1.19", + "version": "0.1.20", "description": "Firebase Component Platform", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.cjs.js", @@ -22,7 +22,7 @@ "prepare": "yarn build" }, "dependencies": { - "@firebase/util": "0.3.2", + "@firebase/util": "0.3.3", "tslib": "^1.11.1" }, "license": "Apache-2.0", diff --git a/packages/database-types/CHANGELOG.md b/packages/database-types/CHANGELOG.md index e29615b26b2..c659412cbd4 100644 --- a/packages/database-types/CHANGELOG.md +++ b/packages/database-types/CHANGELOG.md @@ -1,8 +1,17 @@ # @firebase/database-types -## 0.5.2 +## 0.6.0 + +### Minor Changes + +- [`ef33328f7`](https://github.com/firebase/firebase-js-sdk/commit/ef33328f7cb7d585a1304ed39649f5b69a111b3c) [#3904](https://github.com/firebase/firebase-js-sdk/pull/3904) - Add a useEmulator(host, port) method to Realtime Database + ### Patch Changes +- [`602ec18e9`](https://github.com/firebase/firebase-js-sdk/commit/602ec18e92fd365a3a6432ff3a5f6a31013eb1f5) [#3968](https://github.com/firebase/firebase-js-sdk/pull/3968) - Updated the type definition for `ThenableReference` to only implement `then` and `catch`, which matches the implementation. +## 0.5.2 + +### Patch Changes -- [`ef348fed`](https://github.com/firebase/firebase-js-sdk/commit/ef348fed291338351706a697cbb9fb17a9d06ff4) [#3511](https://github.com/firebase/firebase-js-sdk/pull/3511) - Added interface `Database` which is implemented by `FirebaseDatabase`. This allows consumer SDKs (such as the Firebase Admin SDK) to export the database types as an interface. +- [`ef348fed`](https://github.com/firebase/firebase-js-sdk/commit/ef348fed291338351706a697cbb9fb17a9d06ff4) [#3511](https://github.com/firebase/firebase-js-sdk/pull/3511) - Added interface `Database` which is implemented by `FirebaseDatabase`. This allows consumer SDKs (such as the Firebase Admin SDK) to export the database types as an interface. diff --git a/packages/database-types/package.json b/packages/database-types/package.json index 7dcbd1718a9..37db39c2a25 100644 --- a/packages/database-types/package.json +++ b/packages/database-types/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/database-types", - "version": "0.5.2", + "version": "0.6.0", "description": "@firebase/database Types", "author": "Firebase (https://firebase.google.com/)", "license": "Apache-2.0", diff --git a/packages/database/CHANGELOG.md b/packages/database/CHANGELOG.md index e3602112654..6a6604a2c46 100644 --- a/packages/database/CHANGELOG.md +++ b/packages/database/CHANGELOG.md @@ -1,5 +1,34 @@ # Unreleased +## 0.7.0 + +### Minor Changes + +- [`ef33328f7`](https://github.com/firebase/firebase-js-sdk/commit/ef33328f7cb7d585a1304ed39649f5b69a111b3c) [#3904](https://github.com/firebase/firebase-js-sdk/pull/3904) - Add a useEmulator(host, port) method to Realtime Database + +### Patch Changes + +- [`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487) [#3932](https://github.com/firebase/firebase-js-sdk/pull/3932) - Point browser field to esm build. Now you need to use default import instead of namespace import to import firebase. + + Before this change + + ``` + import * as firebase from 'firebase/app'; + ``` + + After this change + + ``` + import firebase from 'firebase/app'; + ``` + +* [`602ec18e9`](https://github.com/firebase/firebase-js-sdk/commit/602ec18e92fd365a3a6432ff3a5f6a31013eb1f5) [#3968](https://github.com/firebase/firebase-js-sdk/pull/3968) - Updated the type definition for `ThenableReference` to only implement `then` and `catch`, which matches the implementation. + +* Updated dependencies [[`ef33328f7`](https://github.com/firebase/firebase-js-sdk/commit/ef33328f7cb7d585a1304ed39649f5b69a111b3c), [`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487), [`7d916d905`](https://github.com/firebase/firebase-js-sdk/commit/7d916d905ba16816ac8ac7c8748c83831ff614ce), [`602ec18e9`](https://github.com/firebase/firebase-js-sdk/commit/602ec18e92fd365a3a6432ff3a5f6a31013eb1f5)]: + - @firebase/database-types@0.6.0 + - @firebase/component@0.1.20 + - @firebase/util@0.3.3 + ## 0.6.13 ### Patch Changes diff --git a/packages/database/package.json b/packages/database/package.json index 8ed372271cf..054a7c66abb 100644 --- a/packages/database/package.json +++ b/packages/database/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/database", - "version": "0.6.13", + "version": "0.7.0", "description": "", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.node.cjs.js", @@ -25,16 +25,16 @@ "license": "Apache-2.0", "peerDependencies": {}, "dependencies": { - "@firebase/database-types": "0.5.2", + "@firebase/database-types": "0.6.0", "@firebase/logger": "0.2.6", - "@firebase/util": "0.3.2", - "@firebase/component": "0.1.19", + "@firebase/util": "0.3.3", + "@firebase/component": "0.1.20", "@firebase/auth-interop-types": "0.1.5", "faye-websocket": "0.11.3", "tslib": "^1.11.1" }, "devDependencies": { - "@firebase/app": "0.6.11", + "@firebase/app": "0.6.12", "@firebase/app-types": "0.6.1", "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", diff --git a/packages/firebase/CHANGELOG.md b/packages/firebase/CHANGELOG.md index 345b2c48cba..097b2b54644 100644 --- a/packages/firebase/CHANGELOG.md +++ b/packages/firebase/CHANGELOG.md @@ -1,5 +1,59 @@ # firebase +## 8.0.0 + +### Major Changes + +- [`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487) [#3932](https://github.com/firebase/firebase-js-sdk/pull/3932) - Point browser field to esm build. Now you need to use default import instead of namespace import to import firebase. + + Before this change + + ``` + import * as firebase from 'firebase/app'; + ``` + + After this change + + ``` + import firebase from 'firebase/app'; + ``` + +* [`8939aeca0`](https://github.com/firebase/firebase-js-sdk/commit/8939aeca02921f9eacf1badb1068de22f670293e) [#3944](https://github.com/firebase/firebase-js-sdk/pull/3944) - Removed the undocumented `Firestore.logLevel` property. + +- [`344bd8856`](https://github.com/firebase/firebase-js-sdk/commit/344bd88566e2c42fd7ee92f28bb0f784629b48ee) [#3943](https://github.com/firebase/firebase-js-sdk/pull/3943) - Removed depreacted `experimentalTabSynchronization` settings. To enable multi-tab sychronization, use `synchronizeTabs` instead. + +* [`4b540f91d`](https://github.com/firebase/firebase-js-sdk/commit/4b540f91dbad217e8ec04b382b4c724308cb3df1) [#3939](https://github.com/firebase/firebase-js-sdk/pull/3939) - This releases removes all input validation. Please use our TypeScript types to validate API usage. + +- [`ffef32e38`](https://github.com/firebase/firebase-js-sdk/commit/ffef32e3837d3ee1098129b237e7a6e2e738182d) [#3897](https://github.com/firebase/firebase-js-sdk/pull/3897) (fixes [#3879](https://github.com/firebase/firebase-js-sdk/issues/3879)) - Removed the `timestampsInSnapshots` option from `FirestoreSettings`. Now, Firestore always returns `Timestamp` values for all timestamp values. + +* [`b247ffa76`](https://github.com/firebase/firebase-js-sdk/commit/b247ffa760aec1636de6cfc78851f97a840181ae) [#3967](https://github.com/firebase/firebase-js-sdk/pull/3967) - This releases removes all input validation. Please use our TypeScript types to validate API usage. + +### Minor Changes + +- [`ef33328f7`](https://github.com/firebase/firebase-js-sdk/commit/ef33328f7cb7d585a1304ed39649f5b69a111b3c) [#3904](https://github.com/firebase/firebase-js-sdk/pull/3904) - Add a useEmulator(host, port) method to Realtime Database + +* [`79b049375`](https://github.com/firebase/firebase-js-sdk/commit/79b04937537b90422e051086112f6b43c2880cdb) [#3909](https://github.com/firebase/firebase-js-sdk/pull/3909) - Add a useEmulator(host, port) method to Firestore + +- [`0322c1bda`](https://github.com/firebase/firebase-js-sdk/commit/0322c1bda93b2885b995e3df2b63b48314546961) [#3906](https://github.com/firebase/firebase-js-sdk/pull/3906) - Add a useEmulator(host, port) method to Cloud Functions + +### Patch Changes + +- [`602ec18e9`](https://github.com/firebase/firebase-js-sdk/commit/602ec18e92fd365a3a6432ff3a5f6a31013eb1f5) [#3968](https://github.com/firebase/firebase-js-sdk/pull/3968) - Updated the type definition for `ThenableReference` to only implement `then` and `catch`, which matches the implementation. + +- Updated dependencies [[`ef33328f7`](https://github.com/firebase/firebase-js-sdk/commit/ef33328f7cb7d585a1304ed39649f5b69a111b3c), [`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487), [`8939aeca0`](https://github.com/firebase/firebase-js-sdk/commit/8939aeca02921f9eacf1badb1068de22f670293e), [`79b049375`](https://github.com/firebase/firebase-js-sdk/commit/79b04937537b90422e051086112f6b43c2880cdb), [`344bd8856`](https://github.com/firebase/firebase-js-sdk/commit/344bd88566e2c42fd7ee92f28bb0f784629b48ee), [`0322c1bda`](https://github.com/firebase/firebase-js-sdk/commit/0322c1bda93b2885b995e3df2b63b48314546961), [`4b540f91d`](https://github.com/firebase/firebase-js-sdk/commit/4b540f91dbad217e8ec04b382b4c724308cb3df1), [`ffef32e38`](https://github.com/firebase/firebase-js-sdk/commit/ffef32e3837d3ee1098129b237e7a6e2e738182d), [`7d916d905`](https://github.com/firebase/firebase-js-sdk/commit/7d916d905ba16816ac8ac7c8748c83831ff614ce), [`602ec18e9`](https://github.com/firebase/firebase-js-sdk/commit/602ec18e92fd365a3a6432ff3a5f6a31013eb1f5), [`b247ffa76`](https://github.com/firebase/firebase-js-sdk/commit/b247ffa760aec1636de6cfc78851f97a840181ae), [`9719635fe`](https://github.com/firebase/firebase-js-sdk/commit/9719635fe2ecbb5b981076ce4807d0df775b8332)]: + - @firebase/database@0.7.0 + - @firebase/app@0.6.12 + - @firebase/auth@0.15.1 + - @firebase/firestore@2.0.0 + - @firebase/functions@0.6.0 + - @firebase/performance@0.4.3 + - @firebase/remote-config@0.1.29 + - @firebase/util@0.3.3 + - @firebase/storage@0.4.0 + - @firebase/analytics@0.6.1 + - @firebase/installations@0.4.18 + - @firebase/messaging@0.7.2 + ## 7.24.0 ### Minor Changes diff --git a/packages/firebase/package.json b/packages/firebase/package.json index 9473206d414..381dc9aaec4 100644 --- a/packages/firebase/package.json +++ b/packages/firebase/package.json @@ -1,6 +1,6 @@ { "name": "firebase", - "version": "7.24.0", + "version": "8.0.0", "description": "Firebase JavaScript library for web and Node.js", "author": "Firebase (https://firebase.google.com/)", "license": "Apache-2.0", @@ -45,20 +45,20 @@ "module": "dist/index.esm.js", "react-native": "dist/index.rn.cjs.js", "dependencies": { - "@firebase/app": "0.6.11", + "@firebase/app": "0.6.12", "@firebase/app-types": "0.6.1", - "@firebase/auth": "0.15.0", - "@firebase/database": "0.6.13", - "@firebase/firestore": "1.18.0", - "@firebase/functions": "0.5.1", - "@firebase/installations": "0.4.17", - "@firebase/messaging": "0.7.1", + "@firebase/auth": "0.15.1", + "@firebase/database": "0.7.0", + "@firebase/firestore": "2.0.0", + "@firebase/functions": "0.6.0", + "@firebase/installations": "0.4.18", + "@firebase/messaging": "0.7.2", "@firebase/polyfill": "0.3.36", - "@firebase/storage": "0.3.43", - "@firebase/performance": "0.4.2", - "@firebase/remote-config": "0.1.28", - "@firebase/analytics": "0.6.0", - "@firebase/util": "0.3.2" + "@firebase/storage": "0.4.0", + "@firebase/performance": "0.4.3", + "@firebase/remote-config": "0.1.29", + "@firebase/analytics": "0.6.1", + "@firebase/util": "0.3.3" }, "devDependencies": { "rollup": "2.29.0", diff --git a/packages/firestore-types/CHANGELOG.md b/packages/firestore-types/CHANGELOG.md index db25a7fcddd..ea195a7eb04 100644 --- a/packages/firestore-types/CHANGELOG.md +++ b/packages/firestore-types/CHANGELOG.md @@ -1,5 +1,15 @@ # @firebase/firestore-types +## 2.0.0 + +### Major Changes + +- [`ffef32e38`](https://github.com/firebase/firebase-js-sdk/commit/ffef32e3837d3ee1098129b237e7a6e2e738182d) [#3897](https://github.com/firebase/firebase-js-sdk/pull/3897) (fixes [#3879](https://github.com/firebase/firebase-js-sdk/issues/3879)) - Removed the `timestampsInSnapshots` option from `FirestoreSettings`. Now, Firestore always returns `Timestamp` values for all timestamp values. + +### Minor Changes + +- [`79b049375`](https://github.com/firebase/firebase-js-sdk/commit/79b04937537b90422e051086112f6b43c2880cdb) [#3909](https://github.com/firebase/firebase-js-sdk/pull/3909) - Add a useEmulator(host, port) method to Firestore + ## 1.14.0 ### Minor Changes diff --git a/packages/firestore-types/package.json b/packages/firestore-types/package.json index 851dd0193f4..3c0d23d34a3 100644 --- a/packages/firestore-types/package.json +++ b/packages/firestore-types/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/firestore-types", - "version": "1.14.0", + "version": "2.0.0", "description": "@firebase/firestore Types", "author": "Firebase (https://firebase.google.com/)", "license": "Apache-2.0", diff --git a/packages/firestore/CHANGELOG.md b/packages/firestore/CHANGELOG.md index fa7be50a23a..01b0973d6ac 100644 --- a/packages/firestore/CHANGELOG.md +++ b/packages/firestore/CHANGELOG.md @@ -1,5 +1,44 @@ # @firebase/firestore +## 2.0.0 + +### Major Changes + +- [`8939aeca0`](https://github.com/firebase/firebase-js-sdk/commit/8939aeca02921f9eacf1badb1068de22f670293e) [#3944](https://github.com/firebase/firebase-js-sdk/pull/3944) - Removed the undocumented `Firestore.logLevel` property. + +* [`344bd8856`](https://github.com/firebase/firebase-js-sdk/commit/344bd88566e2c42fd7ee92f28bb0f784629b48ee) [#3943](https://github.com/firebase/firebase-js-sdk/pull/3943) - Removed depreacted `experimentalTabSynchronization` settings. To enable multi-tab sychronization, use `synchronizeTabs` instead. + +- [`4b540f91d`](https://github.com/firebase/firebase-js-sdk/commit/4b540f91dbad217e8ec04b382b4c724308cb3df1) [#3939](https://github.com/firebase/firebase-js-sdk/pull/3939) - This releases removes all input validation. Please use our TypeScript types to validate API usage. + +* [`ffef32e38`](https://github.com/firebase/firebase-js-sdk/commit/ffef32e3837d3ee1098129b237e7a6e2e738182d) [#3897](https://github.com/firebase/firebase-js-sdk/pull/3897) (fixes [#3879](https://github.com/firebase/firebase-js-sdk/issues/3879)) - Removed the `timestampsInSnapshots` option from `FirestoreSettings`. Now, Firestore always returns `Timestamp` values for all timestamp values. + +### Minor Changes + +- [`79b049375`](https://github.com/firebase/firebase-js-sdk/commit/79b04937537b90422e051086112f6b43c2880cdb) [#3909](https://github.com/firebase/firebase-js-sdk/pull/3909) - Add a useEmulator(host, port) method to Firestore + +* [`9719635fe`](https://github.com/firebase/firebase-js-sdk/commit/9719635fe2ecbb5b981076ce4807d0df775b8332) [#3960](https://github.com/firebase/firebase-js-sdk/pull/3960) - Removed excess validation of null and NaN values in query filters. This more closely aligns the SDK with the Firestore backend, which has always accepted null and NaN for all operators, even though this isn't necessarily useful. + +### Patch Changes + +- [`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487) [#3932](https://github.com/firebase/firebase-js-sdk/pull/3932) - Point browser field to esm build. Now you need to use default import instead of namespace import to import firebase. + + Before this change + + ``` + import * as firebase from 'firebase/app'; + ``` + + After this change + + ``` + import firebase from 'firebase/app'; + ``` + +- Updated dependencies [[`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487), [`79b049375`](https://github.com/firebase/firebase-js-sdk/commit/79b04937537b90422e051086112f6b43c2880cdb), [`ffef32e38`](https://github.com/firebase/firebase-js-sdk/commit/ffef32e3837d3ee1098129b237e7a6e2e738182d), [`7d916d905`](https://github.com/firebase/firebase-js-sdk/commit/7d916d905ba16816ac8ac7c8748c83831ff614ce)]: + - @firebase/component@0.1.20 + - @firebase/util@0.3.3 + - @firebase/firestore-types@2.0.0 + ## 1.18.0 ### Minor Changes diff --git a/packages/firestore/package.json b/packages/firestore/package.json index 90ee054b940..f757bb58b92 100644 --- a/packages/firestore/package.json +++ b/packages/firestore/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/firestore", - "version": "1.18.0", + "version": "2.0.0", "engines": { "node": "^8.13.0 || >=10.10.0" }, @@ -60,10 +60,10 @@ "memory/package.json" ], "dependencies": { - "@firebase/component": "0.1.19", - "@firebase/firestore-types": "1.14.0", + "@firebase/component": "0.1.20", + "@firebase/firestore-types": "2.0.0", "@firebase/logger": "0.2.6", - "@firebase/util": "0.3.2", + "@firebase/util": "0.3.3", "@firebase/webchannel-wrapper": "0.4.0", "@grpc/grpc-js": "^1.0.0", "@grpc/proto-loader": "^0.5.0", @@ -75,7 +75,7 @@ "@firebase/app-types": "0.x" }, "devDependencies": { - "@firebase/app": "0.6.11", + "@firebase/app": "0.6.12", "@rollup/plugin-alias": "3.1.1", "@types/json-stable-stringify": "1.0.32", "json-stable-stringify": "1.0.1", diff --git a/packages/functions-types/CHANGELOG.md b/packages/functions-types/CHANGELOG.md new file mode 100644 index 00000000000..30ba1050e04 --- /dev/null +++ b/packages/functions-types/CHANGELOG.md @@ -0,0 +1,8 @@ +# @firebase/functions-types + +## 0.4.0 +### Minor Changes + + + +- [`0322c1bda`](https://github.com/firebase/firebase-js-sdk/commit/0322c1bda93b2885b995e3df2b63b48314546961) [#3906](https://github.com/firebase/firebase-js-sdk/pull/3906) - Add a useEmulator(host, port) method to Cloud Functions diff --git a/packages/functions-types/package.json b/packages/functions-types/package.json index a81809fbfa3..43be179ce39 100644 --- a/packages/functions-types/package.json +++ b/packages/functions-types/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/functions-types", - "version": "0.3.17", + "version": "0.4.0", "description": "@firebase/functions Types", "author": "Firebase (https://firebase.google.com/)", "license": "Apache-2.0", diff --git a/packages/functions/CHANGELOG.md b/packages/functions/CHANGELOG.md index 27b3d0b32f3..e9c129b0ae5 100644 --- a/packages/functions/CHANGELOG.md +++ b/packages/functions/CHANGELOG.md @@ -1,5 +1,31 @@ # @firebase/functions +## 0.6.0 + +### Minor Changes + +- [`0322c1bda`](https://github.com/firebase/firebase-js-sdk/commit/0322c1bda93b2885b995e3df2b63b48314546961) [#3906](https://github.com/firebase/firebase-js-sdk/pull/3906) - Add a useEmulator(host, port) method to Cloud Functions + +### Patch Changes + +- [`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487) [#3932](https://github.com/firebase/firebase-js-sdk/pull/3932) - Point browser field to esm build. Now you need to use default import instead of namespace import to import firebase. + + Before this change + + ``` + import * as firebase from 'firebase/app'; + ``` + + After this change + + ``` + import firebase from 'firebase/app'; + ``` + +- Updated dependencies [[`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487), [`0322c1bda`](https://github.com/firebase/firebase-js-sdk/commit/0322c1bda93b2885b995e3df2b63b48314546961)]: + - @firebase/component@0.1.20 + - @firebase/functions-types@0.4.0 + ## 0.5.1 ### Patch Changes diff --git a/packages/functions/package.json b/packages/functions/package.json index 8fb3d79f8ab..999274b9b3e 100644 --- a/packages/functions/package.json +++ b/packages/functions/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/functions", - "version": "0.5.1", + "version": "0.6.0", "description": "", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.node.cjs.js", @@ -29,8 +29,8 @@ "@firebase/app-types": "0.x" }, "devDependencies": { - "@firebase/app": "0.6.11", - "@firebase/messaging": "0.7.1", + "@firebase/app": "0.6.12", + "@firebase/messaging": "0.7.2", "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", "typescript": "4.0.2" @@ -45,8 +45,8 @@ }, "typings": "dist/index.d.ts", "dependencies": { - "@firebase/component": "0.1.19", - "@firebase/functions-types": "0.3.17", + "@firebase/component": "0.1.20", + "@firebase/functions-types": "0.4.0", "@firebase/messaging-types": "0.5.0", "node-fetch": "2.6.1", "tslib": "^1.11.1" diff --git a/packages/installations/CHANGELOG.md b/packages/installations/CHANGELOG.md index 179023df625..40c4fa57a2b 100644 --- a/packages/installations/CHANGELOG.md +++ b/packages/installations/CHANGELOG.md @@ -1,5 +1,13 @@ # @firebase/installations +## 0.4.18 + +### Patch Changes + +- Updated dependencies [[`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487), [`7d916d905`](https://github.com/firebase/firebase-js-sdk/commit/7d916d905ba16816ac8ac7c8748c83831ff614ce)]: + - @firebase/component@0.1.20 + - @firebase/util@0.3.3 + ## 0.4.17 ### Patch Changes diff --git a/packages/installations/package.json b/packages/installations/package.json index 0e7b91477c0..ca68d7bd7bb 100644 --- a/packages/installations/package.json +++ b/packages/installations/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/installations", - "version": "0.4.17", + "version": "0.4.18", "main": "dist/index.cjs.js", "module": "dist/index.esm.js", "esm2017": "dist/index.esm2017.js", @@ -30,7 +30,7 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "devDependencies": { - "@firebase/app": "0.6.11", + "@firebase/app": "0.6.12", "rollup": "2.29.0", "@rollup/plugin-commonjs": "15.1.0", "@rollup/plugin-json": "4.1.0", @@ -45,8 +45,8 @@ }, "dependencies": { "@firebase/installations-types": "0.3.4", - "@firebase/util": "0.3.2", - "@firebase/component": "0.1.19", + "@firebase/util": "0.3.3", + "@firebase/component": "0.1.20", "idb": "3.0.2", "tslib": "^1.11.1" } diff --git a/packages/messaging/CHANGELOG.md b/packages/messaging/CHANGELOG.md index cae44960687..a4fc93fcf8d 100644 --- a/packages/messaging/CHANGELOG.md +++ b/packages/messaging/CHANGELOG.md @@ -1,5 +1,14 @@ # @firebase/messaging +## 0.7.2 + +### Patch Changes + +- Updated dependencies [[`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487), [`7d916d905`](https://github.com/firebase/firebase-js-sdk/commit/7d916d905ba16816ac8ac7c8748c83831ff614ce)]: + - @firebase/component@0.1.20 + - @firebase/util@0.3.3 + - @firebase/installations@0.4.18 + ## 0.7.1 ### Patch Changes diff --git a/packages/messaging/package.json b/packages/messaging/package.json index aac5c67bf52..80b3b22bc05 100644 --- a/packages/messaging/package.json +++ b/packages/messaging/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/messaging", - "version": "0.7.1", + "version": "0.7.2", "description": "", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.cjs.js", @@ -26,15 +26,15 @@ "@firebase/app-types": "0.x" }, "dependencies": { - "@firebase/installations": "0.4.17", + "@firebase/installations": "0.4.18", "@firebase/messaging-types": "0.5.0", - "@firebase/util": "0.3.2", - "@firebase/component": "0.1.19", + "@firebase/util": "0.3.3", + "@firebase/component": "0.1.20", "idb": "3.0.2", "tslib": "^1.11.1" }, "devDependencies": { - "@firebase/app": "0.6.11", + "@firebase/app": "0.6.12", "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", "ts-essentials": "7.0.0", diff --git a/packages/performance/CHANGELOG.md b/packages/performance/CHANGELOG.md index 15b4db63773..cb17ae0649b 100644 --- a/packages/performance/CHANGELOG.md +++ b/packages/performance/CHANGELOG.md @@ -1,5 +1,28 @@ # @firebase/performance +## 0.4.3 + +### Patch Changes + +- [`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487) [#3932](https://github.com/firebase/firebase-js-sdk/pull/3932) - Point browser field to esm build. Now you need to use default import instead of namespace import to import firebase. + + Before this change + + ``` + import * as firebase from 'firebase/app'; + ``` + + After this change + + ``` + import firebase from 'firebase/app'; + ``` + +- Updated dependencies [[`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487), [`7d916d905`](https://github.com/firebase/firebase-js-sdk/commit/7d916d905ba16816ac8ac7c8748c83831ff614ce)]: + - @firebase/component@0.1.20 + - @firebase/util@0.3.3 + - @firebase/installations@0.4.18 + ## 0.4.2 ### Patch Changes diff --git a/packages/performance/package.json b/packages/performance/package.json index 181efe8bd9d..36c3efae7ac 100644 --- a/packages/performance/package.json +++ b/packages/performance/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/performance", - "version": "0.4.2", + "version": "0.4.3", "description": "Firebase performance for web", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.cjs.js", @@ -27,15 +27,15 @@ }, "dependencies": { "@firebase/logger": "0.2.6", - "@firebase/installations": "0.4.17", - "@firebase/util": "0.3.2", + "@firebase/installations": "0.4.18", + "@firebase/util": "0.3.3", "@firebase/performance-types": "0.0.13", - "@firebase/component": "0.1.19", + "@firebase/component": "0.1.20", "tslib": "^1.11.1" }, "license": "Apache-2.0", "devDependencies": { - "@firebase/app": "0.6.11", + "@firebase/app": "0.6.12", "rollup": "2.29.0", "@rollup/plugin-json": "4.1.0", "rollup-plugin-typescript2": "0.27.3", diff --git a/packages/remote-config/CHANGELOG.md b/packages/remote-config/CHANGELOG.md index dd6cc232321..7b76a97a5a3 100644 --- a/packages/remote-config/CHANGELOG.md +++ b/packages/remote-config/CHANGELOG.md @@ -1,5 +1,28 @@ # @firebase/remote-config +## 0.1.29 + +### Patch Changes + +- [`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487) [#3932](https://github.com/firebase/firebase-js-sdk/pull/3932) - Point browser field to esm build. Now you need to use default import instead of namespace import to import firebase. + + Before this change + + ``` + import * as firebase from 'firebase/app'; + ``` + + After this change + + ``` + import firebase from 'firebase/app'; + ``` + +- Updated dependencies [[`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487), [`7d916d905`](https://github.com/firebase/firebase-js-sdk/commit/7d916d905ba16816ac8ac7c8748c83831ff614ce)]: + - @firebase/component@0.1.20 + - @firebase/util@0.3.3 + - @firebase/installations@0.4.18 + ## 0.1.28 ### Patch Changes diff --git a/packages/remote-config/package.json b/packages/remote-config/package.json index 83ae132d614..97d9c95411b 100644 --- a/packages/remote-config/package.json +++ b/packages/remote-config/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/remote-config", - "version": "0.1.28", + "version": "0.1.29", "description": "The Remote Config package of the Firebase JS SDK", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.cjs.js", @@ -26,16 +26,16 @@ "@firebase/app-types": "0.x" }, "dependencies": { - "@firebase/installations": "0.4.17", + "@firebase/installations": "0.4.18", "@firebase/logger": "0.2.6", "@firebase/remote-config-types": "0.1.9", - "@firebase/util": "0.3.2", - "@firebase/component": "0.1.19", + "@firebase/util": "0.3.3", + "@firebase/component": "0.1.20", "tslib": "^1.11.1" }, "license": "Apache-2.0", "devDependencies": { - "@firebase/app": "0.6.11", + "@firebase/app": "0.6.12", "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", "typescript": "4.0.2" diff --git a/packages/rules-unit-testing/CHANGELOG.md b/packages/rules-unit-testing/CHANGELOG.md index f250115b304..dd1a80d052c 100644 --- a/packages/rules-unit-testing/CHANGELOG.md +++ b/packages/rules-unit-testing/CHANGELOG.md @@ -1,5 +1,13 @@ # @firebase/rules-unit-testing +## 1.0.9 + +### Patch Changes + +- Updated dependencies [[`ef33328f7`](https://github.com/firebase/firebase-js-sdk/commit/ef33328f7cb7d585a1304ed39649f5b69a111b3c), [`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487), [`8939aeca0`](https://github.com/firebase/firebase-js-sdk/commit/8939aeca02921f9eacf1badb1068de22f670293e), [`79b049375`](https://github.com/firebase/firebase-js-sdk/commit/79b04937537b90422e051086112f6b43c2880cdb), [`344bd8856`](https://github.com/firebase/firebase-js-sdk/commit/344bd88566e2c42fd7ee92f28bb0f784629b48ee), [`0322c1bda`](https://github.com/firebase/firebase-js-sdk/commit/0322c1bda93b2885b995e3df2b63b48314546961), [`4b540f91d`](https://github.com/firebase/firebase-js-sdk/commit/4b540f91dbad217e8ec04b382b4c724308cb3df1), [`ffef32e38`](https://github.com/firebase/firebase-js-sdk/commit/ffef32e3837d3ee1098129b237e7a6e2e738182d), [`7d916d905`](https://github.com/firebase/firebase-js-sdk/commit/7d916d905ba16816ac8ac7c8748c83831ff614ce), [`602ec18e9`](https://github.com/firebase/firebase-js-sdk/commit/602ec18e92fd365a3a6432ff3a5f6a31013eb1f5), [`b247ffa76`](https://github.com/firebase/firebase-js-sdk/commit/b247ffa760aec1636de6cfc78851f97a840181ae)]: + - firebase@8.0.0 + - @firebase/util@0.3.3 + ## 1.0.8 ### Patch Changes diff --git a/packages/rules-unit-testing/package.json b/packages/rules-unit-testing/package.json index 0ad86ca4913..9bb90657fb1 100644 --- a/packages/rules-unit-testing/package.json +++ b/packages/rules-unit-testing/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/rules-unit-testing", - "version": "1.0.8", + "version": "1.0.9", "description": "", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.cjs.js", @@ -19,9 +19,9 @@ }, "license": "Apache-2.0", "dependencies": { - "firebase": "7.24.0", + "firebase": "8.0.0", "@firebase/logger": "0.2.6", - "@firebase/util": "0.3.2", + "@firebase/util": "0.3.3", "request": "2.88.2" }, "devDependencies": { diff --git a/packages/rxfire/CHANGELOG.md b/packages/rxfire/CHANGELOG.md new file mode 100644 index 00000000000..9de9b245018 --- /dev/null +++ b/packages/rxfire/CHANGELOG.md @@ -0,0 +1,20 @@ +# rxfire + +## 4.0.0 +### Patch Changes + + + +- [`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487) [#3932](https://github.com/firebase/firebase-js-sdk/pull/3932) - Point browser field to esm build. Now you need to use default import instead of namespace import to import firebase. + + Before this change + ``` + import * as firebase from 'firebase/app'; + ``` + + After this change + ``` + import firebase from 'firebase/app'; + ``` +- Updated dependencies [[`ef33328f7`](https://github.com/firebase/firebase-js-sdk/commit/ef33328f7cb7d585a1304ed39649f5b69a111b3c), [`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487), [`8939aeca0`](https://github.com/firebase/firebase-js-sdk/commit/8939aeca02921f9eacf1badb1068de22f670293e), [`79b049375`](https://github.com/firebase/firebase-js-sdk/commit/79b04937537b90422e051086112f6b43c2880cdb), [`344bd8856`](https://github.com/firebase/firebase-js-sdk/commit/344bd88566e2c42fd7ee92f28bb0f784629b48ee), [`0322c1bda`](https://github.com/firebase/firebase-js-sdk/commit/0322c1bda93b2885b995e3df2b63b48314546961), [`4b540f91d`](https://github.com/firebase/firebase-js-sdk/commit/4b540f91dbad217e8ec04b382b4c724308cb3df1), [`ffef32e38`](https://github.com/firebase/firebase-js-sdk/commit/ffef32e3837d3ee1098129b237e7a6e2e738182d), [`602ec18e9`](https://github.com/firebase/firebase-js-sdk/commit/602ec18e92fd365a3a6432ff3a5f6a31013eb1f5), [`b247ffa76`](https://github.com/firebase/firebase-js-sdk/commit/b247ffa760aec1636de6cfc78851f97a840181ae)]: + - firebase@8.0.0 diff --git a/packages/rxfire/package.json b/packages/rxfire/package.json index 8703120d0de..40b1186beb0 100644 --- a/packages/rxfire/package.json +++ b/packages/rxfire/package.json @@ -1,6 +1,6 @@ { "name": "rxfire", - "version": "3.13.5", + "version": "4.0.0", "private": false, "description": "Firebase JavaScript library RxJS", "author": "Firebase (https://firebase.google.com/)", @@ -36,11 +36,11 @@ "tslib": "^1.11.1" }, "peerDependencies": { - "firebase": ">= 5.0.0 <8", + "firebase": ">=8.0.0", "rxjs": "6.x.x" }, "devDependencies": { - "firebase": "7.24.0", + "firebase": "8.0.0", "rollup": "2.29.0", "@rollup/plugin-commonjs": "15.1.0", "@rollup/plugin-node-resolve": "9.0.0", diff --git a/packages/storage/CHANGELOG.md b/packages/storage/CHANGELOG.md index 28199ef6d8b..45a9c9df684 100644 --- a/packages/storage/CHANGELOG.md +++ b/packages/storage/CHANGELOG.md @@ -1,5 +1,17 @@ #Unreleased +## 0.4.0 + +### Minor Changes + +- [`b247ffa76`](https://github.com/firebase/firebase-js-sdk/commit/b247ffa760aec1636de6cfc78851f97a840181ae) [#3967](https://github.com/firebase/firebase-js-sdk/pull/3967) - This releases removes all input validation. Please use our TypeScript types to validate API usage. + +### Patch Changes + +- Updated dependencies [[`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487), [`7d916d905`](https://github.com/firebase/firebase-js-sdk/commit/7d916d905ba16816ac8ac7c8748c83831ff614ce)]: + - @firebase/component@0.1.20 + - @firebase/util@0.3.3 + ## 0.3.43 ### Patch Changes diff --git a/packages/storage/package.json b/packages/storage/package.json index 302e8ebdea5..ee80f61d509 100644 --- a/packages/storage/package.json +++ b/packages/storage/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/storage", - "version": "0.3.43", + "version": "0.4.0", "description": "", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.cjs.js", @@ -24,8 +24,8 @@ "license": "Apache-2.0", "dependencies": { "@firebase/storage-types": "0.3.13", - "@firebase/util": "0.3.2", - "@firebase/component": "0.1.19", + "@firebase/util": "0.3.3", + "@firebase/component": "0.1.20", "tslib": "^1.11.1" }, "peerDependencies": { @@ -33,8 +33,8 @@ "@firebase/app-types": "0.x" }, "devDependencies": { - "@firebase/app": "0.6.11", - "@firebase/auth": "0.15.0", + "@firebase/app": "0.6.12", + "@firebase/auth": "0.15.1", "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", "typescript": "4.0.2" diff --git a/packages/template/package.json b/packages/template/package.json index 353c2b23bb9..1d014822114 100644 --- a/packages/template/package.json +++ b/packages/template/package.json @@ -32,7 +32,7 @@ }, "license": "Apache-2.0", "devDependencies": { - "@firebase/app": "0.6.11", + "@firebase/app": "0.6.12", "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", "typescript": "4.0.2" diff --git a/packages/util/CHANGELOG.md b/packages/util/CHANGELOG.md index 62b7479a4ea..165a29da248 100644 --- a/packages/util/CHANGELOG.md +++ b/packages/util/CHANGELOG.md @@ -1,5 +1,25 @@ # @firebase/util +## 0.3.3 + +### Patch Changes + +- [`a5768b0aa`](https://github.com/firebase/firebase-js-sdk/commit/a5768b0aa7d7ce732279931aa436e988c9f36487) [#3932](https://github.com/firebase/firebase-js-sdk/pull/3932) - Point browser field to esm build. Now you need to use default import instead of namespace import to import firebase. + + Before this change + + ``` + import * as firebase from 'firebase/app'; + ``` + + After this change + + ``` + import firebase from 'firebase/app'; + ``` + +* [`7d916d905`](https://github.com/firebase/firebase-js-sdk/commit/7d916d905ba16816ac8ac7c8748c83831ff614ce) [#3946](https://github.com/firebase/firebase-js-sdk/pull/3946) - Write template data to a new `customData` field in`FirebaseError` instead of writing to the error object itself to avoid overwriting existing fields. + ## 0.3.2 ### Patch Changes diff --git a/packages/util/package.json b/packages/util/package.json index f3fdfb6a5bc..57d208709d3 100644 --- a/packages/util/package.json +++ b/packages/util/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/util", - "version": "0.3.2", + "version": "0.3.3", "description": "", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.node.cjs.js", diff --git a/repo-scripts/size-analysis/package.json b/repo-scripts/size-analysis/package.json index 74453c02ce5..04151d152b2 100644 --- a/repo-scripts/size-analysis/package.json +++ b/repo-scripts/size-analysis/package.json @@ -32,13 +32,13 @@ "typescript": "4.0.2", "terser": "5.3.5", "yargs": "16.0.3", - "@firebase/util": "0.3.2", + "@firebase/util": "0.3.3", "gzip-size": "5.1.1" }, "license": "Apache-2.0", "devDependencies": { "@firebase/logger": "0.2.6", - "@firebase/app": "0.6.11" + "@firebase/app": "0.6.12" }, "repository": { "directory": "repo-scripts/size-analysis", From e3bf958cb642d4a4d65c014c8fd5b66009a92204 Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Mon, 26 Oct 2020 12:35:23 -0700 Subject: [PATCH 036/624] Update yarn.lock for release (#3998) Temp fix where database version is bumped before firebase-admin can update deps --- yarn.lock | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/yarn.lock b/yarn.lock index c7bc8819b9c..f6cb6b44204 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1247,6 +1247,41 @@ unique-filename "^1.1.1" which "^1.3.1" +"@firebase/component@0.1.19": + version "0.1.19" + resolved "https://registry.npmjs.org/@firebase/component/-/component-0.1.19.tgz#bd2ac601652c22576b574c08c40da245933dbac7" + integrity sha512-L0S3g8eqaerg8y0zox3oOHSTwn/FE8RbcRHiurnbESvDViZtP5S5WnhuAPd7FnFxa8ElWK0z1Tr3ikzWDv1xdQ== + dependencies: + "@firebase/util" "0.3.2" + tslib "^1.11.1" + +"@firebase/database-types@0.5.2", "@firebase/database-types@^0.5.2": + version "0.5.2" + resolved "https://registry.npmjs.org/@firebase/database-types/-/database-types-0.5.2.tgz#23bec8477f84f519727f165c687761e29958b63c" + integrity sha512-ap2WQOS3LKmGuVFKUghFft7RxXTyZTDr0Xd8y2aqmWsbJVjgozi0huL/EUMgTjGFrATAjcf2A7aNs8AKKZ2a8g== + dependencies: + "@firebase/app-types" "0.6.1" + +"@firebase/database@^0.6.10": + version "0.6.13" + resolved "https://registry.npmjs.org/@firebase/database/-/database-0.6.13.tgz#b96fe0c53757dd6404ee085fdcb45c0f9f525c17" + integrity sha512-NommVkAPzU7CKd1gyehmi3lz0K78q0KOfiex7Nfy7MBMwknLm7oNqKovXSgQV1PCLvKXvvAplDSFhDhzIf9obA== + dependencies: + "@firebase/auth-interop-types" "0.1.5" + "@firebase/component" "0.1.19" + "@firebase/database-types" "0.5.2" + "@firebase/logger" "0.2.6" + "@firebase/util" "0.3.2" + faye-websocket "0.11.3" + tslib "^1.11.1" + +"@firebase/util@0.3.2": + version "0.3.2" + resolved "https://registry.npmjs.org/@firebase/util/-/util-0.3.2.tgz#87de27f9cffc2324651cabf6ec133d0a9eb21b52" + integrity sha512-Dqs00++c8rwKky6KCKLLY2T1qYO4Q+X5t+lF7DInXDNF4ae1Oau35bkD+OpJ9u7l1pEv7KHowP6CUKuySCOc8g== + dependencies: + tslib "^1.11.1" + "@google-cloud/common@^3.3.0": version "3.4.0" resolved "https://registry.npmjs.org/@google-cloud/common/-/common-3.4.0.tgz#8951d0dc94c9dfd8af2b49ed125984dc71f1de6b" From 519d2cf6423fa4cd4f5a6e8e75467615e15d64ba Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Mon, 26 Oct 2020 12:35:23 -0700 Subject: [PATCH 037/624] Merge release branch 8.0.0 Update yarn.lock for release (#3998) Temp fix where database version is bumped before firebase-admin can update deps --- yarn.lock | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/yarn.lock b/yarn.lock index c7bc8819b9c..f6cb6b44204 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1247,6 +1247,41 @@ unique-filename "^1.1.1" which "^1.3.1" +"@firebase/component@0.1.19": + version "0.1.19" + resolved "https://registry.npmjs.org/@firebase/component/-/component-0.1.19.tgz#bd2ac601652c22576b574c08c40da245933dbac7" + integrity sha512-L0S3g8eqaerg8y0zox3oOHSTwn/FE8RbcRHiurnbESvDViZtP5S5WnhuAPd7FnFxa8ElWK0z1Tr3ikzWDv1xdQ== + dependencies: + "@firebase/util" "0.3.2" + tslib "^1.11.1" + +"@firebase/database-types@0.5.2", "@firebase/database-types@^0.5.2": + version "0.5.2" + resolved "https://registry.npmjs.org/@firebase/database-types/-/database-types-0.5.2.tgz#23bec8477f84f519727f165c687761e29958b63c" + integrity sha512-ap2WQOS3LKmGuVFKUghFft7RxXTyZTDr0Xd8y2aqmWsbJVjgozi0huL/EUMgTjGFrATAjcf2A7aNs8AKKZ2a8g== + dependencies: + "@firebase/app-types" "0.6.1" + +"@firebase/database@^0.6.10": + version "0.6.13" + resolved "https://registry.npmjs.org/@firebase/database/-/database-0.6.13.tgz#b96fe0c53757dd6404ee085fdcb45c0f9f525c17" + integrity sha512-NommVkAPzU7CKd1gyehmi3lz0K78q0KOfiex7Nfy7MBMwknLm7oNqKovXSgQV1PCLvKXvvAplDSFhDhzIf9obA== + dependencies: + "@firebase/auth-interop-types" "0.1.5" + "@firebase/component" "0.1.19" + "@firebase/database-types" "0.5.2" + "@firebase/logger" "0.2.6" + "@firebase/util" "0.3.2" + faye-websocket "0.11.3" + tslib "^1.11.1" + +"@firebase/util@0.3.2": + version "0.3.2" + resolved "https://registry.npmjs.org/@firebase/util/-/util-0.3.2.tgz#87de27f9cffc2324651cabf6ec133d0a9eb21b52" + integrity sha512-Dqs00++c8rwKky6KCKLLY2T1qYO4Q+X5t+lF7DInXDNF4ae1Oau35bkD+OpJ9u7l1pEv7KHowP6CUKuySCOc8g== + dependencies: + tslib "^1.11.1" + "@google-cloud/common@^3.3.0": version "3.4.0" resolved "https://registry.npmjs.org/@google-cloud/common/-/common-3.4.0.tgz#8951d0dc94c9dfd8af2b49ed125984dc71f1de6b" From a9ba7ba7c2b9da8bd16f14c0062593bd8d941124 Mon Sep 17 00:00:00 2001 From: Alex Volkovitsky Date: Mon, 26 Oct 2020 14:06:59 -0700 Subject: [PATCH 038/624] Add documentation for @firebase/auth-exp (#3952) * Add documentation for @firebase/auth-exp * PR Feedback * Update examples to account for change in API related to credentialFromResult * Rebase conflicts --- common/api-review/auth-exp.api.md | 431 ++++++++++++------ common/api-review/auth-types-exp.api.md | 5 +- docs-exp/auth-types.actioncodeinfo.data.md | 19 +- docs-exp/auth-types.actioncodeinfo.md | 4 +- .../auth-types.actioncodesettings.android.md | 7 +- ...es.actioncodesettings.dynamiclinkdomain.md | 2 +- ...ypes.actioncodesettings.handlecodeinapp.md | 7 +- docs-exp/auth-types.actioncodesettings.ios.md | 11 +- docs-exp/auth-types.actioncodesettings.md | 12 +- docs-exp/auth-types.actioncodesettings.url.md | 7 +- docs-exp/auth-types.actioncodeurl.md | 2 +- .../auth-types.actioncodeurl.parselink.md | 2 +- docs-exp/auth-types.applicationverifier.md | 6 +- docs-exp/auth-types.auth.languagecode.md | 7 +- docs-exp/auth-types.auth.md | 24 +- .../auth-types.auth.onauthstatechanged.md | 6 +- docs-exp/auth-types.auth.onidtokenchanged.md | 6 +- docs-exp/auth-types.auth.setpersistence.md | 10 +- docs-exp/auth-types.auth.settings.md | 7 +- docs-exp/auth-types.auth.tenantid.md | 6 +- docs-exp/auth-types.auth.updatecurrentuser.md | 14 +- docs-exp/auth-types.auth.useemulator.md | 6 +- docs-exp/auth-types.authcredential.md | 10 +- .../auth-types.authcredential.providerid.md | 7 +- .../auth-types.authcredential.signinmethod.md | 7 +- docs-exp/auth-types.autherror.md | 3 +- docs-exp/auth-types.autherror.tenantid.md | 7 +- docs-exp/auth-types.authsettings.md | 6 +- docs-exp/auth-types.config.md | 2 +- docs-exp/auth-types.confirmationresult.md | 2 +- ...types.confirmationresult.verificationid.md | 7 +- docs-exp/auth-types.emailauthprovider.md | 2 +- docs-exp/auth-types.idtokenresult.authtime.md | 7 +- docs-exp/auth-types.idtokenresult.md | 14 +- ...auth-types.idtokenresult.signinprovider.md | 7 +- docs-exp/auth-types.md | 52 +-- docs-exp/auth-types.multifactorassertion.md | 6 +- docs-exp/auth-types.multifactorerror.md | 6 +- docs-exp/auth-types.multifactorsession.md | 2 +- docs-exp/auth-types.multifactoruser.enroll.md | 6 +- docs-exp/auth-types.multifactoruser.md | 6 +- .../auth-types.multifactoruser.unenroll.md | 6 +- .../auth-types.oauthcredential.accesstoken.md | 2 +- docs-exp/auth-types.oauthcredential.md | 8 +- docs-exp/auth-types.operationtype.md | 2 +- docs-exp/auth-types.parsedtoken.md | 2 +- docs-exp/auth-types.persistence.md | 4 +- docs-exp/auth-types.persistence.type.md | 2 +- ...auth-types.phoneauthcredential.fromjson.md | 6 +- docs-exp/auth-types.phoneauthcredential.md | 5 +- .../auth-types.phoneauthcredential.tojson.md | 19 + ...h-types.phoneauthprovider._constructor_.md | 6 +- ...auth-types.phoneauthprovider.credential.md | 4 +- docs-exp/auth-types.phoneauthprovider.md | 10 +- ...pes.phoneauthprovider.verifyphonenumber.md | 4 +- docs-exp/auth-types.phoneinfooptions.md | 7 +- ...pes.phonemultifactorgenerator.assertion.md | 2 +- .../auth-types.phonemultifactorgenerator.md | 2 +- docs-exp/auth-types.popupredirectresolver.md | 2 +- docs-exp/auth-types.providerid.md | 2 +- docs-exp/auth-types.recaptchaverifier.md | 2 +- docs-exp/auth-types.recaptchaverifier.type.md | 7 +- docs-exp/auth-types.signinmethod.md | 2 +- docs-exp/auth-types.user.delete.md | 6 +- docs-exp/auth-types.user.emailverified.md | 2 +- docs-exp/auth-types.user.getidtoken.md | 6 +- docs-exp/auth-types.user.getidtokenresult.md | 6 +- docs-exp/auth-types.user.isanonymous.md | 2 +- docs-exp/auth-types.user.md | 14 +- docs-exp/auth-types.user.refreshtoken.md | 2 +- docs-exp/auth-types.user.tenantid.md | 6 +- docs-exp/auth-types.usercredential.md | 6 +- docs-exp/auth-types.userinfo.md | 2 +- docs-exp/auth-types.userinfo.phonenumber.md | 7 +- docs-exp/auth.actioncodeurl.md | 4 +- docs-exp/auth.actioncodeurl.operation.md | 2 +- docs-exp/auth.actioncodeurl.parselink.md | 2 +- docs-exp/auth.applyactioncode.md | 6 +- docs-exp/auth.authcredential._constructor_.md | 21 - ...auth.authcredential._getidtokenresponse.md | 22 - ...credential._getreauthenticationresolver.md | 22 - .../auth.authcredential._linktoidtoken.md | 23 - docs-exp/auth.authcredential.md | 13 +- docs-exp/auth.authcredential.tojson.md | 4 + docs-exp/auth.autherrorcode.md | 112 +++++ docs-exp/auth.browserlocalpersistence.md | 2 + docs-exp/auth.browserpopupredirectresolver.md | 2 + docs-exp/auth.browsersessionpersistence.md | 2 + docs-exp/auth.checkactioncode.md | 8 +- docs-exp/auth.confirmpasswordreset.md | 8 +- .../auth.createuserwithemailandpassword.md | 16 +- docs-exp/auth.customparameters.md | 13 + docs-exp/auth.deleteuser.md | 8 +- ...h.emailauthcredential._fromemailandcode.md | 24 - ...ailauthcredential._fromemailandpassword.md | 23 - ...emailauthcredential._getidtokenresponse.md | 22 - ...credential._getreauthenticationresolver.md | 22 - ...auth.emailauthcredential._linktoidtoken.md | 23 - docs-exp/auth.emailauthcredential.fromjson.md | 6 +- docs-exp/auth.emailauthcredential.md | 17 +- docs-exp/auth.emailauthcredential.tojson.md | 4 + docs-exp/auth.emailauthprovider.credential.md | 8 +- ...th.emailauthprovider.credentialwithlink.md | 8 +- ...lauthprovider.email_link_sign_in_method.md | 2 + ...hprovider.email_password_sign_in_method.md | 2 + docs-exp/auth.emailauthprovider.md | 14 +- .../auth.emailauthprovider.provider_id.md | 2 + docs-exp/auth.emailauthprovider.providerid.md | 2 + .../auth.facebookauthprovider.credential.md | 14 +- ...acebookauthprovider.credentialfromerror.md | 2 + ...cebookauthprovider.credentialfromresult.md | 4 +- ...ookauthprovider.facebook_sign_in_method.md | 2 + docs-exp/auth.facebookauthprovider.md | 52 ++- .../auth.facebookauthprovider.provider_id.md | 2 + .../auth.facebookauthprovider.providerid.md | 11 - docs-exp/auth.fetchsigninmethodsforemail.md | 10 +- docs-exp/auth.getadditionaluserinfo.md | 4 +- docs-exp/auth.getauth.md | 4 +- docs-exp/auth.getidtoken.md | 10 +- docs-exp/auth.getidtokenresult.md | 12 +- docs-exp/auth.getmultifactorresolver.md | 8 +- docs-exp/auth.getredirectresult.md | 40 +- .../auth.githubauthprovider.credential.md | 4 +- ....githubauthprovider.credentialfromerror.md | 2 + ...githubauthprovider.credentialfromresult.md | 4 +- ...ithubauthprovider.github_sign_in_method.md | 2 + docs-exp/auth.githubauthprovider.md | 56 ++- .../auth.githubauthprovider.provider_id.md | 2 + .../auth.githubauthprovider.providerid.md | 11 - .../auth.googleauthprovider.credential.md | 16 +- ....googleauthprovider.credentialfromerror.md | 2 + ...googleauthprovider.credentialfromresult.md | 4 +- ...oogleauthprovider.google_sign_in_method.md | 2 + docs-exp/auth.googleauthprovider.md | 54 ++- .../auth.googleauthprovider.provider_id.md | 2 + .../auth.googleauthprovider.providerid.md | 11 - docs-exp/auth.indexeddblocalpersistence.md | 2 + docs-exp/auth.initializeauth.md | 1 + docs-exp/auth.inmemorypersistence.md | 2 + docs-exp/auth.issigninwithemaillink.md | 6 +- docs-exp/auth.linkwithcredential.md | 12 +- docs-exp/auth.linkwithphonenumber.md | 10 +- docs-exp/auth.linkwithpopup.md | 26 +- docs-exp/auth.linkwithredirect.md | 26 +- docs-exp/auth.md | 150 +++--- docs-exp/auth.multifactor.md | 8 +- docs-exp/auth.oauthcredential._fromparams.md | 22 - ...uth.oauthcredential._getidtokenresponse.md | 22 - ...credential._getreauthenticationresolver.md | 22 - .../auth.oauthcredential._linktoidtoken.md | 23 - docs-exp/auth.oauthcredential.accesstoken.md | 2 + docs-exp/auth.oauthcredential.fromjson.md | 6 +- docs-exp/auth.oauthcredential.idtoken.md | 2 + docs-exp/auth.oauthcredential.md | 19 +- docs-exp/auth.oauthcredential.nonce.md | 11 - docs-exp/auth.oauthcredential.secret.md | 2 + docs-exp/auth.oauthcredential.tojson.md | 1 + ...auth.oauthcredentialoptions.accesstoken.md | 13 + .../auth.oauthcredentialoptions.idtoken.md | 13 + docs-exp/auth.oauthcredentialoptions.md | 26 ++ .../auth.oauthcredentialoptions.rawnonce.md | 18 + docs-exp/auth.oauthprovider._constructor_.md | 4 +- docs-exp/auth.oauthprovider.addscope.md | 4 +- docs-exp/auth.oauthprovider.credential.md | 24 +- .../auth.oauthprovider.defaultlanguagecode.md | 11 - .../auth.oauthprovider.getcustomparameters.md | 4 +- docs-exp/auth.oauthprovider.getscopes.md | 2 + docs-exp/auth.oauthprovider.md | 59 ++- .../auth.oauthprovider.setcustomparameters.md | 8 +- .../auth.oauthprovider.setdefaultlanguage.md | 4 +- docs-exp/auth.onauthstatechanged.md | 14 +- docs-exp/auth.onidtokenchanged.md | 10 +- docs-exp/auth.parseactioncodeurl.md | 2 +- ....phoneauthcredential._fromtokenresponse.md | 23 - ...h.phoneauthcredential._fromverification.md | 23 - ...phoneauthcredential._getidtokenresponse.md | 22 - ...credential._getreauthenticationresolver.md | 22 - ...auth.phoneauthcredential._linktoidtoken.md | 23 - ...authcredential._makeverificationrequest.md | 15 - docs-exp/auth.phoneauthcredential.fromjson.md | 1 + docs-exp/auth.phoneauthcredential.md | 8 +- docs-exp/auth.phoneauthcredential.tojson.md | 1 + docs-exp/auth.phoneauthprovider.credential.md | 8 +- docs-exp/auth.phoneauthprovider.md | 12 +- ....phoneauthprovider.phone_sign_in_method.md | 2 + .../auth.phoneauthprovider.provider_id.md | 2 + docs-exp/auth.phoneauthprovider.providerid.md | 2 + ...uth.phoneauthprovider.verifyphonenumber.md | 6 +- ...uth.phonemultifactorgenerator.assertion.md | 4 + docs-exp/auth.phonemultifactorgenerator.md | 4 +- docs-exp/auth.reauthenticatewithcredential.md | 12 +- .../auth.reauthenticatewithphonenumber.md | 14 +- docs-exp/auth.reauthenticatewithpopup.md | 26 +- docs-exp/auth.reauthenticatewithredirect.md | 30 +- ...auth.recaptchaverifier._recaptchaloader.md | 11 - docs-exp/auth.recaptchaverifier._reset.md | 15 - docs-exp/auth.recaptchaverifier.clear.md | 2 + docs-exp/auth.recaptchaverifier.md | 10 +- docs-exp/auth.recaptchaverifier.render.md | 4 + docs-exp/auth.recaptchaverifier.verify.md | 4 + docs-exp/auth.reload.md | 6 +- docs-exp/auth.sendemailverification.md | 34 +- docs-exp/auth.sendpasswordresetemail.md | 34 +- docs-exp/auth.sendsigninlinktoemail.md | 38 +- docs-exp/auth.setpersistence.md | 18 +- docs-exp/auth.signinanonymously.md | 8 +- docs-exp/auth.signinwithcredential.md | 10 +- docs-exp/auth.signinwithcustomtoken.md | 14 +- docs-exp/auth.signinwithemailandpassword.md | 14 +- docs-exp/auth.signinwithemaillink.md | 40 +- docs-exp/auth.signinwithphonenumber.md | 26 +- docs-exp/auth.signinwithpopup.md | 30 +- docs-exp/auth.signinwithredirect.md | 42 +- docs-exp/auth.signout.md | 4 +- .../auth.twitterauthprovider.credential.md | 6 +- ...twitterauthprovider.credentialfromerror.md | 2 + ...witterauthprovider.credentialfromresult.md | 4 +- docs-exp/auth.twitterauthprovider.md | 48 +- .../auth.twitterauthprovider.providerid.md | 11 - docs-exp/auth.unlink.md | 8 +- docs-exp/auth.updatecurrentuser.md | 14 +- docs-exp/auth.updateemail.md | 14 +- docs-exp/auth.updatepassword.md | 12 +- docs-exp/auth.updatephonenumber.md | 20 +- docs-exp/auth.updateprofile.md | 6 +- docs-exp/auth.usedevicelanguage.md | 4 +- docs-exp/auth.verifybeforeupdateemail.md | 38 +- docs-exp/auth.verifypasswordresetcode.md | 8 +- packages-exp/auth-exp/index.ts | 7 + packages-exp/auth-exp/package.json | 2 +- .../auth-exp/src/core/action_code_url.ts | 18 +- .../auth-exp/src/core/auth/initialize.ts | 1 + .../auth-exp/src/core/auth/register.ts | 1 + .../src/core/credentials/auth_credential.ts | 10 + .../auth-exp/src/core/credentials/email.ts | 18 + .../auth-exp/src/core/credentials/oauth.ts | 18 + .../auth-exp/src/core/credentials/phone.ts | 14 + packages-exp/auth-exp/src/core/errors.ts | 6 +- packages-exp/auth-exp/src/core/index.ts | 96 +++- .../src/core/persistence/in_memory.ts | 5 + .../auth-exp/src/core/providers/email.ts | 11 + .../auth-exp/src/core/providers/facebook.ts | 64 +++ .../auth-exp/src/core/providers/github.ts | 60 +++ .../auth-exp/src/core/providers/google.ts | 68 ++- .../auth-exp/src/core/providers/oauth.ts | 126 ++++- .../auth-exp/src/core/providers/twitter.ts | 56 +++ .../auth-exp/src/core/strategies/anonymous.ts | 11 + .../src/core/strategies/credential.ts | 56 ++- .../src/core/strategies/custom_token.ts | 26 +- .../auth-exp/src/core/strategies/email.ts | 102 ++++- .../src/core/strategies/email_and_password.ts | 102 +++++ .../src/core/strategies/email_link.ts | 83 ++++ .../auth-exp/src/core/strategies/idp.ts | 9 +- .../auth-exp/src/core/user/account_info.ts | 64 ++- .../src/core/user/additional_user_info.ts | 9 + .../auth-exp/src/core/user/id_token_result.ts | 31 +- .../auth-exp/src/core/user/link_unlink.ts | 26 +- packages-exp/auth-exp/src/core/user/reload.ts | 17 +- .../auth-exp/src/core/user/token_manager.ts | 2 + packages-exp/auth-exp/src/mfa/mfa_resolver.ts | 19 +- packages-exp/auth-exp/src/mfa/mfa_user.ts | 10 + .../src/model/application_verifier.ts | 2 + packages-exp/auth-exp/src/model/auth.ts | 30 ++ packages-exp/auth-exp/src/model/id_token.ts | 11 + .../auth-exp/src/model/popup_redirect.ts | 13 + packages-exp/auth-exp/src/model/user.ts | 30 ++ .../platform_browser/mfa/assertions/phone.ts | 13 + .../persistence/indexed_db.ts | 13 + .../persistence/local_storage.ts | 6 + .../persistence/session_storage.ts | 6 + .../src/platform_browser/popup_redirect.ts | 14 + .../src/platform_browser/providers/phone.ts | 9 + .../recaptcha/recaptcha_verifier.ts | 9 + .../src/platform_browser/strategies/phone.ts | 85 +++- .../src/platform_browser/strategies/popup.ts | 130 +++++- .../platform_browser/strategies/redirect.ts | 195 ++++++-- packages-exp/auth-types-exp/index.d.ts | 391 ++++++++++------ 277 files changed, 3876 insertions(+), 1380 deletions(-) create mode 100644 docs-exp/auth-types.phoneauthcredential.tojson.md delete mode 100644 docs-exp/auth.authcredential._constructor_.md delete mode 100644 docs-exp/auth.authcredential._getidtokenresponse.md delete mode 100644 docs-exp/auth.authcredential._getreauthenticationresolver.md delete mode 100644 docs-exp/auth.authcredential._linktoidtoken.md create mode 100644 docs-exp/auth.autherrorcode.md create mode 100644 docs-exp/auth.customparameters.md delete mode 100644 docs-exp/auth.emailauthcredential._fromemailandcode.md delete mode 100644 docs-exp/auth.emailauthcredential._fromemailandpassword.md delete mode 100644 docs-exp/auth.emailauthcredential._getidtokenresponse.md delete mode 100644 docs-exp/auth.emailauthcredential._getreauthenticationresolver.md delete mode 100644 docs-exp/auth.emailauthcredential._linktoidtoken.md delete mode 100644 docs-exp/auth.facebookauthprovider.providerid.md delete mode 100644 docs-exp/auth.githubauthprovider.providerid.md delete mode 100644 docs-exp/auth.googleauthprovider.providerid.md delete mode 100644 docs-exp/auth.oauthcredential._fromparams.md delete mode 100644 docs-exp/auth.oauthcredential._getidtokenresponse.md delete mode 100644 docs-exp/auth.oauthcredential._getreauthenticationresolver.md delete mode 100644 docs-exp/auth.oauthcredential._linktoidtoken.md delete mode 100644 docs-exp/auth.oauthcredential.nonce.md create mode 100644 docs-exp/auth.oauthcredentialoptions.accesstoken.md create mode 100644 docs-exp/auth.oauthcredentialoptions.idtoken.md create mode 100644 docs-exp/auth.oauthcredentialoptions.md create mode 100644 docs-exp/auth.oauthcredentialoptions.rawnonce.md delete mode 100644 docs-exp/auth.oauthprovider.defaultlanguagecode.md delete mode 100644 docs-exp/auth.phoneauthcredential._fromtokenresponse.md delete mode 100644 docs-exp/auth.phoneauthcredential._fromverification.md delete mode 100644 docs-exp/auth.phoneauthcredential._getidtokenresponse.md delete mode 100644 docs-exp/auth.phoneauthcredential._getreauthenticationresolver.md delete mode 100644 docs-exp/auth.phoneauthcredential._linktoidtoken.md delete mode 100644 docs-exp/auth.phoneauthcredential._makeverificationrequest.md delete mode 100644 docs-exp/auth.recaptchaverifier._recaptchaloader.md delete mode 100644 docs-exp/auth.recaptchaverifier._reset.md delete mode 100644 docs-exp/auth.twitterauthprovider.providerid.md diff --git a/common/api-review/auth-exp.api.md b/common/api-review/auth-exp.api.md index 283f0788137..23aa51decd1 100644 --- a/common/api-review/auth-exp.api.md +++ b/common/api-review/auth-exp.api.md @@ -35,22 +35,23 @@ export class ActionCodeURL implements externs.ActionCodeURL { readonly tenantId: string | null; } -// @public (undocumented) +// @public export function applyActionCode(auth: externs.Auth, oobCode: string): Promise; // @public (undocumented) export class AuthCredential { + // @internal protected constructor(providerId: string, signInMethod: string); // Warning: (ae-forgotten-export) The symbol "Auth" needs to be exported by the entry point index.d.ts // Warning: (ae-forgotten-export) The symbol "PhoneOrOauthTokenResponse" needs to be exported by the entry point index.d.ts // - // (undocumented) + // @internal (undocumented) _getIdTokenResponse(_auth: Auth_2): Promise; - // (undocumented) + // @internal (undocumented) _getReauthenticationResolver(_auth: Auth_2): Promise; // Warning: (ae-forgotten-export) The symbol "IdTokenResponse" needs to be exported by the entry point index.d.ts // - // (undocumented) + // @internal (undocumented) _linkToIdToken(_auth: Auth_2, _idToken: string): Promise; // (undocumented) readonly providerId: string; @@ -60,42 +61,235 @@ export class AuthCredential { toJSON(): object; } -// @public (undocumented) +// @public +export const enum AuthErrorCode { + // (undocumented) + ADMIN_ONLY_OPERATION = "admin-restricted-operation", + // (undocumented) + APP_NOT_AUTHORIZED = "app-not-authorized", + // (undocumented) + APP_NOT_INSTALLED = "app-not-installed", + // (undocumented) + ARGUMENT_ERROR = "argument-error", + // (undocumented) + CAPTCHA_CHECK_FAILED = "captcha-check-failed", + // (undocumented) + CODE_EXPIRED = "code-expired", + // (undocumented) + CORDOVA_NOT_READY = "cordova-not-ready", + // (undocumented) + CORS_UNSUPPORTED = "cors-unsupported", + // (undocumented) + CREDENTIAL_ALREADY_IN_USE = "credential-already-in-use", + // (undocumented) + CREDENTIAL_MISMATCH = "custom-token-mismatch", + // (undocumented) + CREDENTIAL_TOO_OLD_LOGIN_AGAIN = "requires-recent-login", + // (undocumented) + DYNAMIC_LINK_NOT_ACTIVATED = "dynamic-link-not-activated", + // (undocumented) + EMAIL_CHANGE_NEEDS_VERIFICATION = "email-change-needs-verification", + // (undocumented) + EMAIL_EXISTS = "email-already-in-use", + // (undocumented) + EMULATOR_CONFIG_FAILED = "emulator-config-failed", + // (undocumented) + EXPIRED_OOB_CODE = "expired-action-code", + // (undocumented) + EXPIRED_POPUP_REQUEST = "cancelled-popup-request", + // (undocumented) + INTERNAL_ERROR = "internal-error", + // (undocumented) + INVALID_API_KEY = "invalid-api-key", + // (undocumented) + INVALID_APP_CREDENTIAL = "invalid-app-credential", + // (undocumented) + INVALID_APP_ID = "invalid-app-id", + // (undocumented) + INVALID_AUTH = "invalid-user-token", + // (undocumented) + INVALID_AUTH_EVENT = "invalid-auth-event", + // (undocumented) + INVALID_CERT_HASH = "invalid-cert-hash", + // (undocumented) + INVALID_CODE = "invalid-verification-code", + // (undocumented) + INVALID_CONTINUE_URI = "invalid-continue-uri", + // (undocumented) + INVALID_CORDOVA_CONFIGURATION = "invalid-cordova-configuration", + // (undocumented) + INVALID_CUSTOM_TOKEN = "invalid-custom-token", + // (undocumented) + INVALID_DYNAMIC_LINK_DOMAIN = "invalid-dynamic-link-domain", + // (undocumented) + INVALID_EMAIL = "invalid-email", + // (undocumented) + INVALID_EMULATOR_SCHEME = "invalid-emulator-scheme", + // (undocumented) + INVALID_IDP_RESPONSE = "invalid-credential", + // (undocumented) + INVALID_MESSAGE_PAYLOAD = "invalid-message-payload", + // (undocumented) + INVALID_MFA_SESSION = "invalid-multi-factor-session", + // (undocumented) + INVALID_OAUTH_CLIENT_ID = "invalid-oauth-client-id", + // (undocumented) + INVALID_OAUTH_PROVIDER = "invalid-oauth-provider", + // (undocumented) + INVALID_OOB_CODE = "invalid-action-code", + // (undocumented) + INVALID_ORIGIN = "unauthorized-domain", + // (undocumented) + INVALID_PASSWORD = "wrong-password", + // (undocumented) + INVALID_PERSISTENCE = "invalid-persistence-type", + // (undocumented) + INVALID_PHONE_NUMBER = "invalid-phone-number", + // (undocumented) + INVALID_PROVIDER_ID = "invalid-provider-id", + // (undocumented) + INVALID_RECIPIENT_EMAIL = "invalid-recipient-email", + // (undocumented) + INVALID_SENDER = "invalid-sender", + // (undocumented) + INVALID_SESSION_INFO = "invalid-verification-id", + // (undocumented) + INVALID_TENANT_ID = "invalid-tenant-id", + // (undocumented) + MFA_INFO_NOT_FOUND = "multi-factor-info-not-found", + // (undocumented) + MFA_REQUIRED = "multi-factor-auth-required", + // (undocumented) + MISSING_ANDROID_PACKAGE_NAME = "missing-android-pkg-name", + // (undocumented) + MISSING_APP_CREDENTIAL = "missing-app-credential", + // (undocumented) + MISSING_AUTH_DOMAIN = "auth-domain-config-required", + // (undocumented) + MISSING_CODE = "missing-verification-code", + // (undocumented) + MISSING_CONTINUE_URI = "missing-continue-uri", + // (undocumented) + MISSING_IFRAME_START = "missing-iframe-start", + // (undocumented) + MISSING_IOS_BUNDLE_ID = "missing-ios-bundle-id", + // (undocumented) + MISSING_MFA_INFO = "missing-multi-factor-info", + // (undocumented) + MISSING_MFA_SESSION = "missing-multi-factor-session", + // (undocumented) + MISSING_OR_INVALID_NONCE = "missing-or-invalid-nonce", + // (undocumented) + MISSING_PHONE_NUMBER = "missing-phone-number", + // (undocumented) + MISSING_SESSION_INFO = "missing-verification-id", + // (undocumented) + MODULE_DESTROYED = "app-deleted", + // (undocumented) + NEED_CONFIRMATION = "account-exists-with-different-credential", + // (undocumented) + NETWORK_REQUEST_FAILED = "network-request-failed", + // (undocumented) + NO_AUTH_EVENT = "no-auth-event", + // (undocumented) + NO_SUCH_PROVIDER = "no-such-provider", + // (undocumented) + NULL_USER = "null-user", + // (undocumented) + OPERATION_NOT_ALLOWED = "operation-not-allowed", + // (undocumented) + OPERATION_NOT_SUPPORTED = "operation-not-supported-in-this-environment", + // (undocumented) + POPUP_BLOCKED = "popup-blocked", + // (undocumented) + POPUP_CLOSED_BY_USER = "popup-closed-by-user", + // (undocumented) + PROVIDER_ALREADY_LINKED = "provider-already-linked", + // (undocumented) + QUOTA_EXCEEDED = "quota-exceeded", + // (undocumented) + REDIRECT_CANCELLED_BY_USER = "redirect-cancelled-by-user", + // (undocumented) + REDIRECT_OPERATION_PENDING = "redirect-operation-pending", + // (undocumented) + REJECTED_CREDENTIAL = "rejected-credential", + // (undocumented) + SECOND_FACTOR_ALREADY_ENROLLED = "second-factor-already-in-use", + // (undocumented) + SECOND_FACTOR_LIMIT_EXCEEDED = "maximum-second-factor-count-exceeded", + // (undocumented) + TENANT_ID_MISMATCH = "tenant-id-mismatch", + // (undocumented) + TIMEOUT = "timeout", + // (undocumented) + TOKEN_EXPIRED = "user-token-expired", + // (undocumented) + TOO_MANY_ATTEMPTS_TRY_LATER = "too-many-requests", + // (undocumented) + UNAUTHORIZED_DOMAIN = "unauthorized-continue-uri", + // (undocumented) + UNSUPPORTED_FIRST_FACTOR = "unsupported-first-factor", + // (undocumented) + UNSUPPORTED_PERSISTENCE = "unsupported-persistence-type", + // (undocumented) + UNSUPPORTED_TENANT_OPERATION = "unsupported-tenant-operation", + // (undocumented) + UNVERIFIED_EMAIL = "unverified-email", + // (undocumented) + USER_CANCELLED = "user-cancelled", + // (undocumented) + USER_DELETED = "user-not-found", + // (undocumented) + USER_DISABLED = "user-disabled", + // (undocumented) + USER_MISMATCH = "user-mismatch", + // (undocumented) + USER_SIGNED_OUT = "user-signed-out", + // (undocumented) + WEAK_PASSWORD = "weak-password", + // (undocumented) + WEB_STORAGE_UNSUPPORTED = "web-storage-unsupported" +} + +// @public export const browserLocalPersistence: externs.Persistence; -// @public (undocumented) +// @public export const browserPopupRedirectResolver: externs.PopupRedirectResolver; -// @public (undocumented) +// @public export const browserSessionPersistence: externs.Persistence; -// @public (undocumented) +// @public export function checkActionCode(auth: externs.Auth, oobCode: string): Promise; -// @public (undocumented) +// @public export function confirmPasswordReset(auth: externs.Auth, oobCode: string, newPassword: string): Promise; -// @public (undocumented) +// @public export function createUserWithEmailAndPassword(auth: externs.Auth, email: string, password: string): Promise; -// @public (undocumented) +// @public +export type CustomParameters = Record; + +// @public export function deleteUser(user: externs.User): Promise; -// @public (undocumented) +// @public export class EmailAuthCredential extends AuthCredential implements externs.AuthCredential { // (undocumented) readonly email: string; - // (undocumented) + // @internal (undocumented) static _fromEmailAndCode(email: string, oobCode: string, tenantId?: string | null): EmailAuthCredential; - // (undocumented) + // @internal (undocumented) static _fromEmailAndPassword(email: string, password: string): EmailAuthCredential; // (undocumented) static fromJSON(json: object | string): EmailAuthCredential | null; - // (undocumented) + // @internal (undocumented) _getIdTokenResponse(auth: Auth_2): Promise; - // (undocumented) + // @internal (undocumented) _getReauthenticationResolver(auth: Auth_2): Promise; - // (undocumented) + // @internal (undocumented) _linkToIdToken(auth: Auth_2, idToken: string): Promise; // (undocumented) readonly password: string; @@ -121,73 +315,58 @@ export class EmailAuthProvider implements externs.EmailAuthProvider { readonly providerId = externs.ProviderId.PASSWORD; } -// @public (undocumented) +// @public export class FacebookAuthProvider extends OAuthProvider { constructor(); - // (undocumented) static credential(accessToken: string): externs.OAuthCredential; - // (undocumented) static credentialFromError(error: FirebaseError): externs.OAuthCredential | null; - // (undocumented) static credentialFromResult(userCredential: externs.UserCredential): externs.OAuthCredential | null; - // (undocumented) static readonly FACEBOOK_SIGN_IN_METHOD = externs.SignInMethod.FACEBOOK; - // (undocumented) static readonly PROVIDER_ID = externs.ProviderId.FACEBOOK; } -// @public (undocumented) +// @public export function fetchSignInMethodsForEmail(auth: externs.Auth, email: string): Promise; -// @public (undocumented) +// @public export function getAdditionalUserInfo(userCredential: externs.UserCredential): externs.AdditionalUserInfo | null; -// @public (undocumented) +// @public export function getAuth(app?: FirebaseApp): Auth; -// @public (undocumented) +// @public export function getIdToken(user: externs.User, forceRefresh?: boolean): Promise; -// @public (undocumented) -export function getIdTokenResult(externUser: externs.User, forceRefresh?: boolean): Promise; +// @public +export function getIdTokenResult(user: externs.User, forceRefresh?: boolean): Promise; -// @public (undocumented) -export function getMultiFactorResolver(auth: externs.Auth, errorExtern: externs.MultiFactorError): externs.MultiFactorResolver; +// @public +export function getMultiFactorResolver(auth: externs.Auth, error: externs.MultiFactorError): externs.MultiFactorResolver; -// @public (undocumented) -export function getRedirectResult(authExtern: externs.Auth, resolverExtern?: externs.PopupRedirectResolver): Promise; +// @public +export function getRedirectResult(auth: externs.Auth, resolver?: externs.PopupRedirectResolver): Promise; -// @public (undocumented) +// @public export class GithubAuthProvider extends OAuthProvider { constructor(); - // (undocumented) static credential(accessToken: string): externs.OAuthCredential; - // (undocumented) static credentialFromError(error: FirebaseError): externs.OAuthCredential | null; - // (undocumented) static credentialFromResult(userCredential: externs.UserCredential): externs.OAuthCredential | null; - // (undocumented) static readonly GITHUB_SIGN_IN_METHOD = externs.SignInMethod.GITHUB; - // (undocumented) static readonly PROVIDER_ID = externs.ProviderId.GITHUB; } -// @public (undocumented) +// @public export class GoogleAuthProvider extends OAuthProvider { constructor(); - // (undocumented) static credential(idToken?: string | null, accessToken?: string | null): externs.OAuthCredential; - // (undocumented) static credentialFromError(error: FirebaseError): externs.OAuthCredential | null; - // (undocumented) static credentialFromResult(userCredential: externs.UserCredential): externs.OAuthCredential | null; - // (undocumented) static readonly GOOGLE_SIGN_IN_METHOD = externs.SignInMethod.GOOGLE; - // (undocumented) static readonly PROVIDER_ID = externs.ProviderId.GOOGLE; } -// @public (undocumented) +// @public export const indexedDBLocalPersistence: externs.Persistence; // Warning: (ae-forgotten-export) The symbol "Dependencies" needs to be exported by the entry point index.d.ts @@ -195,25 +374,25 @@ export const indexedDBLocalPersistence: externs.Persistence; // @public (undocumented) export function initializeAuth(app?: FirebaseApp, deps?: Dependencies): externs.Auth; -// @public (undocumented) +// @public export const inMemoryPersistence: externs.Persistence; -// @public (undocumented) +// @public export function isSignInWithEmailLink(auth: externs.Auth, emailLink: string): boolean; -// @public (undocumented) -export function linkWithCredential(userExtern: externs.User, credentialExtern: externs.AuthCredential): Promise; +// @public +export function linkWithCredential(user: externs.User, credential: externs.AuthCredential): Promise; -// @public (undocumented) -export function linkWithPhoneNumber(userExtern: externs.User, phoneNumber: string, appVerifier: externs.ApplicationVerifier): Promise; +// @public +export function linkWithPhoneNumber(user: externs.User, phoneNumber: string, appVerifier: externs.ApplicationVerifier): Promise; -// @public (undocumented) -export function linkWithPopup(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern?: externs.PopupRedirectResolver): Promise; +// @public +export function linkWithPopup(user: externs.User, provider: externs.AuthProvider, resolver?: externs.PopupRedirectResolver): Promise; -// @public (undocumented) -export function linkWithRedirect(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern?: externs.PopupRedirectResolver): Promise; +// @public +export function linkWithRedirect(user: externs.User, provider: externs.AuthProvider, resolver?: externs.PopupRedirectResolver): Promise; -// @public (undocumented) +// @public export function multiFactor(user: externs.User): externs.MultiFactorUser; // @public (undocumented) @@ -224,17 +403,17 @@ export class OAuthCredential extends AuthCredential implements externs.OAuthCred static fromJSON(json: string | object): OAuthCredential | null; // Warning: (ae-forgotten-export) The symbol "OAuthCredentialParams" needs to be exported by the entry point index.d.ts // - // (undocumented) + // @internal (undocumented) static _fromParams(params: OAuthCredentialParams): OAuthCredential; - // (undocumented) + // @internal (undocumented) _getIdTokenResponse(auth: Auth_2): Promise; - // (undocumented) + // @internal (undocumented) _getReauthenticationResolver(auth: Auth_2): Promise; // (undocumented) idToken?: string; - // (undocumented) + // @internal (undocumented) _linkToIdToken(auth: Auth_2, idToken: string): Promise; - // (undocumented) + // @internal (undocumented) nonce?: string; // (undocumented) secret?: string; @@ -242,37 +421,34 @@ export class OAuthCredential extends AuthCredential implements externs.OAuthCred toJSON(): object; } -// @public (undocumented) +// @public +export interface OAuthCredentialOptions { + accessToken?: string; + idToken?: string; + rawNonce?: string; +} + +// @public export class OAuthProvider implements externs.AuthProvider { constructor(providerId: string); - // (undocumented) addScope(scope: string): externs.AuthProvider; - // Warning: (ae-forgotten-export) The symbol "CredentialParameters" needs to be exported by the entry point index.d.ts - // - // (undocumented) - credential(params: CredentialParameters): externs.OAuthCredential; + credential(params: OAuthCredentialOptions): externs.OAuthCredential; // (undocumented) static credentialFromJSON(json: object | string): externs.OAuthCredential; - // (undocumented) + // @internal (undocumented) defaultLanguageCode: string | null; - // (undocumented) getCustomParameters(): CustomParameters; - // (undocumented) getScopes(): string[]; // (undocumented) readonly providerId: string; - // Warning: (ae-forgotten-export) The symbol "CustomParameters" needs to be exported by the entry point index.d.ts - // - // (undocumented) setCustomParameters(customOAuthParameters: CustomParameters): externs.AuthProvider; - // (undocumented) setDefaultLanguage(languageCode: string | null): void; } -// @public (undocumented) +// @public export function onAuthStateChanged(auth: externs.Auth, nextOrObserver: externs.NextOrObserver, error?: ErrorFn, completed?: CompleteFn): Unsubscribe; -// @public (undocumented) +// @public export function onIdTokenChanged(auth: externs.Auth, nextOrObserver: externs.NextOrObserver, error?: ErrorFn, completed?: CompleteFn): Unsubscribe; // @public (undocumented) @@ -282,19 +458,19 @@ export function parseActionCodeURL(link: string): externs.ActionCodeURL | null; export class PhoneAuthCredential extends AuthCredential implements externs.PhoneAuthCredential { // (undocumented) static fromJSON(json: object | string): PhoneAuthCredential | null; - // (undocumented) + // @internal (undocumented) static _fromTokenResponse(phoneNumber: string, temporaryProof: string): PhoneAuthCredential; - // (undocumented) + // @internal (undocumented) static _fromVerification(verificationId: string, verificationCode: string): PhoneAuthCredential; - // (undocumented) + // @internal (undocumented) _getIdTokenResponse(auth: Auth_2): Promise; - // (undocumented) + // @internal (undocumented) _getReauthenticationResolver(auth: Auth_2): Promise; - // (undocumented) + // @internal (undocumented) _linkToIdToken(auth: Auth_2, idToken: string): Promise; // Warning: (ae-forgotten-export) The symbol "SignInWithPhoneNumberRequest" needs to be exported by the entry point index.d.ts // - // (undocumented) + // @internal (undocumented) _makeVerificationRequest(): SignInWithPhoneNumberRequest; // (undocumented) toJSON(): object; @@ -323,17 +499,17 @@ export class PhoneMultiFactorGenerator implements externs.PhoneMultiFactorGenera static assertion(credential: externs.PhoneAuthCredential): externs.PhoneMultiFactorAssertion; } -// @public (undocumented) -export function reauthenticateWithCredential(userExtern: externs.User, credentialExtern: externs.AuthCredential): Promise; +// @public +export function reauthenticateWithCredential(user: externs.User, credential: externs.AuthCredential): Promise; -// @public (undocumented) -export function reauthenticateWithPhoneNumber(userExtern: externs.User, phoneNumber: string, appVerifier: externs.ApplicationVerifier): Promise; +// @public +export function reauthenticateWithPhoneNumber(user: externs.User, phoneNumber: string, appVerifier: externs.ApplicationVerifier): Promise; -// @public (undocumented) -export function reauthenticateWithPopup(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern?: externs.PopupRedirectResolver): Promise; +// @public +export function reauthenticateWithPopup(user: externs.User, provider: externs.AuthProvider, resolver?: externs.PopupRedirectResolver): Promise; -// @public (undocumented) -export function reauthenticateWithRedirect(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern?: externs.PopupRedirectResolver): Promise; +// @public +export function reauthenticateWithRedirect(user: externs.User, provider: externs.AuthProvider, resolver?: externs.PopupRedirectResolver): Promise; // Warning: (ae-forgotten-export) The symbol "ApplicationVerifier" needs to be exported by the entry point index.d.ts // @@ -345,11 +521,11 @@ export class RecaptchaVerifier implements externs.RecaptchaVerifier, Application clear(): void; // Warning: (ae-forgotten-export) The symbol "ReCaptchaLoader" needs to be exported by the entry point index.d.ts // - // (undocumented) + // @internal (undocumented) readonly _recaptchaLoader: ReCaptchaLoader; // (undocumented) render(): Promise; - // (undocumented) + // @internal (undocumented) _reset(): void; // (undocumented) readonly type = "recaptcha"; @@ -357,56 +533,53 @@ export class RecaptchaVerifier implements externs.RecaptchaVerifier, Application verify(): Promise; } -// @public (undocumented) -export function reload(externUser: externs.User): Promise; +// @public +export function reload(user: externs.User): Promise; -// @public (undocumented) -export function sendEmailVerification(userExtern: externs.User, actionCodeSettings?: externs.ActionCodeSettings | null): Promise; +// @public +export function sendEmailVerification(user: externs.User, actionCodeSettings?: externs.ActionCodeSettings | null): Promise; -// @public (undocumented) +// @public export function sendPasswordResetEmail(auth: externs.Auth, email: string, actionCodeSettings?: externs.ActionCodeSettings): Promise; -// @public (undocumented) +// @public export function sendSignInLinkToEmail(auth: externs.Auth, email: string, actionCodeSettings?: externs.ActionCodeSettings): Promise; -// @public (undocumented) +// @public export function setPersistence(auth: externs.Auth, persistence: externs.Persistence): void; -// @public (undocumented) +// @public export function signInAnonymously(auth: externs.Auth): Promise; -// @public (undocumented) +// @public export function signInWithCredential(auth: externs.Auth, credential: externs.AuthCredential): Promise; -// @public (undocumented) -export function signInWithCustomToken(authExtern: externs.Auth, customToken: string): Promise; +// @public +export function signInWithCustomToken(auth: externs.Auth, customToken: string): Promise; -// @public (undocumented) +// @public export function signInWithEmailAndPassword(auth: externs.Auth, email: string, password: string): Promise; -// @public (undocumented) +// @public export function signInWithEmailLink(auth: externs.Auth, email: string, emailLink?: string): Promise; -// @public (undocumented) +// @public export function signInWithPhoneNumber(auth: externs.Auth, phoneNumber: string, appVerifier: externs.ApplicationVerifier): Promise; -// @public (undocumented) -export function signInWithPopup(authExtern: externs.Auth, provider: externs.AuthProvider, resolverExtern?: externs.PopupRedirectResolver): Promise; +// @public +export function signInWithPopup(auth: externs.Auth, provider: externs.AuthProvider, resolver?: externs.PopupRedirectResolver): Promise; -// @public (undocumented) -export function signInWithRedirect(authExtern: externs.Auth, provider: externs.AuthProvider, resolverExtern?: externs.PopupRedirectResolver): Promise; +// @public +export function signInWithRedirect(auth: externs.Auth, provider: externs.AuthProvider, resolver?: externs.PopupRedirectResolver): Promise; -// @public (undocumented) +// @public export function signOut(auth: externs.Auth): Promise; -// @public (undocumented) +// @public export class TwitterAuthProvider extends OAuthProvider { constructor(); - // (undocumented) static credential(token: string, secret: string): externs.OAuthCredential; - // (undocumented) static credentialFromError(error: FirebaseError): externs.OAuthCredential | null; - // (undocumented) static credentialFromResult(userCredential: externs.UserCredential): externs.OAuthCredential | null; // (undocumented) static readonly PROVIDER_ID = externs.ProviderId.TWITTER; @@ -415,32 +588,32 @@ export class TwitterAuthProvider extends OAuthProvider { } // @public -export function unlink(userExtern: externs.User, providerId: externs.ProviderId): Promise; +export function unlink(user: externs.User, providerId: externs.ProviderId): Promise; -// @public (undocumented) +// @public export function updateCurrentUser(auth: externs.Auth, user: externs.User | null): Promise; -// @public (undocumented) -export function updateEmail(externUser: externs.User, newEmail: string): Promise; +// @public +export function updateEmail(user: externs.User, newEmail: string): Promise; -// @public (undocumented) -export function updatePassword(externUser: externs.User, newPassword: string): Promise; +// @public +export function updatePassword(user: externs.User, newPassword: string): Promise; -// @public (undocumented) +// @public export function updatePhoneNumber(user: externs.User, credential: externs.PhoneAuthCredential): Promise; // Warning: (ae-forgotten-export) The symbol "Profile" needs to be exported by the entry point index.d.ts // -// @public (undocumented) -export function updateProfile(externUser: externs.User, { displayName, photoURL: photoUrl }: Profile): Promise; +// @public +export function updateProfile(user: externs.User, { displayName, photoURL: photoUrl }: Profile): Promise; -// @public (undocumented) +// @public export function useDeviceLanguage(auth: externs.Auth): void; -// @public (undocumented) -export function verifyBeforeUpdateEmail(userExtern: externs.User, newEmail: string, actionCodeSettings?: externs.ActionCodeSettings | null): Promise; +// @public +export function verifyBeforeUpdateEmail(user: externs.User, newEmail: string, actionCodeSettings?: externs.ActionCodeSettings | null): Promise; -// @public (undocumented) +// @public export function verifyPasswordResetCode(auth: externs.Auth, code: string): Promise; diff --git a/common/api-review/auth-types-exp.api.md b/common/api-review/auth-types-exp.api.md index ea4cc5cbe18..922fb6fa9e5 100644 --- a/common/api-review/auth-types-exp.api.md +++ b/common/api-review/auth-types-exp.api.md @@ -97,7 +97,7 @@ export abstract class AuthCredential { toJSON(): object; } -// @public (undocumented) +// @public export interface AuthError extends FirebaseError { readonly appName: string; readonly email?: string; @@ -247,7 +247,10 @@ export interface Persistence { // @public export abstract class PhoneAuthCredential extends AuthCredential { + // (undocumented) static fromJSON(json: object | string): PhoneAuthCredential | null; + // (undocumented) + toJSON(): object; } // @public diff --git a/docs-exp/auth-types.actioncodeinfo.data.md b/docs-exp/auth-types.actioncodeinfo.data.md index 36b056bafbb..b95ba946739 100644 --- a/docs-exp/auth-types.actioncodeinfo.data.md +++ b/docs-exp/auth-types.actioncodeinfo.data.md @@ -4,13 +4,7 @@ ## ActionCodeInfo.data property -The data associated with the action code. For the [Operation.PASSWORD\_RESET](./auth-types.operation.password_reset.md), [Operation.VERIFY\_EMAIL](./auth-types.operation.verify_email.md), and [Operation.RECOVER\_EMAIL](./auth-types.operation.recover_email.md) actions, this object contains an email field with the address the email was sent to. - -For the [Operation.RECOVER\_EMAIL](./auth-types.operation.recover_email.md) action, which allows a user to undo an email address change, this object also contains a `previousEmail` field with the user account's current email address. After the action completes, the user's email address will revert to the value in the `email` field from the value in `previousEmail` field. - -For the [Operation.VERIFY\_AND\_CHANGE\_EMAIL](./auth-types.operation.verify_and_change_email.md) action, which allows a user to verify the email before updating it, this object contains a `previousEmail` field with the user account's email address before updating. After the action completes, the user's email address will be updated to the value in the `email` field from the value in `previousEmail` field. - -For the [Operation.REVERT\_SECOND\_FACTOR\_ADDITION](./auth-types.operation.revert_second_factor_addition.md) action, which allows a user to unenroll a newly added second factor, this object contains a `multiFactorInfo` field with the information about the second factor. For phone second factor, the `multiFactorInfo` is a [MultiFactorInfo](./auth-types.multifactorinfo.md) object, which contains the phone number. +The data associated with the action code. Signature: @@ -21,3 +15,14 @@ data: { previousEmail?: string | null; }; ``` + +## Remarks + +For the [Operation.PASSWORD\_RESET](./auth-types.operation.password_reset.md), [Operation.VERIFY\_EMAIL](./auth-types.operation.verify_email.md), and [Operation.RECOVER\_EMAIL](./auth-types.operation.recover_email.md) actions, this object contains an email field with the address the email was sent to. + +For the [Operation.RECOVER\_EMAIL](./auth-types.operation.recover_email.md) action, which allows a user to undo an email address change, this object also contains a `previousEmail` field with the user account's current email address. After the action completes, the user's email address will revert to the value in the `email` field from the value in `previousEmail` field. + +For the [Operation.VERIFY\_AND\_CHANGE\_EMAIL](./auth-types.operation.verify_and_change_email.md) action, which allows a user to verify the email before updating it, this object contains a `previousEmail` field with the user account's email address before updating. After the action completes, the user's email address will be updated to the value in the `email` field from the value in `previousEmail` field. + +For the [Operation.REVERT\_SECOND\_FACTOR\_ADDITION](./auth-types.operation.revert_second_factor_addition.md) action, which allows a user to unenroll a newly added second factor, this object contains a `multiFactorInfo` field with the information about the second factor. For phone second factor, the `multiFactorInfo` is a [MultiFactorInfo](./auth-types.multifactorinfo.md) object, which contains the phone number. + diff --git a/docs-exp/auth-types.actioncodeinfo.md b/docs-exp/auth-types.actioncodeinfo.md index 5fb1ee74f22..471ad707082 100644 --- a/docs-exp/auth-types.actioncodeinfo.md +++ b/docs-exp/auth-types.actioncodeinfo.md @@ -4,7 +4,7 @@ ## ActionCodeInfo interface -A response from `checkActionCode`. +A response from [checkActionCode()](./auth.checkactioncode.md). Signature: @@ -16,6 +16,6 @@ export interface ActionCodeInfo | Property | Type | Description | | --- | --- | --- | -| [data](./auth-types.actioncodeinfo.data.md) | { email?: string \| null; multiFactorInfo?: [MultiFactorInfo](./auth-types.multifactorinfo.md) \| null; previousEmail?: string \| null; } | The data associated with the action code. For the [Operation.PASSWORD\_RESET](./auth-types.operation.password_reset.md), [Operation.VERIFY\_EMAIL](./auth-types.operation.verify_email.md), and [Operation.RECOVER\_EMAIL](./auth-types.operation.recover_email.md) actions, this object contains an email field with the address the email was sent to.For the [Operation.RECOVER\_EMAIL](./auth-types.operation.recover_email.md) action, which allows a user to undo an email address change, this object also contains a previousEmail field with the user account's current email address. After the action completes, the user's email address will revert to the value in the email field from the value in previousEmail field.For the [Operation.VERIFY\_AND\_CHANGE\_EMAIL](./auth-types.operation.verify_and_change_email.md) action, which allows a user to verify the email before updating it, this object contains a previousEmail field with the user account's email address before updating. After the action completes, the user's email address will be updated to the value in the email field from the value in previousEmail field.For the [Operation.REVERT\_SECOND\_FACTOR\_ADDITION](./auth-types.operation.revert_second_factor_addition.md) action, which allows a user to unenroll a newly added second factor, this object contains a multiFactorInfo field with the information about the second factor. For phone second factor, the multiFactorInfo is a [MultiFactorInfo](./auth-types.multifactorinfo.md) object, which contains the phone number. | +| [data](./auth-types.actioncodeinfo.data.md) | { email?: string \| null; multiFactorInfo?: [MultiFactorInfo](./auth-types.multifactorinfo.md) \| null; previousEmail?: string \| null; } | The data associated with the action code. | | [operation](./auth-types.actioncodeinfo.operation.md) | [Operation](./auth-types.operation.md) | The type of operation that generated the action code. | diff --git a/docs-exp/auth-types.actioncodesettings.android.md b/docs-exp/auth-types.actioncodesettings.android.md index e275039ca3b..8333a391afa 100644 --- a/docs-exp/auth-types.actioncodesettings.android.md +++ b/docs-exp/auth-types.actioncodesettings.android.md @@ -4,7 +4,7 @@ ## ActionCodeSettings.android property -Sets the Android package name. This will try to open the link in an android app if it is installed. If `installApp` is passed, it specifies whether to install the Android app if the device supports it and the app is not already installed. If this field is provided without a `packageName`, an error is thrown explaining that the `packageName` must be provided in conjunction with this field. If `minimumVersion` is specified, and an older version of the app is installed, the user is taken to the Play Store to upgrade the app. +Sets the Android package name. Signature: @@ -15,3 +15,8 @@ android?: { packageName: string; }; ``` + +## Remarks + +This will try to open the link in an android app if it is installed. If `installApp` is passed, it specifies whether to install the Android app if the device supports it and the app is not already installed. If this field is provided without a `packageName`, an error is thrown explaining that the `packageName` must be provided in conjunction with this field. If `minimumVersion` is specified, and an older version of the app is installed, the user is taken to the Play Store to upgrade the app. + diff --git a/docs-exp/auth-types.actioncodesettings.dynamiclinkdomain.md b/docs-exp/auth-types.actioncodesettings.dynamiclinkdomain.md index 31a23fdd59e..bd8f3b53da1 100644 --- a/docs-exp/auth-types.actioncodesettings.dynamiclinkdomain.md +++ b/docs-exp/auth-types.actioncodesettings.dynamiclinkdomain.md @@ -4,7 +4,7 @@ ## ActionCodeSettings.dynamicLinkDomain property -When multiple custom dynamic link domains are defined for a project, specify which one to use when the link is to be opened via a specified mobile app (for example, `example.page.link`). Otherwise the first domain is automatically selected. +When multiple custom dynamic link domains are defined for a project, specify which one to use when the link is to be opened via a specified mobile app (for example, `example.page.link`). Signature: diff --git a/docs-exp/auth-types.actioncodesettings.handlecodeinapp.md b/docs-exp/auth-types.actioncodesettings.handlecodeinapp.md index b4b6277429e..436140614d0 100644 --- a/docs-exp/auth-types.actioncodesettings.handlecodeinapp.md +++ b/docs-exp/auth-types.actioncodesettings.handlecodeinapp.md @@ -4,10 +4,15 @@ ## ActionCodeSettings.handleCodeInApp property -The default is false. When set to true, the action code link will be be sent as a Universal Link or Android App Link and will be opened by the app if installed. In the false case, the code will be sent to the web widget first and then on continue will redirect to the app if installed. +When set to true, the action code link will be be sent as a Universal Link or Android App Link and will be opened by the app if installed. Signature: ```typescript handleCodeInApp?: boolean; ``` + +## Remarks + +In the false case, the code will be sent to the web widget first and then on continue will redirect to the app if installed. + diff --git a/docs-exp/auth-types.actioncodesettings.ios.md b/docs-exp/auth-types.actioncodesettings.ios.md index e5ab5a0da60..3bd06cdedd9 100644 --- a/docs-exp/auth-types.actioncodesettings.ios.md +++ b/docs-exp/auth-types.actioncodesettings.ios.md @@ -4,9 +4,7 @@ ## ActionCodeSettings.iOS property -Sets the iOS bundle ID. This will try to open the link in an iOS app if it is installed. - -App installation is not supported for iOS. +Sets the iOS bundle ID. Signature: @@ -15,3 +13,10 @@ iOS?: { bundleId: string; }; ``` + +## Remarks + +This will try to open the link in an iOS app if it is installed. + +App installation is not supported for iOS. + diff --git a/docs-exp/auth-types.actioncodesettings.md b/docs-exp/auth-types.actioncodesettings.md index 4677ad18086..4df4d05eec8 100644 --- a/docs-exp/auth-types.actioncodesettings.md +++ b/docs-exp/auth-types.actioncodesettings.md @@ -4,7 +4,7 @@ ## ActionCodeSettings interface -This is the interface that defines the required continue/state URL with optional Android and iOS bundle identifiers. +An interface that defines the required continue/state URL with optional Android and iOS bundle identifiers. Signature: @@ -16,9 +16,9 @@ export interface ActionCodeSettings | Property | Type | Description | | --- | --- | --- | -| [android](./auth-types.actioncodesettings.android.md) | { installApp?: boolean; minimumVersion?: string; packageName: string; } | Sets the Android package name. This will try to open the link in an android app if it is installed. If installApp is passed, it specifies whether to install the Android app if the device supports it and the app is not already installed. If this field is provided without a packageName, an error is thrown explaining that the packageName must be provided in conjunction with this field. If minimumVersion is specified, and an older version of the app is installed, the user is taken to the Play Store to upgrade the app. | -| [dynamicLinkDomain](./auth-types.actioncodesettings.dynamiclinkdomain.md) | string | When multiple custom dynamic link domains are defined for a project, specify which one to use when the link is to be opened via a specified mobile app (for example, example.page.link). Otherwise the first domain is automatically selected. | -| [handleCodeInApp](./auth-types.actioncodesettings.handlecodeinapp.md) | boolean | The default is false. When set to true, the action code link will be be sent as a Universal Link or Android App Link and will be opened by the app if installed. In the false case, the code will be sent to the web widget first and then on continue will redirect to the app if installed. | -| [iOS](./auth-types.actioncodesettings.ios.md) | { bundleId: string; } | Sets the iOS bundle ID. This will try to open the link in an iOS app if it is installed.App installation is not supported for iOS. | -| [url](./auth-types.actioncodesettings.url.md) | string | Sets the link continue/state URL, which has different meanings in different contexts: - When the link is handled in the web action widgets, this is the deep link in the continueUrl query parameter. - When the link is handled in the app directly, this is the continueUrl query parameter in the deep link of the Dynamic Link. | +| [android](./auth-types.actioncodesettings.android.md) | { installApp?: boolean; minimumVersion?: string; packageName: string; } | Sets the Android package name. | +| [dynamicLinkDomain](./auth-types.actioncodesettings.dynamiclinkdomain.md) | string | When multiple custom dynamic link domains are defined for a project, specify which one to use when the link is to be opened via a specified mobile app (for example, example.page.link). | +| [handleCodeInApp](./auth-types.actioncodesettings.handlecodeinapp.md) | boolean | When set to true, the action code link will be be sent as a Universal Link or Android App Link and will be opened by the app if installed. | +| [iOS](./auth-types.actioncodesettings.ios.md) | { bundleId: string; } | Sets the iOS bundle ID. | +| [url](./auth-types.actioncodesettings.url.md) | string | Sets the link continue/state URL. | diff --git a/docs-exp/auth-types.actioncodesettings.url.md b/docs-exp/auth-types.actioncodesettings.url.md index 8de2c2860d6..3a0f2a88967 100644 --- a/docs-exp/auth-types.actioncodesettings.url.md +++ b/docs-exp/auth-types.actioncodesettings.url.md @@ -4,10 +4,15 @@ ## ActionCodeSettings.url property -Sets the link continue/state URL, which has different meanings in different contexts: - When the link is handled in the web action widgets, this is the deep link in the `continueUrl` query parameter. - When the link is handled in the app directly, this is the `continueUrl` query parameter in the deep link of the Dynamic Link. +Sets the link continue/state URL. Signature: ```typescript url: string; ``` + +## Remarks + +This has different meanings in different contexts: - When the link is handled in the web action widgets, this is the deep link in the `continueUrl` query parameter. - When the link is handled in the app directly, this is the `continueUrl` query parameter in the deep link of the Dynamic Link. + diff --git a/docs-exp/auth-types.actioncodeurl.md b/docs-exp/auth-types.actioncodeurl.md index f3de723cf1c..d29f27b0cb7 100644 --- a/docs-exp/auth-types.actioncodeurl.md +++ b/docs-exp/auth-types.actioncodeurl.md @@ -27,5 +27,5 @@ export abstract class ActionCodeURL | Method | Modifiers | Description | | --- | --- | --- | -| [parseLink(link)](./auth-types.actioncodeurl.parselink.md) | static | Parses the email action link string and returns an ActionCodeURL object if the link is valid, otherwise returns null. | +| [parseLink(link)](./auth-types.actioncodeurl.parselink.md) | static | Parses the email action link string and returns an [ActionCodeURL](./auth-types.actioncodeurl.md) if the link is valid, otherwise returns null. | diff --git a/docs-exp/auth-types.actioncodeurl.parselink.md b/docs-exp/auth-types.actioncodeurl.parselink.md index 05d933b4ef5..d6045fb551a 100644 --- a/docs-exp/auth-types.actioncodeurl.parselink.md +++ b/docs-exp/auth-types.actioncodeurl.parselink.md @@ -4,7 +4,7 @@ ## ActionCodeURL.parseLink() method -Parses the email action link string and returns an ActionCodeURL object if the link is valid, otherwise returns null. +Parses the email action link string and returns an [ActionCodeURL](./auth-types.actioncodeurl.md) if the link is valid, otherwise returns null. Signature: diff --git a/docs-exp/auth-types.applicationverifier.md b/docs-exp/auth-types.applicationverifier.md index 74f9b3dc2f3..c2230069796 100644 --- a/docs-exp/auth-types.applicationverifier.md +++ b/docs-exp/auth-types.applicationverifier.md @@ -4,7 +4,7 @@ ## ApplicationVerifier interface -A verifier for domain verification and abuse prevention. Currently, the only implementation is [RecaptchaVerifier](./auth-types.recaptchaverifier.md). +A verifier for domain verification and abuse prevention. Signature: @@ -12,6 +12,10 @@ A verifier for domain verification and abuse prevention. Currently, the only imp export interface ApplicationVerifier ``` +## Remarks + +Currently, the only implementation is [RecaptchaVerifier](./auth.recaptchaverifier.md). + ## Properties | Property | Type | Description | diff --git a/docs-exp/auth-types.auth.languagecode.md b/docs-exp/auth-types.auth.languagecode.md index 43d7d1c93d2..7923dce8990 100644 --- a/docs-exp/auth-types.auth.languagecode.md +++ b/docs-exp/auth-types.auth.languagecode.md @@ -4,10 +4,15 @@ ## Auth.languageCode property -The Auth instance's language code. This is a readable/writable property. When set to null, the default Firebase Console language setting is applied. The language code will propagate to email action templates (password reset, email verification and email change revocation), SMS templates for phone authentication, reCAPTCHA verifier and OAuth popup/redirect operations provided the specified providers support localization with the language code specified. +The Auth instance's language code. Signature: ```typescript languageCode: string | null; ``` + +## Remarks + +This is a readable/writable property. When set to null, the default Firebase Console language setting is applied. The language code will propagate to email action templates (password reset, email verification and email change revocation), SMS templates for phone authentication, reCAPTCHA verifier and OAuth popup/redirect operations provided the specified providers support localization with the language code specified. + diff --git a/docs-exp/auth-types.auth.md b/docs-exp/auth-types.auth.md index 6e4319c0b7b..32e19efe562 100644 --- a/docs-exp/auth-types.auth.md +++ b/docs-exp/auth-types.auth.md @@ -4,9 +4,7 @@ ## Auth interface -The Firebase Auth service interface. - -See [Firebase Authentication](https://firebase.google.com/docs/auth/) for a full guide on how to use the Firebase Auth service. +Interface representing Firebase Auth service. Signature: @@ -14,26 +12,30 @@ See [Firebase Authentication](https://firebase.google.com/docs/auth/) for a full export interface Auth ``` +## Remarks + +See [Firebase Authentication](https://firebase.google.com/docs/auth/) for a full guide on how to use the Firebase Auth service. + ## Properties | Property | Type | Description | | --- | --- | --- | | [config](./auth-types.auth.config.md) | [Config](./auth-types.config.md) | The [Config](./auth-types.config.md) used to initialize this instance. | | [currentUser](./auth-types.auth.currentuser.md) | [User](./auth-types.user.md) \| null | The currently signed-in user (or null). | -| [languageCode](./auth-types.auth.languagecode.md) | string \| null | The Auth instance's language code. This is a readable/writable property. When set to null, the default Firebase Console language setting is applied. The language code will propagate to email action templates (password reset, email verification and email change revocation), SMS templates for phone authentication, reCAPTCHA verifier and OAuth popup/redirect operations provided the specified providers support localization with the language code specified. | +| [languageCode](./auth-types.auth.languagecode.md) | string \| null | The Auth instance's language code. | | [name](./auth-types.auth.name.md) | string | The name of the app associated with the Auth service instance. | -| [settings](./auth-types.auth.settings.md) | [AuthSettings](./auth-types.authsettings.md) | The Auth instance's settings. This is used to edit/read configuration related options like app verification mode for phone authentication. | -| [tenantId](./auth-types.auth.tenantid.md) | string \| null | The Auth instance's tenant ID. This is a readable/writable property. When you set the tenant ID of an Auth instance, all future sign-in/sign-up operations will pass this tenant ID and sign in or sign up users to the specified tenant project. When set to null, users are signed in to the parent project. By default, this is set to null. | +| [settings](./auth-types.auth.settings.md) | [AuthSettings](./auth-types.authsettings.md) | The Auth instance's settings. | +| [tenantId](./auth-types.auth.tenantid.md) | string \| null | The Auth instance's tenant ID. | ## Methods | Method | Description | | --- | --- | -| [onAuthStateChanged(nextOrObserver, error, completed)](./auth-types.auth.onauthstatechanged.md) | Adds an observer for changes to the user's sign-in state.To keep the old behavior, see [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md). | -| [onIdTokenChanged(nextOrObserver, error, completed)](./auth-types.auth.onidtokenchanged.md) | Adds an observer for changes to the signed-in user's ID token, which includes sign-in, sign-out, and token refresh events. | -| [setPersistence(persistence)](./auth-types.auth.setpersistence.md) | Changes the type of persistence on the Auth instance for the currently saved Auth session and applies this type of persistence for future sign-in requests, including sign-in with redirect requests.This makes it easy for a user signing in to specify whether their session should be remembered or not. It also makes it easier to never persist the Auth state for applications that are shared by other users or have sensitive data. | +| [onAuthStateChanged(nextOrObserver, error, completed)](./auth-types.auth.onauthstatechanged.md) | Adds an observer for changes to the user's sign-in state. | +| [onIdTokenChanged(nextOrObserver, error, completed)](./auth-types.auth.onidtokenchanged.md) | Adds an observer for changes to the signed-in user's ID token. | +| [setPersistence(persistence)](./auth-types.auth.setpersistence.md) | Changes the type of persistence on the Auth instance. | | [signOut()](./auth-types.auth.signout.md) | Signs out the current user. | -| [updateCurrentUser(user)](./auth-types.auth.updatecurrentuser.md) | Asynchronously sets the provided user as currentUser on the Auth instance. A new instance copy of the user provided will be made and set as currentUser.This will trigger [Auth.onAuthStateChanged()](./auth-types.auth.onauthstatechanged.md) and [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md) listeners like other sign in methods.The operation fails with an error if the user to be updated belongs to a different Firebase project. | +| [updateCurrentUser(user)](./auth-types.auth.updatecurrentuser.md) | Asynchronously sets the provided user as [Auth.currentUser](./auth-types.auth.currentuser.md) on the [Auth](./auth-types.auth.md) instance. | | [useDeviceLanguage()](./auth-types.auth.usedevicelanguage.md) | Sets the current language to the default device/browser preference. | -| [useEmulator(url)](./auth-types.auth.useemulator.md) | Modify this Auth instance to communicate with the Firebase Auth emulator. This must be called synchronously immediately following the first call to initializeAuth(). Do not use with production credentials as emulator traffic is not encrypted. | +| [useEmulator(url)](./auth-types.auth.useemulator.md) | Modify this Auth instance to communicate with the Firebase Auth emulator. | diff --git a/docs-exp/auth-types.auth.onauthstatechanged.md b/docs-exp/auth-types.auth.onauthstatechanged.md index 0f4292b70b4..db373319213 100644 --- a/docs-exp/auth-types.auth.onauthstatechanged.md +++ b/docs-exp/auth-types.auth.onauthstatechanged.md @@ -6,8 +6,6 @@ Adds an observer for changes to the user's sign-in state. -To keep the old behavior, see [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md). - Signature: ```typescript @@ -30,3 +28,7 @@ onAuthStateChanged( Unsubscribe +## Remarks + +To keep the old behavior, see [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md). + diff --git a/docs-exp/auth-types.auth.onidtokenchanged.md b/docs-exp/auth-types.auth.onidtokenchanged.md index 0857e19cc2a..da3f8bb65a0 100644 --- a/docs-exp/auth-types.auth.onidtokenchanged.md +++ b/docs-exp/auth-types.auth.onidtokenchanged.md @@ -4,7 +4,7 @@ ## Auth.onIdTokenChanged() method -Adds an observer for changes to the signed-in user's ID token, which includes sign-in, sign-out, and token refresh events. +Adds an observer for changes to the signed-in user's ID token. Signature: @@ -28,3 +28,7 @@ onIdTokenChanged( Unsubscribe +## Remarks + +This includes sign-in, sign-out, and token refresh events. + diff --git a/docs-exp/auth-types.auth.setpersistence.md b/docs-exp/auth-types.auth.setpersistence.md index 3e1eeac3cba..ab2590aa405 100644 --- a/docs-exp/auth-types.auth.setpersistence.md +++ b/docs-exp/auth-types.auth.setpersistence.md @@ -4,9 +4,7 @@ ## Auth.setPersistence() method -Changes the type of persistence on the Auth instance for the currently saved Auth session and applies this type of persistence for future sign-in requests, including sign-in with redirect requests. - -This makes it easy for a user signing in to specify whether their session should be remembered or not. It also makes it easier to never persist the Auth state for applications that are shared by other users or have sensitive data. +Changes the type of persistence on the Auth instance. Signature: @@ -24,6 +22,12 @@ setPersistence(persistence: Persistence): void; void +## Remarks + +This will affect the currently saved Auth session and applies this type of persistence for future sign-in requests, including sign-in with redirect requests. + +This makes it easy for a user signing in to specify whether their session should be remembered or not. It also makes it easier to never persist the Auth state for applications that are shared by other users or have sensitive data. + ## Example diff --git a/docs-exp/auth-types.auth.settings.md b/docs-exp/auth-types.auth.settings.md index 37a2d8b25ed..d415766a68d 100644 --- a/docs-exp/auth-types.auth.settings.md +++ b/docs-exp/auth-types.auth.settings.md @@ -4,10 +4,15 @@ ## Auth.settings property -The Auth instance's settings. This is used to edit/read configuration related options like app verification mode for phone authentication. +The Auth instance's settings. Signature: ```typescript readonly settings: AuthSettings; ``` + +## Remarks + +This is used to edit/read configuration related options such as app verification mode for phone authentication. + diff --git a/docs-exp/auth-types.auth.tenantid.md b/docs-exp/auth-types.auth.tenantid.md index 1f57720fe45..72c437f373b 100644 --- a/docs-exp/auth-types.auth.tenantid.md +++ b/docs-exp/auth-types.auth.tenantid.md @@ -4,7 +4,7 @@ ## Auth.tenantId property -The Auth instance's tenant ID. This is a readable/writable property. When you set the tenant ID of an Auth instance, all future sign-in/sign-up operations will pass this tenant ID and sign in or sign up users to the specified tenant project. When set to null, users are signed in to the parent project. By default, this is set to null. +The Auth instance's tenant ID. Signature: @@ -12,6 +12,10 @@ The Auth instance's tenant ID. This is a readable/writable property. When you se tenantId: string | null; ``` +## Remarks + +This is a readable/writable property. When you set the tenant ID of an Auth instance, all future sign-in/sign-up operations will pass this tenant ID and sign in or sign up users to the specified tenant project. When set to null, users are signed in to the parent project. + ## Example diff --git a/docs-exp/auth-types.auth.updatecurrentuser.md b/docs-exp/auth-types.auth.updatecurrentuser.md index 545e2fd1122..23dd544fcd1 100644 --- a/docs-exp/auth-types.auth.updatecurrentuser.md +++ b/docs-exp/auth-types.auth.updatecurrentuser.md @@ -4,11 +4,7 @@ ## Auth.updateCurrentUser() method -Asynchronously sets the provided user as `currentUser` on the Auth instance. A new instance copy of the user provided will be made and set as currentUser. - -This will trigger [Auth.onAuthStateChanged()](./auth-types.auth.onauthstatechanged.md) and [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md) listeners like other sign in methods. - -The operation fails with an error if the user to be updated belongs to a different Firebase project. +Asynchronously sets the provided user as [Auth.currentUser](./auth-types.auth.currentuser.md) on the [Auth](./auth-types.auth.md) instance. Signature: @@ -26,3 +22,11 @@ updateCurrentUser(user: User | null): Promise; Promise<void> +## Remarks + +A new instance copy of the user provided will be made and set as currentUser. + +This will trigger [Auth.onAuthStateChanged()](./auth-types.auth.onauthstatechanged.md) and [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md) listeners like other sign in methods. + +The operation fails with an error if the user to be updated belongs to a different Firebase project. + diff --git a/docs-exp/auth-types.auth.useemulator.md b/docs-exp/auth-types.auth.useemulator.md index 5d741617811..372f4c44248 100644 --- a/docs-exp/auth-types.auth.useemulator.md +++ b/docs-exp/auth-types.auth.useemulator.md @@ -4,7 +4,7 @@ ## Auth.useEmulator() method -Modify this Auth instance to communicate with the Firebase Auth emulator. This must be called synchronously immediately following the first call to `initializeAuth()`. Do not use with production credentials as emulator traffic is not encrypted. +Modify this Auth instance to communicate with the Firebase Auth emulator. Signature: @@ -22,3 +22,7 @@ useEmulator(url: string): void; void +## Remarks + +This must be called synchronously immediately following the first call to [initializeAuth()](./auth.initializeauth.md). Do not use with production credentials as emulator traffic is not encrypted. + diff --git a/docs-exp/auth-types.authcredential.md b/docs-exp/auth-types.authcredential.md index cc05c945cae..ae411daaa69 100644 --- a/docs-exp/auth-types.authcredential.md +++ b/docs-exp/auth-types.authcredential.md @@ -4,7 +4,7 @@ ## AuthCredential class -Interface that represents the credentials returned by an auth provider. Implementations specify the details about each auth provider's credential requirements. +Interface that represents the credentials returned by an [AuthProvider](./auth-types.authprovider.md). Signature: @@ -12,12 +12,16 @@ Interface that represents the credentials returned by an auth provider. Implemen export abstract class AuthCredential ``` +## Remarks + +Implementations specify the details about each auth provider's credential requirements. + ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [providerId](./auth-types.authcredential.providerid.md) | | string | The authentication provider ID for the credential. For example, 'facebook.com', or 'google.com'. | -| [signInMethod](./auth-types.authcredential.signinmethod.md) | | string | The authentication sign in method for the credential. For example, [SignInMethod.EMAIL\_PASSWORD](./auth-types.signinmethod.email_password.md), or [SignInMethod.EMAIL\_LINK](./auth-types.signinmethod.email_link.md). This corresponds to the sign-in method identifier as returned in fetchSignInMethodsForEmail. | +| [providerId](./auth-types.authcredential.providerid.md) | | string | The authentication provider ID for the credential. | +| [signInMethod](./auth-types.authcredential.signinmethod.md) | | string | The authentication sign in method for the credential. | ## Methods diff --git a/docs-exp/auth-types.authcredential.providerid.md b/docs-exp/auth-types.authcredential.providerid.md index ae332c4bf0a..23fe69a5131 100644 --- a/docs-exp/auth-types.authcredential.providerid.md +++ b/docs-exp/auth-types.authcredential.providerid.md @@ -4,10 +4,15 @@ ## AuthCredential.providerId property -The authentication provider ID for the credential. For example, 'facebook.com', or 'google.com'. +The authentication provider ID for the credential. Signature: ```typescript readonly providerId: string; ``` + +## Remarks + +For example, 'facebook.com', or 'google.com'. + diff --git a/docs-exp/auth-types.authcredential.signinmethod.md b/docs-exp/auth-types.authcredential.signinmethod.md index 9f33f338e34..ed2cc5d7ab5 100644 --- a/docs-exp/auth-types.authcredential.signinmethod.md +++ b/docs-exp/auth-types.authcredential.signinmethod.md @@ -4,10 +4,15 @@ ## AuthCredential.signInMethod property -The authentication sign in method for the credential. For example, [SignInMethod.EMAIL\_PASSWORD](./auth-types.signinmethod.email_password.md), or [SignInMethod.EMAIL\_LINK](./auth-types.signinmethod.email_link.md). This corresponds to the sign-in method identifier as returned in `fetchSignInMethodsForEmail`. +The authentication sign in method for the credential. Signature: ```typescript readonly signInMethod: string; ``` + +## Remarks + +For example, [SignInMethod.EMAIL\_PASSWORD](./auth-types.signinmethod.email_password.md), or [SignInMethod.EMAIL\_LINK](./auth-types.signinmethod.email_link.md). This corresponds to the sign-in method identifier as returned in [fetchSignInMethodsForEmail()](./auth.fetchsigninmethodsforemail.md). + diff --git a/docs-exp/auth-types.autherror.md b/docs-exp/auth-types.autherror.md index 049734bd44b..18ac24db8c4 100644 --- a/docs-exp/auth-types.autherror.md +++ b/docs-exp/auth-types.autherror.md @@ -4,6 +4,7 @@ ## AuthError interface +Interface for an Auth error. Signature: @@ -19,5 +20,5 @@ export interface AuthError extends FirebaseError | [appName](./auth-types.autherror.appname.md) | string | The name of the Firebase App which triggered this error. | | [email](./auth-types.autherror.email.md) | string | The email of the user's account, used for sign-in/linking. | | [phoneNumber](./auth-types.autherror.phonenumber.md) | string | The phone number of the user's account, used for sign-in/linking. | -| [tenantid](./auth-types.autherror.tenantid.md) | string | The tenant ID being used for sign-in/linking. If you use signInWithRedirect to sign in, you have to set the tenant ID on [Auth](./auth-types.auth.md) instance again as the tenant ID is not persisted after redirection. | +| [tenantid](./auth-types.autherror.tenantid.md) | string | The tenant ID being used for sign-in/linking. | diff --git a/docs-exp/auth-types.autherror.tenantid.md b/docs-exp/auth-types.autherror.tenantid.md index 1ac2110482d..ac6e1735a45 100644 --- a/docs-exp/auth-types.autherror.tenantid.md +++ b/docs-exp/auth-types.autherror.tenantid.md @@ -4,10 +4,15 @@ ## AuthError.tenantid property -The tenant ID being used for sign-in/linking. If you use `signInWithRedirect` to sign in, you have to set the tenant ID on [Auth](./auth-types.auth.md) instance again as the tenant ID is not persisted after redirection. +The tenant ID being used for sign-in/linking. Signature: ```typescript readonly tenantid?: string; ``` + +## Remarks + +If you use [signInWithRedirect()](./auth.signinwithredirect.md) to sign in, you have to set the tenant ID on [Auth](./auth-types.auth.md) instance again as the tenant ID is not persisted after redirection. + diff --git a/docs-exp/auth-types.authsettings.md b/docs-exp/auth-types.authsettings.md index 83d2efde315..7148b137ba7 100644 --- a/docs-exp/auth-types.authsettings.md +++ b/docs-exp/auth-types.authsettings.md @@ -4,7 +4,7 @@ ## AuthSettings interface -Interface representing an Auth instance's settings, currently used for enabling/disabling app verification for phone Auth testing. +Interface representing an Auth instance's settings. Signature: @@ -12,6 +12,10 @@ Interface representing an Auth instance's settings, currently used for enabling/ export interface AuthSettings ``` +## Remarks + +Currently used for enabling/disabling app verification for phone Auth testing. + ## Properties | Property | Type | Description | diff --git a/docs-exp/auth-types.config.md b/docs-exp/auth-types.config.md index a2d855b17e2..451c8833fc2 100644 --- a/docs-exp/auth-types.config.md +++ b/docs-exp/auth-types.config.md @@ -4,7 +4,7 @@ ## Config interface -Auth config object. +Interface representing the Auth config. Signature: diff --git a/docs-exp/auth-types.confirmationresult.md b/docs-exp/auth-types.confirmationresult.md index b97ca4bca8a..276423f8e0b 100644 --- a/docs-exp/auth-types.confirmationresult.md +++ b/docs-exp/auth-types.confirmationresult.md @@ -16,7 +16,7 @@ export interface ConfirmationResult | Property | Type | Description | | --- | --- | --- | -| [verificationId](./auth-types.confirmationresult.verificationid.md) | string | The phone number authentication operation's verification ID. This can be used along with the verification code to initialize a phone auth credential. | +| [verificationId](./auth-types.confirmationresult.verificationid.md) | string | The phone number authentication operation's verification ID. | ## Methods diff --git a/docs-exp/auth-types.confirmationresult.verificationid.md b/docs-exp/auth-types.confirmationresult.verificationid.md index 11e8ff1f103..e7f239dca8a 100644 --- a/docs-exp/auth-types.confirmationresult.verificationid.md +++ b/docs-exp/auth-types.confirmationresult.verificationid.md @@ -4,10 +4,15 @@ ## ConfirmationResult.verificationId property -The phone number authentication operation's verification ID. This can be used along with the verification code to initialize a phone auth credential. +The phone number authentication operation's verification ID. Signature: ```typescript readonly verificationId: string; ``` + +## Remarks + +This can be used along with the verification code to initialize a [PhoneAuthCredential](./auth-types.phoneauthcredential.md). + diff --git a/docs-exp/auth-types.emailauthprovider.md b/docs-exp/auth-types.emailauthprovider.md index a57424f1da8..0aed67f1788 100644 --- a/docs-exp/auth-types.emailauthprovider.md +++ b/docs-exp/auth-types.emailauthprovider.md @@ -4,7 +4,7 @@ ## EmailAuthProvider class -Email and password auth provider implementation. +Provider for generating [EmailAuthCredential](./auth.emailauthcredential.md). Signature: diff --git a/docs-exp/auth-types.idtokenresult.authtime.md b/docs-exp/auth-types.idtokenresult.authtime.md index 7b9312e6355..075aa39fb38 100644 --- a/docs-exp/auth-types.idtokenresult.authtime.md +++ b/docs-exp/auth-types.idtokenresult.authtime.md @@ -4,10 +4,15 @@ ## IdTokenResult.authTime property -The authentication time formatted as a UTC string. This is the time the user authenticated (signed in) and not the time the token was refreshed. +The authentication time formatted as a UTC string. Signature: ```typescript authTime: string; ``` + +## Remarks + +This is the time the user authenticated (signed in) and not the time the token was refreshed. + diff --git a/docs-exp/auth-types.idtokenresult.md b/docs-exp/auth-types.idtokenresult.md index de7393ba273..1ac016498ca 100644 --- a/docs-exp/auth-types.idtokenresult.md +++ b/docs-exp/auth-types.idtokenresult.md @@ -4,9 +4,7 @@ ## IdTokenResult interface -Interface representing ID token result obtained from `getIdTokenResult`. It contains the ID token JWT string and other helper properties for getting different data associated with the token as well as all the decoded payload claims. - -Note that these claims are not to be trusted as they are parsed client side. Only server side verification can guarantee the integrity of the token claims. +Interface representing ID token result obtained from [User.getIdTokenResult()](./auth-types.user.getidtokenresult.md). Signature: @@ -14,15 +12,21 @@ Note that these claims are not to be trusted as they are parsed client side. Onl export interface IdTokenResult ``` +## Remarks + +It contains the ID token JWT string and other helper properties for getting different data associated with the token as well as all the decoded payload claims. + +Note that these claims are not to be trusted as they are parsed client side. Only server side verification can guarantee the integrity of the token claims. + ## Properties | Property | Type | Description | | --- | --- | --- | -| [authTime](./auth-types.idtokenresult.authtime.md) | string | The authentication time formatted as a UTC string. This is the time the user authenticated (signed in) and not the time the token was refreshed. | +| [authTime](./auth-types.idtokenresult.authtime.md) | string | The authentication time formatted as a UTC string. | | [claims](./auth-types.idtokenresult.claims.md) | [ParsedToken](./auth-types.parsedtoken.md) | The entire payload claims of the ID token including the standard reserved claims as well as the custom claims. | | [expirationTime](./auth-types.idtokenresult.expirationtime.md) | string | The ID token expiration time formatted as a UTC string. | | [issuedAtTime](./auth-types.idtokenresult.issuedattime.md) | string | The ID token issuance time formatted as a UTC string. | -| [signInProvider](./auth-types.idtokenresult.signinprovider.md) | string \| null | The sign-in provider through which the ID token was obtained (anonymous, custom, phone, password, etc). Note, this does not map to provider IDs. | +| [signInProvider](./auth-types.idtokenresult.signinprovider.md) | string \| null | The sign-in provider through which the ID token was obtained (anonymous, custom, phone, password, etc). | | [signInSecondFactor](./auth-types.idtokenresult.signinsecondfactor.md) | string \| null | The type of second factor associated with this session, provided the user was multi-factor authenticated (eg. phone, etc). | | [token](./auth-types.idtokenresult.token.md) | string | The Firebase Auth ID token JWT string. | diff --git a/docs-exp/auth-types.idtokenresult.signinprovider.md b/docs-exp/auth-types.idtokenresult.signinprovider.md index f2457987cdc..09943105169 100644 --- a/docs-exp/auth-types.idtokenresult.signinprovider.md +++ b/docs-exp/auth-types.idtokenresult.signinprovider.md @@ -4,10 +4,15 @@ ## IdTokenResult.signInProvider property -The sign-in provider through which the ID token was obtained (anonymous, custom, phone, password, etc). Note, this does not map to provider IDs. +The sign-in provider through which the ID token was obtained (anonymous, custom, phone, password, etc). Signature: ```typescript signInProvider: string | null; ``` + +## Remarks + +Note, this does not map to provider IDs. + diff --git a/docs-exp/auth-types.md b/docs-exp/auth-types.md index d7deb0718f1..86c555f19c9 100644 --- a/docs-exp/auth-types.md +++ b/docs-exp/auth-types.md @@ -9,13 +9,13 @@ | Class | Description | | --- | --- | | [ActionCodeURL](./auth-types.actioncodeurl.md) | A utility class to parse email action URLs such as password reset, email verification, email link sign in, etc. | -| [AuthCredential](./auth-types.authcredential.md) | Interface that represents the credentials returned by an auth provider. Implementations specify the details about each auth provider's credential requirements. | -| [EmailAuthProvider](./auth-types.emailauthprovider.md) | Email and password auth provider implementation. | +| [AuthCredential](./auth-types.authcredential.md) | Interface that represents the credentials returned by an [AuthProvider](./auth-types.authprovider.md). | +| [EmailAuthProvider](./auth-types.emailauthprovider.md) | Provider for generating [EmailAuthCredential](./auth.emailauthcredential.md). | | [MultiFactorResolver](./auth-types.multifactorresolver.md) | The class used to facilitate recovery from [MultiFactorError](./auth-types.multifactorerror.md) when a user needs to provide a second factor to sign in. | -| [OAuthCredential](./auth-types.oauthcredential.md) | Interface that represents the OAuth credentials returned by an OAuth provider. Implementations specify the details about each auth provider's credential requirements. | -| [PhoneAuthCredential](./auth-types.phoneauthcredential.md) | Class that represents the Phone Auth credentials returned by a [PhoneAuthProvider](./auth-types.phoneauthprovider.md). | -| [PhoneAuthProvider](./auth-types.phoneauthprovider.md) | A provider for generating phone credentials. | -| [PhoneMultiFactorGenerator](./auth-types.phonemultifactorgenerator.md) | The class used to initialize a [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md). | +| [OAuthCredential](./auth-types.oauthcredential.md) | Interface that represents the OAuth credentials returned by an [OAuthProvider](./auth.oauthprovider.md). | +| [PhoneAuthCredential](./auth-types.phoneauthcredential.md) | Interface that represents the credentials returned by a [PhoneAuthProvider](./auth.phoneauthprovider.md). | +| [PhoneAuthProvider](./auth-types.phoneauthprovider.md) | Provider for generating an [PhoneAuthCredential](./auth.phoneauthcredential.md). | +| [PhoneMultiFactorGenerator](./auth-types.phonemultifactorgenerator.md) | Provider for generating a [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md). | | [RecaptchaVerifier](./auth-types.recaptchaverifier.md) | An [reCAPTCHA](https://www.google.com/recaptcha/)-based application verifier. | ## Enumerations @@ -23,40 +23,40 @@ | Enumeration | Description | | --- | --- | | [Operation](./auth-types.operation.md) | An enumeration of the possible email action types. | -| [OperationType](./auth-types.operationtype.md) | Supported operation types. | -| [ProviderId](./auth-types.providerid.md) | Supported providers. | -| [SignInMethod](./auth-types.signinmethod.md) | Supported sign-in methods. | +| [OperationType](./auth-types.operationtype.md) | Enumeration of supported operation types. | +| [ProviderId](./auth-types.providerid.md) | Enumeration of supported providers. | +| [SignInMethod](./auth-types.signinmethod.md) | Enumeration of supported sign-in methods. | ## Interfaces | Interface | Description | | --- | --- | -| [ActionCodeInfo](./auth-types.actioncodeinfo.md) | A response from checkActionCode. | -| [ActionCodeSettings](./auth-types.actioncodesettings.md) | This is the interface that defines the required continue/state URL with optional Android and iOS bundle identifiers. | +| [ActionCodeInfo](./auth-types.actioncodeinfo.md) | A response from [checkActionCode()](./auth.checkactioncode.md). | +| [ActionCodeSettings](./auth-types.actioncodesettings.md) | An interface that defines the required continue/state URL with optional Android and iOS bundle identifiers. | | [AdditionalUserInfo](./auth-types.additionaluserinfo.md) | A structure containing additional user information from a federated identity provider. | -| [ApplicationVerifier](./auth-types.applicationverifier.md) | A verifier for domain verification and abuse prevention. Currently, the only implementation is [RecaptchaVerifier](./auth-types.recaptchaverifier.md). | -| [Auth](./auth-types.auth.md) | The Firebase Auth service interface.See [Firebase Authentication](https://firebase.google.com/docs/auth/) for a full guide on how to use the Firebase Auth service. | -| [AuthError](./auth-types.autherror.md) | | +| [ApplicationVerifier](./auth-types.applicationverifier.md) | A verifier for domain verification and abuse prevention. | +| [Auth](./auth-types.auth.md) | Interface representing Firebase Auth service. | +| [AuthError](./auth-types.autherror.md) | Interface for an Auth error. | | [AuthProvider](./auth-types.authprovider.md) | Interface that represents an auth provider, used to facilitate creating [AuthCredential](./auth-types.authcredential.md). | -| [AuthSettings](./auth-types.authsettings.md) | Interface representing an Auth instance's settings, currently used for enabling/disabling app verification for phone Auth testing. | -| [Config](./auth-types.config.md) | Auth config object. | +| [AuthSettings](./auth-types.authsettings.md) | Interface representing an Auth instance's settings. | +| [Config](./auth-types.config.md) | Interface representing the Auth config. | | [ConfirmationResult](./auth-types.confirmationresult.md) | A result from a phone number sign-in, link, or reauthenticate call. | -| [IdTokenResult](./auth-types.idtokenresult.md) | Interface representing ID token result obtained from getIdTokenResult. It contains the ID token JWT string and other helper properties for getting different data associated with the token as well as all the decoded payload claims.Note that these claims are not to be trusted as they are parsed client side. Only server side verification can guarantee the integrity of the token claims. | -| [MultiFactorAssertion](./auth-types.multifactorassertion.md) | The base class for asserting ownership of a second factor. This is used to facilitate enrollment of a second factor on an existing user or sign-in of a user who already verified the first factor. | -| [MultiFactorError](./auth-types.multifactorerror.md) | The error thrown when the user needs to provide a second factor to sign in successfully. The error code for this error is auth/multi-factor-auth-required. | +| [IdTokenResult](./auth-types.idtokenresult.md) | Interface representing ID token result obtained from [User.getIdTokenResult()](./auth-types.user.getidtokenresult.md). | +| [MultiFactorAssertion](./auth-types.multifactorassertion.md) | The base class for asserting ownership of a second factor. | +| [MultiFactorError](./auth-types.multifactorerror.md) | The error thrown when the user needs to provide a second factor to sign in successfully. | | [MultiFactorInfo](./auth-types.multifactorinfo.md) | A structure containing the information of a second factor entity. | -| [MultiFactorSession](./auth-types.multifactorsession.md) | The multi-factor session object used for enrolling a second factor on a user or helping sign in an enrolled user with a second factor. | -| [MultiFactorUser](./auth-types.multifactoruser.md) | This is the interface that defines the multi-factor related properties and operations pertaining to a [User](./auth-types.user.md). | -| [ParsedToken](./auth-types.parsedtoken.md) | Parsed ID token. | -| [Persistence](./auth-types.persistence.md) | An enumeration of the possible persistence mechanism types. | +| [MultiFactorSession](./auth-types.multifactorsession.md) | An interface defining the multi-factor session object used for enrolling a second factor on a user or helping sign in an enrolled user with a second factor. | +| [MultiFactorUser](./auth-types.multifactoruser.md) | An interface that defines the multi-factor related properties and operations pertaining to a [User](./auth-types.user.md). | +| [ParsedToken](./auth-types.parsedtoken.md) | Interface representing a parsed ID token. | +| [Persistence](./auth-types.persistence.md) | An interface covering the possible persistence mechanism types. | | [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) | The class for asserting ownership of a phone second factor. Provided by [PhoneMultiFactorGenerator.assertion()](./auth-types.phonemultifactorgenerator.assertion.md). | | [PhoneMultiFactorEnrollInfoOptions](./auth-types.phonemultifactorenrollinfooptions.md) | Options used for enrolling a second factor. | | [PhoneMultiFactorSignInInfoOptions](./auth-types.phonemultifactorsignininfooptions.md) | Options used for signing-in with a second factor. | | [PhoneSingleFactorInfoOptions](./auth-types.phonesinglefactorinfooptions.md) | Options used for single-factor sign-in. | -| [PopupRedirectResolver](./auth-types.popupredirectresolver.md) | A resolver used for handling DOM specific operations like signInWithPopup() or signInWithRedirect(). | +| [PopupRedirectResolver](./auth-types.popupredirectresolver.md) | A resolver used for handling DOM specific operations like [signInWithPopup()](./auth.signinwithpopup.md) or [signInWithRedirect()](./auth.signinwithredirect.md). | | [ReactNativeAsyncStorage](./auth-types.reactnativeasyncstorage.md) | Interface for a supplied AsyncStorage. | | [User](./auth-types.user.md) | A user account. | -| [UserCredential](./auth-types.usercredential.md) | A structure containing a [User](./auth-types.user.md), an [AuthCredential](./auth-types.authcredential.md), the [OperationType](./auth-types.operationtype.md), and any additional user information that was returned from the identity provider. operationType could be [OperationType.SIGN\_IN](./auth-types.operationtype.sign_in.md) for a sign-in operation, [OperationType.LINK](./auth-types.operationtype.link.md) for a linking operation and [OperationType.REAUTHENTICATE](./auth-types.operationtype.reauthenticate.md) for a reauthentication operation. | +| [UserCredential](./auth-types.usercredential.md) | A structure containing a [User](./auth-types.user.md), an [AuthCredential](./auth-types.authcredential.md), the [OperationType](./auth-types.operationtype.md), and any additional user information that was returned from the identity provider. | | [UserInfo](./auth-types.userinfo.md) | User profile information, visible only to the Firebase project's apps. | | [UserMetadata](./auth-types.usermetadata.md) | Interface representing a user's metadata. | @@ -65,6 +65,6 @@ | Type Alias | Description | | --- | --- | | [NextOrObserver](./auth-types.nextorobserver.md) | Type definition for an event callback. | -| [PhoneInfoOptions](./auth-types.phoneinfooptions.md) | The information required to verify the ownership of a phone number. The information that's required depends on whether you are doing single-factor sign-in, multi-factor enrollment or multi-factor sign-in. | +| [PhoneInfoOptions](./auth-types.phoneinfooptions.md) | The information required to verify the ownership of a phone number. | | [UserProfile](./auth-types.userprofile.md) | User profile used in [AdditionalUserInfo](./auth-types.additionaluserinfo.md). | diff --git a/docs-exp/auth-types.multifactorassertion.md b/docs-exp/auth-types.multifactorassertion.md index e2bb7bee388..d3462495776 100644 --- a/docs-exp/auth-types.multifactorassertion.md +++ b/docs-exp/auth-types.multifactorassertion.md @@ -4,7 +4,7 @@ ## MultiFactorAssertion interface -The base class for asserting ownership of a second factor. This is used to facilitate enrollment of a second factor on an existing user or sign-in of a user who already verified the first factor. +The base class for asserting ownership of a second factor. Signature: @@ -12,6 +12,10 @@ The base class for asserting ownership of a second factor. This is used to facil export interface MultiFactorAssertion ``` +## Remarks + +This is used to facilitate enrollment of a second factor on an existing user or sign-in of a user who already verified the first factor. + ## Properties | Property | Type | Description | diff --git a/docs-exp/auth-types.multifactorerror.md b/docs-exp/auth-types.multifactorerror.md index 2d42aa7888b..a392403f65b 100644 --- a/docs-exp/auth-types.multifactorerror.md +++ b/docs-exp/auth-types.multifactorerror.md @@ -4,7 +4,7 @@ ## MultiFactorError interface -The error thrown when the user needs to provide a second factor to sign in successfully. The error code for this error is `auth/multi-factor-auth-required`. +The error thrown when the user needs to provide a second factor to sign in successfully. Signature: @@ -13,6 +13,10 @@ export interface MultiFactorError extends AuthError ``` Extends: [AuthError](./auth-types.autherror.md) +## Remarks + +The error code for this error is `auth/multi-factor-auth-required`. + ## Example diff --git a/docs-exp/auth-types.multifactorsession.md b/docs-exp/auth-types.multifactorsession.md index 436b748c34e..8c348a7b6f0 100644 --- a/docs-exp/auth-types.multifactorsession.md +++ b/docs-exp/auth-types.multifactorsession.md @@ -4,7 +4,7 @@ ## MultiFactorSession interface -The multi-factor session object used for enrolling a second factor on a user or helping sign in an enrolled user with a second factor. +An interface defining the multi-factor session object used for enrolling a second factor on a user or helping sign in an enrolled user with a second factor. Signature: diff --git a/docs-exp/auth-types.multifactoruser.enroll.md b/docs-exp/auth-types.multifactoruser.enroll.md index a51b67ad58b..b75ed9ca9a3 100644 --- a/docs-exp/auth-types.multifactoruser.enroll.md +++ b/docs-exp/auth-types.multifactoruser.enroll.md @@ -4,7 +4,7 @@ ## MultiFactorUser.enroll() method -Enrolls a second factor as identified by the [MultiFactorAssertion](./auth-types.multifactorassertion.md) for the user. On resolution, the user tokens are updated to reflect the change in the JWT payload. Accepts an additional display name parameter used to identify the second factor to the end user. Recent re-authentication is required for this operation to succeed. On successful enrollment, existing Firebase sessions (refresh tokens) are revoked. When a new factor is enrolled, an email notification is sent to the user’s email. +Enrolls a second factor as identified by the [MultiFactorAssertion](./auth-types.multifactorassertion.md) for the user. Signature: @@ -26,6 +26,10 @@ enroll( Promise<void> +## Remarks + +On resolution, the user tokens are updated to reflect the change in the JWT payload. Accepts an additional display name parameter used to identify the second factor to the end user. Recent re-authentication is required for this operation to succeed. On successful enrollment, existing Firebase sessions (refresh tokens) are revoked. When a new factor is enrolled, an email notification is sent to the user’s email. + ## Example diff --git a/docs-exp/auth-types.multifactoruser.md b/docs-exp/auth-types.multifactoruser.md index e40bb6ce3ba..39c34813142 100644 --- a/docs-exp/auth-types.multifactoruser.md +++ b/docs-exp/auth-types.multifactoruser.md @@ -4,7 +4,7 @@ ## MultiFactorUser interface -This is the interface that defines the multi-factor related properties and operations pertaining to a [User](./auth-types.user.md). +An interface that defines the multi-factor related properties and operations pertaining to a [User](./auth-types.user.md). Signature: @@ -22,7 +22,7 @@ export interface MultiFactorUser | Method | Description | | --- | --- | -| [enroll(assertion, displayName)](./auth-types.multifactoruser.enroll.md) | Enrolls a second factor as identified by the [MultiFactorAssertion](./auth-types.multifactorassertion.md) for the user. On resolution, the user tokens are updated to reflect the change in the JWT payload. Accepts an additional display name parameter used to identify the second factor to the end user. Recent re-authentication is required for this operation to succeed. On successful enrollment, existing Firebase sessions (refresh tokens) are revoked. When a new factor is enrolled, an email notification is sent to the user’s email. | +| [enroll(assertion, displayName)](./auth-types.multifactoruser.enroll.md) | Enrolls a second factor as identified by the [MultiFactorAssertion](./auth-types.multifactorassertion.md) for the user. | | [getSession()](./auth-types.multifactoruser.getsession.md) | Returns the session identifier for a second factor enrollment operation. This is used to identify the user trying to enroll a second factor. | -| [unenroll(option)](./auth-types.multifactoruser.unenroll.md) | Unenrolls the specified second factor. To specify the factor to remove, pass a [MultiFactorInfo](./auth-types.multifactorinfo.md) object (retrieved from [MultiFactorUser.enrolledFactors](./auth-types.multifactoruser.enrolledfactors.md)) or the factor's UID string. Sessions are not revoked when the account is unenrolled. An email notification is likely to be sent to the user notifying them of the change. Recent re-authentication is required for this operation to succeed. When an existing factor is unenrolled, an email notification is sent to the user’s email. | +| [unenroll(option)](./auth-types.multifactoruser.unenroll.md) | Unenrolls the specified second factor. | diff --git a/docs-exp/auth-types.multifactoruser.unenroll.md b/docs-exp/auth-types.multifactoruser.unenroll.md index 1ee948e90eb..4ebbee84a86 100644 --- a/docs-exp/auth-types.multifactoruser.unenroll.md +++ b/docs-exp/auth-types.multifactoruser.unenroll.md @@ -4,7 +4,7 @@ ## MultiFactorUser.unenroll() method -Unenrolls the specified second factor. To specify the factor to remove, pass a [MultiFactorInfo](./auth-types.multifactorinfo.md) object (retrieved from [MultiFactorUser.enrolledFactors](./auth-types.multifactoruser.enrolledfactors.md)) or the factor's UID string. Sessions are not revoked when the account is unenrolled. An email notification is likely to be sent to the user notifying them of the change. Recent re-authentication is required for this operation to succeed. When an existing factor is unenrolled, an email notification is sent to the user’s email. +Unenrolls the specified second factor. Signature: @@ -24,6 +24,10 @@ Promise<void> - A promise which resolves when the unenroll operation is complete. +## Remarks + +To specify the factor to remove, pass a [MultiFactorInfo](./auth-types.multifactorinfo.md) object (retrieved from [MultiFactorUser.enrolledFactors](./auth-types.multifactoruser.enrolledfactors.md)) or the factor's UID string. Sessions are not revoked when the account is unenrolled. An email notification is likely to be sent to the user notifying them of the change. Recent re-authentication is required for this operation to succeed. When an existing factor is unenrolled, an email notification is sent to the user’s email. + ## Example diff --git a/docs-exp/auth-types.oauthcredential.accesstoken.md b/docs-exp/auth-types.oauthcredential.accesstoken.md index 62c79284b66..51dfa8b6135 100644 --- a/docs-exp/auth-types.oauthcredential.accesstoken.md +++ b/docs-exp/auth-types.oauthcredential.accesstoken.md @@ -4,7 +4,7 @@ ## OAuthCredential.accessToken property -The OAuth access token associated with the credential if it belongs to an OAuth provider, such as `facebook.com`, `twitter.com`, etc. +The OAuth access token associated with the credential if it belongs to an [OAuthProvider](./auth.oauthprovider.md), such as `facebook.com`, `twitter.com`, etc. Signature: diff --git a/docs-exp/auth-types.oauthcredential.md b/docs-exp/auth-types.oauthcredential.md index 89e79d18518..70b4a908c54 100644 --- a/docs-exp/auth-types.oauthcredential.md +++ b/docs-exp/auth-types.oauthcredential.md @@ -4,7 +4,7 @@ ## OAuthCredential class -Interface that represents the OAuth credentials returned by an OAuth provider. Implementations specify the details about each auth provider's credential requirements. +Interface that represents the OAuth credentials returned by an [OAuthProvider](./auth.oauthprovider.md). Signature: @@ -13,11 +13,15 @@ export abstract class OAuthCredential extends AuthCredential ``` Extends: [AuthCredential](./auth-types.authcredential.md) +## Remarks + +Implementations specify the details about each auth provider's credential requirements. + ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [accessToken](./auth-types.oauthcredential.accesstoken.md) | | string | The OAuth access token associated with the credential if it belongs to an OAuth provider, such as facebook.com, twitter.com, etc. | +| [accessToken](./auth-types.oauthcredential.accesstoken.md) | | string | The OAuth access token associated with the credential if it belongs to an [OAuthProvider](./auth.oauthprovider.md), such as facebook.com, twitter.com, etc. | | [idToken](./auth-types.oauthcredential.idtoken.md) | | string | The OAuth ID token associated with the credential if it belongs to an OIDC provider, such as google.com. | | [secret](./auth-types.oauthcredential.secret.md) | | string | The OAuth access token secret associated with the credential if it belongs to an OAuth 1.0 provider, such as twitter.com. | diff --git a/docs-exp/auth-types.operationtype.md b/docs-exp/auth-types.operationtype.md index 99d4207adbd..94bc09443a2 100644 --- a/docs-exp/auth-types.operationtype.md +++ b/docs-exp/auth-types.operationtype.md @@ -4,7 +4,7 @@ ## OperationType enum -Supported operation types. +Enumeration of supported operation types. Signature: diff --git a/docs-exp/auth-types.parsedtoken.md b/docs-exp/auth-types.parsedtoken.md index c192ad7ffea..5e12f27b315 100644 --- a/docs-exp/auth-types.parsedtoken.md +++ b/docs-exp/auth-types.parsedtoken.md @@ -4,7 +4,7 @@ ## ParsedToken interface -Parsed ID token. +Interface representing a parsed ID token. Signature: diff --git a/docs-exp/auth-types.persistence.md b/docs-exp/auth-types.persistence.md index c290291bc50..fec7826628d 100644 --- a/docs-exp/auth-types.persistence.md +++ b/docs-exp/auth-types.persistence.md @@ -4,7 +4,7 @@ ## Persistence interface -An enumeration of the possible persistence mechanism types. +An interface covering the possible persistence mechanism types. Signature: @@ -16,5 +16,5 @@ export interface Persistence | Property | Type | Description | | --- | --- | --- | -| [type](./auth-types.persistence.type.md) | 'SESSION' \| 'LOCAL' \| 'NONE' | Type of Persistence. - 'SESSION' is used for temporary persistence such as sessionStorage. - 'LOCAL' is used for long term persistence such as localStorage or 'IndexedDB\`. - 'NONE' is used for in-memory, or no persistence. | +| [type](./auth-types.persistence.type.md) | 'SESSION' \| 'LOCAL' \| 'NONE' | Type of Persistence. - 'SESSION' is used for temporary persistence such as sessionStorage. - 'LOCAL' is used for long term persistence such as localStorage or IndexedDB. - 'NONE' is used for in-memory, or no persistence. | diff --git a/docs-exp/auth-types.persistence.type.md b/docs-exp/auth-types.persistence.type.md index 6cdd734f962..3cc1085d46f 100644 --- a/docs-exp/auth-types.persistence.type.md +++ b/docs-exp/auth-types.persistence.type.md @@ -4,7 +4,7 @@ ## Persistence.type property -Type of Persistence. - 'SESSION' is used for temporary persistence such as `sessionStorage`. - 'LOCAL' is used for long term persistence such as `localStorage` or 'IndexedDB\`. - 'NONE' is used for in-memory, or no persistence. +Type of Persistence. - 'SESSION' is used for temporary persistence such as `sessionStorage`. - 'LOCAL' is used for long term persistence such as `localStorage` or `IndexedDB`. - 'NONE' is used for in-memory, or no persistence. Signature: diff --git a/docs-exp/auth-types.phoneauthcredential.fromjson.md b/docs-exp/auth-types.phoneauthcredential.fromjson.md index 9046b450f7b..fd42af97868 100644 --- a/docs-exp/auth-types.phoneauthcredential.fromjson.md +++ b/docs-exp/auth-types.phoneauthcredential.fromjson.md @@ -4,7 +4,7 @@ ## PhoneAuthCredential.fromJSON() method -Interface that represents the credentials returned by an auth provider. Implementations specify the details about each auth provider's credential requirements. +Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth-types.authcredential.md). Signature: @@ -16,9 +16,11 @@ static fromJSON(json: object | string): PhoneAuthCredential | null; | Parameter | Type | Description | | --- | --- | --- | -| json | object \| string | | +| json | object \| string | Either object or the stringified representation of the object. When string is provided, JSON.parse would be called first. | Returns: [PhoneAuthCredential](./auth-types.phoneauthcredential.md) \| null +If the JSON input does not represent an [AuthCredential](./auth-types.authcredential.md), null is returned. + diff --git a/docs-exp/auth-types.phoneauthcredential.md b/docs-exp/auth-types.phoneauthcredential.md index db7fe60eac5..d7e4f42f556 100644 --- a/docs-exp/auth-types.phoneauthcredential.md +++ b/docs-exp/auth-types.phoneauthcredential.md @@ -4,7 +4,7 @@ ## PhoneAuthCredential class -Class that represents the Phone Auth credentials returned by a [PhoneAuthProvider](./auth-types.phoneauthprovider.md). +Interface that represents the credentials returned by a [PhoneAuthProvider](./auth.phoneauthprovider.md). Signature: @@ -17,5 +17,6 @@ export abstract class PhoneAuthCredential extends AuthCredential | Method | Modifiers | Description | | --- | --- | --- | -| [fromJSON(json)](./auth-types.phoneauthcredential.fromjson.md) | static | Interface that represents the credentials returned by an auth provider. Implementations specify the details about each auth provider's credential requirements. | +| [fromJSON(json)](./auth-types.phoneauthcredential.fromjson.md) | static | Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth-types.authcredential.md). | +| [toJSON()](./auth-types.phoneauthcredential.tojson.md) | | Returns a JSON-serializable representation of this object. | diff --git a/docs-exp/auth-types.phoneauthcredential.tojson.md b/docs-exp/auth-types.phoneauthcredential.tojson.md new file mode 100644 index 00000000000..7b457ea9b80 --- /dev/null +++ b/docs-exp/auth-types.phoneauthcredential.tojson.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@firebase/auth-types](./auth-types.md) > [PhoneAuthCredential](./auth-types.phoneauthcredential.md) > [toJSON](./auth-types.phoneauthcredential.tojson.md) + +## PhoneAuthCredential.toJSON() method + +Returns a JSON-serializable representation of this object. + +Signature: + +```typescript +toJSON(): object; +``` +Returns: + +object + +a JSON-serializable representation of this object. + diff --git a/docs-exp/auth-types.phoneauthprovider._constructor_.md b/docs-exp/auth-types.phoneauthprovider._constructor_.md index e008f4b6fba..5f572453c30 100644 --- a/docs-exp/auth-types.phoneauthprovider._constructor_.md +++ b/docs-exp/auth-types.phoneauthprovider._constructor_.md @@ -16,5 +16,9 @@ constructor(auth?: Auth | null); | Parameter | Type | Description | | --- | --- | --- | -| auth | [Auth](./auth-types.auth.md) \| null | The Firebase Auth instance in which sign-ins should occur. Uses the default Auth instance if unspecified. | +| auth | [Auth](./auth-types.auth.md) \| null | The Firebase Auth instance in which sign-ins should occur. | + +## Remarks + +Uses the default Auth instance if unspecified. diff --git a/docs-exp/auth-types.phoneauthprovider.credential.md b/docs-exp/auth-types.phoneauthprovider.credential.md index ae24c0ef86c..572ff97605b 100644 --- a/docs-exp/auth-types.phoneauthprovider.credential.md +++ b/docs-exp/auth-types.phoneauthprovider.credential.md @@ -4,7 +4,7 @@ ## PhoneAuthProvider.credential() method -Creates a phone auth credential, given the verification ID from [PhoneAuthProvider.verifyPhoneNumber()](./auth-types.phoneauthprovider.verifyphonenumber.md) and the code that was sent to the user's mobile device. +Creates a phone auth credential, given the verification ID from [PhoneAuthProvider.verifyPhoneNumber()](./auth.phoneauthprovider.verifyphonenumber.md) and the code that was sent to the user's mobile device. Signature: @@ -19,7 +19,7 @@ static credential( | Parameter | Type | Description | | --- | --- | --- | -| verificationId | string | The verification ID returned from [PhoneAuthProvider.verifyPhoneNumber()](./auth-types.phoneauthprovider.verifyphonenumber.md). | +| verificationId | string | The verification ID returned from [PhoneAuthProvider.verifyPhoneNumber()](./auth.phoneauthprovider.verifyphonenumber.md). | | verificationCode | string | The verification code sent to the user's mobile device. | Returns: diff --git a/docs-exp/auth-types.phoneauthprovider.md b/docs-exp/auth-types.phoneauthprovider.md index 584991d57aa..0ce8396e19c 100644 --- a/docs-exp/auth-types.phoneauthprovider.md +++ b/docs-exp/auth-types.phoneauthprovider.md @@ -4,7 +4,7 @@ ## PhoneAuthProvider class -A provider for generating phone credentials. +Provider for generating an [PhoneAuthCredential](./auth.phoneauthcredential.md). Signature: @@ -21,8 +21,8 @@ export class PhoneAuthProvider implements AuthProvider const applicationVerifier = new RecaptchaVerifier('recaptcha-container'); const provider = new PhoneAuthProvider(auth); const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier); -const verificationCode = window.prompt('Please enter the verification code that was sent to your mobile device.'); -const phoneCredential = await PhoneAuthProvider.credential(verificationId, verificationCode); +// Obtain the verificationCode from the user. +const phoneCredential = PhoneAuthProvider.credential(verificationId, verificationCode); const userCredential = await signInWithCredential(auth, phoneCredential); ``` @@ -45,6 +45,6 @@ const userCredential = await signInWithCredential(auth, phoneCredential); | Method | Modifiers | Description | | --- | --- | --- | -| [credential(verificationId, verificationCode)](./auth-types.phoneauthprovider.credential.md) | static | Creates a phone auth credential, given the verification ID from [PhoneAuthProvider.verifyPhoneNumber()](./auth-types.phoneauthprovider.verifyphonenumber.md) and the code that was sent to the user's mobile device. | -| [verifyPhoneNumber(phoneInfoOptions, applicationVerifier)](./auth-types.phoneauthprovider.verifyphonenumber.md) | | Starts a phone number authentication flow by sending a verification code to the given phone number. Returns an ID that can be passed to [PhoneAuthProvider.credential()](./auth-types.phoneauthprovider.credential.md) to identify this flow. | +| [credential(verificationId, verificationCode)](./auth-types.phoneauthprovider.credential.md) | static | Creates a phone auth credential, given the verification ID from [PhoneAuthProvider.verifyPhoneNumber()](./auth.phoneauthprovider.verifyphonenumber.md) and the code that was sent to the user's mobile device. | +| [verifyPhoneNumber(phoneInfoOptions, applicationVerifier)](./auth-types.phoneauthprovider.verifyphonenumber.md) | | Starts a phone number authentication flow by sending a verification code to the given phone number. | diff --git a/docs-exp/auth-types.phoneauthprovider.verifyphonenumber.md b/docs-exp/auth-types.phoneauthprovider.verifyphonenumber.md index 4bd36b87c32..2bbf0155d30 100644 --- a/docs-exp/auth-types.phoneauthprovider.verifyphonenumber.md +++ b/docs-exp/auth-types.phoneauthprovider.verifyphonenumber.md @@ -4,7 +4,7 @@ ## PhoneAuthProvider.verifyPhoneNumber() method -Starts a phone number authentication flow by sending a verification code to the given phone number. Returns an ID that can be passed to [PhoneAuthProvider.credential()](./auth-types.phoneauthprovider.credential.md) to identify this flow. +Starts a phone number authentication flow by sending a verification code to the given phone number. Signature: @@ -26,7 +26,7 @@ verifyPhoneNumber( Promise<string> -A Promise for the verification ID. +A Promise for a verification ID that can be passed to [PhoneAuthProvider.credential()](./auth.phoneauthprovider.credential.md) to identify this flow.. ## Example 1 diff --git a/docs-exp/auth-types.phoneinfooptions.md b/docs-exp/auth-types.phoneinfooptions.md index 3371b2b01d1..e4e92f86bc1 100644 --- a/docs-exp/auth-types.phoneinfooptions.md +++ b/docs-exp/auth-types.phoneinfooptions.md @@ -4,7 +4,7 @@ ## PhoneInfoOptions type -The information required to verify the ownership of a phone number. The information that's required depends on whether you are doing single-factor sign-in, multi-factor enrollment or multi-factor sign-in. +The information required to verify the ownership of a phone number. Signature: @@ -14,3 +14,8 @@ export type PhoneInfoOptions = | PhoneMultiFactorEnrollInfoOptions | PhoneMultiFactorSignInInfoOptions; ``` + +## Remarks + +The information that's required depends on whether you are doing single-factor sign-in, multi-factor enrollment or multi-factor sign-in. + diff --git a/docs-exp/auth-types.phonemultifactorgenerator.assertion.md b/docs-exp/auth-types.phonemultifactorgenerator.assertion.md index 1ddcf2b450e..bb0b8715d95 100644 --- a/docs-exp/auth-types.phonemultifactorgenerator.assertion.md +++ b/docs-exp/auth-types.phonemultifactorgenerator.assertion.md @@ -18,7 +18,7 @@ static assertion( | Parameter | Type | Description | | --- | --- | --- | -| phoneAuthCredential | [PhoneAuthCredential](./auth-types.phoneauthcredential.md) | A credential provided by [PhoneAuthProvider.credential()](./auth-types.phoneauthprovider.credential.md). | +| phoneAuthCredential | [PhoneAuthCredential](./auth-types.phoneauthcredential.md) | A credential provided by [PhoneAuthProvider.credential()](./auth.phoneauthprovider.credential.md). | Returns: diff --git a/docs-exp/auth-types.phonemultifactorgenerator.md b/docs-exp/auth-types.phonemultifactorgenerator.md index 54414a615ce..b1a891467c8 100644 --- a/docs-exp/auth-types.phonemultifactorgenerator.md +++ b/docs-exp/auth-types.phonemultifactorgenerator.md @@ -4,7 +4,7 @@ ## PhoneMultiFactorGenerator class -The class used to initialize a [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md). +Provider for generating a [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md). Signature: diff --git a/docs-exp/auth-types.popupredirectresolver.md b/docs-exp/auth-types.popupredirectresolver.md index 26074dd7421..cf02603d8a5 100644 --- a/docs-exp/auth-types.popupredirectresolver.md +++ b/docs-exp/auth-types.popupredirectresolver.md @@ -4,7 +4,7 @@ ## PopupRedirectResolver interface -A resolver used for handling DOM specific operations like `signInWithPopup()` or `signInWithRedirect()`. +A resolver used for handling DOM specific operations like [signInWithPopup()](./auth.signinwithpopup.md) or [signInWithRedirect()](./auth.signinwithredirect.md). Signature: diff --git a/docs-exp/auth-types.providerid.md b/docs-exp/auth-types.providerid.md index fec988ae5fc..4119aadd9de 100644 --- a/docs-exp/auth-types.providerid.md +++ b/docs-exp/auth-types.providerid.md @@ -4,7 +4,7 @@ ## ProviderId enum -Supported providers. +Enumeration of supported providers. Signature: diff --git a/docs-exp/auth-types.recaptchaverifier.md b/docs-exp/auth-types.recaptchaverifier.md index ceb3edb7692..073a13ff84c 100644 --- a/docs-exp/auth-types.recaptchaverifier.md +++ b/docs-exp/auth-types.recaptchaverifier.md @@ -23,7 +23,7 @@ export abstract class RecaptchaVerifier implements ApplicationVerifier | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [type](./auth-types.recaptchaverifier.type.md) | | string | The application verifier type. For a reCAPTCHA verifier, this is 'recaptcha'. | +| [type](./auth-types.recaptchaverifier.type.md) | | string | The application verifier type. | ## Methods diff --git a/docs-exp/auth-types.recaptchaverifier.type.md b/docs-exp/auth-types.recaptchaverifier.type.md index 7e202a68f8d..7e56581e6d7 100644 --- a/docs-exp/auth-types.recaptchaverifier.type.md +++ b/docs-exp/auth-types.recaptchaverifier.type.md @@ -4,10 +4,15 @@ ## RecaptchaVerifier.type property -The application verifier type. For a reCAPTCHA verifier, this is 'recaptcha'. +The application verifier type. Signature: ```typescript readonly type: string; ``` + +## Remarks + +For a reCAPTCHA verifier, this is 'recaptcha'. + diff --git a/docs-exp/auth-types.signinmethod.md b/docs-exp/auth-types.signinmethod.md index 6871ee95bd6..a4707f54161 100644 --- a/docs-exp/auth-types.signinmethod.md +++ b/docs-exp/auth-types.signinmethod.md @@ -4,7 +4,7 @@ ## SignInMethod enum -Supported sign-in methods. +Enumeration of supported sign-in methods. Signature: diff --git a/docs-exp/auth-types.user.delete.md b/docs-exp/auth-types.user.delete.md index 86f63287cb8..ad5c586cf13 100644 --- a/docs-exp/auth-types.user.delete.md +++ b/docs-exp/auth-types.user.delete.md @@ -6,8 +6,6 @@ Deletes and signs out the user. -Important: this is a security-sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and then call one of the reauthentication methods like `reauthenticateWithCredential`. - Signature: ```typescript @@ -17,3 +15,7 @@ delete(): Promise; Promise<void> +## Remarks + +Important: this is a security-sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and then call one of the reauthentication methods like [reauthenticateWithCredential()](./auth.reauthenticatewithcredential.md). + diff --git a/docs-exp/auth-types.user.emailverified.md b/docs-exp/auth-types.user.emailverified.md index 32bde397782..c6499e8f0b4 100644 --- a/docs-exp/auth-types.user.emailverified.md +++ b/docs-exp/auth-types.user.emailverified.md @@ -4,7 +4,7 @@ ## User.emailVerified property -Whether the email has been verified with `sendEmailVerification` and `applyActionCode`. +Whether the email has been verified with [sendEmailVerification()](./auth.sendemailverification.md) and [applyActionCode()](./auth.applyactioncode.md). Signature: diff --git a/docs-exp/auth-types.user.getidtoken.md b/docs-exp/auth-types.user.getidtoken.md index e1a421159c2..e70cad9db9b 100644 --- a/docs-exp/auth-types.user.getidtoken.md +++ b/docs-exp/auth-types.user.getidtoken.md @@ -6,8 +6,6 @@ Returns a JSON Web Token (JWT) used to identify the user to a Firebase service. -Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one. - Signature: ```typescript @@ -24,3 +22,7 @@ getIdToken(forceRefresh?: boolean): Promise; Promise<string> +## Remarks + +Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one. + diff --git a/docs-exp/auth-types.user.getidtokenresult.md b/docs-exp/auth-types.user.getidtokenresult.md index db451357842..3ea0209cd23 100644 --- a/docs-exp/auth-types.user.getidtokenresult.md +++ b/docs-exp/auth-types.user.getidtokenresult.md @@ -6,8 +6,6 @@ Returns a deserialized JSON Web Token (JWT) used to identitfy the user to a Firebase service. -Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one. - Signature: ```typescript @@ -24,3 +22,7 @@ getIdTokenResult(forceRefresh?: boolean): Promise; Promise<[IdTokenResult](./auth-types.idtokenresult.md)> +## Remarks + +Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one. + diff --git a/docs-exp/auth-types.user.isanonymous.md b/docs-exp/auth-types.user.isanonymous.md index 9ac4e143aaf..7d5a6700b35 100644 --- a/docs-exp/auth-types.user.isanonymous.md +++ b/docs-exp/auth-types.user.isanonymous.md @@ -4,7 +4,7 @@ ## User.isAnonymous property -Whether the user is authenticated using the [ProviderId.ANONYMOUS](./auth-types.providerid.anonymous.md) provider. +Whether the user is authenticated using the provider. Signature: diff --git a/docs-exp/auth-types.user.md b/docs-exp/auth-types.user.md index f6ce6aa8656..c3a3a8a8546 100644 --- a/docs-exp/auth-types.user.md +++ b/docs-exp/auth-types.user.md @@ -17,20 +17,20 @@ export interface User extends UserInfo | Property | Type | Description | | --- | --- | --- | -| [emailVerified](./auth-types.user.emailverified.md) | boolean | Whether the email has been verified with sendEmailVerification and applyActionCode. | -| [isAnonymous](./auth-types.user.isanonymous.md) | boolean | Whether the user is authenticated using the [ProviderId.ANONYMOUS](./auth-types.providerid.anonymous.md) provider. | +| [emailVerified](./auth-types.user.emailverified.md) | boolean | Whether the email has been verified with [sendEmailVerification()](./auth.sendemailverification.md) and [applyActionCode()](./auth.applyactioncode.md). | +| [isAnonymous](./auth-types.user.isanonymous.md) | boolean | Whether the user is authenticated using the provider. | | [metadata](./auth-types.user.metadata.md) | [UserMetadata](./auth-types.usermetadata.md) | Additional metadata around user creation and sign-in times. | | [providerData](./auth-types.user.providerdata.md) | [UserInfo](./auth-types.userinfo.md)\[\] | Additional per provider such as displayName and profile information. | -| [refreshToken](./auth-types.user.refreshtoken.md) | string | Refresh token used to reauthenticate the user. Avoid using this directly and prefer to refresh the ID token instead. | -| [tenantId](./auth-types.user.tenantid.md) | string \| null | The user's tenant ID. This is a read-only property, which indicates the tenant ID used to sign in the user. This is null if the user is signed in from the parent project. | +| [refreshToken](./auth-types.user.refreshtoken.md) | string | Refresh token used to reauthenticate the user. Avoid using this directly and prefer [User.getIdToken()](./auth-types.user.getidtoken.md) to refresh the ID token instead. | +| [tenantId](./auth-types.user.tenantid.md) | string \| null | The user's tenant ID. | ## Methods | Method | Description | | --- | --- | -| [delete()](./auth-types.user.delete.md) | Deletes and signs out the user.Important: this is a security-sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and then call one of the reauthentication methods like reauthenticateWithCredential. | -| [getIdToken(forceRefresh)](./auth-types.user.getidtoken.md) | Returns a JSON Web Token (JWT) used to identify the user to a Firebase service.Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one. | -| [getIdTokenResult(forceRefresh)](./auth-types.user.getidtokenresult.md) | Returns a deserialized JSON Web Token (JWT) used to identitfy the user to a Firebase service.Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one. | +| [delete()](./auth-types.user.delete.md) | Deletes and signs out the user. | +| [getIdToken(forceRefresh)](./auth-types.user.getidtoken.md) | Returns a JSON Web Token (JWT) used to identify the user to a Firebase service. | +| [getIdTokenResult(forceRefresh)](./auth-types.user.getidtokenresult.md) | Returns a deserialized JSON Web Token (JWT) used to identitfy the user to a Firebase service. | | [reload()](./auth-types.user.reload.md) | Refreshes the user, if signed in. | | [toJSON()](./auth-types.user.tojson.md) | Returns a JSON-serializable representation of this object. | diff --git a/docs-exp/auth-types.user.refreshtoken.md b/docs-exp/auth-types.user.refreshtoken.md index 4267915a368..9eca76e15a7 100644 --- a/docs-exp/auth-types.user.refreshtoken.md +++ b/docs-exp/auth-types.user.refreshtoken.md @@ -4,7 +4,7 @@ ## User.refreshToken property -Refresh token used to reauthenticate the user. Avoid using this directly and prefer to refresh the ID token instead. +Refresh token used to reauthenticate the user. Avoid using this directly and prefer [User.getIdToken()](./auth-types.user.getidtoken.md) to refresh the ID token instead. Signature: diff --git a/docs-exp/auth-types.user.tenantid.md b/docs-exp/auth-types.user.tenantid.md index f10c3439ed1..1447a4ca45c 100644 --- a/docs-exp/auth-types.user.tenantid.md +++ b/docs-exp/auth-types.user.tenantid.md @@ -4,7 +4,7 @@ ## User.tenantId property -The user's tenant ID. This is a read-only property, which indicates the tenant ID used to sign in the user. This is null if the user is signed in from the parent project. +The user's tenant ID. Signature: @@ -12,6 +12,10 @@ The user's tenant ID. This is a read-only property, which indicates the tenant I readonly tenantId: string | null; ``` +## Remarks + +This is a read-only property, which indicates the tenant ID used to sign in the user. This is null if the user is signed in from the parent project. + ## Example diff --git a/docs-exp/auth-types.usercredential.md b/docs-exp/auth-types.usercredential.md index ebf5ccd06c8..15a92853427 100644 --- a/docs-exp/auth-types.usercredential.md +++ b/docs-exp/auth-types.usercredential.md @@ -4,7 +4,7 @@ ## UserCredential interface -A structure containing a [User](./auth-types.user.md), an [AuthCredential](./auth-types.authcredential.md), the [OperationType](./auth-types.operationtype.md), and any additional user information that was returned from the identity provider. `operationType` could be [OperationType.SIGN\_IN](./auth-types.operationtype.sign_in.md) for a sign-in operation, [OperationType.LINK](./auth-types.operationtype.link.md) for a linking operation and [OperationType.REAUTHENTICATE](./auth-types.operationtype.reauthenticate.md) for a reauthentication operation. +A structure containing a [User](./auth-types.user.md), an [AuthCredential](./auth-types.authcredential.md), the [OperationType](./auth-types.operationtype.md), and any additional user information that was returned from the identity provider. Signature: @@ -12,6 +12,10 @@ A structure containing a [User](./auth-types.user.md), an [AuthCredentia export interface UserCredential ``` +## Remarks + +`operationType` could be [OperationType.SIGN\_IN](./auth-types.operationtype.sign_in.md) for a sign-in operation, [OperationType.LINK](./auth-types.operationtype.link.md) for a linking operation and [OperationType.REAUTHENTICATE](./auth-types.operationtype.reauthenticate.md) for a reauthentication operation. + ## Properties | Property | Type | Description | diff --git a/docs-exp/auth-types.userinfo.md b/docs-exp/auth-types.userinfo.md index def00ec097a..27cf7386dd3 100644 --- a/docs-exp/auth-types.userinfo.md +++ b/docs-exp/auth-types.userinfo.md @@ -18,7 +18,7 @@ export interface UserInfo | --- | --- | --- | | [displayName](./auth-types.userinfo.displayname.md) | string \| null | The display name of the user. | | [email](./auth-types.userinfo.email.md) | string \| null | The email of the user. | -| [phoneNumber](./auth-types.userinfo.phonenumber.md) | string \| null | The phone number normalized based on the E.164 standard (e.g. +16505550101) for the user. This is null if the user has no phone credential linked to the account. | +| [phoneNumber](./auth-types.userinfo.phonenumber.md) | string \| null | The phone number normalized based on the E.164 standard (e.g. +16505550101) for the user. | | [photoURL](./auth-types.userinfo.photourl.md) | string \| null | The profile photo URL of the user. | | [providerId](./auth-types.userinfo.providerid.md) | string | The provider used to authenticate the user. | | [uid](./auth-types.userinfo.uid.md) | string | The user's unique ID, scoped to the project. | diff --git a/docs-exp/auth-types.userinfo.phonenumber.md b/docs-exp/auth-types.userinfo.phonenumber.md index 441d36f0623..777a5f22f1b 100644 --- a/docs-exp/auth-types.userinfo.phonenumber.md +++ b/docs-exp/auth-types.userinfo.phonenumber.md @@ -4,10 +4,15 @@ ## UserInfo.phoneNumber property -The phone number normalized based on the E.164 standard (e.g. +16505550101) for the user. This is null if the user has no phone credential linked to the account. +The phone number normalized based on the E.164 standard (e.g. +16505550101) for the user. Signature: ```typescript readonly phoneNumber: string | null; ``` + +## Remarks + +This is null if the user has no phone credential linked to the account. + diff --git a/docs-exp/auth.actioncodeurl.md b/docs-exp/auth.actioncodeurl.md index 30d65d287c6..5a08dcb6fe2 100644 --- a/docs-exp/auth.actioncodeurl.md +++ b/docs-exp/auth.actioncodeurl.md @@ -21,12 +21,12 @@ export declare class ActionCodeURL implements externs.ActionCodeURL | [code](./auth.actioncodeurl.code.md) | | string | The action code of the email action link. | | [continueUrl](./auth.actioncodeurl.continueurl.md) | | string \| null | The continue URL of the email action link. Null if not provided. | | [languageCode](./auth.actioncodeurl.languagecode.md) | | string \| null | The language code of the email action link. Null if not provided. | -| [operation](./auth.actioncodeurl.operation.md) | | externs.[Operation](./auth-types.operation.md) | The action performed by the email action link. It returns from one of the types from | +| [operation](./auth.actioncodeurl.operation.md) | | externs.[Operation](./auth-types.operation.md) | The action performed by the email action link. It returns from one of the types from [ActionCodeInfo](./auth-types.actioncodeinfo.md) | | [tenantId](./auth.actioncodeurl.tenantid.md) | | string \| null | The tenant ID of the email action link. Null if the email action is from the parent project. | ## Methods | Method | Modifiers | Description | | --- | --- | --- | -| [parseLink(link)](./auth.actioncodeurl.parselink.md) | static | Parses the email action link string and returns an ActionCodeURL object if the link is valid, otherwise returns null. | +| [parseLink(link)](./auth.actioncodeurl.parselink.md) | static | Parses the email action link string and returns an [ActionCodeURL](./auth.actioncodeurl.md) if the link is valid, otherwise returns null. | diff --git a/docs-exp/auth.actioncodeurl.operation.md b/docs-exp/auth.actioncodeurl.operation.md index 0c39873bc6b..d0037033362 100644 --- a/docs-exp/auth.actioncodeurl.operation.md +++ b/docs-exp/auth.actioncodeurl.operation.md @@ -4,7 +4,7 @@ ## ActionCodeURL.operation property -The action performed by the email action link. It returns from one of the types from +The action performed by the email action link. It returns from one of the types from [ActionCodeInfo](./auth-types.actioncodeinfo.md) Signature: diff --git a/docs-exp/auth.actioncodeurl.parselink.md b/docs-exp/auth.actioncodeurl.parselink.md index 4e2861b1efa..2bd17b16c06 100644 --- a/docs-exp/auth.actioncodeurl.parselink.md +++ b/docs-exp/auth.actioncodeurl.parselink.md @@ -4,7 +4,7 @@ ## ActionCodeURL.parseLink() method -Parses the email action link string and returns an ActionCodeURL object if the link is valid, otherwise returns null. +Parses the email action link string and returns an [ActionCodeURL](./auth.actioncodeurl.md) if the link is valid, otherwise returns null. Signature: diff --git a/docs-exp/auth.applyactioncode.md b/docs-exp/auth.applyactioncode.md index c2bcb0f8416..385cc26cbb0 100644 --- a/docs-exp/auth.applyactioncode.md +++ b/docs-exp/auth.applyactioncode.md @@ -4,6 +4,8 @@ ## applyActionCode() function +Applies a verification code sent to the user by email or other out-of-band mechanism. + Signature: ```typescript @@ -14,8 +16,8 @@ export declare function applyActionCode(auth: externs.Auth, oobCode: string): Pr | Parameter | Type | Description | | --- | --- | --- | -| auth | externs.[Auth](./auth-types.auth.md) | | -| oobCode | string | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| oobCode | string | A verification code sent to the user. | Returns: diff --git a/docs-exp/auth.authcredential._constructor_.md b/docs-exp/auth.authcredential._constructor_.md deleted file mode 100644 index b5c53f465e3..00000000000 --- a/docs-exp/auth.authcredential._constructor_.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [AuthCredential](./auth.authcredential.md) > [(constructor)](./auth.authcredential._constructor_.md) - -## AuthCredential.(constructor) - -Constructs a new instance of the `AuthCredential` class - -Signature: - -```typescript -protected constructor(providerId: string, signInMethod: string); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| providerId | string | | -| signInMethod | string | | - diff --git a/docs-exp/auth.authcredential._getidtokenresponse.md b/docs-exp/auth.authcredential._getidtokenresponse.md deleted file mode 100644 index 03c42c19047..00000000000 --- a/docs-exp/auth.authcredential._getidtokenresponse.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [AuthCredential](./auth.authcredential.md) > [\_getIdTokenResponse](./auth.authcredential._getidtokenresponse.md) - -## AuthCredential.\_getIdTokenResponse() method - -Signature: - -```typescript -_getIdTokenResponse(_auth: Auth): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| \_auth | Auth | | - -Returns: - -Promise<PhoneOrOauthTokenResponse> - diff --git a/docs-exp/auth.authcredential._getreauthenticationresolver.md b/docs-exp/auth.authcredential._getreauthenticationresolver.md deleted file mode 100644 index db7f3688f37..00000000000 --- a/docs-exp/auth.authcredential._getreauthenticationresolver.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [AuthCredential](./auth.authcredential.md) > [\_getReauthenticationResolver](./auth.authcredential._getreauthenticationresolver.md) - -## AuthCredential.\_getReauthenticationResolver() method - -Signature: - -```typescript -_getReauthenticationResolver(_auth: Auth): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| \_auth | Auth | | - -Returns: - -Promise<IdTokenResponse> - diff --git a/docs-exp/auth.authcredential._linktoidtoken.md b/docs-exp/auth.authcredential._linktoidtoken.md deleted file mode 100644 index 67bcf7c2ddc..00000000000 --- a/docs-exp/auth.authcredential._linktoidtoken.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [AuthCredential](./auth.authcredential.md) > [\_linkToIdToken](./auth.authcredential._linktoidtoken.md) - -## AuthCredential.\_linkToIdToken() method - -Signature: - -```typescript -_linkToIdToken(_auth: Auth, _idToken: string): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| \_auth | Auth | | -| \_idToken | string | | - -Returns: - -Promise<IdTokenResponse> - diff --git a/docs-exp/auth.authcredential.md b/docs-exp/auth.authcredential.md index 9afaf9f26e8..4347728a76d 100644 --- a/docs-exp/auth.authcredential.md +++ b/docs-exp/auth.authcredential.md @@ -4,17 +4,17 @@ ## AuthCredential class +Interface that represents the credentials returned by an [AuthProvider](./auth-types.authprovider.md). + Signature: ```typescript export declare class AuthCredential ``` -## Constructors +## Remarks -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(providerId, signInMethod)](./auth.authcredential._constructor_.md) | | Constructs a new instance of the AuthCredential class | +Implementations specify the details about each auth provider's credential requirements. ## Properties @@ -27,8 +27,5 @@ export declare class AuthCredential | Method | Modifiers | Description | | --- | --- | --- | -| [\_getIdTokenResponse(\_auth)](./auth.authcredential._getidtokenresponse.md) | | | -| [\_getReauthenticationResolver(\_auth)](./auth.authcredential._getreauthenticationresolver.md) | | | -| [\_linkToIdToken(\_auth, \_idToken)](./auth.authcredential._linktoidtoken.md) | | | -| [toJSON()](./auth.authcredential.tojson.md) | | | +| [toJSON()](./auth.authcredential.tojson.md) | | Returns a JSON-serializable representation of this object. | diff --git a/docs-exp/auth.authcredential.tojson.md b/docs-exp/auth.authcredential.tojson.md index cf6beaa1d04..8f0e14a1957 100644 --- a/docs-exp/auth.authcredential.tojson.md +++ b/docs-exp/auth.authcredential.tojson.md @@ -4,6 +4,8 @@ ## AuthCredential.toJSON() method +Returns a JSON-serializable representation of this object. + Signature: ```typescript @@ -13,3 +15,5 @@ toJSON(): object; object +a JSON-serializable representation of this object. + diff --git a/docs-exp/auth.autherrorcode.md b/docs-exp/auth.autherrorcode.md new file mode 100644 index 00000000000..450c821170f --- /dev/null +++ b/docs-exp/auth.autherrorcode.md @@ -0,0 +1,112 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [AuthErrorCode](./auth.autherrorcode.md) + +## AuthErrorCode enum + +Enumeration of Firebase Auth error codes. + +Signature: + +```typescript +export declare const enum AuthErrorCode +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| ADMIN\_ONLY\_OPERATION | "admin-restricted-operation" | | +| APP\_NOT\_AUTHORIZED | "app-not-authorized" | | +| APP\_NOT\_INSTALLED | "app-not-installed" | | +| ARGUMENT\_ERROR | "argument-error" | | +| CAPTCHA\_CHECK\_FAILED | "captcha-check-failed" | | +| CODE\_EXPIRED | "codeired" | | +| CORDOVA\_NOT\_READY | "cordova-not-ready" | | +| CORS\_UNSUPPORTED | "cors-unsupported" | | +| CREDENTIAL\_ALREADY\_IN\_USE | "credential-already-in-use" | | +| CREDENTIAL\_MISMATCH | "custom-token-mismatch" | | +| CREDENTIAL\_TOO\_OLD\_LOGIN\_AGAIN | "requires-recent-login" | | +| DYNAMIC\_LINK\_NOT\_ACTIVATED | "dynamic-link-not-activated" | | +| EMAIL\_CHANGE\_NEEDS\_VERIFICATION | "email-change-needs-verification" | | +| EMAIL\_EXISTS | "email-already-in-use" | | +| EMULATOR\_CONFIG\_FAILED | "emulator-config-failed" | | +| EXPIRED\_OOB\_CODE | "expired-action-code" | | +| EXPIRED\_POPUP\_REQUEST | "cancelled-popup-request" | | +| INTERNAL\_ERROR | "internal-error" | | +| INVALID\_API\_KEY | "invalid-api-key" | | +| INVALID\_APP\_CREDENTIAL | "invalid-app-credential" | | +| INVALID\_APP\_ID | "invalid-app-id" | | +| INVALID\_AUTH | "invalid-user-token" | | +| INVALID\_AUTH\_EVENT | "invalid-auth-event" | | +| INVALID\_CERT\_HASH | "invalid-cert-hash" | | +| INVALID\_CODE | "invalid-verification-code" | | +| INVALID\_CONTINUE\_URI | "invalid-continue-uri" | | +| INVALID\_CORDOVA\_CONFIGURATION | "invalid-cordova-configuration" | | +| INVALID\_CUSTOM\_TOKEN | "invalid-custom-token" | | +| INVALID\_DYNAMIC\_LINK\_DOMAIN | "invalid-dynamic-link-domain" | | +| INVALID\_EMAIL | "invalid-email" | | +| INVALID\_EMULATOR\_SCHEME | "invalid-emulator-scheme" | | +| INVALID\_IDP\_RESPONSE | "invalid-credential" | | +| INVALID\_MESSAGE\_PAYLOAD | "invalid-message-payload" | | +| INVALID\_MFA\_SESSION | "invalid-multi-factor-session" | | +| INVALID\_OAUTH\_CLIENT\_ID | "invalid-oauth-client-id" | | +| INVALID\_OAUTH\_PROVIDER | "invalid-oauth-provider" | | +| INVALID\_OOB\_CODE | "invalid-action-code" | | +| INVALID\_ORIGIN | "unauthorized-domain" | | +| INVALID\_PASSWORD | "wrong-password" | | +| INVALID\_PERSISTENCE | "invalid-persistence-type" | | +| INVALID\_PHONE\_NUMBER | "invalid-phone-number" | | +| INVALID\_PROVIDER\_ID | "invalid-provider-id" | | +| INVALID\_RECIPIENT\_EMAIL | "invalid-recipient-email" | | +| INVALID\_SENDER | "invalid-sender" | | +| INVALID\_SESSION\_INFO | "invalid-verification-id" | | +| INVALID\_TENANT\_ID | "invalid-tenant-id" | | +| MFA\_INFO\_NOT\_FOUND | "multi-factor-info-not-found" | | +| MFA\_REQUIRED | "multi-factor-auth-required" | | +| MISSING\_ANDROID\_PACKAGE\_NAME | "missing-android-pkg-name" | | +| MISSING\_APP\_CREDENTIAL | "missing-app-credential" | | +| MISSING\_AUTH\_DOMAIN | "auth-domain-config-required" | | +| MISSING\_CODE | "missing-verification-code" | | +| MISSING\_CONTINUE\_URI | "missing-continue-uri" | | +| MISSING\_IFRAME\_START | "missing-iframe-start" | | +| MISSING\_IOS\_BUNDLE\_ID | "missing-ios-bundle-id" | | +| MISSING\_MFA\_INFO | "missing-multi-factor-info" | | +| MISSING\_MFA\_SESSION | "missing-multi-factor-session" | | +| MISSING\_OR\_INVALID\_NONCE | "missing-or-invalid-nonce" | | +| MISSING\_PHONE\_NUMBER | "missing-phone-number" | | +| MISSING\_SESSION\_INFO | "missing-verification-id" | | +| MODULE\_DESTROYED | "app-deleted" | | +| NEED\_CONFIRMATION | "account-exists-with-different-credential" | | +| NETWORK\_REQUEST\_FAILED | "network-request-failed" | | +| NO\_AUTH\_EVENT | "no-auth-event" | | +| NO\_SUCH\_PROVIDER | "no-such-provider" | | +| NULL\_USER | "null-user" | | +| OPERATION\_NOT\_ALLOWED | "operation-not-allowed" | | +| OPERATION\_NOT\_SUPPORTED | "operation-not-supported-in-this-environment" | | +| POPUP\_BLOCKED | "popup-blocked" | | +| POPUP\_CLOSED\_BY\_USER | "popup-closed-by-user" | | +| PROVIDER\_ALREADY\_LINKED | "provider-already-linked" | | +| QUOTA\_EXCEEDED | "quota-exceeded" | | +| REDIRECT\_CANCELLED\_BY\_USER | "redirect-cancelled-by-user" | | +| REDIRECT\_OPERATION\_PENDING | "redirect-operation-pending" | | +| REJECTED\_CREDENTIAL | "rejected-credential" | | +| SECOND\_FACTOR\_ALREADY\_ENROLLED | "second-factor-already-in-use" | | +| SECOND\_FACTOR\_LIMIT\_EXCEEDED | "maximum-second-factor-count-exceeded" | | +| TENANT\_ID\_MISMATCH | "tenant-id-mismatch" | | +| TIMEOUT | "timeout" | | +| TOKEN\_EXPIRED | "user-tokenired" | | +| TOO\_MANY\_ATTEMPTS\_TRY\_LATER | "too-many-requests" | | +| UNAUTHORIZED\_DOMAIN | "unauthorized-continue-uri" | | +| UNSUPPORTED\_FIRST\_FACTOR | "unsupported-first-factor" | | +| UNSUPPORTED\_PERSISTENCE | "unsupported-persistence-type" | | +| UNSUPPORTED\_TENANT\_OPERATION | "unsupported-tenant-operation" | | +| UNVERIFIED\_EMAIL | "unverified-email" | | +| USER\_CANCELLED | "user-cancelled" | | +| USER\_DELETED | "user-not-found" | | +| USER\_DISABLED | "user-disabled" | | +| USER\_MISMATCH | "user-mismatch" | | +| USER\_SIGNED\_OUT | "user-signed-out" | | +| WEAK\_PASSWORD | "weak-password" | | +| WEB\_STORAGE\_UNSUPPORTED | "web-storage-unsupported" | | + diff --git a/docs-exp/auth.browserlocalpersistence.md b/docs-exp/auth.browserlocalpersistence.md index fb783710869..a846510c9dd 100644 --- a/docs-exp/auth.browserlocalpersistence.md +++ b/docs-exp/auth.browserlocalpersistence.md @@ -4,6 +4,8 @@ ## browserLocalPersistence variable +An implementation of [Persistence](./auth-types.persistence.md) of type 'LOCAL' using `localStorage` for the underlying storage. + Signature: ```typescript diff --git a/docs-exp/auth.browserpopupredirectresolver.md b/docs-exp/auth.browserpopupredirectresolver.md index fcf0fe7fd25..6df739e0531 100644 --- a/docs-exp/auth.browserpopupredirectresolver.md +++ b/docs-exp/auth.browserpopupredirectresolver.md @@ -4,6 +4,8 @@ ## browserPopupRedirectResolver variable +An implementation of [PopupRedirectResolver](./auth-types.popupredirectresolver.md) suitable for browser based applications. + Signature: ```typescript diff --git a/docs-exp/auth.browsersessionpersistence.md b/docs-exp/auth.browsersessionpersistence.md index 614260f5092..7eac9aaf80c 100644 --- a/docs-exp/auth.browsersessionpersistence.md +++ b/docs-exp/auth.browsersessionpersistence.md @@ -4,6 +4,8 @@ ## browserSessionPersistence variable +An implementation of [Persistence](./auth-types.persistence.md) of 'SESSION' using `sessionStorage` for the underlying storage. + Signature: ```typescript diff --git a/docs-exp/auth.checkactioncode.md b/docs-exp/auth.checkactioncode.md index 349fd4daba4..ccf313526d6 100644 --- a/docs-exp/auth.checkactioncode.md +++ b/docs-exp/auth.checkactioncode.md @@ -4,6 +4,8 @@ ## checkActionCode() function +Checks a verification code sent to the user by email or other out-of-band mechanism. + Signature: ```typescript @@ -14,10 +16,12 @@ export declare function checkActionCode(auth: externs.Auth, oobCode: string): Pr | Parameter | Type | Description | | --- | --- | --- | -| auth | externs.[Auth](./auth-types.auth.md) | | -| oobCode | string | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| oobCode | string | A verification code sent to the user. | Returns: Promise<externs.[ActionCodeInfo](./auth-types.actioncodeinfo.md)> +metadata about the code. + diff --git a/docs-exp/auth.confirmpasswordreset.md b/docs-exp/auth.confirmpasswordreset.md index 2006eaa961b..13e9cadf7e2 100644 --- a/docs-exp/auth.confirmpasswordreset.md +++ b/docs-exp/auth.confirmpasswordreset.md @@ -4,6 +4,8 @@ ## confirmPasswordReset() function +Completes the password reset process, given a confirmation code and new password. + Signature: ```typescript @@ -14,9 +16,9 @@ export declare function confirmPasswordReset(auth: externs.Auth, oobCode: string | Parameter | Type | Description | | --- | --- | --- | -| auth | externs.[Auth](./auth-types.auth.md) | | -| oobCode | string | | -| newPassword | string | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| oobCode | string | A confirmation code sent to the user. | +| newPassword | string | The new password. | Returns: diff --git a/docs-exp/auth.createuserwithemailandpassword.md b/docs-exp/auth.createuserwithemailandpassword.md index 9b7b66ab58f..93ca9766bff 100644 --- a/docs-exp/auth.createuserwithemailandpassword.md +++ b/docs-exp/auth.createuserwithemailandpassword.md @@ -4,6 +4,8 @@ ## createUserWithEmailAndPassword() function +Creates a new user account associated with the specified email address and password. + Signature: ```typescript @@ -14,11 +16,19 @@ export declare function createUserWithEmailAndPassword(auth: externs.Auth, email | Parameter | Type | Description | | --- | --- | --- | -| auth | externs.[Auth](./auth-types.auth.md) | | -| email | string | | -| password | string | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| email | string | The user's email address. | +| password | string | The user's chosen password. | Returns: Promise<externs.[UserCredential](./auth-types.usercredential.md)> +## Remarks + +On successful creation of the user account, this user will also be signed in to your application. + +User account creation can fail if the account already exists or the password is invalid. + +Note: The email address acts as a unique identifier for the user and enables an email-based password reset. This function will create a new user account and set the initial user password. + diff --git a/docs-exp/auth.customparameters.md b/docs-exp/auth.customparameters.md new file mode 100644 index 00000000000..4e1885a051c --- /dev/null +++ b/docs-exp/auth.customparameters.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [CustomParameters](./auth.customparameters.md) + +## CustomParameters type + +Map of OAuth Custom Parameters. + +Signature: + +```typescript +export declare type CustomParameters = Record; +``` diff --git a/docs-exp/auth.deleteuser.md b/docs-exp/auth.deleteuser.md index 3cc1811f228..fc11944e6be 100644 --- a/docs-exp/auth.deleteuser.md +++ b/docs-exp/auth.deleteuser.md @@ -4,6 +4,8 @@ ## deleteUser() function +Deletes and signs out the user. + Signature: ```typescript @@ -14,9 +16,13 @@ export declare function deleteUser(user: externs.User): Promise; | Parameter | Type | Description | | --- | --- | --- | -| user | externs.[User](./auth-types.user.md) | | +| user | externs.[User](./auth-types.user.md) | The user. | Returns: Promise<void> +## Remarks + +Important: this is a security-sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and then call [reauthenticateWithCredential()](./auth.reauthenticatewithcredential.md). + diff --git a/docs-exp/auth.emailauthcredential._fromemailandcode.md b/docs-exp/auth.emailauthcredential._fromemailandcode.md deleted file mode 100644 index e446f40f791..00000000000 --- a/docs-exp/auth.emailauthcredential._fromemailandcode.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthCredential](./auth.emailauthcredential.md) > [\_fromEmailAndCode](./auth.emailauthcredential._fromemailandcode.md) - -## EmailAuthCredential.\_fromEmailAndCode() method - -Signature: - -```typescript -static _fromEmailAndCode(email: string, oobCode: string, tenantId?: string | null): EmailAuthCredential; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| email | string | | -| oobCode | string | | -| tenantId | string \| null | | - -Returns: - -[EmailAuthCredential](./auth.emailauthcredential.md) - diff --git a/docs-exp/auth.emailauthcredential._fromemailandpassword.md b/docs-exp/auth.emailauthcredential._fromemailandpassword.md deleted file mode 100644 index f362d10f488..00000000000 --- a/docs-exp/auth.emailauthcredential._fromemailandpassword.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthCredential](./auth.emailauthcredential.md) > [\_fromEmailAndPassword](./auth.emailauthcredential._fromemailandpassword.md) - -## EmailAuthCredential.\_fromEmailAndPassword() method - -Signature: - -```typescript -static _fromEmailAndPassword(email: string, password: string): EmailAuthCredential; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| email | string | | -| password | string | | - -Returns: - -[EmailAuthCredential](./auth.emailauthcredential.md) - diff --git a/docs-exp/auth.emailauthcredential._getidtokenresponse.md b/docs-exp/auth.emailauthcredential._getidtokenresponse.md deleted file mode 100644 index 15535401477..00000000000 --- a/docs-exp/auth.emailauthcredential._getidtokenresponse.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthCredential](./auth.emailauthcredential.md) > [\_getIdTokenResponse](./auth.emailauthcredential._getidtokenresponse.md) - -## EmailAuthCredential.\_getIdTokenResponse() method - -Signature: - -```typescript -_getIdTokenResponse(auth: Auth): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| auth | Auth | | - -Returns: - -Promise<IdTokenResponse> - diff --git a/docs-exp/auth.emailauthcredential._getreauthenticationresolver.md b/docs-exp/auth.emailauthcredential._getreauthenticationresolver.md deleted file mode 100644 index 7b8eadfbff1..00000000000 --- a/docs-exp/auth.emailauthcredential._getreauthenticationresolver.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthCredential](./auth.emailauthcredential.md) > [\_getReauthenticationResolver](./auth.emailauthcredential._getreauthenticationresolver.md) - -## EmailAuthCredential.\_getReauthenticationResolver() method - -Signature: - -```typescript -_getReauthenticationResolver(auth: Auth): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| auth | Auth | | - -Returns: - -Promise<IdTokenResponse> - diff --git a/docs-exp/auth.emailauthcredential._linktoidtoken.md b/docs-exp/auth.emailauthcredential._linktoidtoken.md deleted file mode 100644 index ea4f92b5264..00000000000 --- a/docs-exp/auth.emailauthcredential._linktoidtoken.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [EmailAuthCredential](./auth.emailauthcredential.md) > [\_linkToIdToken](./auth.emailauthcredential._linktoidtoken.md) - -## EmailAuthCredential.\_linkToIdToken() method - -Signature: - -```typescript -_linkToIdToken(auth: Auth, idToken: string): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| auth | Auth | | -| idToken | string | | - -Returns: - -Promise<IdTokenResponse> - diff --git a/docs-exp/auth.emailauthcredential.fromjson.md b/docs-exp/auth.emailauthcredential.fromjson.md index 9b59922d1d9..bd95b276755 100644 --- a/docs-exp/auth.emailauthcredential.fromjson.md +++ b/docs-exp/auth.emailauthcredential.fromjson.md @@ -4,6 +4,8 @@ ## EmailAuthCredential.fromJSON() method +Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth-types.authcredential.md). + Signature: ```typescript @@ -14,9 +16,11 @@ static fromJSON(json: object | string): EmailAuthCredential | null; | Parameter | Type | Description | | --- | --- | --- | -| json | object \| string | | +| json | object \| string | Either object or the stringified representation of the object. When string is provided, JSON.parse would be called first. | Returns: [EmailAuthCredential](./auth.emailauthcredential.md) \| null +If the JSON input does not represent an [AuthCredential](./auth-types.authcredential.md), null is returned. + diff --git a/docs-exp/auth.emailauthcredential.md b/docs-exp/auth.emailauthcredential.md index d4c4de7cb10..32cd74b80cc 100644 --- a/docs-exp/auth.emailauthcredential.md +++ b/docs-exp/auth.emailauthcredential.md @@ -4,6 +4,8 @@ ## EmailAuthCredential class +Interface that represents the credentials returned by [EmailAuthProvider](./auth.emailauthprovider.md) for [ProviderId.PASSWORD](./auth-types.providerid.password.md) + Signature: ```typescript @@ -13,6 +15,12 @@ export declare class EmailAuthCredential extends AuthCredential implements exter Implements: externs.[AuthCredential](./auth-types.authcredential.md) +## Remarks + +Covers both [SignInMethod.EMAIL\_PASSWORD](./auth-types.signinmethod.email_password.md) and [SignInMethod.EMAIL\_LINK](./auth-types.signinmethod.email_link.md). + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `EmailAuthCredential` class. + ## Properties | Property | Modifiers | Type | Description | @@ -25,11 +33,6 @@ export declare class EmailAuthCredential extends AuthCredential implements exter | Method | Modifiers | Description | | --- | --- | --- | -| [\_fromEmailAndCode(email, oobCode, tenantId)](./auth.emailauthcredential._fromemailandcode.md) | static | | -| [\_fromEmailAndPassword(email, password)](./auth.emailauthcredential._fromemailandpassword.md) | static | | -| [\_getIdTokenResponse(auth)](./auth.emailauthcredential._getidtokenresponse.md) | | | -| [\_getReauthenticationResolver(auth)](./auth.emailauthcredential._getreauthenticationresolver.md) | | | -| [\_linkToIdToken(auth, idToken)](./auth.emailauthcredential._linktoidtoken.md) | | | -| [fromJSON(json)](./auth.emailauthcredential.fromjson.md) | static | | -| [toJSON()](./auth.emailauthcredential.tojson.md) | | | +| [fromJSON(json)](./auth.emailauthcredential.fromjson.md) | static | Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth-types.authcredential.md). | +| [toJSON()](./auth.emailauthcredential.tojson.md) | | Returns a JSON-serializable representation of this object. | diff --git a/docs-exp/auth.emailauthcredential.tojson.md b/docs-exp/auth.emailauthcredential.tojson.md index 2c361c80906..b86cfb260b2 100644 --- a/docs-exp/auth.emailauthcredential.tojson.md +++ b/docs-exp/auth.emailauthcredential.tojson.md @@ -4,6 +4,8 @@ ## EmailAuthCredential.toJSON() method +Returns a JSON-serializable representation of this object. + Signature: ```typescript @@ -13,3 +15,5 @@ toJSON(): object; object +a JSON-serializable representation of this object. + diff --git a/docs-exp/auth.emailauthprovider.credential.md b/docs-exp/auth.emailauthprovider.credential.md index 259c895d748..3823a90de40 100644 --- a/docs-exp/auth.emailauthprovider.credential.md +++ b/docs-exp/auth.emailauthprovider.credential.md @@ -4,6 +4,8 @@ ## EmailAuthProvider.credential() method +Initialize an [AuthCredential](./auth-types.authcredential.md) using an email and password. + Signature: ```typescript @@ -14,10 +16,12 @@ static credential(email: string, password: string): EmailAuthCredential; | Parameter | Type | Description | | --- | --- | --- | -| email | string | | -| password | string | | +| email | string | Email address. | +| password | string | User account password. | Returns: [EmailAuthCredential](./auth.emailauthcredential.md) +The auth provider credential. + diff --git a/docs-exp/auth.emailauthprovider.credentialwithlink.md b/docs-exp/auth.emailauthprovider.credentialwithlink.md index 63f44a625f8..7259619db4d 100644 --- a/docs-exp/auth.emailauthprovider.credentialwithlink.md +++ b/docs-exp/auth.emailauthprovider.credentialwithlink.md @@ -4,6 +4,8 @@ ## EmailAuthProvider.credentialWithLink() method +Initialize an [AuthCredential](./auth-types.authcredential.md) using an email and an email link after a sign in with email link operation. + Signature: ```typescript @@ -14,10 +16,12 @@ static credentialWithLink(email: string, emailLink: string): EmailAuthCredential | Parameter | Type | Description | | --- | --- | --- | -| email | string | | -| emailLink | string | | +| email | string | Email address. | +| emailLink | string | Sign-in email link. | Returns: [EmailAuthCredential](./auth.emailauthcredential.md) +- The auth provider credential. + diff --git a/docs-exp/auth.emailauthprovider.email_link_sign_in_method.md b/docs-exp/auth.emailauthprovider.email_link_sign_in_method.md index 88cb9fa850d..27b116fb2f2 100644 --- a/docs-exp/auth.emailauthprovider.email_link_sign_in_method.md +++ b/docs-exp/auth.emailauthprovider.email_link_sign_in_method.md @@ -4,6 +4,8 @@ ## EmailAuthProvider.EMAIL\_LINK\_SIGN\_IN\_METHOD property +Always set to [SignInMethod.EMAIL\_LINK](./auth-types.signinmethod.email_link.md). + Signature: ```typescript diff --git a/docs-exp/auth.emailauthprovider.email_password_sign_in_method.md b/docs-exp/auth.emailauthprovider.email_password_sign_in_method.md index 35e1392dc4f..5100808d9ed 100644 --- a/docs-exp/auth.emailauthprovider.email_password_sign_in_method.md +++ b/docs-exp/auth.emailauthprovider.email_password_sign_in_method.md @@ -4,6 +4,8 @@ ## EmailAuthProvider.EMAIL\_PASSWORD\_SIGN\_IN\_METHOD property +Always set to [SignInMethod.EMAIL\_PASSWORD](./auth-types.signinmethod.email_password.md). + Signature: ```typescript diff --git a/docs-exp/auth.emailauthprovider.md b/docs-exp/auth.emailauthprovider.md index 3908a331975..2ea58213b60 100644 --- a/docs-exp/auth.emailauthprovider.md +++ b/docs-exp/auth.emailauthprovider.md @@ -4,6 +4,8 @@ ## EmailAuthProvider class +Provider for generating [EmailAuthCredential](./auth.emailauthcredential.md). + Signature: ```typescript @@ -15,15 +17,15 @@ export declare class EmailAuthProvider implements externs.EmailAuthProvider | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [EMAIL\_LINK\_SIGN\_IN\_METHOD](./auth.emailauthprovider.email_link_sign_in_method.md) | static | (not declared) | | -| [EMAIL\_PASSWORD\_SIGN\_IN\_METHOD](./auth.emailauthprovider.email_password_sign_in_method.md) | static | (not declared) | | -| [PROVIDER\_ID](./auth.emailauthprovider.provider_id.md) | static | (not declared) | | -| [providerId](./auth.emailauthprovider.providerid.md) | | (not declared) | | +| [EMAIL\_LINK\_SIGN\_IN\_METHOD](./auth.emailauthprovider.email_link_sign_in_method.md) | static | (not declared) | Always set to [SignInMethod.EMAIL\_LINK](./auth-types.signinmethod.email_link.md). | +| [EMAIL\_PASSWORD\_SIGN\_IN\_METHOD](./auth.emailauthprovider.email_password_sign_in_method.md) | static | (not declared) | Always set to [SignInMethod.EMAIL\_PASSWORD](./auth-types.signinmethod.email_password.md). | +| [PROVIDER\_ID](./auth.emailauthprovider.provider_id.md) | static | (not declared) | Always set to [ProviderId.PASSWORD](./auth-types.providerid.password.md), even for email link. | +| [providerId](./auth.emailauthprovider.providerid.md) | | (not declared) | Always set to [ProviderId.PASSWORD](./auth-types.providerid.password.md), even for email link. | ## Methods | Method | Modifiers | Description | | --- | --- | --- | -| [credential(email, password)](./auth.emailauthprovider.credential.md) | static | | -| [credentialWithLink(email, emailLink)](./auth.emailauthprovider.credentialwithlink.md) | static | | +| [credential(email, password)](./auth.emailauthprovider.credential.md) | static | Initialize an [AuthCredential](./auth-types.authcredential.md) using an email and password. | +| [credentialWithLink(email, emailLink)](./auth.emailauthprovider.credentialwithlink.md) | static | Initialize an [AuthCredential](./auth-types.authcredential.md) using an email and an email link after a sign in with email link operation. | diff --git a/docs-exp/auth.emailauthprovider.provider_id.md b/docs-exp/auth.emailauthprovider.provider_id.md index f0ee1c8473f..fdd3151c33d 100644 --- a/docs-exp/auth.emailauthprovider.provider_id.md +++ b/docs-exp/auth.emailauthprovider.provider_id.md @@ -4,6 +4,8 @@ ## EmailAuthProvider.PROVIDER\_ID property +Always set to [ProviderId.PASSWORD](./auth-types.providerid.password.md), even for email link. + Signature: ```typescript diff --git a/docs-exp/auth.emailauthprovider.providerid.md b/docs-exp/auth.emailauthprovider.providerid.md index 78f44363bf5..829f61672a7 100644 --- a/docs-exp/auth.emailauthprovider.providerid.md +++ b/docs-exp/auth.emailauthprovider.providerid.md @@ -4,6 +4,8 @@ ## EmailAuthProvider.providerId property +Always set to [ProviderId.PASSWORD](./auth-types.providerid.password.md), even for email link. + Signature: ```typescript diff --git a/docs-exp/auth.facebookauthprovider.credential.md b/docs-exp/auth.facebookauthprovider.credential.md index afbb7920b65..8d4eb8a667e 100644 --- a/docs-exp/auth.facebookauthprovider.credential.md +++ b/docs-exp/auth.facebookauthprovider.credential.md @@ -4,6 +4,8 @@ ## FacebookAuthProvider.credential() method +Creates a credential for Facebook. + Signature: ```typescript @@ -14,9 +16,19 @@ static credential(accessToken: string): externs.OAuthCredential; | Parameter | Type | Description | | --- | --- | --- | -| accessToken | string | | +| accessToken | string | Facebook access token. | Returns: externs.[OAuthCredential](./auth-types.oauthcredential.md) +## Example + + +```javascript +// `event` from the Facebook auth.authResponseChange callback. +const credential = FacebookAuthProvider.credential(event.authResponse.accessToken); +const result = await signInWithCredential(credential); + +``` + diff --git a/docs-exp/auth.facebookauthprovider.credentialfromerror.md b/docs-exp/auth.facebookauthprovider.credentialfromerror.md index a0db89a729a..8142b18cc0c 100644 --- a/docs-exp/auth.facebookauthprovider.credentialfromerror.md +++ b/docs-exp/auth.facebookauthprovider.credentialfromerror.md @@ -4,6 +4,8 @@ ## FacebookAuthProvider.credentialFromError() method +Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [AuthError](./auth-types.autherror.md) which was thrown during a sign-in, link, or reauthenticate operation. + Signature: ```typescript diff --git a/docs-exp/auth.facebookauthprovider.credentialfromresult.md b/docs-exp/auth.facebookauthprovider.credentialfromresult.md index 30b05a61011..1154ce073ea 100644 --- a/docs-exp/auth.facebookauthprovider.credentialfromresult.md +++ b/docs-exp/auth.facebookauthprovider.credentialfromresult.md @@ -4,6 +4,8 @@ ## FacebookAuthProvider.credentialFromResult() method +Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [UserCredential](./auth-types.usercredential.md). + Signature: ```typescript @@ -14,7 +16,7 @@ static credentialFromResult(userCredential: externs.UserCredential): externs.OAu | Parameter | Type | Description | | --- | --- | --- | -| userCredential | externs.[UserCredential](./auth-types.usercredential.md) | | +| userCredential | externs.[UserCredential](./auth-types.usercredential.md) | The user credential. | Returns: diff --git a/docs-exp/auth.facebookauthprovider.facebook_sign_in_method.md b/docs-exp/auth.facebookauthprovider.facebook_sign_in_method.md index 80627f8c3f6..b7983b23a12 100644 --- a/docs-exp/auth.facebookauthprovider.facebook_sign_in_method.md +++ b/docs-exp/auth.facebookauthprovider.facebook_sign_in_method.md @@ -4,6 +4,8 @@ ## FacebookAuthProvider.FACEBOOK\_SIGN\_IN\_METHOD property +Always set to [SignInMethod.FACEBOOK](./auth-types.signinmethod.facebook.md). + Signature: ```typescript diff --git a/docs-exp/auth.facebookauthprovider.md b/docs-exp/auth.facebookauthprovider.md index 18ab266365a..a40663c50d7 100644 --- a/docs-exp/auth.facebookauthprovider.md +++ b/docs-exp/auth.facebookauthprovider.md @@ -4,6 +4,8 @@ ## FacebookAuthProvider class +Provider for generating an [OAuthCredential](./auth.oauthcredential.md) for [ProviderId.FACEBOOK](./auth-types.providerid.facebook.md). + Signature: ```typescript @@ -11,6 +13,46 @@ export declare class FacebookAuthProvider extends OAuthProvider ``` Extends: [OAuthProvider](./auth.oauthprovider.md) +## Example 1 + + +```javascript +// Sign in using a redirect. +const provider = new FacebookAuthProvider(); +// Start a sign in process for an unauthenticated user. +provider.addScope('user_birthday'); +await signInWithRedirect(auth, provider); +// This will trigger a full page redirect away from your app + +// After returning from the redirect when your app initializes you can obtain the result +const result = await getRedirectResult(auth); +if (result) { + // This is the signed-in user + const user = result.user; + // This gives you a Facebook Access Token. + const credential = provider.credentialFromResult(auth, result); + const token = credential.accessToken; +} + +``` + +## Example 2 + + +```javascript +// Sign in using a popup. +const provider = new FacebookAuthProvider(); +provider.addScope('user_birthday'); +const result = await signInWithPopup(auth, provider); + +// The signed-in user info. +const user = result.user; +// This gives you a Facebook Access Token. +const credential = provider.credentialFromResult(auth, result); +const token = credential.accessToken; + +``` + ## Constructors | Constructor | Modifiers | Description | @@ -21,14 +63,14 @@ export declare class FacebookAuthProvider extends OAuthProvider | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [FACEBOOK\_SIGN\_IN\_METHOD](./auth.facebookauthprovider.facebook_sign_in_method.md) | static | (not declared) | | -| [PROVIDER\_ID](./auth.facebookauthprovider.provider_id.md) | static | (not declared) | | +| [FACEBOOK\_SIGN\_IN\_METHOD](./auth.facebookauthprovider.facebook_sign_in_method.md) | static | (not declared) | Always set to [SignInMethod.FACEBOOK](./auth-types.signinmethod.facebook.md). | +| [PROVIDER\_ID](./auth.facebookauthprovider.provider_id.md) | static | (not declared) | Always set to [ProviderId.FACEBOOK](./auth-types.providerid.facebook.md). | ## Methods | Method | Modifiers | Description | | --- | --- | --- | -| [credential(accessToken)](./auth.facebookauthprovider.credential.md) | static | | -| [credentialFromError(error)](./auth.facebookauthprovider.credentialfromerror.md) | static | | -| [credentialFromResult(userCredential)](./auth.facebookauthprovider.credentialfromresult.md) | static | | +| [credential(accessToken)](./auth.facebookauthprovider.credential.md) | static | Creates a credential for Facebook. | +| [credentialFromError(error)](./auth.facebookauthprovider.credentialfromerror.md) | static | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [AuthError](./auth-types.autherror.md) which was thrown during a sign-in, link, or reauthenticate operation. | +| [credentialFromResult(userCredential)](./auth.facebookauthprovider.credentialfromresult.md) | static | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [UserCredential](./auth-types.usercredential.md). | diff --git a/docs-exp/auth.facebookauthprovider.provider_id.md b/docs-exp/auth.facebookauthprovider.provider_id.md index 22f95748f94..15e0aadc316 100644 --- a/docs-exp/auth.facebookauthprovider.provider_id.md +++ b/docs-exp/auth.facebookauthprovider.provider_id.md @@ -4,6 +4,8 @@ ## FacebookAuthProvider.PROVIDER\_ID property +Always set to [ProviderId.FACEBOOK](./auth-types.providerid.facebook.md). + Signature: ```typescript diff --git a/docs-exp/auth.facebookauthprovider.providerid.md b/docs-exp/auth.facebookauthprovider.providerid.md deleted file mode 100644 index 7af0f4f7b13..00000000000 --- a/docs-exp/auth.facebookauthprovider.providerid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [FacebookAuthProvider](./auth.facebookauthprovider.md) > [providerId](./auth.facebookauthprovider.providerid.md) - -## FacebookAuthProvider.providerId property - -Signature: - -```typescript -readonly providerId = externs.ProviderId.FACEBOOK; -``` diff --git a/docs-exp/auth.fetchsigninmethodsforemail.md b/docs-exp/auth.fetchsigninmethodsforemail.md index 4dc3362b6b1..2469df1ac6e 100644 --- a/docs-exp/auth.fetchsigninmethodsforemail.md +++ b/docs-exp/auth.fetchsigninmethodsforemail.md @@ -4,6 +4,8 @@ ## fetchSignInMethodsForEmail() function +Gets the list of possible sign in methods for the given email address. + Signature: ```typescript @@ -14,10 +16,14 @@ export declare function fetchSignInMethodsForEmail(auth: externs.Auth, email: st | Parameter | Type | Description | | --- | --- | --- | -| auth | externs.[Auth](./auth-types.auth.md) | | -| email | string | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| email | string | The user's email address. | Returns: Promise<string\[\]> +## Remarks + +This is useful to differentiate methods of sign-in for the same provider, eg. [EmailAuthProvider](./auth.emailauthprovider.md) which has 2 methods of sign-in, [SignInMethod.EMAIL\_PASSWORD](./auth-types.signinmethod.email_password.md) and [SignInMethod.EMAIL\_LINK](./auth-types.signinmethod.email_link.md) . + diff --git a/docs-exp/auth.getadditionaluserinfo.md b/docs-exp/auth.getadditionaluserinfo.md index 126ec9e41ed..8b89e12652b 100644 --- a/docs-exp/auth.getadditionaluserinfo.md +++ b/docs-exp/auth.getadditionaluserinfo.md @@ -4,6 +4,8 @@ ## getAdditionalUserInfo() function +Extracts provider specific [AdditionalUserInfo](./auth-types.additionaluserinfo.md) for the given credential. + Signature: ```typescript @@ -14,7 +16,7 @@ export declare function getAdditionalUserInfo(userCredential: externs.UserCreden | Parameter | Type | Description | | --- | --- | --- | -| userCredential | externs.[UserCredential](./auth-types.usercredential.md) | | +| userCredential | externs.[UserCredential](./auth-types.usercredential.md) | The user credential. | Returns: diff --git a/docs-exp/auth.getauth.md b/docs-exp/auth.getauth.md index 0dab35d0fff..47606120cf9 100644 --- a/docs-exp/auth.getauth.md +++ b/docs-exp/auth.getauth.md @@ -4,6 +4,8 @@ ## getAuth() function +Initializes an Auth instance with platform specific default dependencies. + Signature: ```typescript @@ -14,7 +16,7 @@ export declare function getAuth(app?: FirebaseApp): Auth; | Parameter | Type | Description | | --- | --- | --- | -| app | [FirebaseApp](./app-types.firebaseapp.md) | | +| app | [FirebaseApp](./app-types.firebaseapp.md) | The Firebase App. | Returns: diff --git a/docs-exp/auth.getidtoken.md b/docs-exp/auth.getidtoken.md index 3824d79ed81..93aff76670b 100644 --- a/docs-exp/auth.getidtoken.md +++ b/docs-exp/auth.getidtoken.md @@ -4,6 +4,8 @@ ## getIdToken() function +Returns a JSON Web Token (JWT) used to identify the user to a Firebase service. + Signature: ```typescript @@ -14,10 +16,14 @@ export declare function getIdToken(user: externs.User, forceRefresh?: boolean): | Parameter | Type | Description | | --- | --- | --- | -| user | externs.[User](./auth-types.user.md) | | -| forceRefresh | boolean | | +| user | externs.[User](./auth-types.user.md) | The user. | +| forceRefresh | boolean | Force refresh regardless of token expiration. | Returns: Promise<string> +## Remarks + +Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one. + diff --git a/docs-exp/auth.getidtokenresult.md b/docs-exp/auth.getidtokenresult.md index ff8e33424ee..0df9a2685d6 100644 --- a/docs-exp/auth.getidtokenresult.md +++ b/docs-exp/auth.getidtokenresult.md @@ -4,20 +4,26 @@ ## getIdTokenResult() function +Returns a deserialized JSON Web Token (JWT) used to identitfy the user to a Firebase service. + Signature: ```typescript -export declare function getIdTokenResult(externUser: externs.User, forceRefresh?: boolean): Promise; +export declare function getIdTokenResult(user: externs.User, forceRefresh?: boolean): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| externUser | externs.[User](./auth-types.user.md) | | -| forceRefresh | boolean | | +| user | externs.[User](./auth-types.user.md) | The user. | +| forceRefresh | boolean | Force refresh regardless of token expiration. | Returns: Promise<externs.[IdTokenResult](./auth-types.idtokenresult.md)> +## Remarks + +Returns the current token if it has not expired or if it will not expire in the next five minutes. Otherwise, this will refresh the token and return a new one. + diff --git a/docs-exp/auth.getmultifactorresolver.md b/docs-exp/auth.getmultifactorresolver.md index eace552c52b..f9dc4834866 100644 --- a/docs-exp/auth.getmultifactorresolver.md +++ b/docs-exp/auth.getmultifactorresolver.md @@ -4,18 +4,20 @@ ## getMultiFactorResolver() function +Provides a [MultiFactorResolver](./auth-types.multifactorresolver.md) suitable for completion of a multi-factor flow. + Signature: ```typescript -export declare function getMultiFactorResolver(auth: externs.Auth, errorExtern: externs.MultiFactorError): externs.MultiFactorResolver; +export declare function getMultiFactorResolver(auth: externs.Auth, error: externs.MultiFactorError): externs.MultiFactorResolver; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| auth | externs.[Auth](./auth-types.auth.md) | | -| errorExtern | externs.[MultiFactorError](./auth-types.multifactorerror.md) | | +| auth | externs.[Auth](./auth-types.auth.md) | The auth instance. | +| error | externs.[MultiFactorError](./auth-types.multifactorerror.md) | The [MultiFactorError](./auth-types.multifactorerror.md) raised during a sign-in, or reauthentication operation. | Returns: diff --git a/docs-exp/auth.getredirectresult.md b/docs-exp/auth.getredirectresult.md index 1a793eb5f1e..55e76c9ea97 100644 --- a/docs-exp/auth.getredirectresult.md +++ b/docs-exp/auth.getredirectresult.md @@ -4,20 +4,54 @@ ## getRedirectResult() function +Returns a [UserCredential](./auth-types.usercredential.md) from the redirect-based sign-in flow. + Signature: ```typescript -export declare function getRedirectResult(authExtern: externs.Auth, resolverExtern?: externs.PopupRedirectResolver): Promise; +export declare function getRedirectResult(auth: externs.Auth, resolver?: externs.PopupRedirectResolver): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| authExtern | externs.[Auth](./auth-types.auth.md) | | -| resolverExtern | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| resolver | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | An instance of [PopupRedirectResolver](./auth-types.popupredirectresolver.md), optional if already supplied to [initializeAuth()](./auth.initializeauth.md) or provided by [getAuth()](./auth.getauth.md). | Returns: Promise<externs.[UserCredential](./auth-types.usercredential.md) \| null> +## Remarks + +If sign-in succeeded, returns the signed in user. If sign-in was unsuccessful, fails with an error. If no redirect operation was called, returns a [UserCredential](./auth-types.usercredential.md) with a null `user`. + +## Example + + +```javascript +// Sign in using a redirect. +const provider = new FacebookAuthProvider(); +// You can add additional scopes to the provider: +provider.addScope('user_birthday'); +// Start a sign in process for an unauthenticated user. +await signInWithRedirect(auth, provider); +// This will trigger a full page redirect away from your app + +// After returning from the redirect when your app initializes you can obtain the result +const result = await getRedirectResult(auth); +if (result) { + // This is the signed-in user + const user = result.user; + // This gives you a Facebook Access Token. + const credential = provider.credentialFromResult(auth, result); + const token = credential.accessToken; +} +// As this API can be used for sign-in, linking and reauthentication, +// check the operationType to determine what triggered this redirect +// operation. +const operationType = result.operationType; + +``` + diff --git a/docs-exp/auth.githubauthprovider.credential.md b/docs-exp/auth.githubauthprovider.credential.md index 19ea0dd2857..ff58ea6f4f9 100644 --- a/docs-exp/auth.githubauthprovider.credential.md +++ b/docs-exp/auth.githubauthprovider.credential.md @@ -4,6 +4,8 @@ ## GithubAuthProvider.credential() method +Creates a credential for Github. + Signature: ```typescript @@ -14,7 +16,7 @@ static credential(accessToken: string): externs.OAuthCredential; | Parameter | Type | Description | | --- | --- | --- | -| accessToken | string | | +| accessToken | string | Github access token. | Returns: diff --git a/docs-exp/auth.githubauthprovider.credentialfromerror.md b/docs-exp/auth.githubauthprovider.credentialfromerror.md index 1735880b10d..728439b95a2 100644 --- a/docs-exp/auth.githubauthprovider.credentialfromerror.md +++ b/docs-exp/auth.githubauthprovider.credentialfromerror.md @@ -4,6 +4,8 @@ ## GithubAuthProvider.credentialFromError() method +Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [AuthError](./auth-types.autherror.md) which was thrown during a sign-in, link, or reauthenticate operation. + Signature: ```typescript diff --git a/docs-exp/auth.githubauthprovider.credentialfromresult.md b/docs-exp/auth.githubauthprovider.credentialfromresult.md index 0705a1dd58a..45f311de277 100644 --- a/docs-exp/auth.githubauthprovider.credentialfromresult.md +++ b/docs-exp/auth.githubauthprovider.credentialfromresult.md @@ -4,6 +4,8 @@ ## GithubAuthProvider.credentialFromResult() method +Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [UserCredential](./auth-types.usercredential.md). + Signature: ```typescript @@ -14,7 +16,7 @@ static credentialFromResult(userCredential: externs.UserCredential): externs.OAu | Parameter | Type | Description | | --- | --- | --- | -| userCredential | externs.[UserCredential](./auth-types.usercredential.md) | | +| userCredential | externs.[UserCredential](./auth-types.usercredential.md) | The user credential. | Returns: diff --git a/docs-exp/auth.githubauthprovider.github_sign_in_method.md b/docs-exp/auth.githubauthprovider.github_sign_in_method.md index 0ceb5771f6f..2c5c2f3e770 100644 --- a/docs-exp/auth.githubauthprovider.github_sign_in_method.md +++ b/docs-exp/auth.githubauthprovider.github_sign_in_method.md @@ -4,6 +4,8 @@ ## GithubAuthProvider.GITHUB\_SIGN\_IN\_METHOD property +Always set to [SignInMethod.GITHUB](./auth-types.signinmethod.github.md). + Signature: ```typescript diff --git a/docs-exp/auth.githubauthprovider.md b/docs-exp/auth.githubauthprovider.md index 8a19d9676ba..b17d82e1eaf 100644 --- a/docs-exp/auth.githubauthprovider.md +++ b/docs-exp/auth.githubauthprovider.md @@ -4,6 +4,8 @@ ## GithubAuthProvider class +Provider for generating an [OAuthCredential](./auth.oauthcredential.md) for [ProviderId.GITHUB](./auth-types.providerid.github.md). + Signature: ```typescript @@ -11,6 +13,50 @@ export declare class GithubAuthProvider extends OAuthProvider ``` Extends: [OAuthProvider](./auth.oauthprovider.md) +## Remarks + +GitHub requires an OAuth 2.0 redirect, so you can either handle the redirect directly, or use the [signInWithPopup()](./auth.signinwithpopup.md) handler: + +## Example 1 + + +```javascript +// Sign in using a redirect. +const provider = new GithubAuthProvider(); +// Start a sign in process for an unauthenticated user. +provider.addScope('repo'); +await signInWithRedirect(auth, provider); +// This will trigger a full page redirect away from your app + +// After returning from the redirect when your app initializes you can obtain the result +const result = await getRedirectResult(auth); +if (result) { + // This is the signed-in user + const user = result.user; + // This gives you a Github Access Token. + const credential = provider.credentialFromResult(auth, result); + const token = credential.accessToken; +} + +``` + +## Example 2 + + +```javascript +// Sign in using a popup. +const provider = new GithubAuthProvider(); +provider.addScope('repo'); +const result = await signInWithPopup(auth, provider); + +// The signed-in user info. +const user = result.user; +// This gives you a Github Access Token. +const credential = provider.credentialFromResult(auth, result); +const token = credential.accessToken; + +``` + ## Constructors | Constructor | Modifiers | Description | @@ -21,14 +67,14 @@ export declare class GithubAuthProvider extends OAuthProvider | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [GITHUB\_SIGN\_IN\_METHOD](./auth.githubauthprovider.github_sign_in_method.md) | static | (not declared) | | -| [PROVIDER\_ID](./auth.githubauthprovider.provider_id.md) | static | (not declared) | | +| [GITHUB\_SIGN\_IN\_METHOD](./auth.githubauthprovider.github_sign_in_method.md) | static | (not declared) | Always set to [SignInMethod.GITHUB](./auth-types.signinmethod.github.md). | +| [PROVIDER\_ID](./auth.githubauthprovider.provider_id.md) | static | (not declared) | Always set to [ProviderId.GITHUB](./auth-types.providerid.github.md). | ## Methods | Method | Modifiers | Description | | --- | --- | --- | -| [credential(accessToken)](./auth.githubauthprovider.credential.md) | static | | -| [credentialFromError(error)](./auth.githubauthprovider.credentialfromerror.md) | static | | -| [credentialFromResult(userCredential)](./auth.githubauthprovider.credentialfromresult.md) | static | | +| [credential(accessToken)](./auth.githubauthprovider.credential.md) | static | Creates a credential for Github. | +| [credentialFromError(error)](./auth.githubauthprovider.credentialfromerror.md) | static | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [AuthError](./auth-types.autherror.md) which was thrown during a sign-in, link, or reauthenticate operation. | +| [credentialFromResult(userCredential)](./auth.githubauthprovider.credentialfromresult.md) | static | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [UserCredential](./auth-types.usercredential.md). | diff --git a/docs-exp/auth.githubauthprovider.provider_id.md b/docs-exp/auth.githubauthprovider.provider_id.md index 702ae3425ac..1d823b151fa 100644 --- a/docs-exp/auth.githubauthprovider.provider_id.md +++ b/docs-exp/auth.githubauthprovider.provider_id.md @@ -4,6 +4,8 @@ ## GithubAuthProvider.PROVIDER\_ID property +Always set to [ProviderId.GITHUB](./auth-types.providerid.github.md). + Signature: ```typescript diff --git a/docs-exp/auth.githubauthprovider.providerid.md b/docs-exp/auth.githubauthprovider.providerid.md deleted file mode 100644 index 7aaaf5165a5..00000000000 --- a/docs-exp/auth.githubauthprovider.providerid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [GithubAuthProvider](./auth.githubauthprovider.md) > [providerId](./auth.githubauthprovider.providerid.md) - -## GithubAuthProvider.providerId property - -Signature: - -```typescript -readonly providerId = externs.ProviderId.GITHUB; -``` diff --git a/docs-exp/auth.googleauthprovider.credential.md b/docs-exp/auth.googleauthprovider.credential.md index 5d115aa03df..1ccd9d78f54 100644 --- a/docs-exp/auth.googleauthprovider.credential.md +++ b/docs-exp/auth.googleauthprovider.credential.md @@ -4,6 +4,8 @@ ## GoogleAuthProvider.credential() method +Creates a credential for Google. At least one of ID token and access token is required. + Signature: ```typescript @@ -14,10 +16,20 @@ static credential(idToken?: string | null, accessToken?: string | null): externs | Parameter | Type | Description | | --- | --- | --- | -| idToken | string \| null | | -| accessToken | string \| null | | +| idToken | string \| null | Google ID token. | +| accessToken | string \| null | Google access token. | Returns: externs.[OAuthCredential](./auth-types.oauthcredential.md) +## Example + + +```javascript +// \`googleUser\` from the onsuccess Google Sign In callback. +const credential = GoogleAuthProvider.credential(googleUser.getAuthResponse().id_token); +const result = await signInWithCredential(credential); + +``` + diff --git a/docs-exp/auth.googleauthprovider.credentialfromerror.md b/docs-exp/auth.googleauthprovider.credentialfromerror.md index e793b3ba237..36ad9945a2c 100644 --- a/docs-exp/auth.googleauthprovider.credentialfromerror.md +++ b/docs-exp/auth.googleauthprovider.credentialfromerror.md @@ -4,6 +4,8 @@ ## GoogleAuthProvider.credentialFromError() method +Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [AuthError](./auth-types.autherror.md) which was thrown during a sign-in, link, or reauthenticate operation. + Signature: ```typescript diff --git a/docs-exp/auth.googleauthprovider.credentialfromresult.md b/docs-exp/auth.googleauthprovider.credentialfromresult.md index 50e009cf5a6..ca7d96c69fb 100644 --- a/docs-exp/auth.googleauthprovider.credentialfromresult.md +++ b/docs-exp/auth.googleauthprovider.credentialfromresult.md @@ -4,6 +4,8 @@ ## GoogleAuthProvider.credentialFromResult() method +Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [UserCredential](./auth-types.usercredential.md). + Signature: ```typescript @@ -14,7 +16,7 @@ static credentialFromResult(userCredential: externs.UserCredential): externs.OAu | Parameter | Type | Description | | --- | --- | --- | -| userCredential | externs.[UserCredential](./auth-types.usercredential.md) | | +| userCredential | externs.[UserCredential](./auth-types.usercredential.md) | The user credential. | Returns: diff --git a/docs-exp/auth.googleauthprovider.google_sign_in_method.md b/docs-exp/auth.googleauthprovider.google_sign_in_method.md index 1a9fc3251a4..565701f6f23 100644 --- a/docs-exp/auth.googleauthprovider.google_sign_in_method.md +++ b/docs-exp/auth.googleauthprovider.google_sign_in_method.md @@ -4,6 +4,8 @@ ## GoogleAuthProvider.GOOGLE\_SIGN\_IN\_METHOD property +Always set to [SignInMethod.GOOGLE](./auth-types.signinmethod.google.md). + Signature: ```typescript diff --git a/docs-exp/auth.googleauthprovider.md b/docs-exp/auth.googleauthprovider.md index daca19904b4..4f00e8116b6 100644 --- a/docs-exp/auth.googleauthprovider.md +++ b/docs-exp/auth.googleauthprovider.md @@ -4,6 +4,8 @@ ## GoogleAuthProvider class +Provider for generating an an [OAuthCredential](./auth.oauthcredential.md) for [ProviderId.GOOGLE](./auth-types.providerid.google.md). + Signature: ```typescript @@ -11,6 +13,48 @@ export declare class GoogleAuthProvider extends OAuthProvider ``` Extends: [OAuthProvider](./auth.oauthprovider.md) +## Example 1 + + +```javascript +// Sign in using a redirect. +const provider = new GoogleAuthProvider(); +// Start a sign in process for an unauthenticated user. +provider.addScope('profile'); +provider.addScope('email'); +await signInWithRedirect(auth, provider); +// This will trigger a full page redirect away from your app + +// After returning from the redirect when your app initializes you can obtain the result +const result = await getRedirectResult(auth); +if (result) { + // This is the signed-in user + const user = result.user; + // This gives you a Google Access Token. + const credential = provider.credentialFromResult(auth, result); + const token = credential.accessToken; +} + +``` + +## Example 2 + + +```javascript +// Sign in using a popup. +const provider = new GoogleAuthProvider(); +provider.addScope('profile'); +provider.addScope('email'); +const result = await signInWithPopup(auth, provider); + +// The signed-in user info. +const user = result.user; +// This gives you a Google Access Token. +const credential = provider.credentialFromResult(auth, result); +const token = credential.accessToken; + +``` + ## Constructors | Constructor | Modifiers | Description | @@ -21,14 +65,14 @@ export declare class GoogleAuthProvider extends OAuthProvider | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [GOOGLE\_SIGN\_IN\_METHOD](./auth.googleauthprovider.google_sign_in_method.md) | static | (not declared) | | -| [PROVIDER\_ID](./auth.googleauthprovider.provider_id.md) | static | (not declared) | | +| [GOOGLE\_SIGN\_IN\_METHOD](./auth.googleauthprovider.google_sign_in_method.md) | static | (not declared) | Always set to [SignInMethod.GOOGLE](./auth-types.signinmethod.google.md). | +| [PROVIDER\_ID](./auth.googleauthprovider.provider_id.md) | static | (not declared) | Always set to [ProviderId.GOOGLE](./auth-types.providerid.google.md). | ## Methods | Method | Modifiers | Description | | --- | --- | --- | -| [credential(idToken, accessToken)](./auth.googleauthprovider.credential.md) | static | | -| [credentialFromError(error)](./auth.googleauthprovider.credentialfromerror.md) | static | | -| [credentialFromResult(userCredential)](./auth.googleauthprovider.credentialfromresult.md) | static | | +| [credential(idToken, accessToken)](./auth.googleauthprovider.credential.md) | static | Creates a credential for Google. At least one of ID token and access token is required. | +| [credentialFromError(error)](./auth.googleauthprovider.credentialfromerror.md) | static | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [AuthError](./auth-types.autherror.md) which was thrown during a sign-in, link, or reauthenticate operation. | +| [credentialFromResult(userCredential)](./auth.googleauthprovider.credentialfromresult.md) | static | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [UserCredential](./auth-types.usercredential.md). | diff --git a/docs-exp/auth.googleauthprovider.provider_id.md b/docs-exp/auth.googleauthprovider.provider_id.md index 912a8dab3da..884553c6f9f 100644 --- a/docs-exp/auth.googleauthprovider.provider_id.md +++ b/docs-exp/auth.googleauthprovider.provider_id.md @@ -4,6 +4,8 @@ ## GoogleAuthProvider.PROVIDER\_ID property +Always set to [ProviderId.GOOGLE](./auth-types.providerid.google.md). + Signature: ```typescript diff --git a/docs-exp/auth.googleauthprovider.providerid.md b/docs-exp/auth.googleauthprovider.providerid.md deleted file mode 100644 index 6b80693aecc..00000000000 --- a/docs-exp/auth.googleauthprovider.providerid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [GoogleAuthProvider](./auth.googleauthprovider.md) > [providerId](./auth.googleauthprovider.providerid.md) - -## GoogleAuthProvider.providerId property - -Signature: - -```typescript -readonly providerId = externs.ProviderId.GOOGLE; -``` diff --git a/docs-exp/auth.indexeddblocalpersistence.md b/docs-exp/auth.indexeddblocalpersistence.md index 9373896af2f..97043859d20 100644 --- a/docs-exp/auth.indexeddblocalpersistence.md +++ b/docs-exp/auth.indexeddblocalpersistence.md @@ -4,6 +4,8 @@ ## indexedDBLocalPersistence variable +An implementation of [Persistence](./auth-types.persistence.md) of type 'LOCAL' using `indexedDB` for the underlying storage. + Signature: ```typescript diff --git a/docs-exp/auth.initializeauth.md b/docs-exp/auth.initializeauth.md index eb5e84a4f4b..734862c0c52 100644 --- a/docs-exp/auth.initializeauth.md +++ b/docs-exp/auth.initializeauth.md @@ -4,6 +4,7 @@ ## initializeAuth() function + Signature: ```typescript diff --git a/docs-exp/auth.inmemorypersistence.md b/docs-exp/auth.inmemorypersistence.md index 6f139c69668..baa34e407e0 100644 --- a/docs-exp/auth.inmemorypersistence.md +++ b/docs-exp/auth.inmemorypersistence.md @@ -4,6 +4,8 @@ ## inMemoryPersistence variable +An implementation of [Persistence](./auth-types.persistence.md) of type 'NONE'. + Signature: ```typescript diff --git a/docs-exp/auth.issigninwithemaillink.md b/docs-exp/auth.issigninwithemaillink.md index 5bd6fc0e6d6..63ca0a5e452 100644 --- a/docs-exp/auth.issigninwithemaillink.md +++ b/docs-exp/auth.issigninwithemaillink.md @@ -4,6 +4,8 @@ ## isSignInWithEmailLink() function +Checks if an incoming link is a sign-in with email link suitable for [signInWithEmailLink()](./auth.signinwithemaillink.md). + Signature: ```typescript @@ -14,8 +16,8 @@ export declare function isSignInWithEmailLink(auth: externs.Auth, emailLink: str | Parameter | Type | Description | | --- | --- | --- | -| auth | externs.[Auth](./auth-types.auth.md) | | -| emailLink | string | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| emailLink | string | The link sent to the user's email address. | Returns: diff --git a/docs-exp/auth.linkwithcredential.md b/docs-exp/auth.linkwithcredential.md index 0a55932ece5..2fa42c332f1 100644 --- a/docs-exp/auth.linkwithcredential.md +++ b/docs-exp/auth.linkwithcredential.md @@ -4,20 +4,26 @@ ## linkWithCredential() function +Links the user account with the given credentials. + Signature: ```typescript -export declare function linkWithCredential(userExtern: externs.User, credentialExtern: externs.AuthCredential): Promise; +export declare function linkWithCredential(user: externs.User, credential: externs.AuthCredential): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| userExtern | externs.[User](./auth-types.user.md) | | -| credentialExtern | externs.[AuthCredential](./auth-types.authcredential.md) | | +| user | externs.[User](./auth-types.user.md) | The user. | +| credential | externs.[AuthCredential](./auth-types.authcredential.md) | The auth credential. | Returns: Promise<[UserCredential](./auth-types.usercredential.md)> +## Remarks + +An [AuthProvider](./auth-types.authprovider.md) can be used to generate the credential. + diff --git a/docs-exp/auth.linkwithphonenumber.md b/docs-exp/auth.linkwithphonenumber.md index d2b406e922a..7ffd4ff9a6f 100644 --- a/docs-exp/auth.linkwithphonenumber.md +++ b/docs-exp/auth.linkwithphonenumber.md @@ -4,19 +4,21 @@ ## linkWithPhoneNumber() function +Links the user account with the given phone number. + Signature: ```typescript -export declare function linkWithPhoneNumber(userExtern: externs.User, phoneNumber: string, appVerifier: externs.ApplicationVerifier): Promise; +export declare function linkWithPhoneNumber(user: externs.User, phoneNumber: string, appVerifier: externs.ApplicationVerifier): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| userExtern | externs.[User](./auth-types.user.md) | | -| phoneNumber | string | | -| appVerifier | externs.[ApplicationVerifier](./auth-types.applicationverifier.md) | | +| user | externs.[User](./auth-types.user.md) | The user. | +| phoneNumber | string | The user's phone number in E.164 format (e.g. +16505550101). | +| appVerifier | externs.[ApplicationVerifier](./auth-types.applicationverifier.md) | The [ApplicationVerifier](./auth-types.applicationverifier.md). | Returns: diff --git a/docs-exp/auth.linkwithpopup.md b/docs-exp/auth.linkwithpopup.md index 76c36378633..b9a287782f1 100644 --- a/docs-exp/auth.linkwithpopup.md +++ b/docs-exp/auth.linkwithpopup.md @@ -4,21 +4,39 @@ ## linkWithPopup() function +Links the authenticated provider to the user account using a pop-up based OAuth flow. + Signature: ```typescript -export declare function linkWithPopup(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern?: externs.PopupRedirectResolver): Promise; +export declare function linkWithPopup(user: externs.User, provider: externs.AuthProvider, resolver?: externs.PopupRedirectResolver): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| userExtern | externs.[User](./auth-types.user.md) | | -| provider | externs.[AuthProvider](./auth-types.authprovider.md) | | -| resolverExtern | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | | +| user | externs.[User](./auth-types.user.md) | The user. | +| provider | externs.[AuthProvider](./auth-types.authprovider.md) | The provider to authenticate. The provider has to be an [OAuthProvider](./auth.oauthprovider.md). Non-OAuth providers like [EmailAuthProvider](./auth.emailauthprovider.md) will throw an error. | +| resolver | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | An instance of [PopupRedirectResolver](./auth-types.popupredirectresolver.md), optional if already supplied to [initializeAuth()](./auth.initializeauth.md) or provided by [getAuth()](./auth.getauth.md). | Returns: Promise<externs.[UserCredential](./auth-types.usercredential.md)> +## Remarks + +If the linking is successful, the returned result will contain the user and the provider's credential. + +## Example + + +```javascript +// Sign in using some other provider. +const result = await signInWithEmailAndPassword(auth, email, password); +// Link using a popup. +const provider = new FacebookAuthProvider(); +await linkWithPopup(result.user, provider); + +``` + diff --git a/docs-exp/auth.linkwithredirect.md b/docs-exp/auth.linkwithredirect.md index dc31203de75..2fb50dc5458 100644 --- a/docs-exp/auth.linkwithredirect.md +++ b/docs-exp/auth.linkwithredirect.md @@ -4,21 +4,39 @@ ## linkWithRedirect() function +Links the [OAuthProvider](./auth.oauthprovider.md) to the user account using a full-page redirect flow. + Signature: ```typescript -export declare function linkWithRedirect(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern?: externs.PopupRedirectResolver): Promise; +export declare function linkWithRedirect(user: externs.User, provider: externs.AuthProvider, resolver?: externs.PopupRedirectResolver): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| userExtern | externs.[User](./auth-types.user.md) | | -| provider | externs.[AuthProvider](./auth-types.authprovider.md) | | -| resolverExtern | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | | +| user | externs.[User](./auth-types.user.md) | The user. | +| provider | externs.[AuthProvider](./auth-types.authprovider.md) | The provider to authenticate. The provider has to be an [OAuthProvider](./auth.oauthprovider.md). Non-OAuth providers like [EmailAuthProvider](./auth.emailauthprovider.md) will throw an error. | +| resolver | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | An instance of [PopupRedirectResolver](./auth-types.popupredirectresolver.md), optional if already supplied to [initializeAuth()](./auth.initializeauth.md) or provided by [getAuth()](./auth.getauth.md). | Returns: Promise<never> +## Example + + +```javascript +// Sign in using some other provider. +const result = await signInWithEmailAndPassword(auth, email, password); +// Link using a redirect. +const provider = new FacebookAuthProvider(); +await linkWithRedirect(result.user, provider); +// This will trigger a full page redirect away from your app + +// After returning from the redirect when your app initializes you can obtain the result +const result = await getRedirectResult(auth); + +``` + diff --git a/docs-exp/auth.md b/docs-exp/auth.md index e36e91f8cf3..12f1d9bc52b 100644 --- a/docs-exp/auth.md +++ b/docs-exp/auth.md @@ -9,81 +9,99 @@ | Class | Description | | --- | --- | | [ActionCodeURL](./auth.actioncodeurl.md) | A utility class to parse email action URLs such as password reset, email verification, email link sign in, etc. | -| [AuthCredential](./auth.authcredential.md) | | -| [EmailAuthCredential](./auth.emailauthcredential.md) | | -| [EmailAuthProvider](./auth.emailauthprovider.md) | | -| [FacebookAuthProvider](./auth.facebookauthprovider.md) | | -| [GithubAuthProvider](./auth.githubauthprovider.md) | | -| [GoogleAuthProvider](./auth.googleauthprovider.md) | | -| [OAuthCredential](./auth.oauthcredential.md) | | -| [OAuthProvider](./auth.oauthprovider.md) | | -| [PhoneAuthCredential](./auth.phoneauthcredential.md) | | -| [PhoneAuthProvider](./auth.phoneauthprovider.md) | | -| [PhoneMultiFactorGenerator](./auth.phonemultifactorgenerator.md) | | -| [RecaptchaVerifier](./auth.recaptchaverifier.md) | | -| [TwitterAuthProvider](./auth.twitterauthprovider.md) | | +| [AuthCredential](./auth.authcredential.md) | Interface that represents the credentials returned by an [AuthProvider](./auth-types.authprovider.md). | +| [EmailAuthCredential](./auth.emailauthcredential.md) | Interface that represents the credentials returned by [EmailAuthProvider](./auth.emailauthprovider.md) for [ProviderId.PASSWORD](./auth-types.providerid.password.md) | +| [EmailAuthProvider](./auth.emailauthprovider.md) | Provider for generating [EmailAuthCredential](./auth.emailauthcredential.md). | +| [FacebookAuthProvider](./auth.facebookauthprovider.md) | Provider for generating an [OAuthCredential](./auth.oauthcredential.md) for [ProviderId.FACEBOOK](./auth-types.providerid.facebook.md). | +| [GithubAuthProvider](./auth.githubauthprovider.md) | Provider for generating an [OAuthCredential](./auth.oauthcredential.md) for [ProviderId.GITHUB](./auth-types.providerid.github.md). | +| [GoogleAuthProvider](./auth.googleauthprovider.md) | Provider for generating an an [OAuthCredential](./auth.oauthcredential.md) for [ProviderId.GOOGLE](./auth-types.providerid.google.md). | +| [OAuthCredential](./auth.oauthcredential.md) | Interface that represents the OAuth credentials returned by an [OAuthProvider](./auth.oauthprovider.md). | +| [OAuthProvider](./auth.oauthprovider.md) | Provider for generating generic [OAuthCredential](./auth.oauthcredential.md). | +| [PhoneAuthCredential](./auth.phoneauthcredential.md) | Interface that represents the credentials returned by a [PhoneAuthProvider](./auth.phoneauthprovider.md). | +| [PhoneAuthProvider](./auth.phoneauthprovider.md) | Provider for generating an [PhoneAuthCredential](./auth.phoneauthcredential.md). | +| [PhoneMultiFactorGenerator](./auth.phonemultifactorgenerator.md) | Provider for generating a [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md). | +| [RecaptchaVerifier](./auth.recaptchaverifier.md) | An [reCAPTCHA](https://www.google.com/recaptcha/)-based application verifier. | +| [TwitterAuthProvider](./auth.twitterauthprovider.md) | Provider for generating an [OAuthCredential](./auth.oauthcredential.md) for [ProviderId.TWITTER](./auth-types.providerid.twitter.md). | + +## Enumerations + +| Enumeration | Description | +| --- | --- | +| [AuthErrorCode](./auth.autherrorcode.md) | Enumeration of Firebase Auth error codes. | ## Functions | Function | Description | | --- | --- | -| [applyActionCode(auth, oobCode)](./auth.applyactioncode.md) | | -| [checkActionCode(auth, oobCode)](./auth.checkactioncode.md) | | -| [confirmPasswordReset(auth, oobCode, newPassword)](./auth.confirmpasswordreset.md) | | -| [createUserWithEmailAndPassword(auth, email, password)](./auth.createuserwithemailandpassword.md) | | -| [deleteUser(user)](./auth.deleteuser.md) | | -| [fetchSignInMethodsForEmail(auth, email)](./auth.fetchsigninmethodsforemail.md) | | -| [getAdditionalUserInfo(userCredential)](./auth.getadditionaluserinfo.md) | | -| [getAuth(app)](./auth.getauth.md) | | -| [getIdToken(user, forceRefresh)](./auth.getidtoken.md) | | -| [getIdTokenResult(externUser, forceRefresh)](./auth.getidtokenresult.md) | | -| [getMultiFactorResolver(auth, errorExtern)](./auth.getmultifactorresolver.md) | | -| [getRedirectResult(authExtern, resolverExtern)](./auth.getredirectresult.md) | | +| [applyActionCode(auth, oobCode)](./auth.applyactioncode.md) | Applies a verification code sent to the user by email or other out-of-band mechanism. | +| [checkActionCode(auth, oobCode)](./auth.checkactioncode.md) | Checks a verification code sent to the user by email or other out-of-band mechanism. | +| [confirmPasswordReset(auth, oobCode, newPassword)](./auth.confirmpasswordreset.md) | Completes the password reset process, given a confirmation code and new password. | +| [createUserWithEmailAndPassword(auth, email, password)](./auth.createuserwithemailandpassword.md) | Creates a new user account associated with the specified email address and password. | +| [deleteUser(user)](./auth.deleteuser.md) | Deletes and signs out the user. | +| [fetchSignInMethodsForEmail(auth, email)](./auth.fetchsigninmethodsforemail.md) | Gets the list of possible sign in methods for the given email address. | +| [getAdditionalUserInfo(userCredential)](./auth.getadditionaluserinfo.md) | Extracts provider specific [AdditionalUserInfo](./auth-types.additionaluserinfo.md) for the given credential. | +| [getAuth(app)](./auth.getauth.md) | Initializes an Auth instance with platform specific default dependencies. | +| [getIdToken(user, forceRefresh)](./auth.getidtoken.md) | Returns a JSON Web Token (JWT) used to identify the user to a Firebase service. | +| [getIdTokenResult(user, forceRefresh)](./auth.getidtokenresult.md) | Returns a deserialized JSON Web Token (JWT) used to identitfy the user to a Firebase service. | +| [getMultiFactorResolver(auth, error)](./auth.getmultifactorresolver.md) | Provides a [MultiFactorResolver](./auth-types.multifactorresolver.md) suitable for completion of a multi-factor flow. | +| [getRedirectResult(auth, resolver)](./auth.getredirectresult.md) | Returns a [UserCredential](./auth-types.usercredential.md) from the redirect-based sign-in flow. | | [initializeAuth(app, deps)](./auth.initializeauth.md) | | -| [isSignInWithEmailLink(auth, emailLink)](./auth.issigninwithemaillink.md) | | -| [linkWithCredential(userExtern, credentialExtern)](./auth.linkwithcredential.md) | | -| [linkWithPhoneNumber(userExtern, phoneNumber, appVerifier)](./auth.linkwithphonenumber.md) | | -| [linkWithPopup(userExtern, provider, resolverExtern)](./auth.linkwithpopup.md) | | -| [linkWithRedirect(userExtern, provider, resolverExtern)](./auth.linkwithredirect.md) | | -| [multiFactor(user)](./auth.multifactor.md) | | -| [onAuthStateChanged(auth, nextOrObserver, error, completed)](./auth.onauthstatechanged.md) | | -| [onIdTokenChanged(auth, nextOrObserver, error, completed)](./auth.onidtokenchanged.md) | | -| [parseActionCodeURL(link)](./auth.parseactioncodeurl.md) | Parses the email action link string and returns an ActionCodeURL object if the link is valid, otherwise returns null. | -| [reauthenticateWithCredential(userExtern, credentialExtern)](./auth.reauthenticatewithcredential.md) | | -| [reauthenticateWithPhoneNumber(userExtern, phoneNumber, appVerifier)](./auth.reauthenticatewithphonenumber.md) | | -| [reauthenticateWithPopup(userExtern, provider, resolverExtern)](./auth.reauthenticatewithpopup.md) | | -| [reauthenticateWithRedirect(userExtern, provider, resolverExtern)](./auth.reauthenticatewithredirect.md) | | -| [reload(externUser)](./auth.reload.md) | | -| [sendEmailVerification(userExtern, actionCodeSettings)](./auth.sendemailverification.md) | | -| [sendPasswordResetEmail(auth, email, actionCodeSettings)](./auth.sendpasswordresetemail.md) | | -| [sendSignInLinkToEmail(auth, email, actionCodeSettings)](./auth.sendsigninlinktoemail.md) | | -| [setPersistence(auth, persistence)](./auth.setpersistence.md) | | -| [signInAnonymously(auth)](./auth.signinanonymously.md) | | -| [signInWithCredential(auth, credential)](./auth.signinwithcredential.md) | | -| [signInWithCustomToken(authExtern, customToken)](./auth.signinwithcustomtoken.md) | | -| [signInWithEmailAndPassword(auth, email, password)](./auth.signinwithemailandpassword.md) | | -| [signInWithEmailLink(auth, email, emailLink)](./auth.signinwithemaillink.md) | | -| [signInWithPhoneNumber(auth, phoneNumber, appVerifier)](./auth.signinwithphonenumber.md) | | -| [signInWithPopup(authExtern, provider, resolverExtern)](./auth.signinwithpopup.md) | | -| [signInWithRedirect(authExtern, provider, resolverExtern)](./auth.signinwithredirect.md) | | -| [signOut(auth)](./auth.signout.md) | | -| [unlink(userExtern, providerId)](./auth.unlink.md) | This is the externally visible unlink function | -| [updateCurrentUser(auth, user)](./auth.updatecurrentuser.md) | | -| [updateEmail(externUser, newEmail)](./auth.updateemail.md) | | -| [updatePassword(externUser, newPassword)](./auth.updatepassword.md) | | -| [updatePhoneNumber(user, credential)](./auth.updatephonenumber.md) | | -| [updateProfile(externUser, { displayName, photoURL: photoUrl })](./auth.updateprofile.md) | | -| [useDeviceLanguage(auth)](./auth.usedevicelanguage.md) | | -| [verifyBeforeUpdateEmail(userExtern, newEmail, actionCodeSettings)](./auth.verifybeforeupdateemail.md) | | -| [verifyPasswordResetCode(auth, code)](./auth.verifypasswordresetcode.md) | | +| [isSignInWithEmailLink(auth, emailLink)](./auth.issigninwithemaillink.md) | Checks if an incoming link is a sign-in with email link suitable for [signInWithEmailLink()](./auth.signinwithemaillink.md). | +| [linkWithCredential(user, credential)](./auth.linkwithcredential.md) | Links the user account with the given credentials. | +| [linkWithPhoneNumber(user, phoneNumber, appVerifier)](./auth.linkwithphonenumber.md) | Links the user account with the given phone number. | +| [linkWithPopup(user, provider, resolver)](./auth.linkwithpopup.md) | Links the authenticated provider to the user account using a pop-up based OAuth flow. | +| [linkWithRedirect(user, provider, resolver)](./auth.linkwithredirect.md) | Links the [OAuthProvider](./auth.oauthprovider.md) to the user account using a full-page redirect flow. | +| [multiFactor(user)](./auth.multifactor.md) | The [MultiFactorUser](./auth-types.multifactoruser.md) corresponding to the user. | +| [onAuthStateChanged(auth, nextOrObserver, error, completed)](./auth.onauthstatechanged.md) | Adds an observer for changes to the user's sign-in state. | +| [onIdTokenChanged(auth, nextOrObserver, error, completed)](./auth.onidtokenchanged.md) | Adds an observer for changes to the signed-in user's ID token, which includes sign-in, sign-out, and token refresh events. | +| [parseActionCodeURL(link)](./auth.parseactioncodeurl.md) | Parses the email action link string and returns an [ActionCodeURL](./auth.actioncodeurl.md) if the link is valid, otherwise returns null. | +| [reauthenticateWithCredential(user, credential)](./auth.reauthenticatewithcredential.md) | Re-authenticates a user using a fresh credential. | +| [reauthenticateWithPhoneNumber(user, phoneNumber, appVerifier)](./auth.reauthenticatewithphonenumber.md) | Re-authenticates a user using a fresh phne credential. | +| [reauthenticateWithPopup(user, provider, resolver)](./auth.reauthenticatewithpopup.md) | Reauthenticates the current user with the specified [OAuthProvider](./auth.oauthprovider.md) using a pop-up based OAuth flow. | +| [reauthenticateWithRedirect(user, provider, resolver)](./auth.reauthenticatewithredirect.md) | Reauthenticates the current user with the specified [OAuthProvider](./auth.oauthprovider.md) using a full-page redirect flow. | +| [reload(user)](./auth.reload.md) | Reloads user account data, if signed in. | +| [sendEmailVerification(user, actionCodeSettings)](./auth.sendemailverification.md) | Sends a verification email to a user. | +| [sendPasswordResetEmail(auth, email, actionCodeSettings)](./auth.sendpasswordresetemail.md) | Sends a password reset email to the given email address. | +| [sendSignInLinkToEmail(auth, email, actionCodeSettings)](./auth.sendsigninlinktoemail.md) | Sends a sign-in email link to the user with the specified email. | +| [setPersistence(auth, persistence)](./auth.setpersistence.md) | Changes the type of persistence on the Auth instance for the currently saved Auth session and applies this type of persistence for future sign-in requests, including sign-in with redirect requests. | +| [signInAnonymously(auth)](./auth.signinanonymously.md) | Asynchronously signs in as an anonymous user. | +| [signInWithCredential(auth, credential)](./auth.signinwithcredential.md) | Asynchronously signs in with the given credentials. | +| [signInWithCustomToken(auth, customToken)](./auth.signinwithcustomtoken.md) | Asynchronously signs in using a custom token. | +| [signInWithEmailAndPassword(auth, email, password)](./auth.signinwithemailandpassword.md) | Asynchronously signs in using an email and password. | +| [signInWithEmailLink(auth, email, emailLink)](./auth.signinwithemaillink.md) | Asynchronously signs in using an email and sign-in email link. | +| [signInWithPhoneNumber(auth, phoneNumber, appVerifier)](./auth.signinwithphonenumber.md) | Asynchronously signs in using a phone number. | +| [signInWithPopup(auth, provider, resolver)](./auth.signinwithpopup.md) | Authenticates a Firebase client using a popup-based OAuth authentication flow. | +| [signInWithRedirect(auth, provider, resolver)](./auth.signinwithredirect.md) | Authenticates a Firebase client using a full-page redirect flow. | +| [signOut(auth)](./auth.signout.md) | Signs out the current user. | +| [unlink(user, providerId)](./auth.unlink.md) | Unlinks a provider from a user account. | +| [updateCurrentUser(auth, user)](./auth.updatecurrentuser.md) | Asynchronously sets the provided user as [Auth.currentUser](./auth-types.auth.currentuser.md) on the [Auth](./auth-types.auth.md) instance. | +| [updateEmail(user, newEmail)](./auth.updateemail.md) | Updates the user's email address. | +| [updatePassword(user, newPassword)](./auth.updatepassword.md) | Updates the user's password. | +| [updatePhoneNumber(user, credential)](./auth.updatephonenumber.md) | Updates the user's phone number. | +| [updateProfile(user, { displayName, photoURL: photoUrl })](./auth.updateprofile.md) | Updates a user's profile data. | +| [useDeviceLanguage(auth)](./auth.usedevicelanguage.md) | Sets the current language to the default device/browser preference. | +| [verifyBeforeUpdateEmail(user, newEmail, actionCodeSettings)](./auth.verifybeforeupdateemail.md) | Sends a verification email to a new email address. | +| [verifyPasswordResetCode(auth, code)](./auth.verifypasswordresetcode.md) | Checks a password reset code sent to the user by email or other out-of-band mechanism. | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [OAuthCredentialOptions](./auth.oauthcredentialoptions.md) | Defines the options for initializing an [OAuthCredential](./auth.oauthcredential.md). | ## Variables | Variable | Description | | --- | --- | -| [browserLocalPersistence](./auth.browserlocalpersistence.md) | | -| [browserPopupRedirectResolver](./auth.browserpopupredirectresolver.md) | | -| [browserSessionPersistence](./auth.browsersessionpersistence.md) | | -| [indexedDBLocalPersistence](./auth.indexeddblocalpersistence.md) | | -| [inMemoryPersistence](./auth.inmemorypersistence.md) | | +| [browserLocalPersistence](./auth.browserlocalpersistence.md) | An implementation of [Persistence](./auth-types.persistence.md) of type 'LOCAL' using localStorage for the underlying storage. | +| [browserPopupRedirectResolver](./auth.browserpopupredirectresolver.md) | An implementation of [PopupRedirectResolver](./auth-types.popupredirectresolver.md) suitable for browser based applications. | +| [browserSessionPersistence](./auth.browsersessionpersistence.md) | An implementation of [Persistence](./auth-types.persistence.md) of 'SESSION' using sessionStorage for the underlying storage. | +| [indexedDBLocalPersistence](./auth.indexeddblocalpersistence.md) | An implementation of [Persistence](./auth-types.persistence.md) of type 'LOCAL' using indexedDB for the underlying storage. | +| [inMemoryPersistence](./auth.inmemorypersistence.md) | An implementation of [Persistence](./auth-types.persistence.md) of type 'NONE'. | + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [CustomParameters](./auth.customparameters.md) | Map of OAuth Custom Parameters. | diff --git a/docs-exp/auth.multifactor.md b/docs-exp/auth.multifactor.md index 1e46c923e73..73217ac362f 100644 --- a/docs-exp/auth.multifactor.md +++ b/docs-exp/auth.multifactor.md @@ -4,6 +4,8 @@ ## multiFactor() function +The [MultiFactorUser](./auth-types.multifactoruser.md) corresponding to the user. + Signature: ```typescript @@ -14,9 +16,13 @@ export declare function multiFactor(user: externs.User): externs.MultiFactorUser | Parameter | Type | Description | | --- | --- | --- | -| user | externs.[User](./auth-types.user.md) | | +| user | externs.[User](./auth-types.user.md) | The user. | Returns: externs.[MultiFactorUser](./auth-types.multifactoruser.md) +## Remarks + +This is used to access all multi-factor properties and operations related to the user. + diff --git a/docs-exp/auth.oauthcredential._fromparams.md b/docs-exp/auth.oauthcredential._fromparams.md deleted file mode 100644 index bc958994759..00000000000 --- a/docs-exp/auth.oauthcredential._fromparams.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthCredential](./auth.oauthcredential.md) > [\_fromParams](./auth.oauthcredential._fromparams.md) - -## OAuthCredential.\_fromParams() method - -Signature: - -```typescript -static _fromParams(params: OAuthCredentialParams): OAuthCredential; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| params | OAuthCredentialParams | | - -Returns: - -[OAuthCredential](./auth.oauthcredential.md) - diff --git a/docs-exp/auth.oauthcredential._getidtokenresponse.md b/docs-exp/auth.oauthcredential._getidtokenresponse.md deleted file mode 100644 index a1b21269649..00000000000 --- a/docs-exp/auth.oauthcredential._getidtokenresponse.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthCredential](./auth.oauthcredential.md) > [\_getIdTokenResponse](./auth.oauthcredential._getidtokenresponse.md) - -## OAuthCredential.\_getIdTokenResponse() method - -Signature: - -```typescript -_getIdTokenResponse(auth: Auth): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| auth | Auth | | - -Returns: - -Promise<IdTokenResponse> - diff --git a/docs-exp/auth.oauthcredential._getreauthenticationresolver.md b/docs-exp/auth.oauthcredential._getreauthenticationresolver.md deleted file mode 100644 index 35a047fda48..00000000000 --- a/docs-exp/auth.oauthcredential._getreauthenticationresolver.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthCredential](./auth.oauthcredential.md) > [\_getReauthenticationResolver](./auth.oauthcredential._getreauthenticationresolver.md) - -## OAuthCredential.\_getReauthenticationResolver() method - -Signature: - -```typescript -_getReauthenticationResolver(auth: Auth): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| auth | Auth | | - -Returns: - -Promise<IdTokenResponse> - diff --git a/docs-exp/auth.oauthcredential._linktoidtoken.md b/docs-exp/auth.oauthcredential._linktoidtoken.md deleted file mode 100644 index eb0a27249d3..00000000000 --- a/docs-exp/auth.oauthcredential._linktoidtoken.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthCredential](./auth.oauthcredential.md) > [\_linkToIdToken](./auth.oauthcredential._linktoidtoken.md) - -## OAuthCredential.\_linkToIdToken() method - -Signature: - -```typescript -_linkToIdToken(auth: Auth, idToken: string): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| auth | Auth | | -| idToken | string | | - -Returns: - -Promise<IdTokenResponse> - diff --git a/docs-exp/auth.oauthcredential.accesstoken.md b/docs-exp/auth.oauthcredential.accesstoken.md index 2c7a53a9da3..b1c09c26732 100644 --- a/docs-exp/auth.oauthcredential.accesstoken.md +++ b/docs-exp/auth.oauthcredential.accesstoken.md @@ -4,6 +4,8 @@ ## OAuthCredential.accessToken property +The OAuth access token associated with the credential if it belongs to an [OAuthProvider](./auth.oauthprovider.md), such as `facebook.com`, `twitter.com`, etc. + Signature: ```typescript diff --git a/docs-exp/auth.oauthcredential.fromjson.md b/docs-exp/auth.oauthcredential.fromjson.md index 5fe608786a4..d3a0a837074 100644 --- a/docs-exp/auth.oauthcredential.fromjson.md +++ b/docs-exp/auth.oauthcredential.fromjson.md @@ -4,6 +4,8 @@ ## OAuthCredential.fromJSON() method +Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth-types.authcredential.md). + Signature: ```typescript @@ -14,9 +16,11 @@ static fromJSON(json: string | object): OAuthCredential | null; | Parameter | Type | Description | | --- | --- | --- | -| json | string \| object | | +| json | string \| object | Input can be either Object or the stringified representation of the object. When string is provided, JSON.parse would be called first. | Returns: [OAuthCredential](./auth.oauthcredential.md) \| null +If the JSON input does not represent an [AuthCredential](./auth-types.authcredential.md), null is returned. + diff --git a/docs-exp/auth.oauthcredential.idtoken.md b/docs-exp/auth.oauthcredential.idtoken.md index 416e44ede0c..e0e79407486 100644 --- a/docs-exp/auth.oauthcredential.idtoken.md +++ b/docs-exp/auth.oauthcredential.idtoken.md @@ -4,6 +4,8 @@ ## OAuthCredential.idToken property +The OAuth ID token associated with the credential if it belongs to an OIDC provider, such as `google.com`. + Signature: ```typescript diff --git a/docs-exp/auth.oauthcredential.md b/docs-exp/auth.oauthcredential.md index 8463d002dd3..c67e80772eb 100644 --- a/docs-exp/auth.oauthcredential.md +++ b/docs-exp/auth.oauthcredential.md @@ -4,6 +4,8 @@ ## OAuthCredential class +Interface that represents the OAuth credentials returned by an [OAuthProvider](./auth.oauthprovider.md). + Signature: ```typescript @@ -13,23 +15,22 @@ export declare class OAuthCredential extends AuthCredential implements externs.O Implements: externs.[OAuthCredential](./auth-types.oauthcredential.md) +## Remarks + +Implementations specify the details about each auth provider's credential requirements. + ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [accessToken](./auth.oauthcredential.accesstoken.md) | | string | | -| [idToken](./auth.oauthcredential.idtoken.md) | | string | | -| [nonce](./auth.oauthcredential.nonce.md) | | string | | -| [secret](./auth.oauthcredential.secret.md) | | string | | +| [accessToken](./auth.oauthcredential.accesstoken.md) | | string | The OAuth access token associated with the credential if it belongs to an [OAuthProvider](./auth.oauthprovider.md), such as facebook.com, twitter.com, etc. | +| [idToken](./auth.oauthcredential.idtoken.md) | | string | The OAuth ID token associated with the credential if it belongs to an OIDC provider, such as google.com. | +| [secret](./auth.oauthcredential.secret.md) | | string | The OAuth access token secret associated with the credential if it belongs to an OAuth 1.0 provider, such as twitter.com. | ## Methods | Method | Modifiers | Description | | --- | --- | --- | -| [\_fromParams(params)](./auth.oauthcredential._fromparams.md) | static | | -| [\_getIdTokenResponse(auth)](./auth.oauthcredential._getidtokenresponse.md) | | | -| [\_getReauthenticationResolver(auth)](./auth.oauthcredential._getreauthenticationresolver.md) | | | -| [\_linkToIdToken(auth, idToken)](./auth.oauthcredential._linktoidtoken.md) | | | -| [fromJSON(json)](./auth.oauthcredential.fromjson.md) | static | | +| [fromJSON(json)](./auth.oauthcredential.fromjson.md) | static | Static method to deserialize a JSON representation of an object into an [AuthCredential](./auth-types.authcredential.md). | | [toJSON()](./auth.oauthcredential.tojson.md) | | | diff --git a/docs-exp/auth.oauthcredential.nonce.md b/docs-exp/auth.oauthcredential.nonce.md deleted file mode 100644 index a3486055025..00000000000 --- a/docs-exp/auth.oauthcredential.nonce.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthCredential](./auth.oauthcredential.md) > [nonce](./auth.oauthcredential.nonce.md) - -## OAuthCredential.nonce property - -Signature: - -```typescript -nonce?: string; -``` diff --git a/docs-exp/auth.oauthcredential.secret.md b/docs-exp/auth.oauthcredential.secret.md index a5fd3ab596d..e351af062e6 100644 --- a/docs-exp/auth.oauthcredential.secret.md +++ b/docs-exp/auth.oauthcredential.secret.md @@ -4,6 +4,8 @@ ## OAuthCredential.secret property +The OAuth access token secret associated with the credential if it belongs to an OAuth 1.0 provider, such as `twitter.com`. + Signature: ```typescript diff --git a/docs-exp/auth.oauthcredential.tojson.md b/docs-exp/auth.oauthcredential.tojson.md index efa72b2674d..15a9712d33b 100644 --- a/docs-exp/auth.oauthcredential.tojson.md +++ b/docs-exp/auth.oauthcredential.tojson.md @@ -4,6 +4,7 @@ ## OAuthCredential.toJSON() method + Signature: ```typescript diff --git a/docs-exp/auth.oauthcredentialoptions.accesstoken.md b/docs-exp/auth.oauthcredentialoptions.accesstoken.md new file mode 100644 index 00000000000..93ebae8843e --- /dev/null +++ b/docs-exp/auth.oauthcredentialoptions.accesstoken.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthCredentialOptions](./auth.oauthcredentialoptions.md) > [accessToken](./auth.oauthcredentialoptions.accesstoken.md) + +## OAuthCredentialOptions.accessToken property + +The OAuth access token used to initialize the [OAuthCredential](./auth.oauthcredential.md). + +Signature: + +```typescript +accessToken?: string; +``` diff --git a/docs-exp/auth.oauthcredentialoptions.idtoken.md b/docs-exp/auth.oauthcredentialoptions.idtoken.md new file mode 100644 index 00000000000..a11d2973787 --- /dev/null +++ b/docs-exp/auth.oauthcredentialoptions.idtoken.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthCredentialOptions](./auth.oauthcredentialoptions.md) > [idToken](./auth.oauthcredentialoptions.idtoken.md) + +## OAuthCredentialOptions.idToken property + +The OAuth ID token used to initialize the [OAuthCredential](./auth.oauthcredential.md). + +Signature: + +```typescript +idToken?: string; +``` diff --git a/docs-exp/auth.oauthcredentialoptions.md b/docs-exp/auth.oauthcredentialoptions.md new file mode 100644 index 00000000000..ac73c04da21 --- /dev/null +++ b/docs-exp/auth.oauthcredentialoptions.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthCredentialOptions](./auth.oauthcredentialoptions.md) + +## OAuthCredentialOptions interface + +Defines the options for initializing an [OAuthCredential](./auth.oauthcredential.md). + +Signature: + +```typescript +export interface OAuthCredentialOptions +``` + +## Remarks + +For ID tokens with nonce claim, the raw nonce has to also be provided. + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [accessToken](./auth.oauthcredentialoptions.accesstoken.md) | string | The OAuth access token used to initialize the [OAuthCredential](./auth.oauthcredential.md). | +| [idToken](./auth.oauthcredentialoptions.idtoken.md) | string | The OAuth ID token used to initialize the [OAuthCredential](./auth.oauthcredential.md). | +| [rawNonce](./auth.oauthcredentialoptions.rawnonce.md) | string | The raw nonce associated with the ID token. | + diff --git a/docs-exp/auth.oauthcredentialoptions.rawnonce.md b/docs-exp/auth.oauthcredentialoptions.rawnonce.md new file mode 100644 index 00000000000..d566572a900 --- /dev/null +++ b/docs-exp/auth.oauthcredentialoptions.rawnonce.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthCredentialOptions](./auth.oauthcredentialoptions.md) > [rawNonce](./auth.oauthcredentialoptions.rawnonce.md) + +## OAuthCredentialOptions.rawNonce property + +The raw nonce associated with the ID token. + +Signature: + +```typescript +rawNonce?: string; +``` + +## Remarks + +It is required when an ID token with a nonce field is provided. The SHA-256 hash of the raw nonce must match the nonce field in the ID token. + diff --git a/docs-exp/auth.oauthprovider._constructor_.md b/docs-exp/auth.oauthprovider._constructor_.md index ff89f537fc4..b02a9d5519e 100644 --- a/docs-exp/auth.oauthprovider._constructor_.md +++ b/docs-exp/auth.oauthprovider._constructor_.md @@ -4,7 +4,7 @@ ## OAuthProvider.(constructor) -Constructs a new instance of the `OAuthProvider` class +Constructor for generic OAuth providers. Signature: @@ -16,5 +16,5 @@ constructor(providerId: string); | Parameter | Type | Description | | --- | --- | --- | -| providerId | string | | +| providerId | string | Provider for which credentials should be generated. | diff --git a/docs-exp/auth.oauthprovider.addscope.md b/docs-exp/auth.oauthprovider.addscope.md index 8ed187e64e1..d5da7b3166b 100644 --- a/docs-exp/auth.oauthprovider.addscope.md +++ b/docs-exp/auth.oauthprovider.addscope.md @@ -4,6 +4,8 @@ ## OAuthProvider.addScope() method +Add an OAuth scope to the credential. + Signature: ```typescript @@ -14,7 +16,7 @@ addScope(scope: string): externs.AuthProvider; | Parameter | Type | Description | | --- | --- | --- | -| scope | string | | +| scope | string | Provider OAuth scope to add. | Returns: diff --git a/docs-exp/auth.oauthprovider.credential.md b/docs-exp/auth.oauthprovider.credential.md index a57400bc70d..7338652405b 100644 --- a/docs-exp/auth.oauthprovider.credential.md +++ b/docs-exp/auth.oauthprovider.credential.md @@ -4,19 +4,39 @@ ## OAuthProvider.credential() method +Creates a [OAuthCredential](./auth.oauthcredential.md) from a generic OAuth provider's access token or ID token. + Signature: ```typescript -credential(params: CredentialParameters): externs.OAuthCredential; +credential(params: OAuthCredentialOptions): externs.OAuthCredential; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| params | CredentialParameters | | +| params | [OAuthCredentialOptions](./auth.oauthcredentialoptions.md) | Either the options object containing the ID token, access token and raw nonce or the ID token string. | Returns: externs.[OAuthCredential](./auth-types.oauthcredential.md) +## Remarks + +The raw nonce is required when an ID token with a nonce field is provided. The SHA-256 hash of the raw nonce must match the nonce field in the ID token. + +## Example + + +```javascript +// `googleUser` from the onsuccess Google Sign In callback. +// Initialize a generate OAuth provider with a `google.com` providerId. +const provider = new OAuthProvider('google.com'); +const credential = provider.credential({ + idToken: googleUser.getAuthResponse().id_token, +}); +const result = await signInWithCredential(credential); + +``` + diff --git a/docs-exp/auth.oauthprovider.defaultlanguagecode.md b/docs-exp/auth.oauthprovider.defaultlanguagecode.md deleted file mode 100644 index 139635a85b4..00000000000 --- a/docs-exp/auth.oauthprovider.defaultlanguagecode.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [OAuthProvider](./auth.oauthprovider.md) > [defaultLanguageCode](./auth.oauthprovider.defaultlanguagecode.md) - -## OAuthProvider.defaultLanguageCode property - -Signature: - -```typescript -defaultLanguageCode: string | null; -``` diff --git a/docs-exp/auth.oauthprovider.getcustomparameters.md b/docs-exp/auth.oauthprovider.getcustomparameters.md index 541d5d21cec..29bcb5ef22c 100644 --- a/docs-exp/auth.oauthprovider.getcustomparameters.md +++ b/docs-exp/auth.oauthprovider.getcustomparameters.md @@ -4,6 +4,8 @@ ## OAuthProvider.getCustomParameters() method +Retrieve the current list of [CustomParameters](./auth.customparameters.md). + Signature: ```typescript @@ -11,5 +13,5 @@ getCustomParameters(): CustomParameters; ``` Returns: -CustomParameters +[CustomParameters](./auth.customparameters.md) diff --git a/docs-exp/auth.oauthprovider.getscopes.md b/docs-exp/auth.oauthprovider.getscopes.md index f98f4644306..b8e1ac6aac7 100644 --- a/docs-exp/auth.oauthprovider.getscopes.md +++ b/docs-exp/auth.oauthprovider.getscopes.md @@ -4,6 +4,8 @@ ## OAuthProvider.getScopes() method +Retrieve the current list of OAuth scopes. + Signature: ```typescript diff --git a/docs-exp/auth.oauthprovider.md b/docs-exp/auth.oauthprovider.md index 8976004def3..33de1d7c96a 100644 --- a/docs-exp/auth.oauthprovider.md +++ b/docs-exp/auth.oauthprovider.md @@ -4,6 +4,8 @@ ## OAuthProvider class +Provider for generating generic [OAuthCredential](./auth.oauthcredential.md). + Signature: ```typescript @@ -11,28 +13,69 @@ export declare class OAuthProvider implements externs.AuthProvider ``` Implements: externs.[AuthProvider](./auth-types.authprovider.md) +## Example 1 + + +```javascript +// Sign in using a redirect. +const provider = new OAuthProvider('google.com'); +// Start a sign in process for an unauthenticated user. +provider.addScope('profile'); +provider.addScope('email'); +await signInWithRedirect(auth, provider); +// This will trigger a full page redirect away from your app + +// After returning from the redirect when your app initializes you can obtain the result +const result = await getRedirectResult(auth); +if (result) { + // This is the signed-in user + const user = result.user; + // This gives you a OAuth Access Token for the provider. + const credential = provider.credentialFromResult(auth, result); + const token = credential.accessToken; +} + +``` + +## Example 2 + + +```javascript +// Sign in using a popup. +const provider = new OAuthProvider('google.com'); +provider.addScope('profile'); +provider.addScope('email'); +const result = await signInWithPopup(auth, provider); + +// The signed-in user info. +const user = result.user; +// This gives you a OAuth Access Token for the provider. +const credential = provider.credentialFromResult(auth, result); +const token = credential.accessToken; + +``` + ## Constructors | Constructor | Modifiers | Description | | --- | --- | --- | -| [(constructor)(providerId)](./auth.oauthprovider._constructor_.md) | | Constructs a new instance of the OAuthProvider class | +| [(constructor)(providerId)](./auth.oauthprovider._constructor_.md) | | Constructor for generic OAuth providers. | ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [defaultLanguageCode](./auth.oauthprovider.defaultlanguagecode.md) | | string \| null | | | [providerId](./auth.oauthprovider.providerid.md) | | string | | ## Methods | Method | Modifiers | Description | | --- | --- | --- | -| [addScope(scope)](./auth.oauthprovider.addscope.md) | | | -| [credential(params)](./auth.oauthprovider.credential.md) | | | +| [addScope(scope)](./auth.oauthprovider.addscope.md) | | Add an OAuth scope to the credential. | +| [credential(params)](./auth.oauthprovider.credential.md) | | Creates a [OAuthCredential](./auth.oauthcredential.md) from a generic OAuth provider's access token or ID token. | | [credentialFromJSON(json)](./auth.oauthprovider.credentialfromjson.md) | static | | -| [getCustomParameters()](./auth.oauthprovider.getcustomparameters.md) | | | -| [getScopes()](./auth.oauthprovider.getscopes.md) | | | -| [setCustomParameters(customOAuthParameters)](./auth.oauthprovider.setcustomparameters.md) | | | -| [setDefaultLanguage(languageCode)](./auth.oauthprovider.setdefaultlanguage.md) | | | +| [getCustomParameters()](./auth.oauthprovider.getcustomparameters.md) | | Retrieve the current list of [CustomParameters](./auth.customparameters.md). | +| [getScopes()](./auth.oauthprovider.getscopes.md) | | Retrieve the current list of OAuth scopes. | +| [setCustomParameters(customOAuthParameters)](./auth.oauthprovider.setcustomparameters.md) | | Sets the OAuth custom parameters to pass in an OAuth request for popup and redirect sign-in operations. | +| [setDefaultLanguage(languageCode)](./auth.oauthprovider.setdefaultlanguage.md) | | Set the language gode. | diff --git a/docs-exp/auth.oauthprovider.setcustomparameters.md b/docs-exp/auth.oauthprovider.setcustomparameters.md index f79b8e251db..c61ed53069f 100644 --- a/docs-exp/auth.oauthprovider.setcustomparameters.md +++ b/docs-exp/auth.oauthprovider.setcustomparameters.md @@ -4,6 +4,8 @@ ## OAuthProvider.setCustomParameters() method +Sets the OAuth custom parameters to pass in an OAuth request for popup and redirect sign-in operations. + Signature: ```typescript @@ -14,9 +16,13 @@ setCustomParameters(customOAuthParameters: CustomParameters): externs.AuthProvid | Parameter | Type | Description | | --- | --- | --- | -| customOAuthParameters | CustomParameters | | +| customOAuthParameters | [CustomParameters](./auth.customparameters.md) | The custom OAuth parameters to pass in the OAuth request. | Returns: externs.[AuthProvider](./auth-types.authprovider.md) +## Remarks + +For a detailed list, check the reserved required OAuth 2.0 parameters such as `client_id`, `redirect_uri`, `scope`, `response_type`, and `state` are not allowed and will be ignored. + diff --git a/docs-exp/auth.oauthprovider.setdefaultlanguage.md b/docs-exp/auth.oauthprovider.setdefaultlanguage.md index 471c56f8d03..1f30f92c64d 100644 --- a/docs-exp/auth.oauthprovider.setdefaultlanguage.md +++ b/docs-exp/auth.oauthprovider.setdefaultlanguage.md @@ -4,6 +4,8 @@ ## OAuthProvider.setDefaultLanguage() method +Set the language gode. + Signature: ```typescript @@ -14,7 +16,7 @@ setDefaultLanguage(languageCode: string | null): void; | Parameter | Type | Description | | --- | --- | --- | -| languageCode | string \| null | | +| languageCode | string \| null | language code | Returns: diff --git a/docs-exp/auth.onauthstatechanged.md b/docs-exp/auth.onauthstatechanged.md index 2085ae6d37f..218cdfb46a7 100644 --- a/docs-exp/auth.onauthstatechanged.md +++ b/docs-exp/auth.onauthstatechanged.md @@ -4,6 +4,8 @@ ## onAuthStateChanged() function +Adds an observer for changes to the user's sign-in state. + Signature: ```typescript @@ -14,12 +16,16 @@ export declare function onAuthStateChanged(auth: externs.Auth, nextOrObserver: e | Parameter | Type | Description | | --- | --- | --- | -| auth | externs.[Auth](./auth-types.auth.md) | | -| nextOrObserver | externs.[NextOrObserver](./auth-types.nextorobserver.md)<externs.[User](./auth-types.user.md)> | | -| error | ErrorFn | | -| completed | CompleteFn | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| nextOrObserver | externs.[NextOrObserver](./auth-types.nextorobserver.md)<externs.[User](./auth-types.user.md)> | callback triggered on change. | +| error | ErrorFn | callback triggered on error. | +| completed | CompleteFn | callback triggered when observer is removed. | Returns: Unsubscribe +## Remarks + +To keep the old behavior, see [onIdTokenChanged()](./auth.onidtokenchanged.md). + diff --git a/docs-exp/auth.onidtokenchanged.md b/docs-exp/auth.onidtokenchanged.md index fc9ba84e3d3..2fa15028fb7 100644 --- a/docs-exp/auth.onidtokenchanged.md +++ b/docs-exp/auth.onidtokenchanged.md @@ -4,6 +4,8 @@ ## onIdTokenChanged() function +Adds an observer for changes to the signed-in user's ID token, which includes sign-in, sign-out, and token refresh events. + Signature: ```typescript @@ -14,10 +16,10 @@ export declare function onIdTokenChanged(auth: externs.Auth, nextOrObserver: ext | Parameter | Type | Description | | --- | --- | --- | -| auth | externs.[Auth](./auth-types.auth.md) | | -| nextOrObserver | externs.[NextOrObserver](./auth-types.nextorobserver.md)<externs.[User](./auth-types.user.md)> | | -| error | ErrorFn | | -| completed | CompleteFn | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| nextOrObserver | externs.[NextOrObserver](./auth-types.nextorobserver.md)<externs.[User](./auth-types.user.md)> | callback triggered on change. | +| error | ErrorFn | callback triggered on error. | +| completed | CompleteFn | callback triggered when observer is removed. | Returns: diff --git a/docs-exp/auth.parseactioncodeurl.md b/docs-exp/auth.parseactioncodeurl.md index 9b50bf16f0e..be48cf2448a 100644 --- a/docs-exp/auth.parseactioncodeurl.md +++ b/docs-exp/auth.parseactioncodeurl.md @@ -4,7 +4,7 @@ ## parseActionCodeURL() function -Parses the email action link string and returns an ActionCodeURL object if the link is valid, otherwise returns null. +Parses the email action link string and returns an [ActionCodeURL](./auth.actioncodeurl.md) if the link is valid, otherwise returns null. Signature: diff --git a/docs-exp/auth.phoneauthcredential._fromtokenresponse.md b/docs-exp/auth.phoneauthcredential._fromtokenresponse.md deleted file mode 100644 index 72f3797ebaa..00000000000 --- a/docs-exp/auth.phoneauthcredential._fromtokenresponse.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthCredential](./auth.phoneauthcredential.md) > [\_fromTokenResponse](./auth.phoneauthcredential._fromtokenresponse.md) - -## PhoneAuthCredential.\_fromTokenResponse() method - -Signature: - -```typescript -static _fromTokenResponse(phoneNumber: string, temporaryProof: string): PhoneAuthCredential; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| phoneNumber | string | | -| temporaryProof | string | | - -Returns: - -[PhoneAuthCredential](./auth.phoneauthcredential.md) - diff --git a/docs-exp/auth.phoneauthcredential._fromverification.md b/docs-exp/auth.phoneauthcredential._fromverification.md deleted file mode 100644 index e058d1b940a..00000000000 --- a/docs-exp/auth.phoneauthcredential._fromverification.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthCredential](./auth.phoneauthcredential.md) > [\_fromVerification](./auth.phoneauthcredential._fromverification.md) - -## PhoneAuthCredential.\_fromVerification() method - -Signature: - -```typescript -static _fromVerification(verificationId: string, verificationCode: string): PhoneAuthCredential; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| verificationId | string | | -| verificationCode | string | | - -Returns: - -[PhoneAuthCredential](./auth.phoneauthcredential.md) - diff --git a/docs-exp/auth.phoneauthcredential._getidtokenresponse.md b/docs-exp/auth.phoneauthcredential._getidtokenresponse.md deleted file mode 100644 index 48f709938d9..00000000000 --- a/docs-exp/auth.phoneauthcredential._getidtokenresponse.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthCredential](./auth.phoneauthcredential.md) > [\_getIdTokenResponse](./auth.phoneauthcredential._getidtokenresponse.md) - -## PhoneAuthCredential.\_getIdTokenResponse() method - -Signature: - -```typescript -_getIdTokenResponse(auth: Auth): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| auth | Auth | | - -Returns: - -Promise<PhoneOrOauthTokenResponse> - diff --git a/docs-exp/auth.phoneauthcredential._getreauthenticationresolver.md b/docs-exp/auth.phoneauthcredential._getreauthenticationresolver.md deleted file mode 100644 index 468f2e72bf5..00000000000 --- a/docs-exp/auth.phoneauthcredential._getreauthenticationresolver.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthCredential](./auth.phoneauthcredential.md) > [\_getReauthenticationResolver](./auth.phoneauthcredential._getreauthenticationresolver.md) - -## PhoneAuthCredential.\_getReauthenticationResolver() method - -Signature: - -```typescript -_getReauthenticationResolver(auth: Auth): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| auth | Auth | | - -Returns: - -Promise<IdTokenResponse> - diff --git a/docs-exp/auth.phoneauthcredential._linktoidtoken.md b/docs-exp/auth.phoneauthcredential._linktoidtoken.md deleted file mode 100644 index 9152759d2f0..00000000000 --- a/docs-exp/auth.phoneauthcredential._linktoidtoken.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthCredential](./auth.phoneauthcredential.md) > [\_linkToIdToken](./auth.phoneauthcredential._linktoidtoken.md) - -## PhoneAuthCredential.\_linkToIdToken() method - -Signature: - -```typescript -_linkToIdToken(auth: Auth, idToken: string): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| auth | Auth | | -| idToken | string | | - -Returns: - -Promise<IdTokenResponse> - diff --git a/docs-exp/auth.phoneauthcredential._makeverificationrequest.md b/docs-exp/auth.phoneauthcredential._makeverificationrequest.md deleted file mode 100644 index 44de591a975..00000000000 --- a/docs-exp/auth.phoneauthcredential._makeverificationrequest.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [PhoneAuthCredential](./auth.phoneauthcredential.md) > [\_makeVerificationRequest](./auth.phoneauthcredential._makeverificationrequest.md) - -## PhoneAuthCredential.\_makeVerificationRequest() method - -Signature: - -```typescript -_makeVerificationRequest(): SignInWithPhoneNumberRequest; -``` -Returns: - -SignInWithPhoneNumberRequest - diff --git a/docs-exp/auth.phoneauthcredential.fromjson.md b/docs-exp/auth.phoneauthcredential.fromjson.md index 303befdae07..4615426d59d 100644 --- a/docs-exp/auth.phoneauthcredential.fromjson.md +++ b/docs-exp/auth.phoneauthcredential.fromjson.md @@ -4,6 +4,7 @@ ## PhoneAuthCredential.fromJSON() method + Signature: ```typescript diff --git a/docs-exp/auth.phoneauthcredential.md b/docs-exp/auth.phoneauthcredential.md index 4f090f61b3d..d03079bcd9b 100644 --- a/docs-exp/auth.phoneauthcredential.md +++ b/docs-exp/auth.phoneauthcredential.md @@ -4,6 +4,8 @@ ## PhoneAuthCredential class +Interface that represents the credentials returned by a [PhoneAuthProvider](./auth.phoneauthprovider.md). + Signature: ```typescript @@ -17,12 +19,6 @@ export declare class PhoneAuthCredential extends AuthCredential implements exter | Method | Modifiers | Description | | --- | --- | --- | -| [\_fromTokenResponse(phoneNumber, temporaryProof)](./auth.phoneauthcredential._fromtokenresponse.md) | static | | -| [\_fromVerification(verificationId, verificationCode)](./auth.phoneauthcredential._fromverification.md) | static | | -| [\_getIdTokenResponse(auth)](./auth.phoneauthcredential._getidtokenresponse.md) | | | -| [\_getReauthenticationResolver(auth)](./auth.phoneauthcredential._getreauthenticationresolver.md) | | | -| [\_linkToIdToken(auth, idToken)](./auth.phoneauthcredential._linktoidtoken.md) | | | -| [\_makeVerificationRequest()](./auth.phoneauthcredential._makeverificationrequest.md) | | | | [fromJSON(json)](./auth.phoneauthcredential.fromjson.md) | static | | | [toJSON()](./auth.phoneauthcredential.tojson.md) | | | diff --git a/docs-exp/auth.phoneauthcredential.tojson.md b/docs-exp/auth.phoneauthcredential.tojson.md index aeb65eaf380..a88795b130c 100644 --- a/docs-exp/auth.phoneauthcredential.tojson.md +++ b/docs-exp/auth.phoneauthcredential.tojson.md @@ -4,6 +4,7 @@ ## PhoneAuthCredential.toJSON() method + Signature: ```typescript diff --git a/docs-exp/auth.phoneauthprovider.credential.md b/docs-exp/auth.phoneauthprovider.credential.md index 02d00cc9888..df16af9caea 100644 --- a/docs-exp/auth.phoneauthprovider.credential.md +++ b/docs-exp/auth.phoneauthprovider.credential.md @@ -4,6 +4,8 @@ ## PhoneAuthProvider.credential() method +Creates a phone auth credential, given the verification ID from [PhoneAuthProvider.verifyPhoneNumber()](./auth.phoneauthprovider.verifyphonenumber.md) and the code that was sent to the user's mobile device. + Signature: ```typescript @@ -14,10 +16,12 @@ static credential(verificationId: string, verificationCode: string): PhoneAuthCr | Parameter | Type | Description | | --- | --- | --- | -| verificationId | string | | -| verificationCode | string | | +| verificationId | string | The verification ID returned from [PhoneAuthProvider.verifyPhoneNumber()](./auth.phoneauthprovider.verifyphonenumber.md). | +| verificationCode | string | The verification code sent to the user's mobile device. | Returns: [PhoneAuthCredential](./auth.phoneauthcredential.md) +The auth provider credential. + diff --git a/docs-exp/auth.phoneauthprovider.md b/docs-exp/auth.phoneauthprovider.md index 0aba88cd843..e99af37d62d 100644 --- a/docs-exp/auth.phoneauthprovider.md +++ b/docs-exp/auth.phoneauthprovider.md @@ -4,6 +4,8 @@ ## PhoneAuthProvider class +Provider for generating an [PhoneAuthCredential](./auth.phoneauthcredential.md). + Signature: ```typescript @@ -21,15 +23,15 @@ export declare class PhoneAuthProvider implements externs.PhoneAuthProvider | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [PHONE\_SIGN\_IN\_METHOD](./auth.phoneauthprovider.phone_sign_in_method.md) | static | (not declared) | | -| [PROVIDER\_ID](./auth.phoneauthprovider.provider_id.md) | static | (not declared) | | -| [providerId](./auth.phoneauthprovider.providerid.md) | | (not declared) | | +| [PHONE\_SIGN\_IN\_METHOD](./auth.phoneauthprovider.phone_sign_in_method.md) | static | (not declared) | Always set to [SignInMethod.PHONE](./auth-types.signinmethod.phone.md). | +| [PROVIDER\_ID](./auth.phoneauthprovider.provider_id.md) | static | (not declared) | Always set to [ProviderId.PHONE](./auth-types.providerid.phone.md). | +| [providerId](./auth.phoneauthprovider.providerid.md) | | (not declared) | Always set to [ProviderId.PHONE](./auth-types.providerid.phone.md). | ## Methods | Method | Modifiers | Description | | --- | --- | --- | -| [credential(verificationId, verificationCode)](./auth.phoneauthprovider.credential.md) | static | | +| [credential(verificationId, verificationCode)](./auth.phoneauthprovider.credential.md) | static | Creates a phone auth credential, given the verification ID from [PhoneAuthProvider.verifyPhoneNumber()](./auth.phoneauthprovider.verifyphonenumber.md) and the code that was sent to the user's mobile device. | | [credentialFromResult(userCredential)](./auth.phoneauthprovider.credentialfromresult.md) | static | | -| [verifyPhoneNumber(phoneOptions, applicationVerifier)](./auth.phoneauthprovider.verifyphonenumber.md) | | | +| [verifyPhoneNumber(phoneOptions, applicationVerifier)](./auth.phoneauthprovider.verifyphonenumber.md) | | Starts a phone number authentication flow by sending a verification code to the given phone number. | diff --git a/docs-exp/auth.phoneauthprovider.phone_sign_in_method.md b/docs-exp/auth.phoneauthprovider.phone_sign_in_method.md index c6a47a86cef..22f55b86489 100644 --- a/docs-exp/auth.phoneauthprovider.phone_sign_in_method.md +++ b/docs-exp/auth.phoneauthprovider.phone_sign_in_method.md @@ -4,6 +4,8 @@ ## PhoneAuthProvider.PHONE\_SIGN\_IN\_METHOD property +Always set to [SignInMethod.PHONE](./auth-types.signinmethod.phone.md). + Signature: ```typescript diff --git a/docs-exp/auth.phoneauthprovider.provider_id.md b/docs-exp/auth.phoneauthprovider.provider_id.md index 4aa2cfb3f95..4d48a263d9a 100644 --- a/docs-exp/auth.phoneauthprovider.provider_id.md +++ b/docs-exp/auth.phoneauthprovider.provider_id.md @@ -4,6 +4,8 @@ ## PhoneAuthProvider.PROVIDER\_ID property +Always set to [ProviderId.PHONE](./auth-types.providerid.phone.md). + Signature: ```typescript diff --git a/docs-exp/auth.phoneauthprovider.providerid.md b/docs-exp/auth.phoneauthprovider.providerid.md index e7fd5e2385e..4d240d089a0 100644 --- a/docs-exp/auth.phoneauthprovider.providerid.md +++ b/docs-exp/auth.phoneauthprovider.providerid.md @@ -4,6 +4,8 @@ ## PhoneAuthProvider.providerId property +Always set to [ProviderId.PHONE](./auth-types.providerid.phone.md). + Signature: ```typescript diff --git a/docs-exp/auth.phoneauthprovider.verifyphonenumber.md b/docs-exp/auth.phoneauthprovider.verifyphonenumber.md index f0985746ac3..d44aa64c71b 100644 --- a/docs-exp/auth.phoneauthprovider.verifyphonenumber.md +++ b/docs-exp/auth.phoneauthprovider.verifyphonenumber.md @@ -4,6 +4,8 @@ ## PhoneAuthProvider.verifyPhoneNumber() method +Starts a phone number authentication flow by sending a verification code to the given phone number. + Signature: ```typescript @@ -15,9 +17,11 @@ verifyPhoneNumber(phoneOptions: externs.PhoneInfoOptions | string, applicationVe | Parameter | Type | Description | | --- | --- | --- | | phoneOptions | externs.[PhoneInfoOptions](./auth-types.phoneinfooptions.md) \| string | | -| applicationVerifier | externs.[ApplicationVerifier](./auth-types.applicationverifier.md) | | +| applicationVerifier | externs.[ApplicationVerifier](./auth-types.applicationverifier.md) | For abuse prevention, this method also requires a [ApplicationVerifier](./auth-types.applicationverifier.md). This SDK includes a reCAPTCHA-based implementation, [RecaptchaVerifier](./auth.recaptchaverifier.md). | Returns: Promise<string> +A Promise for a verification ID that can be passed to [PhoneAuthProvider.credential()](./auth.phoneauthprovider.credential.md) to identify this flow.. + diff --git a/docs-exp/auth.phonemultifactorgenerator.assertion.md b/docs-exp/auth.phonemultifactorgenerator.assertion.md index ec67f7dd535..807e70b086e 100644 --- a/docs-exp/auth.phonemultifactorgenerator.assertion.md +++ b/docs-exp/auth.phonemultifactorgenerator.assertion.md @@ -4,6 +4,8 @@ ## PhoneMultiFactorGenerator.assertion() method +Provides a [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) to confirm ownership of the phone second factor. + Signature: ```typescript @@ -20,3 +22,5 @@ static assertion(credential: externs.PhoneAuthCredential): externs.PhoneMultiFac externs.[PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) +A [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) which can be used with [MultiFactorResolver.resolveSignIn()](./auth-types.multifactorresolver.resolvesignin.md) + diff --git a/docs-exp/auth.phonemultifactorgenerator.md b/docs-exp/auth.phonemultifactorgenerator.md index 3b554942994..28f035090f9 100644 --- a/docs-exp/auth.phonemultifactorgenerator.md +++ b/docs-exp/auth.phonemultifactorgenerator.md @@ -4,6 +4,8 @@ ## PhoneMultiFactorGenerator class +Provider for generating a [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md). + Signature: ```typescript @@ -15,5 +17,5 @@ export declare class PhoneMultiFactorGenerator implements externs.PhoneMultiFact | Method | Modifiers | Description | | --- | --- | --- | -| [assertion(credential)](./auth.phonemultifactorgenerator.assertion.md) | static | | +| [assertion(credential)](./auth.phonemultifactorgenerator.assertion.md) | static | Provides a [PhoneMultiFactorAssertion](./auth-types.phonemultifactorassertion.md) to confirm ownership of the phone second factor. | diff --git a/docs-exp/auth.reauthenticatewithcredential.md b/docs-exp/auth.reauthenticatewithcredential.md index 76550ed0700..6de1ca307ae 100644 --- a/docs-exp/auth.reauthenticatewithcredential.md +++ b/docs-exp/auth.reauthenticatewithcredential.md @@ -4,20 +4,26 @@ ## reauthenticateWithCredential() function +Re-authenticates a user using a fresh credential. + Signature: ```typescript -export declare function reauthenticateWithCredential(userExtern: externs.User, credentialExtern: externs.AuthCredential): Promise; +export declare function reauthenticateWithCredential(user: externs.User, credential: externs.AuthCredential): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| userExtern | externs.[User](./auth-types.user.md) | | -| credentialExtern | externs.[AuthCredential](./auth-types.authcredential.md) | | +| user | externs.[User](./auth-types.user.md) | The user. | +| credential | externs.[AuthCredential](./auth-types.authcredential.md) | The auth credential. | Returns: Promise<externs.[UserCredential](./auth-types.usercredential.md)> +## Remarks + +Use before operations such as [updatePassword()](./auth.updatepassword.md) that require tokens from recent sign-in attempts. This method can be used to recover from a [AuthErrorCode.CREDENTIAL\_TOO\_OLD\_LOGIN\_AGAIN](./auth.autherrorcode.credential_too_old_login_again.md) error. + diff --git a/docs-exp/auth.reauthenticatewithphonenumber.md b/docs-exp/auth.reauthenticatewithphonenumber.md index 47c25c6ecba..7973d7fb003 100644 --- a/docs-exp/auth.reauthenticatewithphonenumber.md +++ b/docs-exp/auth.reauthenticatewithphonenumber.md @@ -4,21 +4,27 @@ ## reauthenticateWithPhoneNumber() function +Re-authenticates a user using a fresh phne credential. + Signature: ```typescript -export declare function reauthenticateWithPhoneNumber(userExtern: externs.User, phoneNumber: string, appVerifier: externs.ApplicationVerifier): Promise; +export declare function reauthenticateWithPhoneNumber(user: externs.User, phoneNumber: string, appVerifier: externs.ApplicationVerifier): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| userExtern | externs.[User](./auth-types.user.md) | | -| phoneNumber | string | | -| appVerifier | externs.[ApplicationVerifier](./auth-types.applicationverifier.md) | | +| user | externs.[User](./auth-types.user.md) | The user. | +| phoneNumber | string | The user's phone number in E.164 format (e.g. +16505550101). | +| appVerifier | externs.[ApplicationVerifier](./auth-types.applicationverifier.md) | The [ApplicationVerifier](./auth-types.applicationverifier.md). | Returns: Promise<externs.[ConfirmationResult](./auth-types.confirmationresult.md)> +## Remarks + +Use before operations such as [updatePassword()](./auth.updatepassword.md) that require tokens from recent sign-in attempts. + diff --git a/docs-exp/auth.reauthenticatewithpopup.md b/docs-exp/auth.reauthenticatewithpopup.md index f759246a63a..50cb584086a 100644 --- a/docs-exp/auth.reauthenticatewithpopup.md +++ b/docs-exp/auth.reauthenticatewithpopup.md @@ -4,21 +4,39 @@ ## reauthenticateWithPopup() function +Reauthenticates the current user with the specified [OAuthProvider](./auth.oauthprovider.md) using a pop-up based OAuth flow. + Signature: ```typescript -export declare function reauthenticateWithPopup(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern?: externs.PopupRedirectResolver): Promise; +export declare function reauthenticateWithPopup(user: externs.User, provider: externs.AuthProvider, resolver?: externs.PopupRedirectResolver): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| userExtern | externs.[User](./auth-types.user.md) | | -| provider | externs.[AuthProvider](./auth-types.authprovider.md) | | -| resolverExtern | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | | +| user | externs.[User](./auth-types.user.md) | The user. | +| provider | externs.[AuthProvider](./auth-types.authprovider.md) | The provider to authenticate. The provider has to be an [OAuthProvider](./auth.oauthprovider.md). Non-OAuth providers like [EmailAuthProvider](./auth.emailauthprovider.md) will throw an error. | +| resolver | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | An instance of [PopupRedirectResolver](./auth-types.popupredirectresolver.md), optional if already supplied to [initializeAuth()](./auth.initializeauth.md) or provided by [getAuth()](./auth.getauth.md). | Returns: Promise<externs.[UserCredential](./auth-types.usercredential.md)> +## Remarks + +If the reauthentication is successful, the returned result will contain the user and the provider's credential. + +## Example + + +```javascript +// Sign in using a popup. +const provider = new FacebookAuthProvider(); +const result = await signInWithPopup(auth, provider); +// Reauthenticate using a popup. +await reauthenticateWithPopup(result.user, provider); + +``` + diff --git a/docs-exp/auth.reauthenticatewithredirect.md b/docs-exp/auth.reauthenticatewithredirect.md index 537f4810542..c7786d00ce5 100644 --- a/docs-exp/auth.reauthenticatewithredirect.md +++ b/docs-exp/auth.reauthenticatewithredirect.md @@ -4,21 +4,43 @@ ## reauthenticateWithRedirect() function +Reauthenticates the current user with the specified [OAuthProvider](./auth.oauthprovider.md) using a full-page redirect flow. + Signature: ```typescript -export declare function reauthenticateWithRedirect(userExtern: externs.User, provider: externs.AuthProvider, resolverExtern?: externs.PopupRedirectResolver): Promise; +export declare function reauthenticateWithRedirect(user: externs.User, provider: externs.AuthProvider, resolver?: externs.PopupRedirectResolver): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| userExtern | externs.[User](./auth-types.user.md) | | -| provider | externs.[AuthProvider](./auth-types.authprovider.md) | | -| resolverExtern | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | | +| user | externs.[User](./auth-types.user.md) | The user. | +| provider | externs.[AuthProvider](./auth-types.authprovider.md) | The provider to authenticate. The provider has to be an [OAuthProvider](./auth.oauthprovider.md). Non-OAuth providers like [EmailAuthProvider](./auth.emailauthprovider.md) will throw an error. | +| resolver | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | An instance of [PopupRedirectResolver](./auth-types.popupredirectresolver.md), optional if already supplied to [initializeAuth()](./auth.initializeauth.md) or provided by [getAuth()](./auth.getauth.md). | Returns: Promise<never> +## Example + + +```javascript +// Sign in using a redirect. +const provider = new FacebookAuthProvider(); +const result = await signInWithRedirect(auth, provider); +// This will trigger a full page redirect away from your app + +// After returning from the redirect when your app initializes you can obtain the result +const result = await getRedirectResult(auth); +// Link using a redirect. +await linkWithRedirect(result.user, provider); +// This will again trigger a full page redirect away from your app + +// After returning from the redirect when your app initializes you can obtain the result +const result = await getRedirectResult(auth); + +``` + diff --git a/docs-exp/auth.recaptchaverifier._recaptchaloader.md b/docs-exp/auth.recaptchaverifier._recaptchaloader.md deleted file mode 100644 index d007fadcd77..00000000000 --- a/docs-exp/auth.recaptchaverifier._recaptchaloader.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [RecaptchaVerifier](./auth.recaptchaverifier.md) > [\_recaptchaLoader](./auth.recaptchaverifier._recaptchaloader.md) - -## RecaptchaVerifier.\_recaptchaLoader property - -Signature: - -```typescript -readonly _recaptchaLoader: ReCaptchaLoader; -``` diff --git a/docs-exp/auth.recaptchaverifier._reset.md b/docs-exp/auth.recaptchaverifier._reset.md deleted file mode 100644 index 9eac4ac21fd..00000000000 --- a/docs-exp/auth.recaptchaverifier._reset.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [RecaptchaVerifier](./auth.recaptchaverifier.md) > [\_reset](./auth.recaptchaverifier._reset.md) - -## RecaptchaVerifier.\_reset() method - -Signature: - -```typescript -_reset(): void; -``` -Returns: - -void - diff --git a/docs-exp/auth.recaptchaverifier.clear.md b/docs-exp/auth.recaptchaverifier.clear.md index ba123cbca89..f84c389f8af 100644 --- a/docs-exp/auth.recaptchaverifier.clear.md +++ b/docs-exp/auth.recaptchaverifier.clear.md @@ -4,6 +4,8 @@ ## RecaptchaVerifier.clear() method +Clears the reCAPTCHA widget from the page and destroys the instance. + Signature: ```typescript diff --git a/docs-exp/auth.recaptchaverifier.md b/docs-exp/auth.recaptchaverifier.md index ecbf1958428..56349e83790 100644 --- a/docs-exp/auth.recaptchaverifier.md +++ b/docs-exp/auth.recaptchaverifier.md @@ -4,6 +4,8 @@ ## RecaptchaVerifier class +An [reCAPTCHA](https://www.google.com/recaptcha/)-based application verifier. + Signature: ```typescript @@ -21,15 +23,13 @@ export declare class RecaptchaVerifier implements externs.RecaptchaVerifier, App | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [\_recaptchaLoader](./auth.recaptchaverifier._recaptchaloader.md) | | ReCaptchaLoader | | | [type](./auth.recaptchaverifier.type.md) | | (not declared) | | ## Methods | Method | Modifiers | Description | | --- | --- | --- | -| [\_reset()](./auth.recaptchaverifier._reset.md) | | | -| [clear()](./auth.recaptchaverifier.clear.md) | | | -| [render()](./auth.recaptchaverifier.render.md) | | | -| [verify()](./auth.recaptchaverifier.verify.md) | | | +| [clear()](./auth.recaptchaverifier.clear.md) | | Clears the reCAPTCHA widget from the page and destroys the instance. | +| [render()](./auth.recaptchaverifier.render.md) | | Renders the reCAPTCHA widget on the page. | +| [verify()](./auth.recaptchaverifier.verify.md) | | Waits for the user to solve the reCAPTCHA and resolves with the reCAPTCHA token. | diff --git a/docs-exp/auth.recaptchaverifier.render.md b/docs-exp/auth.recaptchaverifier.render.md index 8906d27b543..1e615bb237f 100644 --- a/docs-exp/auth.recaptchaverifier.render.md +++ b/docs-exp/auth.recaptchaverifier.render.md @@ -4,6 +4,8 @@ ## RecaptchaVerifier.render() method +Renders the reCAPTCHA widget on the page. + Signature: ```typescript @@ -13,3 +15,5 @@ render(): Promise; Promise<number> +A Promise that resolves with the reCAPTCHA widget ID. + diff --git a/docs-exp/auth.recaptchaverifier.verify.md b/docs-exp/auth.recaptchaverifier.verify.md index b43a620c077..3eae6aaa07b 100644 --- a/docs-exp/auth.recaptchaverifier.verify.md +++ b/docs-exp/auth.recaptchaverifier.verify.md @@ -4,6 +4,8 @@ ## RecaptchaVerifier.verify() method +Waits for the user to solve the reCAPTCHA and resolves with the reCAPTCHA token. + Signature: ```typescript @@ -13,3 +15,5 @@ verify(): Promise; Promise<string> +A Promise for the reCAPTCHA token. + diff --git a/docs-exp/auth.reload.md b/docs-exp/auth.reload.md index 80b815e6fba..3231df1b984 100644 --- a/docs-exp/auth.reload.md +++ b/docs-exp/auth.reload.md @@ -4,17 +4,19 @@ ## reload() function +Reloads user account data, if signed in. + Signature: ```typescript -export declare function reload(externUser: externs.User): Promise; +export declare function reload(user: externs.User): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| externUser | externs.[User](./auth-types.user.md) | | +| user | externs.[User](./auth-types.user.md) | The user. | Returns: diff --git a/docs-exp/auth.sendemailverification.md b/docs-exp/auth.sendemailverification.md index 48a278b86bf..a64878d0033 100644 --- a/docs-exp/auth.sendemailverification.md +++ b/docs-exp/auth.sendemailverification.md @@ -4,20 +4,48 @@ ## sendEmailVerification() function +Sends a verification email to a user. + Signature: ```typescript -export declare function sendEmailVerification(userExtern: externs.User, actionCodeSettings?: externs.ActionCodeSettings | null): Promise; +export declare function sendEmailVerification(user: externs.User, actionCodeSettings?: externs.ActionCodeSettings | null): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| userExtern | externs.[User](./auth-types.user.md) | | -| actionCodeSettings | externs.[ActionCodeSettings](./auth-types.actioncodesettings.md) \| null | | +| user | externs.[User](./auth-types.user.md) | The user. | +| actionCodeSettings | externs.[ActionCodeSettings](./auth-types.actioncodesettings.md) \| null | The [ActionCodeSettings](./auth-types.actioncodesettings.md). | Returns: Promise<void> +## Remarks + +The verification process is completed by calling [applyActionCode()](./auth.applyactioncode.md). + +## Example + + +```javascript +const actionCodeSettings = { + url: 'https://www.example.com/?email=user@example.com', + iOS: { + bundleId: 'com.example.ios' + }, + android: { + packageName: 'com.example.android', + installApp: true, + minimumVersion: '12' + }, + handleCodeInApp: true +}; +await sendEmailVerification(user, actionCodeSettings); +// Obtain code from the user. +await applyActionCode(auth, code); + +``` + diff --git a/docs-exp/auth.sendpasswordresetemail.md b/docs-exp/auth.sendpasswordresetemail.md index 43dfca24398..6d8063f9c41 100644 --- a/docs-exp/auth.sendpasswordresetemail.md +++ b/docs-exp/auth.sendpasswordresetemail.md @@ -4,6 +4,8 @@ ## sendPasswordResetEmail() function +Sends a password reset email to the given email address. + Signature: ```typescript @@ -14,11 +16,37 @@ export declare function sendPasswordResetEmail(auth: externs.Auth, email: string | Parameter | Type | Description | | --- | --- | --- | -| auth | externs.[Auth](./auth-types.auth.md) | | -| email | string | | -| actionCodeSettings | externs.[ActionCodeSettings](./auth-types.actioncodesettings.md) | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| email | string | The user's email address. | +| actionCodeSettings | externs.[ActionCodeSettings](./auth-types.actioncodesettings.md) | The [ActionCodeSettings](./auth-types.actioncodesettings.md). | Returns: Promise<void> +## Remarks + +To complete the password reset, call [confirmPasswordReset()](./auth.confirmpasswordreset.md) with the code supplied in the email sent to the user, along with the new password specified by the user. + +## Example + + +```javascript +const actionCodeSettings = { + url: 'https://www.example.com/?email=user@example.com', + iOS: { + bundleId: 'com.example.ios' + }, + android: { + packageName: 'com.example.android', + installApp: true, + minimumVersion: '12' + }, + handleCodeInApp: true +}; +await sendPasswordResetEmail(auth, 'user@example.com', actionCodeSettings); +// Obtain code from user. +await confirmPasswordReset('user@example.com', code); + +``` + diff --git a/docs-exp/auth.sendsigninlinktoemail.md b/docs-exp/auth.sendsigninlinktoemail.md index 22df05cb5cf..a4657bdbc63 100644 --- a/docs-exp/auth.sendsigninlinktoemail.md +++ b/docs-exp/auth.sendsigninlinktoemail.md @@ -4,6 +4,8 @@ ## sendSignInLinkToEmail() function +Sends a sign-in email link to the user with the specified email. + Signature: ```typescript @@ -14,11 +16,41 @@ export declare function sendSignInLinkToEmail(auth: externs.Auth, email: string, | Parameter | Type | Description | | --- | --- | --- | -| auth | externs.[Auth](./auth-types.auth.md) | | -| email | string | | -| actionCodeSettings | externs.[ActionCodeSettings](./auth-types.actioncodesettings.md) | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| email | string | The user's email address. | +| actionCodeSettings | externs.[ActionCodeSettings](./auth-types.actioncodesettings.md) | The [ActionCodeSettings](./auth-types.actioncodesettings.md). | Returns: Promise<void> +## Remarks + +The sign-in operation has to always be completed in the app unlike other out of band email actions (password reset and email verifications). This is because, at the end of the flow, the user is expected to be signed in and their Auth state persisted within the app. + +To complete sign in with the email link, call [signInWithEmailLink()](./auth.signinwithemaillink.md) with the email address and the email link supplied in the email sent to the user. + +## Example + + +```javascript +const actionCodeSettings = { + url: 'https://www.example.com/?email=user@example.com', + iOS: { + bundleId: 'com.example.ios' + }, + android: { + packageName: 'com.example.android', + installApp: true, + minimumVersion: '12' + }, + handleCodeInApp: true +}; +await sendSignInLinkToEmail(auth, 'user@example.com', actionCodeSettings); +// Obtain emailLink from the user. +if(isSignInWithEmailLink(auth, emailLink)) { + await signInWithEmailLink('user@example.com', 'user@example.com', emailLink); +} + +``` + diff --git a/docs-exp/auth.setpersistence.md b/docs-exp/auth.setpersistence.md index 36a154e6e26..94af859d0cf 100644 --- a/docs-exp/auth.setpersistence.md +++ b/docs-exp/auth.setpersistence.md @@ -4,6 +4,8 @@ ## setPersistence() function +Changes the type of persistence on the Auth instance for the currently saved Auth session and applies this type of persistence for future sign-in requests, including sign-in with redirect requests. + Signature: ```typescript @@ -14,10 +16,22 @@ export declare function setPersistence(auth: externs.Auth, persistence: externs. | Parameter | Type | Description | | --- | --- | --- | -| auth | externs.[Auth](./auth-types.auth.md) | | -| persistence | externs.[Persistence](./auth-types.persistence.md) | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| persistence | externs.[Persistence](./auth-types.persistence.md) | The [Persistence](./auth-types.persistence.md) to use. | Returns: void +## Remarks + +This makes it easy for a user signing in to specify whether their session should be remembered or not. It also makes it easier to never persist the Auth state for applications that are shared by other users or have sensitive data. + +## Example + + +```javascript +setPersistence(auth, browserSessionPersistence); + +``` + diff --git a/docs-exp/auth.signinanonymously.md b/docs-exp/auth.signinanonymously.md index a3c8d7be30e..2c855a64db0 100644 --- a/docs-exp/auth.signinanonymously.md +++ b/docs-exp/auth.signinanonymously.md @@ -4,6 +4,8 @@ ## signInAnonymously() function +Asynchronously signs in as an anonymous user. + Signature: ```typescript @@ -14,9 +16,13 @@ export declare function signInAnonymously(auth: externs.Auth): PromiseReturns: Promise<externs.[UserCredential](./auth-types.usercredential.md)> +## Remarks + +If there is already an anonymous user signed in, that user will be returned; otherwise, a new anonymous user identity will be created and returned. + diff --git a/docs-exp/auth.signinwithcredential.md b/docs-exp/auth.signinwithcredential.md index bc33d4a27d9..a67dd4d6186 100644 --- a/docs-exp/auth.signinwithcredential.md +++ b/docs-exp/auth.signinwithcredential.md @@ -4,6 +4,8 @@ ## signInWithCredential() function +Asynchronously signs in with the given credentials. + Signature: ```typescript @@ -14,10 +16,14 @@ export declare function signInWithCredential(auth: externs.Auth, credential: ext | Parameter | Type | Description | | --- | --- | --- | -| auth | externs.[Auth](./auth-types.auth.md) | | -| credential | externs.[AuthCredential](./auth-types.authcredential.md) | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| credential | externs.[AuthCredential](./auth-types.authcredential.md) | The auth credential. | Returns: Promise<externs.[UserCredential](./auth-types.usercredential.md)> +## Remarks + +An [AuthProvider](./auth-types.authprovider.md) can be used to generate the credential. + diff --git a/docs-exp/auth.signinwithcustomtoken.md b/docs-exp/auth.signinwithcustomtoken.md index 236c14cd1c4..e103a0a484d 100644 --- a/docs-exp/auth.signinwithcustomtoken.md +++ b/docs-exp/auth.signinwithcustomtoken.md @@ -4,20 +4,28 @@ ## signInWithCustomToken() function +Asynchronously signs in using a custom token. + Signature: ```typescript -export declare function signInWithCustomToken(authExtern: externs.Auth, customToken: string): Promise; +export declare function signInWithCustomToken(auth: externs.Auth, customToken: string): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| authExtern | externs.[Auth](./auth-types.auth.md) | | -| customToken | string | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| customToken | string | The custom token to sign in with. | Returns: Promise<externs.[UserCredential](./auth-types.usercredential.md)> +## Remarks + +Custom tokens are used to integrate Firebase Auth with existing auth systems, and must be generated by an auth backend using the [createCustomToken](https://firebase.google.com/docs/reference/admin/node/admin.auth.Auth#createcustomtoken) method in the [Admin SDK](https://firebase.google.com/docs/auth/admin) . + +Fails with an error if the token is invalid, expired, or not accepted by the Firebase Auth service. + diff --git a/docs-exp/auth.signinwithemailandpassword.md b/docs-exp/auth.signinwithemailandpassword.md index 38cc2a1832f..82d512b7000 100644 --- a/docs-exp/auth.signinwithemailandpassword.md +++ b/docs-exp/auth.signinwithemailandpassword.md @@ -4,6 +4,8 @@ ## signInWithEmailAndPassword() function +Asynchronously signs in using an email and password. + Signature: ```typescript @@ -14,11 +16,17 @@ export declare function signInWithEmailAndPassword(auth: externs.Auth, email: st | Parameter | Type | Description | | --- | --- | --- | -| auth | externs.[Auth](./auth-types.auth.md) | | -| email | string | | -| password | string | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| email | string | The users email address. | +| password | string | The users password. | Returns: Promise<externs.[UserCredential](./auth-types.usercredential.md)> +## Remarks + +Fails with an error if the email address and password do not match. + +Note: The user's password is NOT the password used to access the user's email account. The email address serves as a unique identifier for the user, and the password is used to access the user's account in your Firebase project. See also: [createUserWithEmailAndPassword()](./auth.createuserwithemailandpassword.md). + diff --git a/docs-exp/auth.signinwithemaillink.md b/docs-exp/auth.signinwithemaillink.md index e99930a1828..bd2be08901b 100644 --- a/docs-exp/auth.signinwithemaillink.md +++ b/docs-exp/auth.signinwithemaillink.md @@ -4,6 +4,8 @@ ## signInWithEmailLink() function +Asynchronously signs in using an email and sign-in email link. + Signature: ```typescript @@ -14,11 +16,43 @@ export declare function signInWithEmailLink(auth: externs.Auth, email: string, e | Parameter | Type | Description | | --- | --- | --- | -| auth | externs.[Auth](./auth-types.auth.md) | | -| email | string | | -| emailLink | string | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| email | string | The user's email address. | +| emailLink | string | The link sent to the user's email address. | Returns: Promise<externs.[UserCredential](./auth-types.usercredential.md)> +## Remarks + +If no link is passed, the link is inferred from the current URL. + +Fails with an error if the email address is invalid or OTP in email link expires. + +Note: Confirm the link is a sign-in email link before calling this method firebase.auth.Auth.isSignInWithEmailLink. + +## Example + + +```javascript +const actionCodeSettings = { + url: 'https://www.example.com/?email=user@example.com', + iOS: { + bundleId: 'com.example.ios' + }, + android: { + packageName: 'com.example.android', + installApp: true, + minimumVersion: '12' + }, + handleCodeInApp: true +}; +await sendSignInLinkToEmail(auth, 'user@example.com', actionCodeSettings); +// Obtain emailLink from the user. +if(isSignInWithEmailLink(auth, emailLink)) { + await signInWithEmailLink('user@example.com', 'user@example.com', emailLink); +} + +``` + diff --git a/docs-exp/auth.signinwithphonenumber.md b/docs-exp/auth.signinwithphonenumber.md index 82768c1b0ee..cfe03247454 100644 --- a/docs-exp/auth.signinwithphonenumber.md +++ b/docs-exp/auth.signinwithphonenumber.md @@ -4,6 +4,8 @@ ## signInWithPhoneNumber() function +Asynchronously signs in using a phone number. + Signature: ```typescript @@ -14,11 +16,29 @@ export declare function signInWithPhoneNumber(auth: externs.Auth, phoneNumber: s | Parameter | Type | Description | | --- | --- | --- | -| auth | externs.[Auth](./auth-types.auth.md) | | -| phoneNumber | string | | -| appVerifier | externs.[ApplicationVerifier](./auth-types.applicationverifier.md) | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| phoneNumber | string | The user's phone number in E.164 format (e.g. +16505550101). | +| appVerifier | externs.[ApplicationVerifier](./auth-types.applicationverifier.md) | The [ApplicationVerifier](./auth-types.applicationverifier.md). | Returns: Promise<externs.[ConfirmationResult](./auth-types.confirmationresult.md)> +## Remarks + +This method sends a code via SMS to the given phone number, and returns a [ConfirmationResult](./auth-types.confirmationresult.md). After the user provides the code sent to their phone, call [ConfirmationResult.confirm()](./auth-types.confirmationresult.confirm.md) with the code to sign the user in. + +For abuse prevention, this method also requires a [ApplicationVerifier](./auth-types.applicationverifier.md). This SDK includes a reCAPTCHA-based implementation, [RecaptchaVerifier](./auth.recaptchaverifier.md). + +## Example + + +```javascript +// 'recaptcha-container' is the ID of an element in the DOM. +const applicationVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container'); +const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier); +// Obtain a verificationCode from the user. +const credential = await confirmationResult.confirm(verificationCode); + +``` + diff --git a/docs-exp/auth.signinwithpopup.md b/docs-exp/auth.signinwithpopup.md index 4be7d318680..0ba4bb59ec0 100644 --- a/docs-exp/auth.signinwithpopup.md +++ b/docs-exp/auth.signinwithpopup.md @@ -4,21 +4,43 @@ ## signInWithPopup() function +Authenticates a Firebase client using a popup-based OAuth authentication flow. + Signature: ```typescript -export declare function signInWithPopup(authExtern: externs.Auth, provider: externs.AuthProvider, resolverExtern?: externs.PopupRedirectResolver): Promise; +export declare function signInWithPopup(auth: externs.Auth, provider: externs.AuthProvider, resolver?: externs.PopupRedirectResolver): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| authExtern | externs.[Auth](./auth-types.auth.md) | | -| provider | externs.[AuthProvider](./auth-types.authprovider.md) | | -| resolverExtern | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| provider | externs.[AuthProvider](./auth-types.authprovider.md) | The provider to authenticate. The provider has to be an [OAuthProvider](./auth.oauthprovider.md). Non-OAuth providers like [EmailAuthProvider](./auth.emailauthprovider.md) will throw an error. | +| resolver | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | An instance of [PopupRedirectResolver](./auth-types.popupredirectresolver.md), optional if already supplied to [initializeAuth()](./auth.initializeauth.md) or provided by [getAuth()](./auth.getauth.md). | Returns: Promise<externs.[UserCredential](./auth-types.usercredential.md)> +## Remarks + +If succeeds, returns the signed in user along with the provider's credential. If sign in was unsuccessful, returns an error object containing additional information about the error. + +## Example + + +```javascript +// Sign in using a popup. +const provider = new FacebookAuthProvider(); +const result = await signInWithPopup(auth, provider); + +// The signed-in user info. +const user = result.user; +// This gives you a Facebook Access Token. +const credential = provider.credentialFromResult(auth, result); +const token = credential.accessToken; + +``` + diff --git a/docs-exp/auth.signinwithredirect.md b/docs-exp/auth.signinwithredirect.md index 86336c4a436..328611e9307 100644 --- a/docs-exp/auth.signinwithredirect.md +++ b/docs-exp/auth.signinwithredirect.md @@ -4,21 +4,55 @@ ## signInWithRedirect() function +Authenticates a Firebase client using a full-page redirect flow. + Signature: ```typescript -export declare function signInWithRedirect(authExtern: externs.Auth, provider: externs.AuthProvider, resolverExtern?: externs.PopupRedirectResolver): Promise; +export declare function signInWithRedirect(auth: externs.Auth, provider: externs.AuthProvider, resolver?: externs.PopupRedirectResolver): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| authExtern | externs.[Auth](./auth-types.auth.md) | | -| provider | externs.[AuthProvider](./auth-types.authprovider.md) | | -| resolverExtern | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| provider | externs.[AuthProvider](./auth-types.authprovider.md) | The provider to authenticate. The provider has to be an [OAuthProvider](./auth.oauthprovider.md). Non-OAuth providers like [EmailAuthProvider](./auth.emailauthprovider.md) will throw an error. | +| resolver | externs.[PopupRedirectResolver](./auth-types.popupredirectresolver.md) | An instance of [PopupRedirectResolver](./auth-types.popupredirectresolver.md), optional if already supplied to [initializeAuth()](./auth.initializeauth.md) or provided by [getAuth()](./auth.getauth.md). | Returns: Promise<never> +## Remarks + +To handle the results and errors for this operation, refer to [getRedirectResult()](./auth.getredirectresult.md). + +## Example + + +```javascript +// Sign in using a redirect. +const provider = new FacebookAuthProvider(); +// You can add additional scopes to the provider: +provider.addScope('user_birthday'); +// Start a sign in process for an unauthenticated user. +await signInWithRedirect(auth, provider); +// This will trigger a full page redirect away from your app + +// After returning from the redirect when your app initializes you can obtain the result +const result = await getRedirectResult(auth); +if (result) { + // This is the signed-in user + const user = result.user; + // This gives you a Facebook Access Token. + const credential = provider.credentialFromResult(auth, result); + const token = credential.accessToken; +} +// As this API can be used for sign-in, linking and reauthentication, +// check the operationType to determine what triggered this redirect +// operation. +const operationType = result.operationType; + +``` + diff --git a/docs-exp/auth.signout.md b/docs-exp/auth.signout.md index 81de60f223d..d5e2fd9d0fb 100644 --- a/docs-exp/auth.signout.md +++ b/docs-exp/auth.signout.md @@ -4,6 +4,8 @@ ## signOut() function +Signs out the current user. + Signature: ```typescript @@ -14,7 +16,7 @@ export declare function signOut(auth: externs.Auth): Promise; | Parameter | Type | Description | | --- | --- | --- | -| auth | externs.[Auth](./auth-types.auth.md) | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | Returns: diff --git a/docs-exp/auth.twitterauthprovider.credential.md b/docs-exp/auth.twitterauthprovider.credential.md index 6d69b167d4f..2ccf365382d 100644 --- a/docs-exp/auth.twitterauthprovider.credential.md +++ b/docs-exp/auth.twitterauthprovider.credential.md @@ -4,6 +4,8 @@ ## TwitterAuthProvider.credential() method +Creates a credential for Twitter. + Signature: ```typescript @@ -14,8 +16,8 @@ static credential(token: string, secret: string): externs.OAuthCredential; | Parameter | Type | Description | | --- | --- | --- | -| token | string | | -| secret | string | | +| token | string | Twitter access token. | +| secret | string | Twitter secret. | Returns: diff --git a/docs-exp/auth.twitterauthprovider.credentialfromerror.md b/docs-exp/auth.twitterauthprovider.credentialfromerror.md index 65415df82a8..795a5f84b34 100644 --- a/docs-exp/auth.twitterauthprovider.credentialfromerror.md +++ b/docs-exp/auth.twitterauthprovider.credentialfromerror.md @@ -4,6 +4,8 @@ ## TwitterAuthProvider.credentialFromError() method +Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [AuthError](./auth-types.autherror.md) which was thrown during a sign-in, link, or reauthenticate operation. + Signature: ```typescript diff --git a/docs-exp/auth.twitterauthprovider.credentialfromresult.md b/docs-exp/auth.twitterauthprovider.credentialfromresult.md index 1f48a64aa6a..ff1dae93a34 100644 --- a/docs-exp/auth.twitterauthprovider.credentialfromresult.md +++ b/docs-exp/auth.twitterauthprovider.credentialfromresult.md @@ -4,6 +4,8 @@ ## TwitterAuthProvider.credentialFromResult() method +Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [UserCredential](./auth-types.usercredential.md). + Signature: ```typescript @@ -14,7 +16,7 @@ static credentialFromResult(userCredential: externs.UserCredential): externs.OAu | Parameter | Type | Description | | --- | --- | --- | -| userCredential | externs.[UserCredential](./auth-types.usercredential.md) | | +| userCredential | externs.[UserCredential](./auth-types.usercredential.md) | The user credential. | Returns: diff --git a/docs-exp/auth.twitterauthprovider.md b/docs-exp/auth.twitterauthprovider.md index e7a1177a995..e868bc5e7e3 100644 --- a/docs-exp/auth.twitterauthprovider.md +++ b/docs-exp/auth.twitterauthprovider.md @@ -4,6 +4,8 @@ ## TwitterAuthProvider class +Provider for generating an [OAuthCredential](./auth.oauthcredential.md) for [ProviderId.TWITTER](./auth-types.providerid.twitter.md). + Signature: ```typescript @@ -11,6 +13,46 @@ export declare class TwitterAuthProvider extends OAuthProvider ``` Extends: [OAuthProvider](./auth.oauthprovider.md) +## Example 1 + + +```javascript +// Sign in using a redirect. +const provider = new TwitterAuthProvider(); +// Start a sign in process for an unauthenticated user. +await signInWithRedirect(auth, provider); +// This will trigger a full page redirect away from your app + +// After returning from the redirect when your app initializes you can obtain the result +const result = await getRedirectResult(auth); +if (result) { + // This is the signed-in user + const user = result.user; + // This gives you a Twitter Access Token and Secret. + const credential = provider.credentialFromResult(auth, result); + const token = credential.accessToken; + const secret = credential.secret; +} + +``` + +## Example 2 + + +```javascript +// Sign in using a popup. +const provider = new TwitterAuthProvider(); +const result = await signInWithPopup(auth, provider); + +// The signed-in user info. +const user = result.user; +// This gives you a Twitter Access Token and Secret. +const credential = provider.credentialFromResult(auth, result); +const token = credential.accessToken; +const secret = credential.secret; + +``` + ## Constructors | Constructor | Modifiers | Description | @@ -28,7 +70,7 @@ export declare class TwitterAuthProvider extends OAuthProvider | Method | Modifiers | Description | | --- | --- | --- | -| [credential(token, secret)](./auth.twitterauthprovider.credential.md) | static | | -| [credentialFromError(error)](./auth.twitterauthprovider.credentialfromerror.md) | static | | -| [credentialFromResult(userCredential)](./auth.twitterauthprovider.credentialfromresult.md) | static | | +| [credential(token, secret)](./auth.twitterauthprovider.credential.md) | static | Creates a credential for Twitter. | +| [credentialFromError(error)](./auth.twitterauthprovider.credentialfromerror.md) | static | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [AuthError](./auth-types.autherror.md) which was thrown during a sign-in, link, or reauthenticate operation. | +| [credentialFromResult(userCredential)](./auth.twitterauthprovider.credentialfromresult.md) | static | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md) from a [UserCredential](./auth-types.usercredential.md). | diff --git a/docs-exp/auth.twitterauthprovider.providerid.md b/docs-exp/auth.twitterauthprovider.providerid.md deleted file mode 100644 index 511fd75a0d7..00000000000 --- a/docs-exp/auth.twitterauthprovider.providerid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [TwitterAuthProvider](./auth.twitterauthprovider.md) > [providerId](./auth.twitterauthprovider.providerid.md) - -## TwitterAuthProvider.providerId property - -Signature: - -```typescript -readonly providerId = externs.ProviderId.TWITTER; -``` diff --git a/docs-exp/auth.unlink.md b/docs-exp/auth.unlink.md index 9ccb9bec4ca..d80742904c2 100644 --- a/docs-exp/auth.unlink.md +++ b/docs-exp/auth.unlink.md @@ -4,20 +4,20 @@ ## unlink() function -This is the externally visible unlink function +Unlinks a provider from a user account. Signature: ```typescript -export declare function unlink(userExtern: externs.User, providerId: externs.ProviderId): Promise; +export declare function unlink(user: externs.User, providerId: externs.ProviderId): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| userExtern | externs.[User](./auth-types.user.md) | | -| providerId | externs.[ProviderId](./auth-types.providerid.md) | | +| user | externs.[User](./auth-types.user.md) | The user. | +| providerId | externs.[ProviderId](./auth-types.providerid.md) | The provider to unlink. | Returns: diff --git a/docs-exp/auth.updatecurrentuser.md b/docs-exp/auth.updatecurrentuser.md index c80b7fcadc2..371fe54fa71 100644 --- a/docs-exp/auth.updatecurrentuser.md +++ b/docs-exp/auth.updatecurrentuser.md @@ -4,6 +4,8 @@ ## updateCurrentUser() function +Asynchronously sets the provided user as [Auth.currentUser](./auth-types.auth.currentuser.md) on the [Auth](./auth-types.auth.md) instance. + Signature: ```typescript @@ -14,10 +16,18 @@ export declare function updateCurrentUser(auth: externs.Auth, user: externs.User | Parameter | Type | Description | | --- | --- | --- | -| auth | externs.[Auth](./auth-types.auth.md) | | -| user | externs.[User](./auth-types.user.md) \| null | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| user | externs.[User](./auth-types.user.md) \| null | The new [User](./auth-types.user.md). | Returns: Promise<void> +## Remarks + +A new instance copy of the user provided will be made and set as currentUser. + +This will trigger [onAuthStateChanged()](./auth.onauthstatechanged.md) and [onIdTokenChanged()](./auth.onidtokenchanged.md) listeners like other sign in methods. + +The operation fails with an error if the user to be updated belongs to a different Firebase project. + diff --git a/docs-exp/auth.updateemail.md b/docs-exp/auth.updateemail.md index 23b46b2f4d8..a4658bf8b11 100644 --- a/docs-exp/auth.updateemail.md +++ b/docs-exp/auth.updateemail.md @@ -4,20 +4,28 @@ ## updateEmail() function +Updates the user's email address. + Signature: ```typescript -export declare function updateEmail(externUser: externs.User, newEmail: string): Promise; +export declare function updateEmail(user: externs.User, newEmail: string): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| externUser | externs.[User](./auth-types.user.md) | | -| newEmail | string | | +| user | externs.[User](./auth-types.user.md) | The user. | +| newEmail | string | The new email address. | Returns: Promise<void> +## Remarks + +An email will be sent to the original email address (if it was set) that allows to revoke the email address change, in order to protect them from account hijacking. + +Important: this is a security sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and then call [reauthenticateWithCredential()](./auth.reauthenticatewithcredential.md). + diff --git a/docs-exp/auth.updatepassword.md b/docs-exp/auth.updatepassword.md index 2ab59fd0837..6bce5e46736 100644 --- a/docs-exp/auth.updatepassword.md +++ b/docs-exp/auth.updatepassword.md @@ -4,20 +4,26 @@ ## updatePassword() function +Updates the user's password. + Signature: ```typescript -export declare function updatePassword(externUser: externs.User, newPassword: string): Promise; +export declare function updatePassword(user: externs.User, newPassword: string): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| externUser | externs.[User](./auth-types.user.md) | | -| newPassword | string | | +| user | externs.[User](./auth-types.user.md) | The user. | +| newPassword | string | The new password. | Returns: Promise<void> +## Remarks + +Important: this is a security sensitive operation that requires the user to have recently signed in. If this requirement isn't met, ask the user to authenticate again and then call [reauthenticateWithCredential()](./auth.reauthenticatewithcredential.md). + diff --git a/docs-exp/auth.updatephonenumber.md b/docs-exp/auth.updatephonenumber.md index b744161c6e8..4192d52ef78 100644 --- a/docs-exp/auth.updatephonenumber.md +++ b/docs-exp/auth.updatephonenumber.md @@ -4,6 +4,8 @@ ## updatePhoneNumber() function +Updates the user's phone number. + Signature: ```typescript @@ -14,10 +16,24 @@ export declare function updatePhoneNumber(user: externs.User, credential: extern | Parameter | Type | Description | | --- | --- | --- | -| user | externs.[User](./auth-types.user.md) | | -| credential | externs.[PhoneAuthCredential](./auth-types.phoneauthcredential.md) | | +| user | externs.[User](./auth-types.user.md) | The user. | +| credential | externs.[PhoneAuthCredential](./auth-types.phoneauthcredential.md) | A credential authenticating the new phone number. | Returns: Promise<void> +## Example + + +``` +// 'recaptcha-container' is the ID of an element in the DOM. +const applicationVerifier = new RecaptchaVerifier('recaptcha-container'); +const provider = new PhoneAuthProvider(auth); +const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier); +// Obtain the verificationCode from the user. +const phoneCredential = PhoneAuthProvider.credential(verificationId, verificationCode); +await updatePhoneNumber(user, phoneCredential); + +``` + diff --git a/docs-exp/auth.updateprofile.md b/docs-exp/auth.updateprofile.md index 4e6185bc6ec..19a4f4a1c03 100644 --- a/docs-exp/auth.updateprofile.md +++ b/docs-exp/auth.updateprofile.md @@ -4,17 +4,19 @@ ## updateProfile() function +Updates a user's profile data. + Signature: ```typescript -export declare function updateProfile(externUser: externs.User, { displayName, photoURL: photoUrl }: Profile): Promise; +export declare function updateProfile(user: externs.User, { displayName, photoURL: photoUrl }: Profile): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| externUser | externs.[User](./auth-types.user.md) | | +| user | externs.[User](./auth-types.user.md) | The user. | | { displayName, photoURL: photoUrl } | Profile | | Returns: diff --git a/docs-exp/auth.usedevicelanguage.md b/docs-exp/auth.usedevicelanguage.md index 66d97759634..d545fdb97e7 100644 --- a/docs-exp/auth.usedevicelanguage.md +++ b/docs-exp/auth.usedevicelanguage.md @@ -4,6 +4,8 @@ ## useDeviceLanguage() function +Sets the current language to the default device/browser preference. + Signature: ```typescript @@ -14,7 +16,7 @@ export declare function useDeviceLanguage(auth: externs.Auth): void; | Parameter | Type | Description | | --- | --- | --- | -| auth | externs.[Auth](./auth-types.auth.md) | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instanec. | Returns: diff --git a/docs-exp/auth.verifybeforeupdateemail.md b/docs-exp/auth.verifybeforeupdateemail.md index c2e1bc53ebc..d619a7ba84a 100644 --- a/docs-exp/auth.verifybeforeupdateemail.md +++ b/docs-exp/auth.verifybeforeupdateemail.md @@ -4,21 +4,51 @@ ## verifyBeforeUpdateEmail() function +Sends a verification email to a new email address. + Signature: ```typescript -export declare function verifyBeforeUpdateEmail(userExtern: externs.User, newEmail: string, actionCodeSettings?: externs.ActionCodeSettings | null): Promise; +export declare function verifyBeforeUpdateEmail(user: externs.User, newEmail: string, actionCodeSettings?: externs.ActionCodeSettings | null): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| userExtern | externs.[User](./auth-types.user.md) | | -| newEmail | string | | -| actionCodeSettings | externs.[ActionCodeSettings](./auth-types.actioncodesettings.md) \| null | | +| user | externs.[User](./auth-types.user.md) | The user. | +| newEmail | string | The new email address to be verified before update. | +| actionCodeSettings | externs.[ActionCodeSettings](./auth-types.actioncodesettings.md) \| null | The [ActionCodeSettings](./auth-types.actioncodesettings.md). | Returns: Promise<void> +## Remarks + +The user's email will be updated to the new one after being verified. + +If you have a custom email action handler, you can complete the verification process by calling [applyActionCode()](./auth.applyactioncode.md). + +## Example + + +```javascript +const actionCodeSettings = { + url: 'https://www.example.com/?email=user@example.com', + iOS: { + bundleId: 'com.example.ios' + }, + android: { + packageName: 'com.example.android', + installApp: true, + minimumVersion: '12' + }, + handleCodeInApp: true +}; +await verifyBeforeUpdateEmail(user, 'newemail@example.com', actionCodeSettings); +// Obtain code from the user. +await applyActionCode(auth, code); + +``` + diff --git a/docs-exp/auth.verifypasswordresetcode.md b/docs-exp/auth.verifypasswordresetcode.md index 9639e5f5e02..9b16287c7fd 100644 --- a/docs-exp/auth.verifypasswordresetcode.md +++ b/docs-exp/auth.verifypasswordresetcode.md @@ -4,6 +4,8 @@ ## verifyPasswordResetCode() function +Checks a password reset code sent to the user by email or other out-of-band mechanism. + Signature: ```typescript @@ -14,10 +16,12 @@ export declare function verifyPasswordResetCode(auth: externs.Auth, code: string | Parameter | Type | Description | | --- | --- | --- | -| auth | externs.[Auth](./auth-types.auth.md) | | -| code | string | | +| auth | externs.[Auth](./auth-types.auth.md) | The Auth instance. | +| code | string | A verification code sent to the user. | Returns: Promise<string> +the user's email address if valid. + diff --git a/packages-exp/auth-exp/index.ts b/packages-exp/auth-exp/index.ts index 884a24ee132..570b35e4a21 100644 --- a/packages-exp/auth-exp/index.ts +++ b/packages-exp/auth-exp/index.ts @@ -63,6 +63,13 @@ export { browserPopupRedirectResolver } from './src/platform_browser/popup_redir // MFA export { PhoneMultiFactorGenerator } from './src/platform_browser/mfa/assertions/phone'; +/** + * Initializes an Auth instance with platform specific default dependencies. + * + * @param app - The Firebase App. + * + * @public + */ export function getAuth(app?: FirebaseApp): Auth { return initializeAuth(app, { popupRedirectResolver: browserPopupRedirectResolver, diff --git a/packages-exp/auth-exp/package.json b/packages-exp/auth-exp/package.json index 42be25277a6..1f31949edc3 100644 --- a/packages-exp/auth-exp/package.json +++ b/packages-exp/auth-exp/package.json @@ -30,7 +30,7 @@ "prepare": "rollup -c rollup.config.release.js", "api-report": "api-extractor run --local --verbose", "predoc": "node ../../scripts/exp/remove-exp.js temp", - "doc": "api-documenter markdown --input temp --input ../auth-types-exp/temp --output docs", + "doc": "api-documenter markdown --input temp --output docs", "build:doc": "yarn build && yarn doc" }, "peerDependencies": { diff --git a/packages-exp/auth-exp/src/core/action_code_url.ts b/packages-exp/auth-exp/src/core/action_code_url.ts index 1703dc35524..85e5776b0ad 100644 --- a/packages-exp/auth-exp/src/core/action_code_url.ts +++ b/packages-exp/auth-exp/src/core/action_code_url.ts @@ -77,22 +77,22 @@ function parseDeepLink(url: string): string { } /** - * {@inheritDoc @firebase/auth-types-exp#ActionCodeURL} + * {@inheritDoc @firebase/auth-types#ActionCodeURL} * * @public */ export class ActionCodeURL implements externs.ActionCodeURL { - /** {@inheritDoc @firebase/auth-types-exp#ActionCodeURL.apiKey} */ + /** {@inheritDoc @firebase/auth-types#ActionCodeURL.apiKey} */ readonly apiKey: string; - /** {@inheritDoc @firebase/auth-types-exp#ActionCodeURL.code} */ + /** {@inheritDoc @firebase/auth-types#ActionCodeURL.code} */ readonly code: string; - /** {@inheritDoc @firebase/auth-types-exp#ActionCodeURL.continueUrl} */ + /** {@inheritDoc @firebase/auth-types#ActionCodeURL.continueUrl} */ readonly continueUrl: string | null; - /** {@inheritDoc @firebase/auth-types-exp#ActionCodeURL.languageCode} */ + /** {@inheritDoc @firebase/auth-types#ActionCodeURL.languageCode} */ readonly languageCode: string | null; - /** {@inheritDoc @firebase/auth-types-exp#ActionCodeURL.operation} */ + /** {@inheritDoc @firebase/auth-types#ActionCodeURL.operation} */ readonly operation: externs.Operation; - /** {@inheritDoc @firebase/auth-types-exp#ActionCodeURL.tenantId} */ + /** {@inheritDoc @firebase/auth-types#ActionCodeURL.tenantId} */ readonly tenantId: string | null; /** @@ -118,7 +118,7 @@ export class ActionCodeURL implements externs.ActionCodeURL { this.tenantId = uri.searchParams.get(QueryField.TENANT_ID); } - /** {@inheritDoc @firebase/auth-types-exp#ActionCodeURL.parseLink} */ + /** {@inheritDoc @firebase/auth-types#ActionCodeURL.parseLink} */ static parseLink(link: string): externs.ActionCodeURL | null { const actionLink = parseDeepLink(link); try { @@ -130,7 +130,7 @@ export class ActionCodeURL implements externs.ActionCodeURL { } /** - * {@inheritDoc @firebase/auth-types-exp#ActionCodeURL.parseLink} + * {@inheritDoc @firebase/auth-types#ActionCodeURL.parseLink} * * @public */ diff --git a/packages-exp/auth-exp/src/core/auth/initialize.ts b/packages-exp/auth-exp/src/core/auth/initialize.ts index 3dae56a94e6..9feb9c5f410 100644 --- a/packages-exp/auth-exp/src/core/auth/initialize.ts +++ b/packages-exp/auth-exp/src/core/auth/initialize.ts @@ -24,6 +24,7 @@ import { Persistence } from '../persistence'; import { _getInstance } from '../util/instantiator'; import { _castAuth, AuthImpl } from './auth_impl'; +/** @public */ export function initializeAuth( app: FirebaseApp = getApp(), deps?: Dependencies diff --git a/packages-exp/auth-exp/src/core/auth/register.ts b/packages-exp/auth-exp/src/core/auth/register.ts index 7d612968639..bfc97674c82 100644 --- a/packages-exp/auth-exp/src/core/auth/register.ts +++ b/packages-exp/auth-exp/src/core/auth/register.ts @@ -50,6 +50,7 @@ function getVersionForPlatform( } } +/** @internal */ export function registerAuth(clientPlatform: ClientPlatform): void { _registerComponent( new Component( diff --git a/packages-exp/auth-exp/src/core/credentials/auth_credential.ts b/packages-exp/auth-exp/src/core/credentials/auth_credential.ts index 9a6842a5d88..0ca02c1dda5 100644 --- a/packages-exp/auth-exp/src/core/credentials/auth_credential.ts +++ b/packages-exp/auth-exp/src/core/credentials/auth_credential.ts @@ -20,22 +20,32 @@ import { Auth } from '../../model/auth'; import { IdTokenResponse } from '../../model/id_token'; import { debugFail } from '../util/assert'; +/** + * {@inheritdoc @firebase/auth-types#AuthCredential} + * + * @public + */ export class AuthCredential { + /** @internal */ protected constructor( readonly providerId: string, readonly signInMethod: string ) {} + /** {@inheritdoc @firebase/auth-types#AuthCredential.toJSON} */ toJSON(): object { return debugFail('not implemented'); } + /** @internal */ _getIdTokenResponse(_auth: Auth): Promise { return debugFail('not implemented'); } + /** @internal */ _linkToIdToken(_auth: Auth, _idToken: string): Promise { return debugFail('not implemented'); } + /** @internal */ _getReauthenticationResolver(_auth: Auth): Promise { return debugFail('not implemented'); } diff --git a/packages-exp/auth-exp/src/core/credentials/email.ts b/packages-exp/auth-exp/src/core/credentials/email.ts index c82a4b65bc1..8680c2fc1c2 100644 --- a/packages-exp/auth-exp/src/core/credentials/email.ts +++ b/packages-exp/auth-exp/src/core/credentials/email.ts @@ -29,9 +29,20 @@ import { AuthErrorCode } from '../errors'; import { fail } from '../util/assert'; import { AuthCredential } from './auth_credential'; +/** + * Interface that represents the credentials returned by {@link EmailAuthProvider} for + * {@link @firebase/auth-types#ProviderId.PASSWORD} + * + * @remarks + * Covers both {@link @firebase/auth-types#SignInMethod.EMAIL_PASSWORD} and + * {@link @firebase/auth-types#SignInMethod.EMAIL_LINK}. + * + * @public + */ export class EmailAuthCredential extends AuthCredential implements externs.AuthCredential { + /** @internal */ private constructor( readonly email: string, readonly password: string, @@ -41,6 +52,7 @@ export class EmailAuthCredential super(externs.ProviderId.PASSWORD, signInMethod); } + /** @internal */ static _fromEmailAndPassword( email: string, password: string @@ -52,6 +64,7 @@ export class EmailAuthCredential ); } + /** @internal */ static _fromEmailAndCode( email: string, oobCode: string, @@ -65,6 +78,7 @@ export class EmailAuthCredential ); } + /** {@inheritdoc @firebase/auth-types#AuthCredential.toJSON} */ toJSON(): object { return { email: this.email, @@ -74,6 +88,7 @@ export class EmailAuthCredential }; } + /** {@inheritdoc @firebase/auth-types#AuthCredential.fromJSON} */ static fromJSON(json: object | string): EmailAuthCredential | null { const obj = typeof json === 'string' ? JSON.parse(json) : json; if (obj?.email && obj?.password) { @@ -86,6 +101,7 @@ export class EmailAuthCredential return null; } + /** @internal */ async _getIdTokenResponse(auth: Auth): Promise { switch (this.signInMethod) { case externs.SignInMethod.EMAIL_PASSWORD: @@ -104,6 +120,7 @@ export class EmailAuthCredential } } + /** @internal */ async _linkToIdToken(auth: Auth, idToken: string): Promise { switch (this.signInMethod) { case externs.SignInMethod.EMAIL_PASSWORD: @@ -124,6 +141,7 @@ export class EmailAuthCredential } } + /** @internal */ _getReauthenticationResolver(auth: Auth): Promise { return this._getIdTokenResponse(auth); } diff --git a/packages-exp/auth-exp/src/core/credentials/oauth.ts b/packages-exp/auth-exp/src/core/credentials/oauth.ts index 50327253207..3242cec2954 100644 --- a/packages-exp/auth-exp/src/core/credentials/oauth.ts +++ b/packages-exp/auth-exp/src/core/credentials/oauth.ts @@ -30,6 +30,9 @@ import { AuthCredential } from './auth_credential'; const IDP_REQUEST_URI = 'http://localhost'; +/** + * @internal + */ export interface OAuthCredentialParams { // OAuth 2 uses either id token or access token idToken?: string | null; @@ -49,15 +52,25 @@ export interface OAuthCredentialParams { signInMethod: string; } +/** + * {@inheritdoc @firebase/auth-types#OAuthCredential} + * + * @public + */ export class OAuthCredential extends AuthCredential implements externs.OAuthCredential { + /** {@inheritdoc @firebase/auth-types#OAuthCredential.idToken} @readonly */ idToken?: string; + /** {@inheritdoc @firebase/auth-types#OAuthCredential.accessToken} @readonly */ accessToken?: string; + /** {@inheritdoc @firebase/auth-types#OAuthCredential.secret} @readonly */ secret?: string; + /** @internal */ nonce?: string; private pendingToken: string | null = null; + /** @internal */ static _fromParams(params: OAuthCredentialParams): OAuthCredential { const cred = new OAuthCredential(params.providerId, params.signInMethod); @@ -90,6 +103,7 @@ export class OAuthCredential return cred; } + /** {@inheritdoc @firebase/auth-types#OAuthCredential.toJSON} */ toJSON(): object { return { idToken: this.idToken, @@ -102,6 +116,7 @@ export class OAuthCredential }; } + /** {@inheritdoc @firebase/auth-types#OAuthCredential.fromJSON} */ static fromJSON(json: string | object): OAuthCredential | null { const obj = typeof json === 'string' ? JSON.parse(json) : json; const { providerId, signInMethod, ...rest }: Partial = obj; @@ -114,17 +129,20 @@ export class OAuthCredential return cred; } + /** @internal */ _getIdTokenResponse(auth: Auth): Promise { const request = this.buildRequest(); return signInWithIdp(auth, request); } + /** @internal */ _linkToIdToken(auth: Auth, idToken: string): Promise { const request = this.buildRequest(); request.idToken = idToken; return signInWithIdp(auth, request); } + /** @internal */ _getReauthenticationResolver(auth: Auth): Promise { const request = this.buildRequest(); request.autoCreate = false; diff --git a/packages-exp/auth-exp/src/core/credentials/phone.ts b/packages-exp/auth-exp/src/core/credentials/phone.ts index 5daef1ac753..cb8ef8c1c5f 100644 --- a/packages-exp/auth-exp/src/core/credentials/phone.ts +++ b/packages-exp/auth-exp/src/core/credentials/phone.ts @@ -28,6 +28,7 @@ import { Auth } from '../../model/auth'; import { IdTokenResponse } from '../../model/id_token'; import { AuthCredential } from './auth_credential'; +/** @internal */ export interface PhoneAuthCredentialParameters { verificationId?: string; verificationCode?: string; @@ -35,6 +36,11 @@ export interface PhoneAuthCredentialParameters { temporaryProof?: string; } +/** + * {@inheritdoc @firebase/auth-types#PhoneAuthCredential} + * + * @public + */ export class PhoneAuthCredential extends AuthCredential implements externs.PhoneAuthCredential { @@ -42,6 +48,7 @@ export class PhoneAuthCredential super(externs.ProviderId.PHONE, externs.SignInMethod.PHONE); } + /** @internal */ static _fromVerification( verificationId: string, verificationCode: string @@ -49,6 +56,7 @@ export class PhoneAuthCredential return new PhoneAuthCredential({ verificationId, verificationCode }); } + /** @internal */ static _fromTokenResponse( phoneNumber: string, temporaryProof: string @@ -56,10 +64,12 @@ export class PhoneAuthCredential return new PhoneAuthCredential({ phoneNumber, temporaryProof }); } + /** @internal */ _getIdTokenResponse(auth: Auth): Promise { return signInWithPhoneNumber(auth, this._makeVerificationRequest()); } + /** @internal */ _linkToIdToken(auth: Auth, idToken: string): Promise { return linkWithPhoneNumber(auth, { idToken, @@ -67,10 +77,12 @@ export class PhoneAuthCredential }); } + /** @internal */ _getReauthenticationResolver(auth: Auth): Promise { return verifyPhoneNumberForExisting(auth, this._makeVerificationRequest()); } + /** @internal */ _makeVerificationRequest(): SignInWithPhoneNumberRequest { const { temporaryProof, @@ -88,6 +100,7 @@ export class PhoneAuthCredential }; } + /** {@inheritdoc @firebase/auth-types#toJSON} */ toJSON(): object { const obj: Record = { providerId: this.providerId @@ -108,6 +121,7 @@ export class PhoneAuthCredential return obj; } + /** {@inheritdoc @firebase/auth-types#fromJSON} */ static fromJSON(json: object | string): PhoneAuthCredential | null { if (typeof json === 'string') { json = JSON.parse(json); diff --git a/packages-exp/auth-exp/src/core/errors.ts b/packages-exp/auth-exp/src/core/errors.ts index 46f61e4ba61..6bdbce44339 100644 --- a/packages-exp/auth-exp/src/core/errors.ts +++ b/packages-exp/auth-exp/src/core/errors.ts @@ -22,8 +22,10 @@ import { ErrorFactory, ErrorMap } from '@firebase/util'; import { IdTokenMfaResponse } from '../api/authentication/mfa'; import { AppName } from '../model/auth'; -/* - * Developer facing Firebase Auth error codes. +/** + * Enumeration of Firebase Auth error codes. + * + * @public */ export const enum AuthErrorCode { ADMIN_ONLY_OPERATION = 'admin-restricted-operation', diff --git a/packages-exp/auth-exp/src/core/index.ts b/packages-exp/auth-exp/src/core/index.ts index cf90414a58d..fdddd706ac1 100644 --- a/packages-exp/auth-exp/src/core/index.ts +++ b/packages-exp/auth-exp/src/core/index.ts @@ -18,13 +18,46 @@ import * as externs from '@firebase/auth-types-exp'; import { CompleteFn, ErrorFn, Unsubscribe } from '@firebase/util'; +export { AuthErrorCode } from './errors'; + // Non-optional auth methods. +/** + * Changes the type of persistence on the Auth instance for the currently saved + * Auth session and applies this type of persistence for future sign-in requests, including + * sign-in with redirect requests. + * + * @remarks + * This makes it easy for a user signing in to specify whether their session should be + * remembered or not. It also makes it easier to never persist the Auth state for applications + * that are shared by other users or have sensitive data. + * + * @example + * ```javascript + * setPersistence(auth, browserSessionPersistence); + * ``` + * + * @param auth - The Auth instance. + * @param persistence - The {@link @firebase/auth-types#Persistence} to use. + * + * @public + */ export function setPersistence( auth: externs.Auth, persistence: externs.Persistence ): void { auth.setPersistence(persistence); } +/** + * Adds an observer for changes to the signed-in user's ID token, which includes sign-in, + * sign-out, and token refresh events. + * + * @param auth - The Auth instance. + * @param nextOrObserver - callback triggered on change. + * @param error - callback triggered on error. + * @param completed - callback triggered when observer is removed. + * + * @public + */ export function onIdTokenChanged( auth: externs.Auth, nextOrObserver: externs.NextOrObserver, @@ -33,6 +66,19 @@ export function onIdTokenChanged( ): Unsubscribe { return auth.onIdTokenChanged(nextOrObserver, error, completed); } +/** + * Adds an observer for changes to the user's sign-in state. + * + * @remarks + * To keep the old behavior, see {@link onIdTokenChanged}. + * + * @param auth - The Auth instance. + * @param nextOrObserver - callback triggered on change. + * @param error - callback triggered on error. + * @param completed - callback triggered when observer is removed. + * + * @public + */ export function onAuthStateChanged( auth: externs.Auth, nextOrObserver: externs.NextOrObserver, @@ -41,15 +87,47 @@ export function onAuthStateChanged( ): Unsubscribe { return auth.onAuthStateChanged(nextOrObserver, error, completed); } +/** + * Sets the current language to the default device/browser preference. + * + * @param auth - The Auth instanec. + * + * @public + */ export function useDeviceLanguage(auth: externs.Auth): void { auth.useDeviceLanguage(); } +/** + * Asynchronously sets the provided user as {@link @firebase/auth-types#Auth.currentUser} on the + * {@link @firebase/auth-types#Auth} instance. + * + * @remarks + * A new instance copy of the user provided will be made and set as currentUser. + * + * This will trigger {@link onAuthStateChanged} and {@link onIdTokenChanged} listeners + * like other sign in methods. + * + * The operation fails with an error if the user to be updated belongs to a different Firebase + * project. + * + * @param auth - The Auth instance. + * @param user - The new {@link @firebase/auth-types#User}. + * + * @public + */ export function updateCurrentUser( auth: externs.Auth, user: externs.User | null ): Promise { return auth.updateCurrentUser(user); } +/** + * Signs out the current user. + * + * @param auth - The Auth instance. + * + * @public + */ export function signOut(auth: externs.Auth): Promise { return auth.signOut(); } @@ -70,7 +148,11 @@ export { EmailAuthProvider } from './providers/email'; export { FacebookAuthProvider } from './providers/facebook'; export { GoogleAuthProvider } from './providers/google'; export { GithubAuthProvider } from './providers/github'; -export { OAuthProvider } from './providers/oauth'; +export { + OAuthProvider, + CustomParameters, + OAuthCredentialOptions +} from './providers/oauth'; export { TwitterAuthProvider } from './providers/twitter'; // strategies @@ -116,6 +198,18 @@ export { getAdditionalUserInfo } from './user/additional_user_info'; // Non-optional user methods. export { reload } from './user/reload'; +/** + * Deletes and signs out the user. + * + * @remarks + * Important: this is a security-sensitive operation that requires the user to have recently + * signed in. If this requirement isn't met, ask the user to authenticate again and then call + * {@link reauthenticateWithCredential}. + * + * @param user - The user. + * + * @public + */ export async function deleteUser(user: externs.User): Promise { return user.delete(); } diff --git a/packages-exp/auth-exp/src/core/persistence/in_memory.ts b/packages-exp/auth-exp/src/core/persistence/in_memory.ts index 4bfaf94b887..5f30f6fce59 100644 --- a/packages-exp/auth-exp/src/core/persistence/in_memory.ts +++ b/packages-exp/auth-exp/src/core/persistence/in_memory.ts @@ -57,4 +57,9 @@ export class InMemoryPersistence implements Persistence { } } +/** + * An implementation of {@link @firebase/auth-types#Persistence} of type 'NONE'. + * + * @public + */ export const inMemoryPersistence: externs.Persistence = InMemoryPersistence; diff --git a/packages-exp/auth-exp/src/core/providers/email.ts b/packages-exp/auth-exp/src/core/providers/email.ts index d3d67172ddf..a278c48dff0 100644 --- a/packages-exp/auth-exp/src/core/providers/email.ts +++ b/packages-exp/auth-exp/src/core/providers/email.ts @@ -22,17 +22,28 @@ import { EmailAuthCredential } from '../credentials/email'; import { AuthErrorCode } from '../errors'; import { assert } from '../util/assert'; +/** + * {@inheritdoc @firebase/auth-types#EmailAuthProvider} + * + * @public + */ export class EmailAuthProvider implements externs.EmailAuthProvider { + /** {@inheritdoc @firebase/auth-types#EmailAuthProvider.PROVIDER_ID} */ static readonly PROVIDER_ID = externs.ProviderId.PASSWORD; + /** {@inheritdoc @firebase/auth-types#EmailAuthProvider.EMAIL_PASSWORD_SIGN_IN_METHOD} */ static readonly EMAIL_PASSWORD_SIGN_IN_METHOD = externs.SignInMethod.EMAIL_PASSWORD; + /** {@inheritdoc @firebase/auth-types#EmailAuthProvider.EMAIL_LINK_SIGN_IN_METHOD} */ static readonly EMAIL_LINK_SIGN_IN_METHOD = externs.SignInMethod.EMAIL_LINK; + /** {@inheritdoc @firebase/auth-types#EmailAuthProvider.providerId} */ readonly providerId = EmailAuthProvider.PROVIDER_ID; + /** {@inheritdoc @firebase/auth-types#EmailAuthProvider.credential} */ static credential(email: string, password: string): EmailAuthCredential { return EmailAuthCredential._fromEmailAndPassword(email, password); } + /** {@inheritdoc @firebase/auth-types#EmailAuthProvider.credentialWithLink} */ static credentialWithLink( email: string, emailLink: string diff --git a/packages-exp/auth-exp/src/core/providers/facebook.ts b/packages-exp/auth-exp/src/core/providers/facebook.ts index 3fb7adf6215..e0aacc0667d 100644 --- a/packages-exp/auth-exp/src/core/providers/facebook.ts +++ b/packages-exp/auth-exp/src/core/providers/facebook.ts @@ -23,14 +23,67 @@ import { UserCredential } from '../../model/user'; import { OAuthCredential } from '../credentials/oauth'; import { OAuthProvider } from './oauth'; +/** + * Provider for generating an {@link OAuthCredential} for {@link @firebase/auth-types#ProviderId.FACEBOOK}. + * + * @example + * ```javascript + * // Sign in using a redirect. + * const provider = new FacebookAuthProvider(); + * // Start a sign in process for an unauthenticated user. + * provider.addScope('user_birthday'); + * await signInWithRedirect(auth, provider); + * // This will trigger a full page redirect away from your app + * + * // After returning from the redirect when your app initializes you can obtain the result + * const result = await getRedirectResult(auth); + * if (result) { + * // This is the signed-in user + * const user = result.user; + * // This gives you a Facebook Access Token. + * const credential = provider.credentialFromResult(auth, result); + * const token = credential.accessToken; + * } + * ``` + * + * @example + * ```javascript + * // Sign in using a popup. + * const provider = new FacebookAuthProvider(); + * provider.addScope('user_birthday'); + * const result = await signInWithPopup(auth, provider); + * + * // The signed-in user info. + * const user = result.user; + * // This gives you a Facebook Access Token. + * const credential = provider.credentialFromResult(auth, result); + * const token = credential.accessToken; + * ``` + * + * @public + */ export class FacebookAuthProvider extends OAuthProvider { + /** Always set to {@link @firebase/auth-types#SignInMethod.FACEBOOK}. */ static readonly FACEBOOK_SIGN_IN_METHOD = externs.SignInMethod.FACEBOOK; + /** Always set to {@link @firebase/auth-types#ProviderId.FACEBOOK}. */ static readonly PROVIDER_ID = externs.ProviderId.FACEBOOK; constructor() { super(externs.ProviderId.FACEBOOK); } + /** + * Creates a credential for Facebook. + * + * @example + * ```javascript + * // `event` from the Facebook auth.authResponseChange callback. + * const credential = FacebookAuthProvider.credential(event.authResponse.accessToken); + * const result = await signInWithCredential(credential); + * ``` + * + * @param accessToken - Facebook access token. + */ static credential(accessToken: string): externs.OAuthCredential { return OAuthCredential._fromParams({ providerId: FacebookAuthProvider.PROVIDER_ID, @@ -39,6 +92,11 @@ export class FacebookAuthProvider extends OAuthProvider { }); } + /** + * Used to extract the underlying {@link OAuthCredential} from a {@link @firebase/auth-types#UserCredential}. + * + * @param userCredential - The user credential. + */ static credentialFromResult( userCredential: externs.UserCredential ): externs.OAuthCredential | null { @@ -47,6 +105,12 @@ export class FacebookAuthProvider extends OAuthProvider { ); } + /** + * Used to extract the underlying {@link OAuthCredential} from a {@link @firebase/auth-types#AuthError} which was + * thrown during a sign-in, link, or reauthenticate operation. + * + * @param userCredential - The user credential. + */ static credentialFromError( error: FirebaseError ): externs.OAuthCredential | null { diff --git a/packages-exp/auth-exp/src/core/providers/github.ts b/packages-exp/auth-exp/src/core/providers/github.ts index 3f8f4dfa10e..6bfebbd6357 100644 --- a/packages-exp/auth-exp/src/core/providers/github.ts +++ b/packages-exp/auth-exp/src/core/providers/github.ts @@ -23,14 +23,63 @@ import { UserCredential } from '../../model/user'; import { OAuthCredential } from '../credentials/oauth'; import { OAuthProvider } from './oauth'; +/** + * Provider for generating an {@link OAuthCredential} for {@link @firebase/auth-types#ProviderId.GITHUB}. + * + * @remarks + * GitHub requires an OAuth 2.0 redirect, so you can either handle the redirect directly, or use + * the {@link signInWithPopup} handler: + * + * @example + * ```javascript + * // Sign in using a redirect. + * const provider = new GithubAuthProvider(); + * // Start a sign in process for an unauthenticated user. + * provider.addScope('repo'); + * await signInWithRedirect(auth, provider); + * // This will trigger a full page redirect away from your app + * + * // After returning from the redirect when your app initializes you can obtain the result + * const result = await getRedirectResult(auth); + * if (result) { + * // This is the signed-in user + * const user = result.user; + * // This gives you a Github Access Token. + * const credential = provider.credentialFromResult(auth, result); + * const token = credential.accessToken; + * } + * ``` + * + * @example + * ```javascript + * // Sign in using a popup. + * const provider = new GithubAuthProvider(); + * provider.addScope('repo'); + * const result = await signInWithPopup(auth, provider); + * + * // The signed-in user info. + * const user = result.user; + * // This gives you a Github Access Token. + * const credential = provider.credentialFromResult(auth, result); + * const token = credential.accessToken; + * ``` + * @public + */ export class GithubAuthProvider extends OAuthProvider { + /** Always set to {@link @firebase/auth-types#SignInMethod.GITHUB}. */ static readonly GITHUB_SIGN_IN_METHOD = externs.SignInMethod.GITHUB; + /** Always set to {@link @firebase/auth-types#ProviderId.GITHUB}. */ static readonly PROVIDER_ID = externs.ProviderId.GITHUB; constructor() { super(externs.ProviderId.GITHUB); } + /** + * Creates a credential for Github. + * + * @param accessToken - Github access token. + */ static credential(accessToken: string): externs.OAuthCredential { return OAuthCredential._fromParams({ providerId: GithubAuthProvider.PROVIDER_ID, @@ -39,6 +88,11 @@ export class GithubAuthProvider extends OAuthProvider { }); } + /** + * Used to extract the underlying {@link OAuthCredential} from a {@link @firebase/auth-types#UserCredential}. + * + * @param userCredential - The user credential. + */ static credentialFromResult( userCredential: externs.UserCredential ): externs.OAuthCredential | null { @@ -47,6 +101,12 @@ export class GithubAuthProvider extends OAuthProvider { ); } + /** + * Used to extract the underlying {@link OAuthCredential} from a {@link @firebase/auth-types#AuthError} which was + * thrown during a sign-in, link, or reauthenticate operation. + * + * @param userCredential - The user credential. + */ static credentialFromError( error: FirebaseError ): externs.OAuthCredential | null { diff --git a/packages-exp/auth-exp/src/core/providers/google.ts b/packages-exp/auth-exp/src/core/providers/google.ts index d70a0aba55d..00514db9098 100644 --- a/packages-exp/auth-exp/src/core/providers/google.ts +++ b/packages-exp/auth-exp/src/core/providers/google.ts @@ -24,14 +24,70 @@ import { UserCredential } from '../../model/user'; import { OAuthCredential } from '../credentials/oauth'; import { OAuthProvider } from './oauth'; +/** + * Provider for generating an an {@link OAuthCredential} for {@link @firebase/auth-types#ProviderId.GOOGLE}. + * + * @example + * ```javascript + * // Sign in using a redirect. + * const provider = new GoogleAuthProvider(); + * // Start a sign in process for an unauthenticated user. + * provider.addScope('profile'); + * provider.addScope('email'); + * await signInWithRedirect(auth, provider); + * // This will trigger a full page redirect away from your app + * + * // After returning from the redirect when your app initializes you can obtain the result + * const result = await getRedirectResult(auth); + * if (result) { + * // This is the signed-in user + * const user = result.user; + * // This gives you a Google Access Token. + * const credential = provider.credentialFromResult(auth, result); + * const token = credential.accessToken; + * } + * ``` + * + * @example + * ```javascript + * // Sign in using a popup. + * const provider = new GoogleAuthProvider(); + * provider.addScope('profile'); + * provider.addScope('email'); + * const result = await signInWithPopup(auth, provider); + * + * // The signed-in user info. + * const user = result.user; + * // This gives you a Google Access Token. + * const credential = provider.credentialFromResult(auth, result); + * const token = credential.accessToken; + * ``` + * + * @public + */ export class GoogleAuthProvider extends OAuthProvider { + /** Always set to {@link @firebase/auth-types#SignInMethod.GOOGLE}. */ static readonly GOOGLE_SIGN_IN_METHOD = externs.SignInMethod.GOOGLE; + /** Always set to {@link @firebase/auth-types#ProviderId.GOOGLE}. */ static readonly PROVIDER_ID = externs.ProviderId.GOOGLE; constructor() { super(externs.ProviderId.GOOGLE); } + /** + * Creates a credential for Google. At least one of ID token and access token is required. + * + * @example + * ```javascript + * // \`googleUser\` from the onsuccess Google Sign In callback. + * const credential = GoogleAuthProvider.credential(googleUser.getAuthResponse().id_token); + * const result = await signInWithCredential(credential); + * ``` + * + * @param idToken - Google ID token. + * @param accessToken - Google access token. + */ static credential( idToken?: string | null, accessToken?: string | null @@ -44,6 +100,11 @@ export class GoogleAuthProvider extends OAuthProvider { }); } + /** + * Used to extract the underlying {@link OAuthCredential} from a {@link @firebase/auth-types#UserCredential}. + * + * @param userCredential - The user credential. + */ static credentialFromResult( userCredential: externs.UserCredential ): externs.OAuthCredential | null { @@ -51,7 +112,12 @@ export class GoogleAuthProvider extends OAuthProvider { userCredential as UserCredential ); } - + /** + * Used to extract the underlying {@link OAuthCredential} from a {@link @firebase/auth-types#AuthError} which was + * thrown during a sign-in, link, or reauthenticate operation. + * + * @param userCredential - The user credential. + */ static credentialFromError( error: FirebaseError ): externs.OAuthCredential | null { diff --git a/packages-exp/auth-exp/src/core/providers/oauth.ts b/packages-exp/auth-exp/src/core/providers/oauth.ts index 0e84e989a1f..bcbebdf3da8 100644 --- a/packages-exp/auth-exp/src/core/providers/oauth.ts +++ b/packages-exp/auth-exp/src/core/providers/oauth.ts @@ -22,18 +22,93 @@ import { AuthErrorCode } from '../errors'; import { OAuthCredential } from '../credentials/oauth'; +/** + * Map of OAuth Custom Parameters. + * + * @public + */ export type CustomParameters = Record; -interface CredentialParameters { +/** + * Defines the options for initializing an {@link OAuthCredential}. + * + * @remarks + * For ID tokens with nonce claim, the raw nonce has to also be provided. + * + * @public + */ +export interface OAuthCredentialOptions { + /** + * The OAuth ID token used to initialize the {@link OAuthCredential}. + */ idToken?: string; + /** + * The OAuth access token used to initialize the {@link OAuthCredential}. + */ accessToken?: string; + /** + * The raw nonce associated with the ID token. + * + * @remarks + * It is required when an ID token with a nonce field is provided. The SHA-256 hash of the + * raw nonce must match the nonce field in the ID token. + */ rawNonce?: string; } +/** + * Provider for generating generic {@link OAuthCredential}. + * + * @example + * ```javascript + * // Sign in using a redirect. + * const provider = new OAuthProvider('google.com'); + * // Start a sign in process for an unauthenticated user. + * provider.addScope('profile'); + * provider.addScope('email'); + * await signInWithRedirect(auth, provider); + * // This will trigger a full page redirect away from your app + * + * // After returning from the redirect when your app initializes you can obtain the result + * const result = await getRedirectResult(auth); + * if (result) { + * // This is the signed-in user + * const user = result.user; + * // This gives you a OAuth Access Token for the provider. + * const credential = provider.credentialFromResult(auth, result); + * const token = credential.accessToken; + * } + * ``` + * + * @example + * ```javascript + * // Sign in using a popup. + * const provider = new OAuthProvider('google.com'); + * provider.addScope('profile'); + * provider.addScope('email'); + * const result = await signInWithPopup(auth, provider); + * + * // The signed-in user info. + * const user = result.user; + * // This gives you a OAuth Access Token for the provider. + * const credential = provider.credentialFromResult(auth, result); + * const token = credential.accessToken; + * ``` + * @public + */ export class OAuthProvider implements externs.AuthProvider { + /** @internal */ defaultLanguageCode: string | null = null; + /** @internal */ private scopes: string[] = []; + /** @internal */ private customParameters: CustomParameters = {}; + + /** + * Constructor for generic OAuth providers. + * + * @param providerId - Provider for which credentials should be generated. + */ constructor(readonly providerId: string) {} static credentialFromJSON(json: object | string): externs.OAuthCredential { @@ -46,7 +121,28 @@ export class OAuthProvider implements externs.AuthProvider { return OAuthCredential._fromParams(obj); } - credential(params: CredentialParameters): externs.OAuthCredential { + /** + * Creates a {@link OAuthCredential} from a generic OAuth provider's access token or ID token. + * + * @remarks + * The raw nonce is required when an ID token with a nonce field is provided. The SHA-256 hash of + * the raw nonce must match the nonce field in the ID token. + * + * @example + * ```javascript + * // `googleUser` from the onsuccess Google Sign In callback. + * // Initialize a generate OAuth provider with a `google.com` providerId. + * const provider = new OAuthProvider('google.com'); + * const credential = provider.credential({ + * idToken: googleUser.getAuthResponse().id_token, + * }); + * const result = await signInWithCredential(credential); + * ``` + * + * @param params - Either the options object containing the ID token, access token and raw nonce + * or the ID token string. + */ + credential(params: OAuthCredentialOptions): externs.OAuthCredential { assert( params.idToken && params.accessToken, AuthErrorCode.ARGUMENT_ERROR, @@ -60,10 +156,25 @@ export class OAuthProvider implements externs.AuthProvider { }); } + /** + * Set the language gode. + * + * @param languageCode - language code + */ setDefaultLanguage(languageCode: string | null): void { this.defaultLanguageCode = languageCode; } + /** + * Sets the OAuth custom parameters to pass in an OAuth request for popup and redirect sign-in + * operations. + * + * @remarks + * For a detailed list, check the reserved required OAuth 2.0 parameters such as `client_id`, + * `redirect_uri`, `scope`, `response_type`, and `state` are not allowed and will be ignored. + * + * @param customOAuthParameters - The custom OAuth parameters to pass in the OAuth request. + */ setCustomParameters( customOAuthParameters: CustomParameters ): externs.AuthProvider { @@ -71,10 +182,18 @@ export class OAuthProvider implements externs.AuthProvider { return this; } + /** + * Retrieve the current list of {@link CustomParameters}. + */ getCustomParameters(): CustomParameters { return this.customParameters; } + /** + * Add an OAuth scope to the credential. + * + * @param scope - Provider OAuth scope to add. + */ addScope(scope: string): externs.AuthProvider { // If not already added, add scope to list. if (!this.scopes.includes(scope)) { @@ -83,6 +202,9 @@ export class OAuthProvider implements externs.AuthProvider { return this; } + /** + * Retrieve the current list of OAuth scopes. + */ getScopes(): string[] { return [...this.scopes]; } diff --git a/packages-exp/auth-exp/src/core/providers/twitter.ts b/packages-exp/auth-exp/src/core/providers/twitter.ts index cb0e150c652..ffb3fc61d13 100644 --- a/packages-exp/auth-exp/src/core/providers/twitter.ts +++ b/packages-exp/auth-exp/src/core/providers/twitter.ts @@ -41,6 +41,45 @@ import { UserCredential } from '../../model/user'; import { OAuthCredential } from '../credentials/oauth'; import { OAuthProvider } from './oauth'; +/** + * Provider for generating an {@link OAuthCredential} for {@link @firebase/auth-types#ProviderId.TWITTER}. + * + * @example + * ```javascript + * // Sign in using a redirect. + * const provider = new TwitterAuthProvider(); + * // Start a sign in process for an unauthenticated user. + * await signInWithRedirect(auth, provider); + * // This will trigger a full page redirect away from your app + * + * // After returning from the redirect when your app initializes you can obtain the result + * const result = await getRedirectResult(auth); + * if (result) { + * // This is the signed-in user + * const user = result.user; + * // This gives you a Twitter Access Token and Secret. + * const credential = provider.credentialFromResult(auth, result); + * const token = credential.accessToken; + * const secret = credential.secret; + * } + * ``` + * + * @example + * ```javascript + * // Sign in using a popup. + * const provider = new TwitterAuthProvider(); + * const result = await signInWithPopup(auth, provider); + * + * // The signed-in user info. + * const user = result.user; + * // This gives you a Twitter Access Token and Secret. + * const credential = provider.credentialFromResult(auth, result); + * const token = credential.accessToken; + * const secret = credential.secret; + * ``` + * + * @public + */ export class TwitterAuthProvider extends OAuthProvider { static readonly TWITTER_SIGN_IN_METHOD = externs.SignInMethod.TWITTER; static readonly PROVIDER_ID = externs.ProviderId.TWITTER; @@ -49,6 +88,12 @@ export class TwitterAuthProvider extends OAuthProvider { super(externs.ProviderId.TWITTER); } + /** + * Creates a credential for Twitter. + * + * @param token - Twitter access token. + * @param secret - Twitter secret. + */ static credential(token: string, secret: string): externs.OAuthCredential { return OAuthCredential._fromParams({ providerId: TwitterAuthProvider.PROVIDER_ID, @@ -58,6 +103,11 @@ export class TwitterAuthProvider extends OAuthProvider { }); } + /** + * Used to extract the underlying {@link OAuthCredential} from a {@link @firebase/auth-types#UserCredential}. + * + * @param userCredential - The user credential. + */ static credentialFromResult( userCredential: externs.UserCredential ): externs.OAuthCredential | null { @@ -66,6 +116,12 @@ export class TwitterAuthProvider extends OAuthProvider { ); } + /** + * Used to extract the underlying {@link OAuthCredential} from a {@link @firebase/auth-types#AuthError} which was + * thrown during a sign-in, link, or reauthenticate operation. + * + * @param userCredential - The user credential. + */ static credentialFromError( error: FirebaseError ): externs.OAuthCredential | null { diff --git a/packages-exp/auth-exp/src/core/strategies/anonymous.ts b/packages-exp/auth-exp/src/core/strategies/anonymous.ts index 693b082a222..71ded6c42c6 100644 --- a/packages-exp/auth-exp/src/core/strategies/anonymous.ts +++ b/packages-exp/auth-exp/src/core/strategies/anonymous.ts @@ -21,6 +21,17 @@ import { User } from '../../model/user'; import { UserCredentialImpl } from '../user/user_credential_impl'; import { _castAuth } from '../auth/auth_impl'; +/** + * Asynchronously signs in as an anonymous user. + * + * @remarks + * If there is already an anonymous user signed in, that user will be returned; otherwise, a + * new anonymous user identity will be created and returned. + * + * @param auth - The Auth instance. + * + * @public + */ export async function signInAnonymously( auth: externs.Auth ): Promise { diff --git a/packages-exp/auth-exp/src/core/strategies/credential.ts b/packages-exp/auth-exp/src/core/strategies/credential.ts index 4ac77ce12cc..012218eb382 100644 --- a/packages-exp/auth-exp/src/core/strategies/credential.ts +++ b/packages-exp/auth-exp/src/core/strategies/credential.ts @@ -27,6 +27,7 @@ import { _reauthenticate } from '../user/reauthenticate'; import { UserCredentialImpl } from '../user/user_credential_impl'; import { _castAuth } from '../auth/auth_impl'; +/** @internal */ export async function _signInWithCredential( auth: Auth, credential: AuthCredential @@ -46,6 +47,17 @@ export async function _signInWithCredential( return userCredential; } +/** + * Asynchronously signs in with the given credentials. + * + * @remarks + * An {@link @firebase/auth-types#AuthProvider} can be used to generate the credential. + * + * @param auth - The Auth instance. + * @param credential - The auth credential. + * + * @public + */ export async function signInWithCredential( auth: externs.Auth, credential: externs.AuthCredential @@ -53,24 +65,44 @@ export async function signInWithCredential( return _signInWithCredential(_castAuth(auth), credential as AuthCredential); } +/** + * Links the user account with the given credentials. + * + * @remarks + * An {@link @firebase/auth-types#AuthProvider} can be used to generate the credential. + * + * @param user - The user. + * @param credential - The auth credential. + * + * @public + */ export async function linkWithCredential( - userExtern: externs.User, - credentialExtern: externs.AuthCredential + user: externs.User, + credential: externs.AuthCredential ): Promise { - const user = userExtern as User; - const credential = credentialExtern as AuthCredential; + const userInternal = user as User; - await _assertLinkedStatus(false, user, credential.providerId); + await _assertLinkedStatus(false, userInternal, credential.providerId); - return _link(user, credential); + return _link(userInternal, credential as AuthCredential); } +/** + * Re-authenticates a user using a fresh credential. + * + * @remarks + * Use before operations such as {@link updatePassword} that require tokens from recent sign-in + * attempts. This method can be used to recover from a + * {@link AuthErrorCode.CREDENTIAL_TOO_OLD_LOGIN_AGAIN} error. + * + * @param user - The user. + * @param credential - The auth credential. + * + * @public + */ export async function reauthenticateWithCredential( - userExtern: externs.User, - credentialExtern: externs.AuthCredential + user: externs.User, + credential: externs.AuthCredential ): Promise { - const credential = credentialExtern as AuthCredential; - const user = userExtern as User; - - return _reauthenticate(user, credential); + return _reauthenticate(user as User, credential as AuthCredential); } diff --git a/packages-exp/auth-exp/src/core/strategies/custom_token.ts b/packages-exp/auth-exp/src/core/strategies/custom_token.ts index 234fa057203..919a638e8b6 100644 --- a/packages-exp/auth-exp/src/core/strategies/custom_token.ts +++ b/packages-exp/auth-exp/src/core/strategies/custom_token.ts @@ -22,19 +22,35 @@ import { IdTokenResponse } from '../../model/id_token'; import { UserCredentialImpl } from '../user/user_credential_impl'; import { _castAuth } from '../auth/auth_impl'; +/** + * Asynchronously signs in using a custom token. + * + * @remarks + * Custom tokens are used to integrate Firebase Auth with existing auth systems, and must + * be generated by an auth backend using the + * {@link https://firebase.google.com/docs/reference/admin/node/admin.auth.Auth#createcustomtoken | createCustomToken} + * method in the {@link https://firebase.google.com/docs/auth/admin | Admin SDK} . + * + * Fails with an error if the token is invalid, expired, or not accepted by the Firebase Auth service. + * + * @param auth - The Auth instance. + * @param customToken - The custom token to sign in with. + * + * @public + */ export async function signInWithCustomToken( - authExtern: externs.Auth, + auth: externs.Auth, customToken: string ): Promise { - const response: IdTokenResponse = await getIdTokenResponse(authExtern, { + const response: IdTokenResponse = await getIdTokenResponse(auth, { token: customToken }); - const auth = _castAuth(authExtern); + const authInternal = _castAuth(auth); const cred = await UserCredentialImpl._fromIdTokenResponse( - auth, + authInternal, externs.OperationType.SIGN_IN, response ); - await auth._updateCurrentUser(cred.user); + await authInternal._updateCurrentUser(cred.user); return cred; } diff --git a/packages-exp/auth-exp/src/core/strategies/email.ts b/packages-exp/auth-exp/src/core/strategies/email.ts index b8b7afe6cb0..4079180fed2 100644 --- a/packages-exp/auth-exp/src/core/strategies/email.ts +++ b/packages-exp/auth-exp/src/core/strategies/email.ts @@ -27,6 +27,20 @@ import { _getCurrentUrl, _isHttpOrHttps } from '../util/location'; import { _setActionCodeSettingsOnRequest } from './action_code_settings'; import { _castAuth } from '../auth/auth_impl'; +/** + * Gets the list of possible sign in methods for the given email address. + * + * @remarks + * This is useful to differentiate methods of sign-in for the same provider, eg. + * {@link EmailAuthProvider} which has 2 methods of sign-in, + * {@link @firebase/auth-types#SignInMethod.EMAIL_PASSWORD} and + * {@link @firebase/auth-types#SignInMethod.EMAIL_LINK} . + * + * @param auth - The Auth instance. + * @param email - The user's email address. + * + * @public + */ export async function fetchSignInMethodsForEmail( auth: externs.Auth, email: string @@ -45,33 +59,101 @@ export async function fetchSignInMethodsForEmail( return signinMethods || []; } +/** + * Sends a verification email to a user. + * + * @remarks + * The verification process is completed by calling {@link applyActionCode}. + * + * @example + * ```javascript + * const actionCodeSettings = { + * url: 'https://www.example.com/?email=user@example.com', + * iOS: { + * bundleId: 'com.example.ios' + * }, + * android: { + * packageName: 'com.example.android', + * installApp: true, + * minimumVersion: '12' + * }, + * handleCodeInApp: true + * }; + * await sendEmailVerification(user, actionCodeSettings); + * // Obtain code from the user. + * await applyActionCode(auth, code); + * ``` + * + * @param user - The user. + * @param actionCodeSettings - The {@link @firebase/auth-types#ActionCodeSettings}. + * + * @public + */ export async function sendEmailVerification( - userExtern: externs.User, + user: externs.User, actionCodeSettings?: externs.ActionCodeSettings | null ): Promise { - const user = userExtern as User; + const userInternal = user as User; const idToken = await user.getIdToken(); const request: api.VerifyEmailRequest = { requestType: externs.Operation.VERIFY_EMAIL, idToken }; if (actionCodeSettings) { - _setActionCodeSettingsOnRequest(user.auth, request, actionCodeSettings); + _setActionCodeSettingsOnRequest( + userInternal.auth, + request, + actionCodeSettings + ); } - const { email } = await api.sendEmailVerification(user.auth, request); + const { email } = await api.sendEmailVerification(userInternal.auth, request); if (email !== user.email) { await user.reload(); } } +/** + * Sends a verification email to a new email address. + * + * @remarks + * The user's email will be updated to the new one after being verified. + * + * If you have a custom email action handler, you can complete the verification process by calling + * {@link applyActionCode}. + * + * @example + * ```javascript + * const actionCodeSettings = { + * url: 'https://www.example.com/?email=user@example.com', + * iOS: { + * bundleId: 'com.example.ios' + * }, + * android: { + * packageName: 'com.example.android', + * installApp: true, + * minimumVersion: '12' + * }, + * handleCodeInApp: true + * }; + * await verifyBeforeUpdateEmail(user, 'newemail@example.com', actionCodeSettings); + * // Obtain code from the user. + * await applyActionCode(auth, code); + * ``` + * + * @param user - The user. + * @param newEmail - The new email address to be verified before update. + * @param actionCodeSettings - The {@link @firebase/auth-types#ActionCodeSettings}. + * + * @public + */ export async function verifyBeforeUpdateEmail( - userExtern: externs.User, + user: externs.User, newEmail: string, actionCodeSettings?: externs.ActionCodeSettings | null ): Promise { - const user = userExtern as User; + const userInternal = user as User; const idToken = await user.getIdToken(); const request: api.VerifyAndChangeEmailRequest = { requestType: externs.Operation.VERIFY_AND_CHANGE_EMAIL, @@ -79,10 +161,14 @@ export async function verifyBeforeUpdateEmail( newEmail }; if (actionCodeSettings) { - _setActionCodeSettingsOnRequest(user.auth, request, actionCodeSettings); + _setActionCodeSettingsOnRequest( + userInternal.auth, + request, + actionCodeSettings + ); } - const { email } = await api.verifyAndChangeEmail(user.auth, request); + const { email } = await api.verifyAndChangeEmail(userInternal.auth, request); if (email !== user.email) { // If the local copy of the email on user is outdated, reload the diff --git a/packages-exp/auth-exp/src/core/strategies/email_and_password.ts b/packages-exp/auth-exp/src/core/strategies/email_and_password.ts index 1662add44ac..0abf00c2f10 100644 --- a/packages-exp/auth-exp/src/core/strategies/email_and_password.ts +++ b/packages-exp/auth-exp/src/core/strategies/email_and_password.ts @@ -29,6 +29,38 @@ import { signInWithCredential } from './credential'; import { _castAuth } from '../auth/auth_impl'; import { AuthErrorCode } from '../errors'; +/** + * Sends a password reset email to the given email address. + * + * @remarks + * To complete the password reset, call {@link confirmPasswordReset} with the code supplied in + * the email sent to the user, along with the new password specified by the user. + * + * @example + * ```javascript + * const actionCodeSettings = { + * url: 'https://www.example.com/?email=user@example.com', + * iOS: { + * bundleId: 'com.example.ios' + * }, + * android: { + * packageName: 'com.example.android', + * installApp: true, + * minimumVersion: '12' + * }, + * handleCodeInApp: true + * }; + * await sendPasswordResetEmail(auth, 'user@example.com', actionCodeSettings); + * // Obtain code from user. + * await confirmPasswordReset('user@example.com', code); + * ``` + * + * @param auth - The Auth instance. + * @param email - The user's email address. + * @param actionCodeSettings - The {@link @firebase/auth-types#ActionCodeSettings}. + * + * @public + */ export async function sendPasswordResetEmail( auth: externs.Auth, email: string, @@ -45,6 +77,15 @@ export async function sendPasswordResetEmail( await authentication.sendPasswordResetEmail(auth, request); } +/** + * Completes the password reset process, given a confirmation code and new password. + * + * @param auth - The Auth instance. + * @param oobCode - A confirmation code sent to the user. + * @param newPassword - The new password. + * + * @public + */ export async function confirmPasswordReset( auth: externs.Auth, oobCode: string, @@ -57,6 +98,14 @@ export async function confirmPasswordReset( // Do not return the email. } +/** + * Applies a verification code sent to the user by email or other out-of-band mechanism. + * + * @param auth - The Auth instance. + * @param oobCode - A verification code sent to the user. + * + * @public + */ export async function applyActionCode( auth: externs.Auth, oobCode: string @@ -64,6 +113,16 @@ export async function applyActionCode( await account.applyActionCode(auth, { oobCode }); } +/** + * Checks a verification code sent to the user by email or other out-of-band mechanism. + * + * @returns metadata about the code. + * + * @param auth - The Auth instance. + * @param oobCode - A verification code sent to the user. + * + * @public + */ export async function checkActionCode( auth: externs.Auth, oobCode: string @@ -122,6 +181,16 @@ export async function checkActionCode( }; } +/** + * Checks a password reset code sent to the user by email or other out-of-band mechanism. + * + * @returns the user's email address if valid. + * + * @param auth - The Auth instance. + * @param code - A verification code sent to the user. + * + * @public + */ export async function verifyPasswordResetCode( auth: externs.Auth, code: string @@ -131,6 +200,23 @@ export async function verifyPasswordResetCode( return data.email!; } +/** + * Creates a new user account associated with the specified email address and password. + * + * @remarks + * On successful creation of the user account, this user will also be signed in to your application. + * + * User account creation can fail if the account already exists or the password is invalid. + * + * Note: The email address acts as a unique identifier for the user and enables an email-based + * password reset. This function will create a new user account and set the initial user password. + * + * @param auth - The Auth instance. + * @param email - The user's email address. + * @param password - The user's chosen password. + * + * @public + */ export async function createUserWithEmailAndPassword( auth: externs.Auth, email: string, @@ -153,6 +239,22 @@ export async function createUserWithEmailAndPassword( return userCredential; } +/** + * Asynchronously signs in using an email and password. + * + * @remarks + * Fails with an error if the email address and password do not match. + * + * Note: The user's password is NOT the password used to access the user's email account. The + * email address serves as a unique identifier for the user, and the password is used to access + * the user's account in your Firebase project. See also: {@link createUserWithEmailAndPassword}. + * + * @param auth - The Auth instance. + * @param email - The users email address. + * @param password - The users password. + * + * @public + */ export function signInWithEmailAndPassword( auth: externs.Auth, email: string, diff --git a/packages-exp/auth-exp/src/core/strategies/email_link.ts b/packages-exp/auth-exp/src/core/strategies/email_link.ts index 697df0d5882..2023249c8be 100644 --- a/packages-exp/auth-exp/src/core/strategies/email_link.ts +++ b/packages-exp/auth-exp/src/core/strategies/email_link.ts @@ -26,6 +26,44 @@ import { signInWithCredential } from './credential'; import { AuthErrorCode } from '../errors'; import { assert } from '../util/assert'; +/** + * Sends a sign-in email link to the user with the specified email. + * + * @remarks + * The sign-in operation has to always be completed in the app unlike other out of band email + * actions (password reset and email verifications). This is because, at the end of the flow, + * the user is expected to be signed in and their Auth state persisted within the app. + * + * To complete sign in with the email link, call {@link signInWithEmailLink} with the email + * address and the email link supplied in the email sent to the user. + * + * @example + * ```javascript + * const actionCodeSettings = { + * url: 'https://www.example.com/?email=user@example.com', + * iOS: { + * bundleId: 'com.example.ios' + * }, + * android: { + * packageName: 'com.example.android', + * installApp: true, + * minimumVersion: '12' + * }, + * handleCodeInApp: true + * }; + * await sendSignInLinkToEmail(auth, 'user@example.com', actionCodeSettings); + * // Obtain emailLink from the user. + * if(isSignInWithEmailLink(auth, emailLink)) { + * await signInWithEmailLink('user@example.com', 'user@example.com', emailLink); + * } + * ``` + * + * @param auth - The Auth instance. + * @param email - The user's email address. + * @param actionCodeSettings - The {@link @firebase/auth-types#ActionCodeSettings}. + * + * @public + */ export async function sendSignInLinkToEmail( auth: externs.Auth, email: string, @@ -42,6 +80,14 @@ export async function sendSignInLinkToEmail( await api.sendSignInLinkToEmail(auth, request); } +/** + * Checks if an incoming link is a sign-in with email link suitable for {@link signInWithEmailLink}. + * + * @param auth - The Auth instance. + * @param emailLink - The link sent to the user's email address. + * + * @public + */ export function isSignInWithEmailLink( auth: externs.Auth, emailLink: string @@ -50,6 +96,43 @@ export function isSignInWithEmailLink( return actionCodeUrl?.operation === externs.Operation.EMAIL_SIGNIN; } +/** + * Asynchronously signs in using an email and sign-in email link. + * + * @remarks + * If no link is passed, the link is inferred from the current URL. + * + * Fails with an error if the email address is invalid or OTP in email link expires. + * + * Note: Confirm the link is a sign-in email link before calling this method firebase.auth.Auth.isSignInWithEmailLink. + * + * @example + * ```javascript + * const actionCodeSettings = { + * url: 'https://www.example.com/?email=user@example.com', + * iOS: { + * bundleId: 'com.example.ios' + * }, + * android: { + * packageName: 'com.example.android', + * installApp: true, + * minimumVersion: '12' + * }, + * handleCodeInApp: true + * }; + * await sendSignInLinkToEmail(auth, 'user@example.com', actionCodeSettings); + * // Obtain emailLink from the user. + * if(isSignInWithEmailLink(auth, emailLink)) { + * await signInWithEmailLink('user@example.com', 'user@example.com', emailLink); + * } + * ``` + * + * @param auth - The Auth instance. + * @param email - The user's email address. + * @param emailLink - The link sent to the user's email address. + * + * @public + */ export async function signInWithEmailLink( auth: externs.Auth, email: string, diff --git a/packages-exp/auth-exp/src/core/strategies/idp.ts b/packages-exp/auth-exp/src/core/strategies/idp.ts index 1dc7302dcdf..2312e7cf75d 100644 --- a/packages-exp/auth-exp/src/core/strategies/idp.ts +++ b/packages-exp/auth-exp/src/core/strategies/idp.ts @@ -31,6 +31,7 @@ import { assert } from '../util/assert'; import { _signInWithCredential } from './credential'; import { AuthErrorCode } from '../errors'; +/** @internal */ export interface IdpTaskParams { auth: Auth; requestUri: string; @@ -41,11 +42,10 @@ export interface IdpTaskParams { user?: User; } +/** @internal */ export type IdpTask = (params: IdpTaskParams) => Promise; -/** - * Private implementation, not for public export - */ +/** @internal */ class IdpCredential extends AuthCredential { constructor(readonly params: IdpTaskParams) { super(externs.ProviderId.CUSTOM, externs.ProviderId.CUSTOM); @@ -81,6 +81,7 @@ class IdpCredential extends AuthCredential { } } +/** @internal */ export function _signIn(params: IdpTaskParams): Promise { return _signInWithCredential( params.auth, @@ -88,12 +89,14 @@ export function _signIn(params: IdpTaskParams): Promise { ) as Promise; } +/** @internal */ export function _reauth(params: IdpTaskParams): Promise { const { auth, user } = params; assert(user, AuthErrorCode.INTERNAL_ERROR, { appName: auth.name }); return _reauthenticate(user, new IdpCredential(params)); } +/** @internal */ export async function _link(params: IdpTaskParams): Promise { const { auth, user } = params; assert(user, AuthErrorCode.INTERNAL_ERROR, { appName: auth.name }); diff --git a/packages-exp/auth-exp/src/core/user/account_info.ts b/packages-exp/auth-exp/src/core/user/account_info.ts index 74abf49c2cf..3829082509b 100644 --- a/packages-exp/auth-exp/src/core/user/account_info.ts +++ b/packages-exp/auth-exp/src/core/user/account_info.ts @@ -31,27 +31,35 @@ interface Profile { photoURL?: string | null; } +/** + * Updates a user's profile data. + * + * @param user - The user. + * @param profile - The profile's `displayName` and `photoURL` to update. + * + * @public + */ export async function updateProfile( - externUser: externs.User, + user: externs.User, { displayName, photoURL: photoUrl }: Profile ): Promise { if (displayName === undefined && photoUrl === undefined) { return; } - const user = externUser as User; + const userInternal = user as User; const idToken = await user.getIdToken(); const profileRequest = { idToken, displayName, photoUrl }; const response = await _logoutIfInvalidated( - user, - apiUpdateProfile(user.auth, profileRequest) + userInternal, + apiUpdateProfile(userInternal.auth, profileRequest) ); - user.displayName = response.displayName || null; - user.photoURL = response.photoUrl || null; + userInternal.displayName = response.displayName || null; + userInternal.photoURL = response.photoUrl || null; // Update the password provider as well - const passwordProvider = user.providerData.find( + const passwordProvider = userInternal.providerData.find( ({ providerId }) => providerId === externs.ProviderId.PASSWORD ); if (passwordProvider) { @@ -59,25 +67,53 @@ export async function updateProfile( passwordProvider.photoURL = user.photoURL; } - await user._updateTokensIfNecessary(response); + await userInternal._updateTokensIfNecessary(response); } +/** + * Updates the user's email address. + * + * @remarks + * An email will be sent to the original email address (if it was set) that allows to revoke the + * email address change, in order to protect them from account hijacking. + * + * Important: this is a security sensitive operation that requires the user to have recently signed + * in. If this requirement isn't met, ask the user to authenticate again and then call + * {@link reauthenticateWithCredential}. + * + * @param user - The user. + * @param newEmail - The new email address. + * + * @public + */ export function updateEmail( - externUser: externs.User, + user: externs.User, newEmail: string ): Promise { - const user = externUser as User; - return updateEmailOrPassword(user, newEmail, null); + return updateEmailOrPassword(user as User, newEmail, null); } +/** + * Updates the user's password. + * + * @remarks + * Important: this is a security sensitive operation that requires the user to have recently signed + * in. If this requirement isn't met, ask the user to authenticate again and then call + * {@link reauthenticateWithCredential}. + * + * @param user - The user. + * @param newPassword - The new password. + * + * @public + */ export function updatePassword( - externUser: externs.User, + user: externs.User, newPassword: string ): Promise { - const user = externUser as User; - return updateEmailOrPassword(user, null, newPassword); + return updateEmailOrPassword(user as User, null, newPassword); } +/** @internal */ async function updateEmailOrPassword( user: User, email: string | null, diff --git a/packages-exp/auth-exp/src/core/user/additional_user_info.ts b/packages-exp/auth-exp/src/core/user/additional_user_info.ts index cd7faf432e1..7e1badb6b62 100644 --- a/packages-exp/auth-exp/src/core/user/additional_user_info.ts +++ b/packages-exp/auth-exp/src/core/user/additional_user_info.ts @@ -22,6 +22,8 @@ import { UserCredential } from '../../model/user'; /** * Parse the `AdditionalUserInfo` from the ID token response. + * + * @internal */ export function _fromIdTokenResponse( idTokenResponse?: IdTokenResponse @@ -126,6 +128,13 @@ class TwitterAdditionalUserInfo extends FederatedAdditionalUserInfoWithUsername } } +/** + * Extracts provider specific {@link @firebase/auth-types#AdditionalUserInfo} for the given credential. + * + * @param userCredential - The user credential. + * + * @public + */ export function getAdditionalUserInfo( userCredential: externs.UserCredential ): externs.AdditionalUserInfo | null { diff --git a/packages-exp/auth-exp/src/core/user/id_token_result.ts b/packages-exp/auth-exp/src/core/user/id_token_result.ts index aa672881081..e002fcfb1e7 100644 --- a/packages-exp/auth-exp/src/core/user/id_token_result.ts +++ b/packages-exp/auth-exp/src/core/user/id_token_result.ts @@ -24,6 +24,18 @@ import { _logError } from '../util/log'; import { utcTimestampToDateString } from '../util/time'; import { AuthErrorCode } from '../errors'; +/** + * Returns a JSON Web Token (JWT) used to identify the user to a Firebase service. + * + * @remarks + * Returns the current token if it has not expired or if it will not expire in the next five + * minutes. Otherwise, this will refresh the token and return a new one. + * + * @param user - The user. + * @param forceRefresh - Force refresh regardless of token expiration. + * + * @public + */ export function getIdToken( user: externs.User, forceRefresh = false @@ -31,18 +43,30 @@ export function getIdToken( return user.getIdToken(forceRefresh); } +/** + * Returns a deserialized JSON Web Token (JWT) used to identitfy the user to a Firebase service. + * + * @remarks + * Returns the current token if it has not expired or if it will not expire in the next five + * minutes. Otherwise, this will refresh the token and return a new one. + * + * @param user - The user. + * @param forceRefresh - Force refresh regardless of token expiration. + * + * @public + */ export async function getIdTokenResult( - externUser: externs.User, + user: externs.User, forceRefresh = false ): Promise { - const user = externUser as User; + const userInternal = user as User; const token = await user.getIdToken(forceRefresh); const claims = _parseToken(token); assert( claims && claims.exp && claims.auth_time && claims.iat, AuthErrorCode.INTERNAL_ERROR, - { appName: user.auth.name } + { appName: userInternal.auth.name } ); const firebase = typeof claims.firebase === 'object' ? claims.firebase : undefined; @@ -70,6 +94,7 @@ function secondsStringToMilliseconds(seconds: string): number { return Number(seconds) * 1000; } +/** @internal */ export function _parseToken(token: string): externs.ParsedToken | null { const [algorithm, payload, signature] = token.split('.'); if ( diff --git a/packages-exp/auth-exp/src/core/user/link_unlink.ts b/packages-exp/auth-exp/src/core/user/link_unlink.ts index 3683f1a3f6f..077c5a97e62 100644 --- a/packages-exp/auth-exp/src/core/user/link_unlink.ts +++ b/packages-exp/auth-exp/src/core/user/link_unlink.ts @@ -29,35 +29,38 @@ import { _reloadWithoutSaving } from './reload'; import { UserCredentialImpl } from './user_credential_impl'; /** - * This is the externally visible unlink function + * Unlinks a provider from a user account. + * + * @param user - The user. + * @param providerId - The provider to unlink. + * + * @public */ export async function unlink( - userExtern: externs.User, + user: externs.User, providerId: externs.ProviderId ): Promise { - const user = userExtern as User; - await _assertLinkedStatus(true, user, providerId); - const { providerUserInfo } = await deleteLinkedAccounts(user.auth, { + const userInternal = user as User; + await _assertLinkedStatus(true, userInternal, providerId); + const { providerUserInfo } = await deleteLinkedAccounts(userInternal.auth, { idToken: await user.getIdToken(), deleteProvider: [providerId] }); const providersLeft = providerDataAsNames(providerUserInfo || []); - user.providerData = user.providerData.filter(pd => + userInternal.providerData = user.providerData.filter(pd => providersLeft.has(pd.providerId) ); if (!providersLeft.has(externs.ProviderId.PHONE)) { - user.phoneNumber = null; + userInternal.phoneNumber = null; } - await user.auth._persistUserIfCurrent(user); + await userInternal.auth._persistUserIfCurrent(userInternal); return user; } -/** - * Internal-only link helper - */ +/** @internal */ export async function _link( user: User, credential: AuthCredential @@ -73,6 +76,7 @@ export async function _link( ); } +/** @internal */ export async function _assertLinkedStatus( expected: boolean, user: User, diff --git a/packages-exp/auth-exp/src/core/user/reload.ts b/packages-exp/auth-exp/src/core/user/reload.ts index fe1a780494b..b0d25465b79 100644 --- a/packages-exp/auth-exp/src/core/user/reload.ts +++ b/packages-exp/auth-exp/src/core/user/reload.ts @@ -61,15 +61,22 @@ export async function _reloadWithoutSaving(user: User): Promise { Object.assign(user, updates); } -export async function reload(externUser: externs.User): Promise { - const user: User = externUser as User; - await _reloadWithoutSaving(user); +/** + * Reloads user account data, if signed in. + * + * @param user - The user. + * + * @public + */ +export async function reload(user: externs.User): Promise { + const userInternal: User = user as User; + await _reloadWithoutSaving(userInternal); // Even though the current user hasn't changed, update // current user will trigger a persistence update w/ the // new info. - await user.auth._persistUserIfCurrent(user); - user.auth._notifyListenersIfCurrent(user); + await userInternal.auth._persistUserIfCurrent(userInternal); + userInternal.auth._notifyListenersIfCurrent(userInternal); } function mergeProviderData( diff --git a/packages-exp/auth-exp/src/core/user/token_manager.ts b/packages-exp/auth-exp/src/core/user/token_manager.ts index 0ab9fae8b7b..d728d7ac1da 100644 --- a/packages-exp/auth-exp/src/core/user/token_manager.ts +++ b/packages-exp/auth-exp/src/core/user/token_manager.ts @@ -26,6 +26,8 @@ import { assert, debugFail } from '../util/assert'; /** * The number of milliseconds before the official expiration time of a token * to refresh that token, to provide a buffer for RPCs to complete. + * + * @internal */ export const TOKEN_REFRESH_BUFFER_MS = 30_000; diff --git a/packages-exp/auth-exp/src/mfa/mfa_resolver.ts b/packages-exp/auth-exp/src/mfa/mfa_resolver.ts index 9b2f1c28977..d414ab1dd4e 100644 --- a/packages-exp/auth-exp/src/mfa/mfa_resolver.ts +++ b/packages-exp/auth-exp/src/mfa/mfa_resolver.ts @@ -36,6 +36,7 @@ export class MultiFactorResolver implements externs.MultiFactorResolver { ) => Promise ) {} + /** @internal */ static _fromError( authExtern: externs.Auth, error: MultiFactorError @@ -104,11 +105,21 @@ export class MultiFactorResolver implements externs.MultiFactorResolver { } } +/** + * Provides a {@link @firebase/auth-types#MultiFactorResolver} suitable for completion of a + * multi-factor flow. + * + * @param auth - The auth instance. + * @param error - The {@link @firebase/auth-types#MultiFactorError} raised during a sign-in, or + * reauthentication operation. + * + * @public + */ export function getMultiFactorResolver( auth: externs.Auth, - errorExtern: externs.MultiFactorError + error: externs.MultiFactorError ): externs.MultiFactorResolver { - const error = errorExtern as MultiFactorError; + const errorInternal = error as MultiFactorError; assert(error.operationType, AuthErrorCode.ARGUMENT_ERROR, { appName: auth.name }); @@ -116,10 +127,10 @@ export function getMultiFactorResolver( appName: auth.name }); assert( - error.serverResponse?.mfaPendingCredential, + errorInternal.serverResponse?.mfaPendingCredential, AuthErrorCode.ARGUMENT_ERROR, { appName: auth.name } ); - return MultiFactorResolver._fromError(auth, error); + return MultiFactorResolver._fromError(auth, errorInternal); } diff --git a/packages-exp/auth-exp/src/mfa/mfa_user.ts b/packages-exp/auth-exp/src/mfa/mfa_user.ts index 1cdbdf3ef71..be2ff51b59c 100644 --- a/packages-exp/auth-exp/src/mfa/mfa_user.ts +++ b/packages-exp/auth-exp/src/mfa/mfa_user.ts @@ -99,6 +99,16 @@ const multiFactorUserCache = new WeakMap< externs.MultiFactorUser >(); +/** + * The {@link @firebase/auth-types#MultiFactorUser} corresponding to the user. + * + * @remarks + * This is used to access all multi-factor properties and operations related to the user. + * + * @param user - The user. + * + * @public + */ export function multiFactor(user: externs.User): externs.MultiFactorUser { if (!multiFactorUserCache.has(user)) { multiFactorUserCache.set(user, MultiFactorUser._fromUser(user as User)); diff --git a/packages-exp/auth-exp/src/model/application_verifier.ts b/packages-exp/auth-exp/src/model/application_verifier.ts index 595ff025e05..cc52a7cdb68 100644 --- a/packages-exp/auth-exp/src/model/application_verifier.ts +++ b/packages-exp/auth-exp/src/model/application_verifier.ts @@ -17,6 +17,8 @@ import * as externs from '@firebase/auth-types-exp'; +/** @internal */ export interface ApplicationVerifier extends externs.ApplicationVerifier { + /** @internal */ _reset(): void; } diff --git a/packages-exp/auth-exp/src/model/auth.ts b/packages-exp/auth-exp/src/model/auth.ts index 1b842c544f6..b7daf7b2d2a 100644 --- a/packages-exp/auth-exp/src/model/auth.ts +++ b/packages-exp/auth-exp/src/model/auth.ts @@ -20,45 +20,75 @@ import * as externs from '@firebase/auth-types-exp'; import { PopupRedirectResolver } from './popup_redirect'; import { User } from './user'; +/** @internal */ export type AppName = string; +/** @internal */ export type ApiKey = string; +/** @internal */ export type AuthDomain = string; +/** @internal */ export interface ConfigInternal extends externs.Config { + /** + * @internal + * @readonly + */ emulator?: { url: string; }; } +/** @internal */ export interface Auth extends externs.Auth { + /** @internal */ currentUser: externs.User | null; + /** @internal */ _canInitEmulator: boolean; + /** @internal */ _isInitialized: boolean; + /** @internal */ _initializationPromise: Promise | null; + /** @internal */ _updateCurrentUser(user: User | null): Promise; + /** @internal */ _onStorageEvent(): void; + /** @internal */ _notifyListenersIfCurrent(user: User): void; + /** @internal */ _persistUserIfCurrent(user: User): Promise; + /** @internal */ _setRedirectUser( user: User | null, popupRedirectResolver?: externs.PopupRedirectResolver ): Promise; + /** @internal */ _redirectUserForId(id: string): Promise; + /** @internal */ _popupRedirectResolver: PopupRedirectResolver | null; + /** @internal */ _key(): string; + /** @internal */ _startProactiveRefresh(): void; + /** @internal */ _stopProactiveRefresh(): void; _getPersistence(): string; + /** @internal */ readonly name: AppName; + /** @internal */ readonly config: ConfigInternal; + /** @internal */ languageCode: string | null; + /** @internal */ tenantId: string | null; + /** @internal */ readonly settings: externs.AuthSettings; + /** @internal */ useDeviceLanguage(): void; + /** @internal */ signOut(): Promise; } diff --git a/packages-exp/auth-exp/src/model/id_token.ts b/packages-exp/auth-exp/src/model/id_token.ts index e2bcd84ac6f..a8325590b24 100644 --- a/packages-exp/auth-exp/src/model/id_token.ts +++ b/packages-exp/auth-exp/src/model/id_token.ts @@ -21,11 +21,15 @@ import { PhoneOrOauthTokenResponse } from '../api/authentication/mfa'; /** * Raw encoded JWT + * + * @internal */ export type IdToken = string; /** * Raw parsed JWT + * + * @internal */ export interface ParsedIdToken { iss: string; @@ -46,6 +50,8 @@ export interface ParsedIdToken { /** * IdToken as returned by the API + * + * @internal */ export interface IdTokenResponse { localId: string; @@ -65,6 +71,8 @@ export interface IdTokenResponse { /** * The possible types of the `IdTokenResponse` + * + * @internal */ export const enum IdTokenResponseKind { CreateAuthUri = 'identitytoolkit#CreateAuthUriResponse', @@ -83,6 +91,9 @@ export const enum IdTokenResponseKind { VerifyPassword = 'identitytoolkit#VerifyPasswordResponse' } +/** + * @internal + */ export interface TaggedWithTokenResponse { _tokenResponse?: PhoneOrOauthTokenResponse; } diff --git a/packages-exp/auth-exp/src/model/popup_redirect.ts b/packages-exp/auth-exp/src/model/popup_redirect.ts index 23908c3e25f..6aa79da7a57 100644 --- a/packages-exp/auth-exp/src/model/popup_redirect.ts +++ b/packages-exp/auth-exp/src/model/popup_redirect.ts @@ -21,20 +21,24 @@ import { FirebaseError } from '@firebase/util'; import { AuthPopup } from '../platform_browser/util/popup'; import { Auth } from './auth'; +/** @internal */ export const enum EventFilter { POPUP, REDIRECT } +/** @internal */ export const enum GapiOutcome { ACK = 'ACK', ERROR = 'ERROR' } +/** @internal */ export interface GapiAuthEvent extends gapi.iframes.Message { authEvent: AuthEvent; } +/** @internal */ export const enum AuthEventType { LINK_VIA_POPUP = 'linkViaPopup', LINK_VIA_REDIRECT = 'linkViaRedirect', @@ -46,11 +50,13 @@ export const enum AuthEventType { VERIFY_APP = 'verifyApp' } +/** @internal */ export interface AuthEventError extends Error { code: string; // in the form of auth/${AuthErrorCode} message: string; } +/** @internal */ export interface AuthEvent { type: AuthEventType; eventId: string | null; @@ -61,6 +67,7 @@ export interface AuthEvent { error?: AuthEventError; } +/** @internal */ export interface AuthEventConsumer { readonly filter: AuthEventType[]; eventId: string | null; @@ -68,25 +75,31 @@ export interface AuthEventConsumer { onError(error: FirebaseError): unknown; } +/** @internal */ export interface EventManager { registerConsumer(authEventConsumer: AuthEventConsumer): void; unregisterConsumer(authEventConsumer: AuthEventConsumer): void; } +/** @internal */ export interface PopupRedirectResolver extends externs.PopupRedirectResolver { + /** @internal */ _initialize(auth: Auth): Promise; + /** @internal */ _openPopup( auth: Auth, provider: externs.AuthProvider, authType: AuthEventType, eventId?: string ): Promise; + /** @internal */ _openRedirect( auth: Auth, provider: externs.AuthProvider, authType: AuthEventType, eventId?: string ): Promise; + /** @internal */ _isIframeWebStorageSupported( auth: Auth, cb: (support: boolean) => unknown diff --git a/packages-exp/auth-exp/src/model/user.ts b/packages-exp/auth-exp/src/model/user.ts index dfec0715e7e..286f2a0c97e 100644 --- a/packages-exp/auth-exp/src/model/user.ts +++ b/packages-exp/auth-exp/src/model/user.ts @@ -25,10 +25,12 @@ import { UserMetadata } from '../core/user/user_metadata'; import { Auth } from './auth'; import { IdTokenResponse, TaggedWithTokenResponse } from './id_token'; +/** @internal */ export type MutableUserInfo = { -readonly [K in keyof externs.UserInfo]: externs.UserInfo[K]; }; +/** @internal */ export interface UserParameters { uid: string; auth: Auth; @@ -46,44 +48,72 @@ export interface UserParameters { lastLoginAt?: string | null; } +/** @internal */ export interface User extends externs.User { + /** @internal */ displayName: string | null; + /** @internal */ email: string | null; + /** @internal */ phoneNumber: string | null; + /** @internal */ photoURL: string | null; + /** @internal */ auth: Auth; + /** @internal */ providerId: externs.ProviderId.FIREBASE; + /** @internal */ refreshToken: string; + /** @internal */ emailVerified: boolean; + /** @internal */ tenantId: string | null; + /** @internal */ providerData: MutableUserInfo[]; + /** @internal */ metadata: UserMetadata; + /** @internal */ stsTokenManager: StsTokenManager; + /** @internal */ _redirectEventId?: string; + /** @internal */ _updateTokensIfNecessary( response: IdTokenResponse | FinalizeMfaResponse, reload?: boolean ): Promise; + /** @internal */ _assign(user: User): void; + /** @internal */ _clone(): User; + /** @internal */ _onReload: (cb: NextFn) => void; + /** @internal */ _notifyReloadListener: NextFn; + /** @internal */ _startProactiveRefresh: () => void; + /** @internal */ _stopProactiveRefresh: () => void; + /** @internal */ getIdToken(forceRefresh?: boolean): Promise; + /** @internal */ getIdTokenResult(forceRefresh?: boolean): Promise; + /** @internal */ reload(): Promise; + /** @internal */ delete(): Promise; + /** @internal */ toJSON(): PersistedBlob; } +/** @internal */ export interface UserCredential extends externs.UserCredential, TaggedWithTokenResponse { + /** @internal */ user: User; } diff --git a/packages-exp/auth-exp/src/platform_browser/mfa/assertions/phone.ts b/packages-exp/auth-exp/src/platform_browser/mfa/assertions/phone.ts index 45aa3b54724..277cb979b46 100644 --- a/packages-exp/auth-exp/src/platform_browser/mfa/assertions/phone.ts +++ b/packages-exp/auth-exp/src/platform_browser/mfa/assertions/phone.ts @@ -25,6 +25,11 @@ import { FinalizeMfaResponse } from '../../../api/authentication/mfa'; +/** + * {@inheritdoc @firebase/auth-types#PhoneMultiFactorAssertion} + * + * @public + */ export class PhoneMultiFactorAssertion extends MultiFactorAssertion implements externs.PhoneMultiFactorAssertion { @@ -32,12 +37,14 @@ export class PhoneMultiFactorAssertion super(credential.providerId); } + /** @internal */ static _fromCredential( credential: PhoneAuthCredential ): PhoneMultiFactorAssertion { return new PhoneMultiFactorAssertion(credential); } + /** @internal */ _finalizeEnroll( auth: Auth, idToken: string, @@ -50,6 +57,7 @@ export class PhoneMultiFactorAssertion }); } + /** @internal */ _finalizeSignIn( auth: Auth, mfaPendingCredential: string @@ -61,10 +69,15 @@ export class PhoneMultiFactorAssertion } } +/** + * {@inheritdoc @firebase/auth-types#PhoneMultiFactorGenerator} + * @public + */ export class PhoneMultiFactorGenerator implements externs.PhoneMultiFactorGenerator { private constructor() {} + /** {@inheritdoc @firebase/auth-types#PhoneMultiFactorGenerator.assertion} */ static assertion( credential: externs.PhoneAuthCredential ): externs.PhoneMultiFactorAssertion { diff --git a/packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.ts b/packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.ts index 0987d73e09c..9fae0a0abb0 100644 --- a/packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.ts +++ b/packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.ts @@ -39,6 +39,8 @@ interface DBObject { * Promise wrapper for IDBRequest * * Unfortunately we can't cleanly extend Promise since promises are not callable in ES6 + * + * @internal */ class DBPromise { constructor(private readonly request: IDBRequest) {} @@ -61,16 +63,19 @@ function getObjectStore(db: IDBDatabase, isReadWrite: boolean): IDBObjectStore { .objectStore(DB_OBJECTSTORE_NAME); } +/** @internal */ export async function _clearDatabase(db: IDBDatabase): Promise { const objectStore = getObjectStore(db, true); return new DBPromise(objectStore.clear()).toPromise(); } +/** @internal */ export function _deleteDatabase(): Promise { const request = indexedDB.deleteDatabase(DB_NAME); return new DBPromise(request).toPromise(); } +/** @internal */ export function _openDatabase(): Promise { const request = indexedDB.open(DB_NAME, DB_VERSION); return new Promise((resolve, reject) => { @@ -105,6 +110,7 @@ export function _openDatabase(): Promise { }); } +/** @internal */ export async function _putObject( db: IDBDatabase, key: string, @@ -140,6 +146,7 @@ function deleteObject(db: IDBDatabase, key: string): Promise { return new DBPromise(request).toPromise(); } +/** @internal */ export const _POLLING_INTERVAL_MS = 800; class IndexedDBLocalPersistence implements Persistence { @@ -286,4 +293,10 @@ class IndexedDBLocalPersistence implements Persistence { } } +/** + * An implementation of {@link @firebase/auth-types#Persistence} of type 'LOCAL' using `indexedDB` + * for the underlying storage. + * + * @public + */ export const indexedDBLocalPersistence: externs.Persistence = IndexedDBLocalPersistence; diff --git a/packages-exp/auth-exp/src/platform_browser/persistence/local_storage.ts b/packages-exp/auth-exp/src/platform_browser/persistence/local_storage.ts index 60509787ad5..e75725643bf 100644 --- a/packages-exp/auth-exp/src/platform_browser/persistence/local_storage.ts +++ b/packages-exp/auth-exp/src/platform_browser/persistence/local_storage.ts @@ -236,4 +236,10 @@ class BrowserLocalPersistence } } +/** + * An implementation of {@link @firebase/auth-types#Persistence} of type 'LOCAL' using `localStorage` + * for the underlying storage. + * + * @public + */ export const browserLocalPersistence: externs.Persistence = BrowserLocalPersistence; diff --git a/packages-exp/auth-exp/src/platform_browser/persistence/session_storage.ts b/packages-exp/auth-exp/src/platform_browser/persistence/session_storage.ts index b585f658b0d..006958a3664 100644 --- a/packages-exp/auth-exp/src/platform_browser/persistence/session_storage.ts +++ b/packages-exp/auth-exp/src/platform_browser/persistence/session_storage.ts @@ -44,4 +44,10 @@ class BrowserSessionPersistence } } +/** + * An implementation of {@link @firebase/auth-types#Persistence} of 'SESSION' using `sessionStorage` + * for the underlying storage. + * + * @public + */ export const browserSessionPersistence: externs.Persistence = BrowserSessionPersistence; diff --git a/packages-exp/auth-exp/src/platform_browser/popup_redirect.ts b/packages-exp/auth-exp/src/platform_browser/popup_redirect.ts index 698bb225f6c..f92d5021370 100644 --- a/packages-exp/auth-exp/src/platform_browser/popup_redirect.ts +++ b/packages-exp/auth-exp/src/platform_browser/popup_redirect.ts @@ -43,16 +43,22 @@ import { _open, AuthPopup } from './util/popup'; /** * URL for Authentication widget which will initiate the OAuth handshake + * + * @internal */ const WIDGET_PATH = '__/auth/handler'; /** * URL for emulated environment + * + * @internal */ const EMULATOR_WIDGET_PATH = 'emulator/auth/handler'; /** * The special web storage event + * + * @internal */ const WEB_STORAGE_SUPPORT_KEY = 'webStorageSupport'; @@ -69,6 +75,8 @@ interface ManagerOrPromise { * Chooses a popup/redirect resolver to use. This prefers the override (which * is directly passed in), and falls back to the property set on the auth * object. If neither are available, this function errors w/ an argument error. + * + * @internal */ export function _withDefaultResolver( auth: Auth, @@ -192,6 +200,12 @@ class BrowserPopupRedirectResolver implements PopupRedirectResolver { } } +/** + * An implementation of {@link @firebase/auth-types#PopupRedirectResolver} suitable for browser + * based applications. + * + * @public + */ export const browserPopupRedirectResolver: externs.PopupRedirectResolver = BrowserPopupRedirectResolver; // eslint-disable-next-line @typescript-eslint/consistent-type-definitions diff --git a/packages-exp/auth-exp/src/platform_browser/providers/phone.ts b/packages-exp/auth-exp/src/platform_browser/providers/phone.ts index 160bf7b95ff..a1a7d014d16 100644 --- a/packages-exp/auth-exp/src/platform_browser/providers/phone.ts +++ b/packages-exp/auth-exp/src/platform_browser/providers/phone.ts @@ -27,10 +27,17 @@ import { _verifyPhoneNumber } from '../strategies/phone'; import { assert, fail } from '../../core/util/assert'; import { _castAuth } from '../../core/auth/auth_impl'; +/** + * {@inheritdoc @firebase/auth-types#PhoneAuthProvider} + * @public + */ export class PhoneAuthProvider implements externs.PhoneAuthProvider { + /** {@inheritdoc @firebase/auth-types#PhoneAuthProvider.PROVIDER_ID} */ static readonly PROVIDER_ID = externs.ProviderId.PHONE; + /** {@inheritdoc @firebase/auth-types#PhoneAuthProvider.PHONE_SIGN_IN_METHOD} */ static readonly PHONE_SIGN_IN_METHOD = externs.SignInMethod.PHONE; + /** {@inheritdoc @firebase/auth-types#PhoneAuthProvider.providerId} */ readonly providerId = PhoneAuthProvider.PROVIDER_ID; private readonly auth: Auth; @@ -38,6 +45,7 @@ export class PhoneAuthProvider implements externs.PhoneAuthProvider { this.auth = _castAuth(auth); } + /** {@inheritdoc @firebase/auth-types#PhoneAuthProvider.verifyPhoneNumber} */ verifyPhoneNumber( phoneOptions: externs.PhoneInfoOptions | string, applicationVerifier: externs.ApplicationVerifier @@ -49,6 +57,7 @@ export class PhoneAuthProvider implements externs.PhoneAuthProvider { ); } + /** {@inheritdoc @firebase/auth-types#PhoneAuthProvider.credential} */ static credential( verificationId: string, verificationCode: string diff --git a/packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha_verifier.ts b/packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha_verifier.ts index 407f4628d97..3c0129dcf11 100644 --- a/packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha_verifier.ts +++ b/packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha_verifier.ts @@ -40,6 +40,10 @@ const DEFAULT_PARAMS: Parameters = { type TokenCallback = (token: string) => void; +/** + * {@inheritdoc @firebase/auth-types#RecaptchaVerifier} + * @public + */ export class RecaptchaVerifier implements externs.RecaptchaVerifier, ApplicationVerifier { readonly type = RECAPTCHA_VERIFIER_TYPE; @@ -52,6 +56,7 @@ export class RecaptchaVerifier private renderPromise: Promise | null = null; private readonly auth: Auth; + /** @internal */ readonly _recaptchaLoader: ReCaptchaLoader; private recaptcha: Recaptcha | null = null; @@ -87,6 +92,7 @@ export class RecaptchaVerifier // TODO: Figure out if sdk version is needed } + /** {@inheritdoc @firebase/auth-types#RecaptchaVerifier.verify} */ async verify(): Promise { this.assertNotDestroyed(); const id = await this.render(); @@ -113,6 +119,7 @@ export class RecaptchaVerifier }); } + /** {@inheritdoc @firebase/auth-types#RecaptchaVerifier.render} */ render(): Promise { try { this.assertNotDestroyed(); @@ -135,6 +142,7 @@ export class RecaptchaVerifier return this.renderPromise; } + /** @internal */ _reset(): void { this.assertNotDestroyed(); if (this.widgetId !== null) { @@ -142,6 +150,7 @@ export class RecaptchaVerifier } } + /** {@inheritdoc @firebase/auth-types#RecaptchaVerifier.clear} */ clear(): void { this.assertNotDestroyed(); this.destroyed = true; diff --git a/packages-exp/auth-exp/src/platform_browser/strategies/phone.ts b/packages-exp/auth-exp/src/platform_browser/strategies/phone.ts index a6c85f5f951..05546cec273 100644 --- a/packages-exp/auth-exp/src/platform_browser/strategies/phone.ts +++ b/packages-exp/auth-exp/src/platform_browser/strategies/phone.ts @@ -58,6 +58,33 @@ class ConfirmationResult implements externs.ConfirmationResult { } } +/** + * Asynchronously signs in using a phone number. + * + * @remarks + * This method sends a code via SMS to the given + * phone number, and returns a {@link @firebase/auth-types#ConfirmationResult}. After the user + * provides the code sent to their phone, call {@link @firebase/auth-types#ConfirmationResult.confirm} + * with the code to sign the user in. + * + * For abuse prevention, this method also requires a {@link @firebase/auth-types#ApplicationVerifier}. + * This SDK includes a reCAPTCHA-based implementation, {@link RecaptchaVerifier}. + * + * @example + * ```javascript + * // 'recaptcha-container' is the ID of an element in the DOM. + * const applicationVerifier = new firebase.auth.RecaptchaVerifier('recaptcha-container'); + * const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier); + * // Obtain a verificationCode from the user. + * const credential = await confirmationResult.confirm(verificationCode); + * ``` + * + * @param auth - The Auth instance. + * @param phoneNumber - The user's phone number in E.164 format (e.g. +16505550101). + * @param appVerifier - The {@link @firebase/auth-types#ApplicationVerifier}. + * + * @public + */ export async function signInWithPhoneNumber( auth: externs.Auth, phoneNumber: string, @@ -73,15 +100,24 @@ export async function signInWithPhoneNumber( ); } +/** + * Links the user account with the given phone number. + * + * @param user - The user. + * @param phoneNumber - The user's phone number in E.164 format (e.g. +16505550101). + * @param appVerifier - The {@link @firebase/auth-types#ApplicationVerifier}. + * + * @public + */ export async function linkWithPhoneNumber( - userExtern: externs.User, + user: externs.User, phoneNumber: string, appVerifier: externs.ApplicationVerifier ): Promise { - const user = userExtern as User; - await _assertLinkedStatus(false, user, externs.ProviderId.PHONE); + const userInternal = user as User; + await _assertLinkedStatus(false, userInternal, externs.ProviderId.PHONE); const verificationId = await _verifyPhoneNumber( - user.auth, + userInternal.auth, phoneNumber, appVerifier as ApplicationVerifier ); @@ -90,14 +126,25 @@ export async function linkWithPhoneNumber( ); } +/** + * Re-authenticates a user using a fresh phne credential. + * + * @remarks Use before operations such as {@link updatePassword} that require tokens from recent sign-in attempts. + * + * @param user - The user. + * @param phoneNumber - The user's phone number in E.164 format (e.g. +16505550101). + * @param appVerifier - The {@link @firebase/auth-types#ApplicationVerifier}. + * + * @public + */ export async function reauthenticateWithPhoneNumber( - userExtern: externs.User, + user: externs.User, phoneNumber: string, appVerifier: externs.ApplicationVerifier ): Promise { - const user = userExtern as User; + const userInternal = user as User; const verificationId = await _verifyPhoneNumber( - user.auth, + userInternal.auth, phoneNumber, appVerifier as ApplicationVerifier ); @@ -107,8 +154,9 @@ export async function reauthenticateWithPhoneNumber( } /** - * Returns a verification ID to be used in conjunction with the SMS code that - * is sent. + * Returns a verification ID to be used in conjunction with the SMS code that is sent. + * + * @internal */ export async function _verifyPhoneNumber( auth: Auth, @@ -187,6 +235,25 @@ export async function _verifyPhoneNumber( } } +/** + * Updates the user's phone number. + * + * @example + * ``` + * // 'recaptcha-container' is the ID of an element in the DOM. + * const applicationVerifier = new RecaptchaVerifier('recaptcha-container'); + * const provider = new PhoneAuthProvider(auth); + * const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier); + * // Obtain the verificationCode from the user. + * const phoneCredential = PhoneAuthProvider.credential(verificationId, verificationCode); + * await updatePhoneNumber(user, phoneCredential); + * ``` + * + * @param user - The user. + * @param credential - A credential authenticating the new phone number. + * + * @public + */ export async function updatePhoneNumber( user: externs.User, credential: externs.PhoneAuthCredential diff --git a/packages-exp/auth-exp/src/platform_browser/strategies/popup.ts b/packages-exp/auth-exp/src/platform_browser/strategies/popup.ts index f53013364e9..cfed5f744a6 100644 --- a/packages-exp/auth-exp/src/platform_browser/strategies/popup.ts +++ b/packages-exp/auth-exp/src/platform_browser/strategies/popup.ts @@ -34,69 +34,151 @@ import { _withDefaultResolver } from '../popup_redirect'; import { AuthPopup } from '../util/popup'; import { AbstractPopupRedirectOperation } from './abstract_popup_redirect_operation'; -// The event timeout is the same on mobile and desktop, no need for Delay. +/** + * The event timeout is the same on mobile and desktop, no need for Delay. + * @internal + */ export const _AUTH_EVENT_TIMEOUT = 2020; +/** @internal */ export const _POLL_WINDOW_CLOSE_TIMEOUT = new Delay(2000, 10000); +/** + * Authenticates a Firebase client using a popup-based OAuth authentication flow. + * + * @remarks + * If succeeds, returns the signed in user along with the provider's credential. If sign in was + * unsuccessful, returns an error object containing additional information about the error. + * + * @example + * ```javascript + * // Sign in using a popup. + * const provider = new FacebookAuthProvider(); + * const result = await signInWithPopup(auth, provider); + * + * // The signed-in user info. + * const user = result.user; + * // This gives you a Facebook Access Token. + * const credential = provider.credentialFromResult(auth, result); + * const token = credential.accessToken; + * ``` + * + * @param auth - The Auth instance. + * @param provider - The provider to authenticate. The provider has to be an {@link OAuthProvider}. + * Non-OAuth providers like {@link EmailAuthProvider} will throw an error. + * @param resolver - An instance of {@link @firebase/auth-types#PopupRedirectResolver}, optional + * if already supplied to {@link initializeAuth} or provided by {@link getAuth}. + * + * + * @public + */ export async function signInWithPopup( - authExtern: externs.Auth, + auth: externs.Auth, provider: externs.AuthProvider, - resolverExtern?: externs.PopupRedirectResolver + resolver?: externs.PopupRedirectResolver ): Promise { - const auth = _castAuth(authExtern); + const authInternal = _castAuth(auth); assert(provider instanceof OAuthProvider, AuthErrorCode.ARGUMENT_ERROR, { appName: auth.name }); - const resolver = _withDefaultResolver(auth, resolverExtern); + const resolverInternal = _withDefaultResolver(authInternal, resolver); const action = new PopupOperation( - auth, + authInternal, AuthEventType.SIGN_IN_VIA_POPUP, provider, - resolver + resolverInternal ); return action.executeNotNull(); } +/** + * Reauthenticates the current user with the specified {@link OAuthProvider} using a pop-up based + * OAuth flow. + * + * @remarks + * If the reauthentication is successful, the returned result will contain the user and the + * provider's credential. + * + * @example + * ```javascript + * // Sign in using a popup. + * const provider = new FacebookAuthProvider(); + * const result = await signInWithPopup(auth, provider); + * // Reauthenticate using a popup. + * await reauthenticateWithPopup(result.user, provider); + * ``` + * + * @param user - The user. + * @param provider - The provider to authenticate. The provider has to be an {@link OAuthProvider}. + * Non-OAuth providers like {@link EmailAuthProvider} will throw an error. + * @param resolver - An instance of {@link @firebase/auth-types#PopupRedirectResolver}, optional + * if already supplied to {@link initializeAuth} or provided by {@link getAuth}. + * + * @public + */ export async function reauthenticateWithPopup( - userExtern: externs.User, + user: externs.User, provider: externs.AuthProvider, - resolverExtern?: externs.PopupRedirectResolver + resolver?: externs.PopupRedirectResolver ): Promise { - const user = userExtern as User; + const userInternal = user as User; assert(provider instanceof OAuthProvider, AuthErrorCode.ARGUMENT_ERROR, { - appName: user.auth.name + appName: userInternal.auth.name }); - const resolver = _withDefaultResolver(user.auth, resolverExtern); + const resolverInternal = _withDefaultResolver(userInternal.auth, resolver); const action = new PopupOperation( - user.auth, + userInternal.auth, AuthEventType.REAUTH_VIA_POPUP, provider, - resolver, - user + resolverInternal, + userInternal ); return action.executeNotNull(); } +/** + * Links the authenticated provider to the user account using a pop-up based OAuth flow. + * + * @remarks + * If the linking is successful, the returned result will contain the user and the provider's credential. + * + * + * @example + * ```javascript + * // Sign in using some other provider. + * const result = await signInWithEmailAndPassword(auth, email, password); + * // Link using a popup. + * const provider = new FacebookAuthProvider(); + * await linkWithPopup(result.user, provider); + * ``` + * + * @param user - The user. + * @param provider - The provider to authenticate. The provider has to be an {@link OAuthProvider}. + * Non-OAuth providers like {@link EmailAuthProvider} will throw an error. + * @param resolver - An instance of {@link @firebase/auth-types#PopupRedirectResolver}, optional + * if already supplied to {@link initializeAuth} or provided by {@link getAuth}. + * + * @public + */ export async function linkWithPopup( - userExtern: externs.User, + user: externs.User, provider: externs.AuthProvider, - resolverExtern?: externs.PopupRedirectResolver + resolver?: externs.PopupRedirectResolver ): Promise { - const user = userExtern as User; + const userInternal = user as User; assert(provider instanceof OAuthProvider, AuthErrorCode.ARGUMENT_ERROR, { - appName: user.auth.name + appName: userInternal.auth.name }); - const resolver = _withDefaultResolver(user.auth, resolverExtern); + const resolverInternal = _withDefaultResolver(userInternal.auth, resolver); const action = new PopupOperation( - user.auth, + userInternal.auth, AuthEventType.LINK_VIA_POPUP, provider, - resolver, - user + resolverInternal, + userInternal ); return action.executeNotNull(); } @@ -104,6 +186,8 @@ export async function linkWithPopup( /** * Popup event manager. Handles the popup's entire lifecycle; listens to auth * events + * + * @internal */ class PopupOperation extends AbstractPopupRedirectOperation { // Only one popup is ever shown at once. The lifecycle of the current popup diff --git a/packages-exp/auth-exp/src/platform_browser/strategies/redirect.ts b/packages-exp/auth-exp/src/platform_browser/strategies/redirect.ts index a2d919d16fa..b6c7615f345 100644 --- a/packages-exp/auth-exp/src/platform_browser/strategies/redirect.ts +++ b/packages-exp/auth-exp/src/platform_browser/strategies/redirect.ts @@ -34,91 +34,223 @@ import { User, UserCredential } from '../../model/user'; import { _withDefaultResolver } from '../popup_redirect'; import { AbstractPopupRedirectOperation } from './abstract_popup_redirect_operation'; +/** + * Authenticates a Firebase client using a full-page redirect flow. + * + * @remarks + * To handle the results and errors for this operation, refer to {@link getRedirectResult}. + * + * @example + * ```javascript + * // Sign in using a redirect. + * const provider = new FacebookAuthProvider(); + * // You can add additional scopes to the provider: + * provider.addScope('user_birthday'); + * // Start a sign in process for an unauthenticated user. + * await signInWithRedirect(auth, provider); + * // This will trigger a full page redirect away from your app + * + * // After returning from the redirect when your app initializes you can obtain the result + * const result = await getRedirectResult(auth); + * if (result) { + * // This is the signed-in user + * const user = result.user; + * // This gives you a Facebook Access Token. + * const credential = provider.credentialFromResult(auth, result); + * const token = credential.accessToken; + * } + * // As this API can be used for sign-in, linking and reauthentication, + * // check the operationType to determine what triggered this redirect + * // operation. + * const operationType = result.operationType; + * ``` + * + * @param auth - The Auth instance. + * @param provider - The provider to authenticate. The provider has to be an {@link OAuthProvider}. + * Non-OAuth providers like {@link EmailAuthProvider} will throw an error. + * @param resolver - An instance of {@link @firebase/auth-types#PopupRedirectResolver}, optional + * if already supplied to {@link initializeAuth} or provided by {@link getAuth}. + * + * @public + */ export async function signInWithRedirect( - authExtern: externs.Auth, + auth: externs.Auth, provider: externs.AuthProvider, - resolverExtern?: externs.PopupRedirectResolver + resolver?: externs.PopupRedirectResolver ): Promise { - const auth = _castAuth(authExtern); + const authInternal = _castAuth(auth); assert(provider instanceof OAuthProvider, AuthErrorCode.ARGUMENT_ERROR, { appName: auth.name }); - return _withDefaultResolver(auth, resolverExtern)._openRedirect( - auth, + return _withDefaultResolver(authInternal, resolver)._openRedirect( + authInternal, provider, AuthEventType.SIGN_IN_VIA_REDIRECT ); } +/** + * Reauthenticates the current user with the specified {@link OAuthProvider} using a full-page redirect flow. + * + * @example + * ```javascript + * // Sign in using a redirect. + * const provider = new FacebookAuthProvider(); + * const result = await signInWithRedirect(auth, provider); + * // This will trigger a full page redirect away from your app + * + * // After returning from the redirect when your app initializes you can obtain the result + * const result = await getRedirectResult(auth); + * // Link using a redirect. + * await linkWithRedirect(result.user, provider); + * // This will again trigger a full page redirect away from your app + * + * // After returning from the redirect when your app initializes you can obtain the result + * const result = await getRedirectResult(auth); + * ``` + * + * @param user - The user. + * @param provider - The provider to authenticate. The provider has to be an {@link OAuthProvider}. + * Non-OAuth providers like {@link EmailAuthProvider} will throw an error. + * @param resolver - An instance of {@link @firebase/auth-types#PopupRedirectResolver}, optional + * if already supplied to {@link initializeAuth} or provided by {@link getAuth}. + * + * @public + */ export async function reauthenticateWithRedirect( - userExtern: externs.User, + user: externs.User, provider: externs.AuthProvider, - resolverExtern?: externs.PopupRedirectResolver + resolver?: externs.PopupRedirectResolver ): Promise { - const user = userExtern as User; + const userInternal = user as User; assert(provider instanceof OAuthProvider, AuthErrorCode.ARGUMENT_ERROR, { - appName: user.auth.name + appName: userInternal.auth.name }); // Allow the resolver to error before persisting the redirect user - const resolver = _withDefaultResolver(user.auth, resolverExtern); + const resolverInternal = _withDefaultResolver(userInternal.auth, resolver); - const eventId = await prepareUserForRedirect(user.auth, user); - return resolver._openRedirect( - user.auth, + const eventId = await prepareUserForRedirect(userInternal); + return resolverInternal._openRedirect( + userInternal.auth, provider, AuthEventType.REAUTH_VIA_REDIRECT, eventId ); } +/** + * Links the {@link OAuthProvider} to the user account using a full-page redirect flow. + * + * @example + * ```javascript + * // Sign in using some other provider. + * const result = await signInWithEmailAndPassword(auth, email, password); + * // Link using a redirect. + * const provider = new FacebookAuthProvider(); + * await linkWithRedirect(result.user, provider); + * // This will trigger a full page redirect away from your app + * + * // After returning from the redirect when your app initializes you can obtain the result + * const result = await getRedirectResult(auth); + * ``` + * + * @param user - The user. + * @param provider - The provider to authenticate. The provider has to be an {@link OAuthProvider}. + * Non-OAuth providers like {@link EmailAuthProvider} will throw an error. + * @param resolver - An instance of {@link @firebase/auth-types#PopupRedirectResolver}, optional + * if already supplied to {@link initializeAuth} or provided by {@link getAuth}. + * + * + * @public + */ export async function linkWithRedirect( - userExtern: externs.User, + user: externs.User, provider: externs.AuthProvider, - resolverExtern?: externs.PopupRedirectResolver + resolver?: externs.PopupRedirectResolver ): Promise { - const user = userExtern as User; + const userInternal = user as User; assert(provider instanceof OAuthProvider, AuthErrorCode.ARGUMENT_ERROR, { - appName: user.auth.name + appName: userInternal.auth.name }); // Allow the resolver to error before persisting the redirect user - const resolver = _withDefaultResolver(user.auth, resolverExtern); + const resolverInternal = _withDefaultResolver(userInternal.auth, resolver); - await _assertLinkedStatus(false, user, provider.providerId); - const eventId = await prepareUserForRedirect(user.auth, user); - return resolver._openRedirect( - user.auth, + await _assertLinkedStatus(false, userInternal, provider.providerId); + const eventId = await prepareUserForRedirect(userInternal); + return resolverInternal._openRedirect( + userInternal.auth, provider, AuthEventType.LINK_VIA_REDIRECT, eventId ); } +/** + * Returns a {@link @firebase/auth-types#UserCredential} from the redirect-based sign-in flow. + * + * @remarks + * If sign-in succeeded, returns the signed in user. If sign-in was unsuccessful, fails with an + * error. If no redirect operation was called, returns a {@link @firebase/auth-types#UserCredential} + * with a null `user`. + * + * @example + * ```javascript + * // Sign in using a redirect. + * const provider = new FacebookAuthProvider(); + * // You can add additional scopes to the provider: + * provider.addScope('user_birthday'); + * // Start a sign in process for an unauthenticated user. + * await signInWithRedirect(auth, provider); + * // This will trigger a full page redirect away from your app + * + * // After returning from the redirect when your app initializes you can obtain the result + * const result = await getRedirectResult(auth); + * if (result) { + * // This is the signed-in user + * const user = result.user; + * // This gives you a Facebook Access Token. + * const credential = provider.credentialFromResult(auth, result); + * const token = credential.accessToken; + * } + * // As this API can be used for sign-in, linking and reauthentication, + * // check the operationType to determine what triggered this redirect + * // operation. + * const operationType = result.operationType; + * ``` + * + * @param auth - The Auth instance. + * @param resolver - An instance of {@link @firebase/auth-types#PopupRedirectResolver}, optional + * if already supplied to {@link initializeAuth} or provided by {@link getAuth}. + * + * @public + */ export async function getRedirectResult( - authExtern: externs.Auth, - resolverExtern?: externs.PopupRedirectResolver + auth: externs.Auth, + resolver?: externs.PopupRedirectResolver ): Promise { - const auth = _castAuth(authExtern); - const resolver = _withDefaultResolver(auth, resolverExtern); - const action = new RedirectAction(auth, resolver); + const authInternal = _castAuth(auth); + const resolverInternal = _withDefaultResolver(authInternal, resolver); + const action = new RedirectAction(authInternal, resolverInternal); const result = await action.execute(); if (result) { delete result.user._redirectEventId; - await auth._persistUserIfCurrent(result.user as User); - await auth._setRedirectUser(null, resolverExtern); + await authInternal._persistUserIfCurrent(result.user as User); + await authInternal._setRedirectUser(null, resolver); } return result; } -async function prepareUserForRedirect(auth: Auth, user: User): Promise { +/** @internal */ +async function prepareUserForRedirect(user: User): Promise { const eventId = _generateEventId(`${user.uid}:::`); user._redirectEventId = eventId; await user.auth._setRedirectUser(user); - await auth._persistUserIfCurrent(user); + await user.auth._persistUserIfCurrent(user); return eventId; } @@ -190,6 +322,7 @@ class RedirectAction extends AbstractPopupRedirectOperation { cleanUp(): void {} } +/** @internal */ export function _clearOutcomes(): void { redirectOutcomeMap.clear(); } diff --git a/packages-exp/auth-types-exp/index.d.ts b/packages-exp/auth-types-exp/index.d.ts index 30bfc64d20a..17c1d322a46 100644 --- a/packages-exp/auth-types-exp/index.d.ts +++ b/packages-exp/auth-types-exp/index.d.ts @@ -25,7 +25,7 @@ import { } from '@firebase/util'; /** - * Supported providers. + * Enumeration of supported providers. * * @public */ @@ -42,7 +42,7 @@ export const enum ProviderId { } /** - * Supported sign-in methods. + * Enumeration of supported sign-in methods. * * @public */ @@ -58,7 +58,7 @@ export const enum SignInMethod { } /** - * Supported operation types. + * Enumeration of supported operation types. * * @public */ @@ -72,7 +72,7 @@ export const enum OperationType { } /** - * Auth config object. + * Interface representing the Auth config. * * @public */ @@ -104,7 +104,7 @@ export interface Config { } /** - * Parsed ID token. + * Interface representing a parsed ID token. * * @privateRemarks TODO(avolkovi): consolidate with parsed_token in implementation. * @@ -138,6 +138,8 @@ export interface ParsedToken { export type NextOrObserver = NextFn | Observer; /** + * Interface for an Auth error. + * * @public */ export interface AuthError extends FirebaseError { @@ -148,7 +150,10 @@ export interface AuthError extends FirebaseError { /** The phone number of the user's account, used for sign-in/linking. */ readonly phoneNumber?: string; /** - * The tenant ID being used for sign-in/linking. If you use `signInWithRedirect` to sign in, + * The tenant ID being used for sign-in/linking. + * + * @remarks + * If you use {@link @firebase/auth#signInWithRedirect} to sign in, * you have to set the tenant ID on {@link Auth} instance again as the tenant ID is not persisted * after redirection. */ @@ -156,8 +161,9 @@ export interface AuthError extends FirebaseError { } /** - * Interface representing an Auth instance's settings, currently used for enabling/disabling app - * verification for phone Auth testing. + * Interface representing an Auth instance's settings. + * + * @remarks Currently used for enabling/disabling app verification for phone Auth testing. * * @public */ @@ -178,8 +184,9 @@ export interface AuthSettings { } /** - * The Firebase Auth service interface. + * Interface representing Firebase Auth service. * + * @remarks * See {@link https://firebase.google.com/docs/auth/ | Firebase Authentication} for a full guide * on how to use the Firebase Auth service. * @@ -191,9 +198,11 @@ export interface Auth { /** The {@link Config} used to initialize this instance. */ readonly config: Config; /** - * Changes the type of persistence on the Auth instance for the currently saved - * Auth session and applies this type of persistence for future sign-in requests, including - * sign-in with redirect requests. + * Changes the type of persistence on the Auth instance. + * + * @remarks + * This will affect the currently saved Auth session and applies this type of persistence for + * future sign-in requests, including sign-in with redirect requests. * * This makes it easy for a user signing in to specify whether their session should be * remembered or not. It also makes it easier to never persist the Auth state for applications @@ -208,19 +217,23 @@ export interface Auth { */ setPersistence(persistence: Persistence): void; /** - * The Auth instance's language code. This is a readable/writable property. When set to - * null, the default Firebase Console language setting is applied. The language code will - * propagate to email action templates (password reset, email verification and email change - * revocation), SMS templates for phone authentication, reCAPTCHA verifier and OAuth - * popup/redirect operations provided the specified providers support localization with the - * language code specified. + * The Auth instance's language code. + * + * @remarks + * This is a readable/writable property. When set to null, the default Firebase Console language + * setting is applied. The language code will propagate to email action templates (password + * reset, email verification and email change revocation), SMS templates for phone authentication, + * reCAPTCHA verifier and OAuth popup/redirect operations provided the specified providers support + * localization with the language code specified. */ languageCode: string | null; /** - * The Auth instance's tenant ID. This is a readable/writable property. When you set - * the tenant ID of an Auth instance, all future sign-in/sign-up operations will pass this - * tenant ID and sign in or sign up users to the specified tenant project. When set to null, - * users are signed in to the parent project. By default, this is set to null. + * The Auth instance's tenant ID. + * + * @remarks + * This is a readable/writable property. When you set the tenant ID of an Auth instance, all + * future sign-in/sign-up operations will pass this tenant ID and sign in or sign up users to + * the specified tenant project. When set to null, users are signed in to the parent project. * * @example * ```javascript @@ -231,16 +244,22 @@ export interface Auth { * const result = await signInWithEmailAndPassword(auth, email, password); * // result.user.tenantId should be 'TENANT_PROJECT_ID'. * ``` + * + * @defaultValue null */ tenantId: string | null; /** - * The Auth instance's settings. This is used to edit/read configuration related options - * like app verification mode for phone authentication. + * The Auth instance's settings. + * + * @remarks + * This is used to edit/read configuration related options such as app verification mode for + * phone authentication. */ readonly settings: AuthSettings; /** * Adds an observer for changes to the user's sign-in state. * + * @remarks * To keep the old behavior, see {@link Auth.onIdTokenChanged}. * * @param nextOrObserver - callback triggered on change. @@ -253,8 +272,10 @@ export interface Auth { completed?: CompleteFn ): Unsubscribe; /** - * Adds an observer for changes to the signed-in user's ID token, which includes sign-in, - * sign-out, and token refresh events. + * Adds an observer for changes to the signed-in user's ID token. + * + * @remarks + * This includes sign-in, sign-out, and token refresh events. * * @param nextOrObserver - callback triggered on change. * @param error - callback triggered on error. @@ -268,8 +289,10 @@ export interface Auth { /** The currently signed-in user (or null). */ readonly currentUser: User | null; /** - * Asynchronously sets the provided user as `currentUser` on the Auth instance. A new - * instance copy of the user provided will be made and set as currentUser. + * Asynchronously sets the provided user as {@link Auth.currentUser} on the {@link Auth} instance. + * + * @remarks + * A new instance copy of the user provided will be made and set as currentUser. * * This will trigger {@link Auth.onAuthStateChanged} and {@link Auth.onIdTokenChanged} listeners * like other sign in methods. @@ -285,9 +308,12 @@ export interface Auth { */ useDeviceLanguage(): void; /** - * Modify this Auth instance to communicate with the Firebase Auth emulator. This must be - * called synchronously immediately following the first call to `initializeAuth()`. Do not use - * with production credentials as emulator traffic is not encrypted. + * Modify this Auth instance to communicate with the Firebase Auth emulator. + * + * @remarks + * This must be called synchronously immediately following the first call to + * {@link @firebase/auth#initializeAuth}. Do not use with production credentials as emulator + * traffic is not encrypted. * * @param url - The URL at which the emulator is running (eg, 'http://localhost:9099'). */ @@ -299,7 +325,7 @@ export interface Auth { } /** - * An enumeration of the possible persistence mechanism types. + * An interface covering the possible persistence mechanism types. * * @public */ @@ -307,16 +333,18 @@ export interface Persistence { /** * Type of Persistence. * - 'SESSION' is used for temporary persistence such as `sessionStorage`. - * - 'LOCAL' is used for long term persistence such as `localStorage` or 'IndexedDB`. + * - 'LOCAL' is used for long term persistence such as `localStorage` or `IndexedDB`. * - 'NONE' is used for in-memory, or no persistence. */ readonly type: 'SESSION' | 'LOCAL' | 'NONE'; } /** - * Interface representing ID token result obtained from `getIdTokenResult`. It contains the ID - * token JWT string and other helper properties for getting different data associated with the - * token as well as all the decoded payload claims. + * Interface representing ID token result obtained from {@link User.getIdTokenResult}. + * + * @remarks + * It contains the ID token JWT string and other helper properties for getting different data + * associated with the token as well as all the decoded payload claims. * * Note that these claims are not to be trusted as they are parsed client side. Only server side * verification can guarantee the integrity of the token claims. @@ -325,8 +353,10 @@ export interface Persistence { */ export interface IdTokenResult { /** - * The authentication time formatted as a UTC string. This is the time the user authenticated - * (signed in) and not the time the token was refreshed. + * The authentication time formatted as a UTC string. + * + * @remarks + * This is the time the user authenticated (signed in) and not the time the token was refreshed. */ authTime: string; /** The ID token expiration time formatted as a UTC string. */ @@ -335,7 +365,10 @@ export interface IdTokenResult { issuedAtTime: string; /** * The sign-in provider through which the ID token was obtained (anonymous, custom, phone, - * password, etc). Note, this does not map to provider IDs. + * password, etc). + * + * @remarks + * Note, this does not map to provider IDs. */ signInProvider: string | null; /** @@ -353,13 +386,15 @@ export interface IdTokenResult { } /** - * A response from `checkActionCode`. + * A response from {@link @firebase/auth#checkActionCode}. * * @public */ export interface ActionCodeInfo { /** * The data associated with the action code. + * + * @remarks * For the {@link Operation.PASSWORD_RESET}, {@link Operation.VERIFY_EMAIL}, and * {@link Operation.RECOVER_EMAIL} actions, this object contains an email field with the address * the email was sent to. @@ -411,14 +446,17 @@ export const enum Operation { } /** - * This is the interface that defines the required continue/state URL with optional Android and iOS + * An interface that defines the required continue/state URL with optional Android and iOS * bundle identifiers. * * @public */ export interface ActionCodeSettings { /** - * Sets the Android package name. This will try to open the link in an android app if it is + * Sets the Android package name. + * + * @remarks + * This will try to open the link in an android app if it is * installed. If `installApp` is passed, it specifies whether to install the Android app if the * device supports it and the app is not already installed. If this field is provided without * a `packageName`, an error is thrown explaining that the `packageName` must be provided in @@ -431,14 +469,21 @@ export interface ActionCodeSettings { packageName: string; }; /** - * The default is false. When set to true, the action code link will be be sent as a Universal - * Link or Android App Link and will be opened by the app if installed. In the false case, - * the code will be sent to the web widget first and then on continue will redirect to the app - * if installed. + * When set to true, the action code link will be be sent as a Universal Link or Android App + * Link and will be opened by the app if installed. + * + * @remarks + * In the false case, the code will be sent to the web widget first and then on continue will + * redirect to the app if installed. + * + * @defaultValue false */ handleCodeInApp?: boolean; /** - * Sets the iOS bundle ID. This will try to open the link in an iOS app if it is installed. + * Sets the iOS bundle ID. + * + * @remarks + * This will try to open the link in an iOS app if it is installed. * * App installation is not supported for iOS. */ @@ -446,7 +491,10 @@ export interface ActionCodeSettings { bundleId: string; }; /** - * Sets the link continue/state URL, which has different meanings in different contexts: + * Sets the link continue/state URL. + * + * @remarks + * This has different meanings in different contexts: * - When the link is handled in the web action widgets, this is the deep link in the * `continueUrl` query parameter. * - When the link is handled in the app directly, this is the `continueUrl` query parameter in @@ -456,7 +504,9 @@ export interface ActionCodeSettings { /** * When multiple custom dynamic link domains are defined for a project, specify which one to use * when the link is to be opened via a specified mobile app (for example, `example.page.link`). - * Otherwise the first domain is automatically selected. + * + * + * @defaultValue The first domain is automatically selected. */ dynamicLinkDomain?: string; } @@ -486,7 +536,7 @@ export abstract class ActionCodeURL { readonly languageCode: string | null; /** * The action performed by the email action link. It returns from one of the types from - * {@link ActionCodeInfo} + * {@link @firebase/auth-types#ActionCodeInfo} */ readonly operation: Operation; /** @@ -495,7 +545,7 @@ export abstract class ActionCodeURL { readonly tenantId: string | null; /** - * Parses the email action link string and returns an ActionCodeURL object if the link is valid, + * Parses the email action link string and returns an {@link ActionCodeURL} if the link is valid, * otherwise returns null. * * @param link - The email action link string. @@ -507,8 +557,10 @@ export abstract class ActionCodeURL { } /** - * A verifier for domain verification and abuse prevention. Currently, the only implementation is - * {@link RecaptchaVerifier}. + * A verifier for domain verification and abuse prevention. + * + * @remarks + * Currently, the only implementation is {@link @firebase/auth#RecaptchaVerifier}. * * @public */ @@ -533,23 +585,31 @@ export interface ApplicationVerifier { export abstract class RecaptchaVerifier implements ApplicationVerifier { constructor( /** - * The reCAPTCHA container parameter. This has different meaning depending on whether the - * reCAPTCHA is hidden or visible. For a visible reCAPTCHA the container must be empty. If a - * string is used, it has to correspond to an element ID. The corresponding element must also - * must be in the DOM at the time of initialization. + * The reCAPTCHA container parameter. + * + * @remarks + * This has different meaning depending on whether the reCAPTCHA is hidden or visible. For a + * visible reCAPTCHA the container must be empty. If a string is used, it has to correspond to + * an element ID. The corresponding element must also must be in the DOM at the time of + * initialization. */ container: any | string, /** - * The optional reCAPTCHA parameters. Check the reCAPTCHA docs for a comprehensive list. - * All parameters are accepted except for the sitekey. Firebase Auth backend provisions a - * reCAPTCHA for each project and will configure this upon rendering. For an invisible - * reCAPTCHA, a size key must have the value 'invisible'. + * The optional reCAPTCHA parameters. + * + * @remarks + * Check the reCAPTCHA docs for a comprehensive list. All parameters are accepted except for + * the sitekey. Firebase Auth backend provisions a reCAPTCHA for each project and will + * configure this upon rendering. For an invisible reCAPTCHA, a size key must have the value + * 'invisible'. */ parameters?: Object | null, /** - * The corresponding Firebase Auth instance. If none is provided, the default Firebase Auth - * instance is used. A Firebase Auth instance must be initialized with an API key, otherwise - * an error will be thrown. + * The corresponding Firebase Auth instance. + * + * @remarks + * If none is provided, the default Firebase Auth instance is used. A Firebase Auth instance + * must be initialized with an API key, otherwise an error will be thrown. */ auth?: Auth | null ); @@ -564,7 +624,10 @@ export abstract class RecaptchaVerifier implements ApplicationVerifier { */ render(): Promise; /** - * The application verifier type. For a reCAPTCHA verifier, this is 'recaptcha'. + * The application verifier type. + * + * @remarks + * For a reCAPTCHA verifier, this is 'recaptcha'. */ readonly type: string; /** @@ -576,31 +639,38 @@ export abstract class RecaptchaVerifier implements ApplicationVerifier { } /** - * Interface that represents the credentials returned by an auth provider. Implementations specify - * the details about each auth provider's credential requirements. + * Interface that represents the credentials returned by an {@link @firebase/auth-types#AuthProvider}. + * + * @remarks + * Implementations specify the details about each auth provider's credential requirements. * * @public */ export abstract class AuthCredential { /** - * Static method to deserialize a JSON representation of an object into an {@link AuthCredential}. + * Static method to deserialize a JSON representation of an object into an {@link @firebase/auth-types#AuthCredential}. * * @param json - Either `object` or the stringified representation of the object. When string is * provided, `JSON.parse` would be called first. * - * @returns If the JSON input does not represent an {@link AuthCredential}, null is returned. + * @returns If the JSON input does not represent an {@link @firebase/auth-types#AuthCredential}, null is returned. */ static fromJSON(json: object | string): AuthCredential | null; /** - * The authentication provider ID for the credential. For example, 'facebook.com', or - * 'google.com'. + * The authentication provider ID for the credential. + * + * @remarks + * For example, 'facebook.com', or 'google.com'. */ readonly providerId: string; /** - * The authentication sign in method for the credential. For example, - * {@link SignInMethod.EMAIL_PASSWORD}, or {@link SignInMethod.EMAIL_LINK}. This corresponds to - * the sign-in method identifier as returned in `fetchSignInMethodsForEmail`. + * The authentication sign in method for the credential. + * + * @remarks + * For example, {@link @firebase/auth-types#SignInMethod.EMAIL_PASSWORD}, or + * {@link @firebase/auth-types#SignInMethod.EMAIL_LINK}. This corresponds to the sign-in method + * identifier as returned in {@link @firebase/auth#fetchSignInMethodsForEmail}. */ readonly signInMethod: string; /** @@ -612,26 +682,28 @@ export abstract class AuthCredential { } /** - * Interface that represents the OAuth credentials returned by an OAuth provider. Implementations - * specify the details about each auth provider's credential requirements. + * Interface that represents the OAuth credentials returned by an {@link @firebase/auth#OAuthProvider}. + * + * @remarks + * Implementations specify the details about each auth provider's credential requirements. * * @public */ export abstract class OAuthCredential extends AuthCredential { /** * Static method to deserialize a JSON representation of an object into an - * {@link AuthCredential}. + * {@link @firebase/auth-types#AuthCredential}. * * @param json - Input can be either Object or the stringified representation of the object. * When string is provided, JSON.parse would be called first. * - * @returns If the JSON input does not represent an {@link AuthCredential}, null is returned. + * @returns If the JSON input does not represent an {@link @firebase/auth-types#AuthCredential}, null is returned. */ static fromJSON(json: object | string): OAuthCredential | null; /** - * The OAuth access token associated with the credential if it belongs to an OAuth provider, - * such as `facebook.com`, `twitter.com`, etc. + * The OAuth access token associated with the credential if it belongs to an + * {@link @firebase/auth#OAuthProvider}, such as `facebook.com`, `twitter.com`, etc. */ readonly accessToken?: string; /** @@ -647,17 +719,20 @@ export abstract class OAuthCredential extends AuthCredential { } /** - * Class that represents the Phone Auth credentials returned by a {@link PhoneAuthProvider}. + * Interface that represents the credentials returned by a + * {@link @firebase/auth#PhoneAuthProvider}. * * @public */ export abstract class PhoneAuthCredential extends AuthCredential { - /** {@inheritdoc AuthCredential} */ + /** {@inheritdoc @firebase/auth-types#AuthCredential.fromJSON} */ static fromJSON(json: object | string): PhoneAuthCredential | null; + /** {@inheritdoc @firebase/auth-types#AuthCredential.toJSON} */ + toJSON(): object; } /** - * Interface that represents an auth provider, used to facilitate creating {@link AuthCredential}. + * Interface that represents an auth provider, used to facilitate creating {@link @firebase/auth-types#AuthCredential}. * * @public */ @@ -669,26 +744,26 @@ export interface AuthProvider { } /** - * Email and password auth provider implementation. + * Provider for generating {@link @firebase/auth#EmailAuthCredential}. * * @public */ export abstract class EmailAuthProvider implements AuthProvider { private constructor(); /** - * Always set to {@link ProviderId.PASSWORD}, even for email link. + * Always set to {@link @firebase/auth-types#ProviderId.PASSWORD}, even for email link. */ static readonly PROVIDER_ID: ProviderId; /** - * Always set to {@link SignInMethod.EMAIL_PASSWORD}. + * Always set to {@link @firebase/auth-types#SignInMethod.EMAIL_PASSWORD}. */ static readonly EMAIL_PASSWORD_SIGN_IN_METHOD: SignInMethod; /** - * Always set to {@link SignInMethod.EMAIL_LINK}. + * Always set to {@link @firebase/auth-types#SignInMethod.EMAIL_LINK}. */ static readonly EMAIL_LINK_SIGN_IN_METHOD: SignInMethod; /** - * Initialize an {@link AuthCredential} using an email and password. + * Initialize an {@link @firebase/auth-types#AuthCredential} using an email and password. * * @example * ```javascript @@ -707,7 +782,7 @@ export abstract class EmailAuthProvider implements AuthProvider { */ static credential(email: string, password: string): AuthCredential; /** - * Initialize an {@link AuthCredential} using an email and an email link after a sign in with + * Initialize an {@link @firebase/auth-types#AuthCredential} using an email and an email link after a sign in with * email link operation. * * @example @@ -734,13 +809,13 @@ export abstract class EmailAuthProvider implements AuthProvider { emailLink: string ): AuthCredential; /** - * Always set to {@link ProviderId.PASSWORD}, even for email link. + * Always set to {@link @firebase/auth-types#ProviderId.PASSWORD}, even for email link. */ readonly providerId: ProviderId; } /** - * A provider for generating phone credentials. + * Provider for generating an {@link @firebase/auth#PhoneAuthCredential}. * * @example * ```javascript @@ -748,21 +823,21 @@ export abstract class EmailAuthProvider implements AuthProvider { * const applicationVerifier = new RecaptchaVerifier('recaptcha-container'); * const provider = new PhoneAuthProvider(auth); * const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier); - * const verificationCode = window.prompt('Please enter the verification code that was sent to your mobile device.'); - * const phoneCredential = await PhoneAuthProvider.credential(verificationId, verificationCode); + * // Obtain the verificationCode from the user. + * const phoneCredential = PhoneAuthProvider.credential(verificationId, verificationCode); * const userCredential = await signInWithCredential(auth, phoneCredential); * ``` * * @public */ export class PhoneAuthProvider implements AuthProvider { - /** Always set to {@link ProviderId.PHONE}. */ + /** Always set to {@link @firebase/auth-types#ProviderId.PHONE}. */ static readonly PROVIDER_ID: ProviderId; - /** Always set to {@link SignInMethod.PHONE}. */ + /** Always set to {@link @firebase/auth-types#SignInMethod.PHONE}. */ static readonly PHONE_SIGN_IN_METHOD: SignInMethod; /** * Creates a phone auth credential, given the verification ID from - * {@link PhoneAuthProvider.verifyPhoneNumber} and the code that was sent to the user's + * {@link @firebase/auth#PhoneAuthProvider.verifyPhoneNumber} and the code that was sent to the user's * mobile device. * * @example @@ -782,8 +857,7 @@ export class PhoneAuthProvider implements AuthProvider { * const userCredential = await confirmationResult.confirm(verificationCode); * ``` * - * @param verificationId - The verification ID returned from - * {@link PhoneAuthProvider.verifyPhoneNumber}. + * @param verificationId - The verification ID returned from {@link @firebase/auth#PhoneAuthProvider.verifyPhoneNumber}. * @param verificationCode - The verification code sent to the user's mobile device. * * @returns The auth provider credential. @@ -793,18 +867,19 @@ export class PhoneAuthProvider implements AuthProvider { verificationCode: string ): AuthCredential; /** - * @param auth - The Firebase Auth instance in which sign-ins should occur. Uses the default Auth - * instance if unspecified. + * @param auth - The Firebase Auth instance in which sign-ins should occur. + * + * @remarks + * Uses the default Auth instance if unspecified. */ constructor(auth?: Auth | null); - /** Always set to {@link ProviderId.PHONE}. */ + /** Always set to {@link @firebase/auth-types#ProviderId.PHONE}. */ readonly providerId: ProviderId; /** * * Starts a phone number authentication flow by sending a verification code to the given phone - * number. Returns an ID that can be passed to {@link PhoneAuthProvider.credential} to identify - * this flow. + * number. * * @example * ```javascript @@ -823,13 +898,14 @@ export class PhoneAuthProvider implements AuthProvider { * const userCredential = confirmationResult.confirm(verificationCode); * ``` * - * @param phoneInfoOptions - The user's {@link PhoneInfoOptions}. The phone number should be in + * @param phoneInfoOptions - The user's {@link @firebase/auth-types#PhoneInfoOptions}. The phone number should be in * E.164 format (e.g. +16505550101). * @param applicationVerifier - For abuse prevention, this method also requires a - * {@link ApplicationVerifier}. This SDK includes a reCAPTCHA-based implementation, + * {@link @firebase/auth-types#ApplicationVerifier}. This SDK includes a reCAPTCHA-based implementation, * {@link RecaptchaVerifier}. * - * @returns A Promise for the verification ID. + * @returns A Promise for a verification ID that can be passed to + * {@link @firebase/auth#PhoneAuthProvider.credential} to identify this flow.. */ verifyPhoneNumber( phoneInfoOptions: PhoneInfoOptions | string, @@ -844,8 +920,11 @@ export class PhoneAuthProvider implements AuthProvider { */ export interface ConfirmationResult { /** - * The phone number authentication operation's verification ID. This can be used along with the - * verification code to initialize a phone auth credential. + * The phone number authentication operation's verification ID. + * + * @remarks + * This can be used along with the verification code to initialize a + * {@link @firebase/auth-types#PhoneAuthCredential}. */ readonly verificationId: string; /** @@ -864,9 +943,11 @@ export interface ConfirmationResult { } /** - * The base class for asserting ownership of a second factor. This is used to facilitate enrollment - * of a second factor on an existing user or sign-in of a user who already verified the first - * factor. + * The base class for asserting ownership of a second factor. + * + * @remarks + * This is used to facilitate enrollment of a second factor on an existing user or sign-in of a + * user who already verified the first factor. * * @public */ @@ -876,8 +957,10 @@ export interface MultiFactorAssertion { } /** - * The error thrown when the user needs to provide a second factor to sign in successfully. The - * error code for this error is `auth/multi-factor-auth-required`. + * The error thrown when the user needs to provide a second factor to sign in successfully. + * + * @remarks + * The error code for this error is `auth/multi-factor-auth-required`. * * @example * ```javascript @@ -932,7 +1015,7 @@ export interface MultiFactorInfo { } /** - * The class used to facilitate recovery from {@link MultiFactorError} when a user needs to + * The class used to facilitate recovery from {@link @firebase/auth-types#MultiFactorError} when a user needs to * provide a second factor to sign in. * * @example @@ -990,7 +1073,7 @@ export abstract class MultiFactorResolver { session: MultiFactorSession; /** * A helper function to help users complete sign in with a second factor using an - * {@link MultiFactorAssertion} confirming the user successfully completed the second factor + * {@link @firebase/auth-types#MultiFactorAssertion} confirming the user successfully completed the second factor * challenge. * * @example @@ -1007,15 +1090,15 @@ export abstract class MultiFactorResolver { } /** - * The multi-factor session object used for enrolling a second factor on a user or helping sign in - * an enrolled user with a second factor. + * An interface defining the multi-factor session object used for enrolling a second factor on a + * user or helping sign in an enrolled user with a second factor. * * @public */ export interface MultiFactorSession {} /** - * This is the interface that defines the multi-factor related properties and operations pertaining + * An interface that defines the multi-factor related properties and operations pertaining * to a {@link User}. * * @public @@ -1046,13 +1129,16 @@ export interface MultiFactorUser { * await multiFactorUser.enroll(multiFactorAssertion); * ``` * - * @returns The promise that resolves with the {@link MultiFactorSession}. + * @returns The promise that resolves with the {@link @firebase/auth-types#MultiFactorSession}. */ getSession(): Promise; /** * - * Enrolls a second factor as identified by the {@link MultiFactorAssertion} for the - * user. On resolution, the user tokens are updated to reflect the change in the JWT payload. + * Enrolls a second factor as identified by the {@link @firebase/auth-types#MultiFactorAssertion} for the + * user. + * + * @remarks + * On resolution, the user tokens are updated to reflect the change in the JWT payload. * Accepts an additional display name parameter used to identify the second factor to the end * user. Recent re-authentication is required for this operation to succeed. On successful * enrollment, existing Firebase sessions (refresh tokens) are revoked. When a new factor is @@ -1086,8 +1172,11 @@ export interface MultiFactorUser { displayName?: string | null ): Promise; /** - * Unenrolls the specified second factor. To specify the factor to remove, pass a - * {@link MultiFactorInfo} object (retrieved from {@link MultiFactorUser.enrolledFactors}) or the + * Unenrolls the specified second factor. + * + * @remarks + * To specify the factor to remove, pass a {@link MultiFactorInfo} object (retrieved from + * {@link MultiFactorUser.enrolledFactors}) or the * factor's UID string. Sessions are not revoked when the account is unenrolled. An email * notification is likely to be sent to the user notifying them of the change. Recent * re-authentication is required for this operation to succeed. When an existing factor is @@ -1108,27 +1197,28 @@ export interface MultiFactorUser { /** * The class for asserting ownership of a phone second factor. Provided by - * {@link PhoneMultiFactorGenerator.assertion}. + * {@link @firebase/auth-types#PhoneMultiFactorGenerator.assertion}. * * @public */ export interface PhoneMultiFactorAssertion extends MultiFactorAssertion {} /** - * The class used to initialize a {@link PhoneMultiFactorAssertion}. + * Provider for generating a {@link @firebase/auth-types#PhoneMultiFactorAssertion}. * * @public */ export abstract class PhoneMultiFactorGenerator { /** - * The identifier of the phone second factor: {@link ProviderId.PHONE}. + * The identifier of the phone second factor: {@link @firebase/auth-types#ProviderId.PHONE}. */ static FACTOR_ID: ProviderId; /** - * Provides a {@link PhoneMultiFactorAssertion} to confirm ownership of the phone second factor. + * Provides a {@link @firebase/auth-types#PhoneMultiFactorAssertion} to confirm ownership of the phone second factor. * - * @param phoneAuthCredential - A credential provided by {@link PhoneAuthProvider.credential}. - * @returns A {@link PhoneMultiFactorAssertion} which can be used with {@link MultiFactorResolver.resolveSignIn} + * @param phoneAuthCredential - A credential provided by {@link @firebase/auth#PhoneAuthProvider.credential}. + * @returns A {@link @firebase/auth-types#PhoneMultiFactorAssertion} which can be used with + * {@link @firebase/auth-types#MultiFactorResolver.resolveSignIn} */ static assertion( phoneAuthCredential: PhoneAuthCredential @@ -1136,9 +1226,11 @@ export abstract class PhoneMultiFactorGenerator { } /** - * The information required to verify the ownership of a phone number. The information that's - * required depends on whether you are doing single-factor sign-in, multi-factor enrollment or - * multi-factor sign-in. + * The information required to verify the ownership of a phone number. + * + * @remarks + * The information that's required depends on whether you are doing single-factor sign-in, + * multi-factor enrollment or multi-factor sign-in. * * @public */ @@ -1224,11 +1316,12 @@ export interface ReactNativeAsyncStorage { */ export interface User extends UserInfo { /** - * Whether the email has been verified with `sendEmailVerification` and `applyActionCode`. + * Whether the email has been verified with {@link @firebase/auth#sendEmailVerification} and + * {@link @firebase/auth#applyActionCode}. */ readonly emailVerified: boolean; /** - * Whether the user is authenticated using the {@link ProviderId.ANONYMOUS} provider. + * Whether the user is authenticated using the {@link @firebase/auth-types@ProviderId.ANONYMOUS} provider. */ readonly isAnonymous: boolean; /** @@ -1241,11 +1334,14 @@ export interface User extends UserInfo { readonly providerData: UserInfo[]; /** * Refresh token used to reauthenticate the user. Avoid using this directly and prefer - * {@link User.getIdToken()} to refresh the ID token instead. + * {@link User.getIdToken} to refresh the ID token instead. */ readonly refreshToken: string; /** - * The user's tenant ID. This is a read-only property, which indicates the tenant ID + * The user's tenant ID. + * + * @remarks + * This is a read-only property, which indicates the tenant ID * used to sign in the user. This is null if the user is signed in from the parent * project. * @@ -1263,14 +1359,16 @@ export interface User extends UserInfo { /** * Deletes and signs out the user. * + * @remarks * Important: this is a security-sensitive operation that requires the user to have recently * signed in. If this requirement isn't met, ask the user to authenticate again and then call - * one of the reauthentication methods like `reauthenticateWithCredential`. + * one of the reauthentication methods like {@link @firebase/auth#reauthenticateWithCredential}. */ delete(): Promise; /** * Returns a JSON Web Token (JWT) used to identify the user to a Firebase service. * + * @remarks * Returns the current token if it has not expired or if it will not expire in the next five * minutes. Otherwise, this will refresh the token and return a new one. * @@ -1280,6 +1378,7 @@ export interface User extends UserInfo { /** * Returns a deserialized JSON Web Token (JWT) used to identitfy the user to a Firebase service. * + * @remarks * Returns the current token if it has not expired or if it will not expire in the next five * minutes. Otherwise, this will refresh the token and return a new one. * @@ -1300,9 +1399,12 @@ export interface User extends UserInfo { /** * A structure containing a {@link User}, an {@link AuthCredential}, the {@link OperationType}, - * and any additional user information that was returned from the identity provider. `operationType` - * could be {@link OperationType.SIGN_IN} for a sign-in operation, {@link OperationType.LINK} for a - * linking operation and {@link OperationType.REAUTHENTICATE} for a reauthentication operation. + * and any additional user information that was returned from the identity provider. + * + * @remarks + * `operationType` could be {@link OperationType.SIGN_IN} for a sign-in operation, + * {@link OperationType.LINK} for a linking operation and {@link OperationType.REAUTHENTICATE} for + * a reauthentication operation. * * @public */ @@ -1337,7 +1439,10 @@ export interface UserInfo { readonly email: string | null; /** * The phone number normalized based on the E.164 standard (e.g. +16505550101) for the - * user. This is null if the user has no phone credential linked to the account. + * user. + * + * @remarks + * This is null if the user has no phone credential linked to the account. */ readonly phoneNumber: string | null; /** @@ -1398,8 +1503,8 @@ export interface AdditionalUserInfo { export type UserProfile = Record; /** - * A resolver used for handling DOM specific operations like `signInWithPopup()` or - * `signInWithRedirect()`. + * A resolver used for handling DOM specific operations like {@link @firebase/auth#signInWithPopup} + * or {@link @firebase/auth#signInWithRedirect}. * * @public */ From 8e9604f7192d95401e325022bb5d620f263f4d9f Mon Sep 17 00:00:00 2001 From: Feiyang Date: Tue, 27 Oct 2020 14:14:46 -0700 Subject: [PATCH 039/624] Make AuthInternal implement the interface (#4000) --- common/api-review/functions-exp.api.md | 2 +- packages-exp/auth-exp/src/core/auth/firebase_internal.ts | 9 ++------- packages-exp/auth-exp/src/core/auth/register.ts | 2 +- 3 files changed, 4 insertions(+), 9 deletions(-) diff --git a/common/api-review/functions-exp.api.md b/common/api-review/functions-exp.api.md index 947534f6548..4f719b67983 100644 --- a/common/api-review/functions-exp.api.md +++ b/common/api-review/functions-exp.api.md @@ -16,7 +16,7 @@ export function getFunctions(app: FirebaseApp, regionOrCustomDomain?: string): F export function httpsCallable(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable; // @public -export function useFunctionsEmulator(functionsInstance: Functions, origin: string): void; +export function useFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void; // (No @packageDocumentation comment for this package) diff --git a/packages-exp/auth-exp/src/core/auth/firebase_internal.ts b/packages-exp/auth-exp/src/core/auth/firebase_internal.ts index 63088abf376..ee1e2473536 100644 --- a/packages-exp/auth-exp/src/core/auth/firebase_internal.ts +++ b/packages-exp/auth-exp/src/core/auth/firebase_internal.ts @@ -16,21 +16,16 @@ */ import { Unsubscribe } from '@firebase/util'; +import { FirebaseAuthInternal } from '@firebase/auth-interop-types'; import { Auth } from '../../model/auth'; import { User } from '../../model/user'; -declare module '@firebase/component' { - interface NameServiceMapping { - 'auth-internal-exp': AuthInternal; - } -} - interface TokenListener { (tok: string | null): unknown; } -export class AuthInternal { +export class AuthInternal implements FirebaseAuthInternal { private readonly internalListeners: Map< TokenListener, Unsubscribe diff --git a/packages-exp/auth-exp/src/core/auth/register.ts b/packages-exp/auth-exp/src/core/auth/register.ts index bfc97674c82..684599a7f15 100644 --- a/packages-exp/auth-exp/src/core/auth/register.ts +++ b/packages-exp/auth-exp/src/core/auth/register.ts @@ -33,7 +33,7 @@ import { import { AuthInternal } from './firebase_internal'; export const _AUTH_COMPONENT_NAME = 'auth-exp'; -export const _AUTH_INTERNAL_COMPONENT_NAME = 'auth-internal-exp'; +export const _AUTH_INTERNAL_COMPONENT_NAME = 'auth-internal'; function getVersionForPlatform( clientPlatform: ClientPlatform From ab0f643571cef59a8f916be0cade1f312fd83bee Mon Sep 17 00:00:00 2001 From: Sebastian Schmidt Date: Tue, 27 Oct 2020 14:20:04 -0700 Subject: [PATCH 040/624] Make FirestoreClient tree-shakeable (#3983) --- packages/firestore/src/api/database.ts | 100 +++-- .../firestore/src/core/firestore_client.ts | 366 +++++++++--------- 2 files changed, 260 insertions(+), 206 deletions(-) diff --git a/packages/firestore/src/api/database.ts b/packages/firestore/src/api/database.ts index 5d682599ef4..0f3a94a4be8 100644 --- a/packages/firestore/src/api/database.ts +++ b/packages/firestore/src/api/database.ts @@ -55,7 +55,20 @@ import { OfflineComponentProvider, OnlineComponentProvider } from '../core/component_provider'; -import { FirestoreClient } from '../core/firestore_client'; +import { + FirestoreClient, + firestoreClientAddSnapshotsInSyncListener, + firestoreClientDisableNetwork, + firestoreClientEnableNetwork, + firestoreClientGetDocumentFromLocalCache, + firestoreClientGetDocumentsFromLocalCache, + firestoreClientGetDocumentsViaSnapshotListener, + firestoreClientGetDocumentViaSnapshotListener, + firestoreClientListen, + firestoreClientTransaction, + firestoreClientWaitForPendingWrites, + firestoreClientWrite +} from '../core/firestore_client'; import { Bound, Direction, @@ -101,7 +114,7 @@ import { validateSetOptions, valueDescription } from '../util/input_validation'; -import { setLogLevel as setClientLogLevel, logWarn } from '../util/log'; +import { logWarn, setLogLevel as setClientLogLevel } from '../util/log'; import { AutoId } from '../util/misc'; import { Deferred } from '../util/promise'; import { FieldPath as ExternalFieldPath } from './field_path'; @@ -461,12 +474,12 @@ export class Firestore implements PublicFirestore, FirebaseService { enableNetwork(): Promise { this.ensureClientConfigured(); - return this._firestoreClient!.enableNetwork(); + return firestoreClientEnableNetwork(this._firestoreClient!); } disableNetwork(): Promise { this.ensureClientConfigured(); - return this._firestoreClient!.disableNetwork(); + return firestoreClientDisableNetwork(this._firestoreClient!); } enablePersistence(settings?: PublicPersistenceSettings): Promise { @@ -528,7 +541,7 @@ export class Firestore implements PublicFirestore, FirebaseService { waitForPendingWrites(): Promise { this.ensureClientConfigured(); - return this._firestoreClient!.waitForPendingWrites(); + return firestoreClientWaitForPendingWrites(this._firestoreClient!); } onSnapshotsInSync(observer: PartialObserver): Unsubscribe; @@ -537,14 +550,18 @@ export class Firestore implements PublicFirestore, FirebaseService { this.ensureClientConfigured(); if (isPartialObserver(arg)) { - return this._firestoreClient!.addSnapshotsInSyncListener( + return firestoreClientAddSnapshotsInSyncListener( + this._firestoreClient!, arg as PartialObserver ); } else { const observer: PartialObserver = { next: arg as () => void }; - return this._firestoreClient!.addSnapshotsInSyncListener(observer); + return firestoreClientAddSnapshotsInSyncListener( + this._firestoreClient!, + observer + ); } } @@ -676,7 +693,9 @@ export class Firestore implements PublicFirestore, FirebaseService { runTransaction( updateFunction: (transaction: PublicTransaction) => Promise ): Promise { - return this.ensureClientConfigured().transaction( + const firestoreClient = this.ensureClientConfigured(); + return firestoreClientTransaction( + firestoreClient, (transaction: InternalTransaction) => { return updateFunction(new Transaction(this, transaction)); } @@ -685,7 +704,6 @@ export class Firestore implements PublicFirestore, FirebaseService { batch(): PublicWriteBatch { this.ensureClientConfigured(); - return new WriteBatch(this); } @@ -966,7 +984,8 @@ export class WriteBatch implements PublicWriteBatch { this.verifyNotCommitted(); this._committed = true; if (this._mutations.length > 0) { - return this._firestore.ensureClientConfigured().write(this._mutations); + const firestoreClient = this._firestore.ensureClientConfigured(); + return firestoreClientWrite(firestoreClient, this._mutations); } return Promise.resolve(); @@ -1080,7 +1099,8 @@ export class DocumentReference this._converter !== null, options ); - return this._firestoreClient.write( + return firestoreClientWrite( + this._firestoreClient, parsed.toMutations(this._key, Precondition.none()) ); } @@ -1119,13 +1139,14 @@ export class DocumentReference ); } - return this._firestoreClient.write( + return firestoreClientWrite( + this._firestoreClient, parsed.toMutations(this._key, Precondition.exists(true)) ); } delete(): Promise { - return this._firestoreClient.write([ + return firestoreClientWrite(this._firestoreClient, [ new DeleteMutation(this._key, Precondition.none()) ]); } @@ -1185,7 +1206,8 @@ export class DocumentReference complete: args[currArg + 2] as CompleteFn }; - return this._firestoreClient.listen( + return firestoreClientListen( + this._firestoreClient, newQueryForPath(this._key.path), internalOptions, observer @@ -1195,23 +1217,26 @@ export class DocumentReference get(options?: GetOptions): Promise> { const firestoreClient = this.firestore.ensureClientConfigured(); if (options && options.source === 'cache') { - return firestoreClient - .getDocumentFromLocalCache(this._key) - .then( - doc => - new DocumentSnapshot( - this.firestore, - this._key, - doc, - /*fromCache=*/ true, - doc instanceof Document ? doc.hasLocalMutations : false, - this._converter - ) - ); + return firestoreClientGetDocumentFromLocalCache( + firestoreClient, + this._key + ).then( + doc => + new DocumentSnapshot( + this.firestore, + this._key, + doc, + /*fromCache=*/ true, + doc instanceof Document ? doc.hasLocalMutations : false, + this._converter + ) + ); } else { - return firestoreClient - .getDocumentViaSnapshotListener(this._key, options) - .then(snapshot => this._convertToDocSnapshot(snapshot)); + return firestoreClientGetDocumentViaSnapshotListener( + firestoreClient, + this._key, + options + ).then(snapshot => this._convertToDocSnapshot(snapshot)); } } @@ -2036,7 +2061,12 @@ export class Query implements PublicQuery { validateHasExplicitOrderByForLimitToLast(this._query); const firestoreClient = this.firestore.ensureClientConfigured(); - return firestoreClient.listen(this._query, options, observer); + return firestoreClientListen( + firestoreClient, + this._query, + options, + observer + ); } get(options?: GetOptions): Promise> { @@ -2045,8 +2075,12 @@ export class Query implements PublicQuery { const firestoreClient = this.firestore.ensureClientConfigured(); return (options && options.source === 'cache' - ? firestoreClient.getDocumentsFromLocalCache(this._query) - : firestoreClient.getDocumentsViaSnapshotListener(this._query, options) + ? firestoreClientGetDocumentsFromLocalCache(firestoreClient, this._query) + : firestoreClientGetDocumentsViaSnapshotListener( + firestoreClient, + this._query, + options + ) ).then( snap => new QuerySnapshot(this.firestore, this._query, snap, this._converter) diff --git a/packages/firestore/src/core/firestore_client.ts b/packages/firestore/src/core/firestore_client.ts index e8a4ac3467f..869c382f0d1 100644 --- a/packages/firestore/src/core/firestore_client.ts +++ b/packages/firestore/src/core/firestore_client.ts @@ -90,12 +90,12 @@ export class FirestoreClient { // with the types rather than littering the code with '!' or unnecessary // undefined checks. private databaseInfo!: DatabaseInfo; - private eventMgr!: EventManager; - private persistence!: Persistence; - private localStore!: LocalStore; - private datastore!: Datastore; - private remoteStore!: RemoteStore; - private syncEngine!: SyncEngine; + eventMgr!: EventManager; + persistence!: Persistence; + localStore!: LocalStore; + datastore!: Datastore; + remoteStore!: RemoteStore; + syncEngine!: SyncEngine; private gcScheduler!: GarbageCollectionScheduler | null; // PORTING NOTE: SharedClientState is only used for multi-tab web. @@ -110,7 +110,7 @@ export class FirestoreClient { // // If initializationDone resolved then the FirestoreClient is in a usable // state. - private readonly initializationDone = new Deferred(); + readonly initializationDone = new Deferred(); constructor( private credentials: CredentialsProvider, @@ -122,7 +122,7 @@ export class FirestoreClient { * start processing a new operation while the previous one is waiting for * an async I/O to complete). */ - private asyncQueue: AsyncQueue + public asyncQueue: AsyncQueue ) {} /** @@ -209,15 +209,6 @@ export class FirestoreClient { return persistenceResult.promise; } - /** Enables the network connection and requeues all pending operations. */ - enableNetwork(): Promise { - this.verifyNotTerminated(); - return this.asyncQueue.enqueue(() => { - this.persistence.setNetworkEnabled(true); - return remoteStoreEnableNetwork(this.remoteStore); - }); - } - /** * Initializes persistent storage, attempting to use IndexedDB if * usePersistence is true or memory-only if false. @@ -307,7 +298,7 @@ export class FirestoreClient { * Checks that the client has not been terminated. Ensures that other methods on * this class cannot be called after the client is terminated. */ - private verifyNotTerminated(): void { + verifyNotTerminated(): void { if (this.asyncQueue.isShuttingDown) { throw new FirestoreError( Code.FAILED_PRECONDITION, @@ -316,15 +307,6 @@ export class FirestoreClient { } } - /** Disables the network connection. Pending operations will not complete. */ - disableNetwork(): Promise { - this.verifyNotTerminated(); - return this.asyncQueue.enqueue(() => { - this.persistence.setNetworkEnabled(false); - return remoteStoreDisableNetwork(this.remoteStore); - }); - } - terminate(): Promise { this.asyncQueue.enterRestrictedMode(); const deferred = new Deferred(); @@ -355,165 +337,203 @@ export class FirestoreClient { return deferred.promise; } - /** - * Returns a Promise that resolves when all writes that were pending at the time this - * method was called received server acknowledgement. An acknowledgement can be either acceptance - * or rejection. - */ - waitForPendingWrites(): Promise { - this.verifyNotTerminated(); - - const deferred = new Deferred(); - this.asyncQueue.enqueueAndForget(() => - registerPendingWritesCallback(this.syncEngine, deferred) - ); - return deferred.promise; + databaseId(): DatabaseId { + return this.databaseInfo.databaseId; } - listen( - query: Query, - options: ListenOptions, - observer: Partial> - ): () => void { - this.verifyNotTerminated(); - const wrappedObserver = new AsyncObserver(observer); - const listener = new QueryListener(query, wrappedObserver, options); - this.asyncQueue.enqueueAndForget(() => - eventManagerListen(this.eventMgr, listener) - ); - return () => { - wrappedObserver.mute(); - this.asyncQueue.enqueueAndForget(() => - eventManagerUnlisten(this.eventMgr, listener) - ); - }; + get clientTerminated(): boolean { + // Technically, the asyncQueue is still running, but only accepting operations + // related to termination or supposed to be run after termination. It is effectively + // terminated to the eyes of users. + return this.asyncQueue.isShuttingDown; } +} - async getDocumentFromLocalCache( - docKey: DocumentKey - ): Promise { - this.verifyNotTerminated(); - await this.initializationDone.promise; - const deferred = new Deferred(); - this.asyncQueue.enqueueAndForget(() => - readDocumentFromCache(this.localStore, docKey, deferred) - ); - return deferred.promise; - } +/** Enables the network connection and requeues all pending operations. */ +export function firestoreClientEnableNetwork( + firestoreClient: FirestoreClient +): Promise { + firestoreClient.verifyNotTerminated(); + return firestoreClient.asyncQueue.enqueue(() => { + firestoreClient.persistence.setNetworkEnabled(true); + return remoteStoreEnableNetwork(firestoreClient.remoteStore); + }); +} - async getDocumentViaSnapshotListener( - key: DocumentKey, - options: GetOptions = {} - ): Promise { - this.verifyNotTerminated(); - await this.initializationDone.promise; - const deferred = new Deferred(); - this.asyncQueue.enqueueAndForget(() => - readDocumentViaSnapshotListener( - this.eventMgr, - this.asyncQueue, - key, - options, - deferred - ) - ); - return deferred.promise; - } +/** Disables the network connection. Pending operations will not complete. */ +export function firestoreClientDisableNetwork( + firestoreClient: FirestoreClient +): Promise { + firestoreClient.verifyNotTerminated(); + return firestoreClient.asyncQueue.enqueue(() => { + firestoreClient.persistence.setNetworkEnabled(false); + return remoteStoreDisableNetwork(firestoreClient.remoteStore); + }); +} - async getDocumentsFromLocalCache(query: Query): Promise { - this.verifyNotTerminated(); - await this.initializationDone.promise; - const deferred = new Deferred(); - this.asyncQueue.enqueueAndForget(() => - executeQueryFromCache(this.localStore, query, deferred) - ); - return deferred.promise; - } +/** + * Returns a Promise that resolves when all writes that were pending at the time this + * method was called received server acknowledgement. An acknowledgement can be either acceptance + * or rejection. + */ +export function firestoreClientWaitForPendingWrites( + firestoreClient: FirestoreClient +): Promise { + firestoreClient.verifyNotTerminated(); - async getDocumentsViaSnapshotListener( - query: Query, - options: GetOptions = {} - ): Promise { - this.verifyNotTerminated(); - await this.initializationDone.promise; - const deferred = new Deferred(); - this.asyncQueue.enqueueAndForget(() => - executeQueryViaSnapshotListener( - this.eventMgr, - this.asyncQueue, - query, - options, - deferred - ) - ); - return deferred.promise; - } + const deferred = new Deferred(); + firestoreClient.asyncQueue.enqueueAndForget(() => + registerPendingWritesCallback(firestoreClient.syncEngine, deferred) + ); + return deferred.promise; +} - write(mutations: Mutation[]): Promise { - this.verifyNotTerminated(); - const deferred = new Deferred(); - this.asyncQueue.enqueueAndForget(() => - syncEngineWrite(this.syncEngine, mutations, deferred) +export function firestoreClientListen( + firestoreClient: FirestoreClient, + query: Query, + options: ListenOptions, + observer: Partial> +): () => void { + firestoreClient.verifyNotTerminated(); + const wrappedObserver = new AsyncObserver(observer); + const listener = new QueryListener(query, wrappedObserver, options); + firestoreClient.asyncQueue.enqueueAndForget(() => + eventManagerListen(firestoreClient.eventMgr, listener) + ); + return () => { + wrappedObserver.mute(); + firestoreClient.asyncQueue.enqueueAndForget(() => + eventManagerUnlisten(firestoreClient.eventMgr, listener) ); - return deferred.promise; - } + }; +} - databaseId(): DatabaseId { - return this.databaseInfo.databaseId; - } +export async function firestoreClientGetDocumentFromLocalCache( + firestoreClient: FirestoreClient, + docKey: DocumentKey +): Promise { + firestoreClient.verifyNotTerminated(); + await firestoreClient.initializationDone.promise; + const deferred = new Deferred(); + firestoreClient.asyncQueue.enqueueAndForget(() => + readDocumentFromCache(firestoreClient.localStore, docKey, deferred) + ); + return deferred.promise; +} - addSnapshotsInSyncListener(observer: Partial>): () => void { - this.verifyNotTerminated(); - const wrappedObserver = new AsyncObserver(observer); - this.asyncQueue.enqueueAndForget(async () => - addSnapshotsInSyncListener(this.eventMgr, wrappedObserver) - ); - return () => { - wrappedObserver.mute(); - this.asyncQueue.enqueueAndForget(async () => - removeSnapshotsInSyncListener(this.eventMgr, wrappedObserver) - ); - }; - } +export async function firestoreClientGetDocumentViaSnapshotListener( + firestoreClient: FirestoreClient, + key: DocumentKey, + options: GetOptions = {} +): Promise { + firestoreClient.verifyNotTerminated(); + await firestoreClient.initializationDone.promise; + const deferred = new Deferred(); + firestoreClient.asyncQueue.enqueueAndForget(() => + readDocumentViaSnapshotListener( + firestoreClient.eventMgr, + firestoreClient.asyncQueue, + key, + options, + deferred + ) + ); + return deferred.promise; +} - get clientTerminated(): boolean { - // Technically, the asyncQueue is still running, but only accepting operations - // related to termination or supposed to be run after termination. It is effectively - // terminated to the eyes of users. - return this.asyncQueue.isShuttingDown; - } +export async function firestoreClientGetDocumentsFromLocalCache( + firestoreClient: FirestoreClient, + query: Query +): Promise { + firestoreClient.verifyNotTerminated(); + await firestoreClient.initializationDone.promise; + const deferred = new Deferred(); + firestoreClient.asyncQueue.enqueueAndForget(() => + executeQueryFromCache(firestoreClient.localStore, query, deferred) + ); + return deferred.promise; +} - /** - * Takes an updateFunction in which a set of reads and writes can be performed - * atomically. In the updateFunction, the client can read and write values - * using the supplied transaction object. After the updateFunction, all - * changes will be committed. If a retryable error occurs (ex: some other - * client has changed any of the data referenced), then the updateFunction - * will be called again after a backoff. If the updateFunction still fails - * after all retries, then the transaction will be rejected. - * - * The transaction object passed to the updateFunction contains methods for - * accessing documents and collections. Unlike other datastore access, data - * accessed with the transaction will not reflect local changes that have not - * been committed. For this reason, it is required that all reads are - * performed before any writes. Transactions must be performed while online. - */ - transaction( - updateFunction: (transaction: Transaction) => Promise - ): Promise { - this.verifyNotTerminated(); - const deferred = new Deferred(); - this.asyncQueue.enqueueAndForget(() => { - new TransactionRunner( - this.asyncQueue, - this.datastore, - updateFunction, - deferred - ).run(); - return Promise.resolve(); - }); - return deferred.promise; - } +export async function firestoreClientGetDocumentsViaSnapshotListener( + firestoreClient: FirestoreClient, + query: Query, + options: GetOptions = {} +): Promise { + firestoreClient.verifyNotTerminated(); + await firestoreClient.initializationDone.promise; + const deferred = new Deferred(); + firestoreClient.asyncQueue.enqueueAndForget(() => + executeQueryViaSnapshotListener( + firestoreClient.eventMgr, + firestoreClient.asyncQueue, + query, + options, + deferred + ) + ); + return deferred.promise; +} + +export function firestoreClientWrite( + firestoreClient: FirestoreClient, + mutations: Mutation[] +): Promise { + firestoreClient.verifyNotTerminated(); + const deferred = new Deferred(); + firestoreClient.asyncQueue.enqueueAndForget(() => + syncEngineWrite(firestoreClient.syncEngine, mutations, deferred) + ); + return deferred.promise; +} + +export function firestoreClientAddSnapshotsInSyncListener( + firestoreClient: FirestoreClient, + observer: Partial> +): () => void { + firestoreClient.verifyNotTerminated(); + const wrappedObserver = new AsyncObserver(observer); + firestoreClient.asyncQueue.enqueueAndForget(async () => + addSnapshotsInSyncListener(firestoreClient.eventMgr, wrappedObserver) + ); + return () => { + wrappedObserver.mute(); + firestoreClient.asyncQueue.enqueueAndForget(async () => + removeSnapshotsInSyncListener(firestoreClient.eventMgr, wrappedObserver) + ); + }; +} + +/** + * Takes an updateFunction in which a set of reads and writes can be performed + * atomically. In the updateFunction, the client can read and write values + * using the supplied transaction object. After the updateFunction, all + * changes will be committed. If a retryable error occurs (ex: some other + * client has changed any of the data referenced), then the updateFunction + * will be called again after a backoff. If the updateFunction still fails + * after all retries, then the transaction will be rejected. + * + * The transaction object passed to the updateFunction contains methods for + * accessing documents and collections. Unlike other datastore access, data + * accessed with the transaction will not reflect local changes that have not + * been committed. For this reason, it is required that all reads are + * performed before any writes. Transactions must be performed while online. + */ +export function firestoreClientTransaction( + firestoreClient: FirestoreClient, + updateFunction: (transaction: Transaction) => Promise +): Promise { + firestoreClient.verifyNotTerminated(); + const deferred = new Deferred(); + firestoreClient.asyncQueue.enqueueAndForget(() => { + new TransactionRunner( + firestoreClient.asyncQueue, + firestoreClient.datastore, + updateFunction, + deferred + ).run(); + return Promise.resolve(); + }); + return deferred.promise; } export async function readDocumentFromCache( From 9cf727fcc3d049551b16ae0698ac33dc2fe45ada Mon Sep 17 00:00:00 2001 From: Feiyang Date: Tue, 27 Oct 2020 14:28:49 -0700 Subject: [PATCH 041/624] Prevent __proto__ pollution in util.deepExtend (#4001) * do not extend __proto__ * replace asserts with expects * Create fuzzy-impalas-brake.md * address comment --- .changeset/fuzzy-impalas-brake.md | 5 +++ packages/util/src/deepCopy.ts | 15 +++++-- packages/util/test/deepCopy.test.ts | 66 ++++++++++++++++------------- 3 files changed, 53 insertions(+), 33 deletions(-) create mode 100644 .changeset/fuzzy-impalas-brake.md diff --git a/.changeset/fuzzy-impalas-brake.md b/.changeset/fuzzy-impalas-brake.md new file mode 100644 index 00000000000..5f171a2958e --- /dev/null +++ b/.changeset/fuzzy-impalas-brake.md @@ -0,0 +1,5 @@ +--- +"@firebase/util": patch +--- + +Do not merge `__proto__` in `deepExtend` to prevent `__proto__` pollution. diff --git a/packages/util/src/deepCopy.ts b/packages/util/src/deepCopy.ts index 4957139e775..5ef5594daee 100644 --- a/packages/util/src/deepCopy.ts +++ b/packages/util/src/deepCopy.ts @@ -33,6 +33,8 @@ export function deepCopy(value: T): T { * * Note that the target can be a function, in which case the properties in * the source Object are copied onto it as static properties of the Function. + * + * Note: we don't merge __proto__ to prevent prototype pollution */ export function deepExtend(target: unknown, source: unknown): unknown { if (!(source instanceof Object)) { @@ -62,14 +64,19 @@ export function deepExtend(target: unknown, source: unknown): unknown { } for (const prop in source) { - if (!source.hasOwnProperty(prop)) { + // use isValidKey to guard against prototype pollution. See https://snyk.io/vuln/SNYK-JS-LODASH-450202 + if (!source.hasOwnProperty(prop) || !isValidKey(prop)) { continue; } - (target as { [key: string]: unknown })[prop] = deepExtend( - (target as { [key: string]: unknown })[prop], - (source as { [key: string]: unknown })[prop] + (target as Record)[prop] = deepExtend( + (target as Record)[prop], + (source as Record)[prop] ); } return target; } + +function isValidKey(key: string): boolean { + return key !== '__proto__'; +} diff --git a/packages/util/test/deepCopy.test.ts b/packages/util/test/deepCopy.test.ts index 267f97f3db0..98861ce24a7 100644 --- a/packages/util/test/deepCopy.test.ts +++ b/packages/util/test/deepCopy.test.ts @@ -14,78 +14,77 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -import { assert } from 'chai'; +import { expect } from 'chai'; import { deepCopy, deepExtend } from '../src/deepCopy'; describe('deepCopy()', () => { it('Scalars', () => { - assert.strictEqual(deepCopy(true), true); - assert.strictEqual(deepCopy(123), 123); - assert.strictEqual(deepCopy('abc'), 'abc'); + expect(deepCopy(true)).to.equal(true); + expect(deepCopy(123)).to.equal(123); + expect(deepCopy('abc')).to.equal('abc'); }); it('Date', () => { const d = new Date(); - assert.deepEqual(deepCopy(d), d); + expect(deepCopy(d)).to.deep.equal(d); }); it('Object', () => { - assert.deepEqual(deepCopy({}), {}); - assert.deepEqual(deepCopy({ a: 123 }), { a: 123 }); - assert.deepEqual(deepCopy({ a: { b: 123 } }), { a: { b: 123 } }); + expect(deepCopy({})).to.deep.equal({}); + expect(deepCopy({ a: 123 })).to.deep.equal({ a: 123 }); + expect(deepCopy({ a: { b: 123 } })).to.deep.equal({ a: { b: 123 } }); }); it('Array', () => { - assert.deepEqual(deepCopy([]), []); - assert.deepEqual(deepCopy([123, 456]), [123, 456]); - assert.deepEqual(deepCopy([123, [456]]), [123, [456]]); + expect(deepCopy([])).to.deep.equal([]); + expect(deepCopy([123, 456])).to.deep.equal([123, 456]); + expect(deepCopy([123, [456]])).to.deep.equal([123, [456]]); }); }); describe('deepExtend', () => { it('Scalars', () => { - assert.strictEqual(deepExtend(1, true), true); - assert.strictEqual(deepExtend(undefined, 123), 123); - assert.strictEqual(deepExtend('was', 'abc'), 'abc'); + expect(deepExtend(1, true)).to.equal(true); + expect(deepExtend(undefined, 123)).to.equal(123); + expect(deepExtend('was', 'abc')).to.equal('abc'); }); it('Date', () => { const d = new Date(); - assert.deepEqual(deepExtend(new Date(), d), d); + expect(deepExtend(new Date(), d)).to.deep.equal(d); }); it('Object', () => { - assert.deepEqual(deepExtend({ old: 123 }, {}), { old: 123 }); - assert.deepEqual(deepExtend({ old: 123 }, { s: 'hello' }), { + expect(deepExtend({ old: 123 }, {})).to.deep.equal({ old: 123 }); + expect(deepExtend({ old: 123 }, { s: 'hello' })).to.deep.equal({ old: 123, s: 'hello' }); - assert.deepEqual( - deepExtend({ old: 123, a: { c: 'in-old' } }, { a: { b: 123 } }), - { old: 123, a: { b: 123, c: 'in-old' } } - ); + expect( + deepExtend({ old: 123, a: { c: 'in-old' } }, { a: { b: 123 } }) + ).to.deep.equal({ old: 123, a: { b: 123, c: 'in-old' } }); }); it('Array', () => { - assert.deepEqual(deepExtend([1], []), []); - assert.deepEqual(deepExtend([1], [123, 456]), [123, 456]); - assert.deepEqual(deepExtend([1], [123, [456]]), [123, [456]]); + expect(deepExtend([1], [])).to.deep.equal([]); + expect(deepExtend([1], [123, 456])).to.deep.equal([123, 456]); + expect(deepExtend([1], [123, [456]])).to.deep.equal([123, [456]]); }); it('Array is copied - not referenced', () => { const o1 = { a: [1] }; const o2 = { a: [2] }; - assert.deepEqual(deepExtend(o1, o2), { a: [2] }); + expect(deepExtend(o1, o2)).to.deep.equal({ a: [2] }); o2.a.push(3); - assert.deepEqual(o1, { a: [2] }); + expect(o1).to.deep.equal({ a: [2] }); }); it('Array with undefined elements', () => { const a: any = []; a[3] = '3'; const b = deepExtend(undefined, a); - assert.deepEqual(b, [, , , '3']); + expect(b).to.deep.equal([, , , '3']); }); it('Function', () => { @@ -100,7 +99,16 @@ describe('deepExtend', () => { }, { a: source } ); - assert.deepEqual({ a: source }, target); - assert.strictEqual(source, target.a); + expect({ a: source }).to.deep.equal(target); + expect(source).to.equal(target.a); + }); + + it('does not extend property __proto__', () => { + const src = JSON.parse('{ "__proto__": { "polluted": "polluted" } }'); + const a: Record = {}; + deepExtend(a, src); + + expect(a.__proto__).to.equal(Object.prototype); + expect(a.polluted).to.be.undefined; }); }); From e0f296dd8366da7d0e03e0dea99abb5cc007a1a3 Mon Sep 17 00:00:00 2001 From: Feiyang Date: Tue, 27 Oct 2020 14:29:19 -0700 Subject: [PATCH 042/624] Support generating ref docs for Firestore exp & lite (#3966) * support ref doc generation for firestore exp * update ref docs --- .gitignore | 1 + common/api-review/firestore.api.md | 756 ++++++++++++++++++ common/api-review/firestore.lite.api.md | 553 +++++++++++++ docs-exp/firestore_.collection.md | 6 +- docs-exp/firestore_.collection_1.md | 6 +- docs-exp/firestore_.collection_2.md | 6 +- .../firestore_.collectionreference.doc.md | 22 - docs-exp/firestore_.collectionreference.md | 1 - docs-exp/firestore_.doc.md | 6 +- docs-exp/firestore_.doc_1.md | 6 +- docs-exp/firestore_.doc_2.md | 6 +- ...firestore_.documentreference.collection.md | 22 - docs-exp/firestore_.documentreference.md | 1 - ...restore_.documentsnapshot._constructor_.md | 2 + docs-exp/firestore_.documentsnapshot.md | 2 +- .../firestore_.enableindexeddbpersistence.md | 4 +- .../firestore_.fieldpath._constructor_.md | 2 + docs-exp/firestore_.fieldpath.md | 2 +- docs-exp/firestore_.geopoint._constructor_.md | 2 + docs-exp/firestore_.geopoint.md | 2 +- docs-exp/firestore_.md | 15 +- ...ore_.persistencesettings.forceownership.md | 11 + docs-exp/firestore_.persistencesettings.md | 18 + docs-exp/firestore_.query._constructor_.md | 2 + .../firestore_.timestamp._constructor_.md | 2 + docs-exp/firestore_.timestamp.md | 2 +- docs-exp/firestore_.wherefilterop.md | 4 +- docs-exp/firestore_lite.collection.md | 6 +- docs-exp/firestore_lite.collection_1.md | 6 +- docs-exp/firestore_lite.collection_2.md | 6 +- .../firestore_lite.collectionreference.doc.md | 22 - .../firestore_lite.collectionreference.md | 1 - docs-exp/firestore_lite.doc.md | 6 +- docs-exp/firestore_lite.doc_1.md | 6 +- docs-exp/firestore_lite.doc_2.md | 6 +- ...store_lite.documentreference.collection.md | 22 - docs-exp/firestore_lite.documentreference.md | 1 - .../firestore_lite.fieldpath._constructor_.md | 2 + docs-exp/firestore_lite.fieldpath.md | 2 +- .../firestore_lite.geopoint._constructor_.md | 2 + docs-exp/firestore_lite.geopoint.md | 2 +- docs-exp/firestore_lite.md | 12 +- .../firestore_lite.query._constructor_.md | 2 + .../firestore_lite.timestamp._constructor_.md | 2 + docs-exp/firestore_lite.timestamp.md | 2 +- docs-exp/firestore_lite.wherefilterop.md | 4 +- docs-exp/functions.md | 2 +- docs-exp/functions.usefunctionsemulator.md | 9 +- docs-exp/index.md | 1 + package.json | 2 +- packages/firestore/api-extractor.json | 11 + packages/firestore/package.json | 5 +- 52 files changed, 1459 insertions(+), 145 deletions(-) create mode 100644 common/api-review/firestore.api.md create mode 100644 common/api-review/firestore.lite.api.md delete mode 100644 docs-exp/firestore_.collectionreference.doc.md delete mode 100644 docs-exp/firestore_.documentreference.collection.md create mode 100644 docs-exp/firestore_.persistencesettings.forceownership.md create mode 100644 docs-exp/firestore_.persistencesettings.md delete mode 100644 docs-exp/firestore_lite.collectionreference.doc.md delete mode 100644 docs-exp/firestore_lite.documentreference.collection.md create mode 100644 packages/firestore/api-extractor.json diff --git a/.gitignore b/.gitignore index 93f49bb5bb0..dc9fe690372 100644 --- a/.gitignore +++ b/.gitignore @@ -88,6 +88,7 @@ packages-exp/**/temp # temp markdowns generated for individual SDKs packages-exp/**/docs +packages/**/docs # files generated by api-extractor that should not be tracked tsdoc-metadata.json \ No newline at end of file diff --git a/common/api-review/firestore.api.md b/common/api-review/firestore.api.md new file mode 100644 index 00000000000..74887c03920 --- /dev/null +++ b/common/api-review/firestore.api.md @@ -0,0 +1,756 @@ +## API Report File for "@firebase/firestore" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { FirebaseApp } from '@firebase/app-types-exp'; + +// @public (undocumented) +export function addDoc( + reference: CollectionReference, + data: T +): Promise>; + +// @public (undocumented) +export function arrayRemove(...elements: any[]): FieldValue; + +// @public (undocumented) +export function arrayUnion(...elements: any[]): FieldValue; + +// @public (undocumented) +export class Bytes { + // (undocumented) + static fromBase64String(base64: string): Blob; + + // (undocumented) + static fromUint8Array(array: Uint8Array): Blob; + + // (undocumented) + isEqual(other: Blob): boolean; + + // (undocumented) + toBase64(): string; + + // (undocumented) + toUint8Array(): Uint8Array; +} + +// @public (undocumented) +export const CACHE_SIZE_UNLIMITED: number; + +// @public (undocumented) +export function clearIndexedDbPersistence( + firestore: FirebaseFirestore +): Promise; + +// @public (undocumented) +export function collection( + firestore: FirebaseFirestore, + path: string, + ...pathComponents: string[] +): CollectionReference; + +// @public (undocumented) +export function collection( + reference: CollectionReference, + path: string, + ...pathComponents: string[] +): CollectionReference; + +// @public (undocumented) +export function collection( + reference: DocumentReference, + path: string, + ...pathComponents: string[] +): CollectionReference; + +// @public (undocumented) +export function collectionGroup( + firestore: FirebaseFirestore, + collectionId: string +): Query; + +// @public (undocumented) +export class CollectionReference extends Query { + // (undocumented) + readonly id: string; + // (undocumented) + get parent(): DocumentReference | null; + // (undocumented) + readonly path: string; + // (undocumented) + readonly type: 'collection'; + // (undocumented) + withConverter( + converter: FirestoreDataConverter + ): CollectionReference; +} + +// @public (undocumented) +export function deleteDoc(reference: DocumentReference): Promise; + +// @public (undocumented) +export function deleteField(): FieldValue; + +// @public (undocumented) +export function disableNetwork(firestore: FirebaseFirestore): Promise; + +// @public (undocumented) +export function doc( + firestore: FirebaseFirestore, + path: string, + ...pathComponents: string[] +): DocumentReference; + +// @public (undocumented) +export function doc( + reference: CollectionReference, + path?: string, + ...pathComponents: string[] +): DocumentReference; + +// @public (undocumented) +export function doc( + reference: DocumentReference, + path: string, + ...pathComponents: string[] +): DocumentReference; + +// @public (undocumented) +export interface DocumentChange { + // (undocumented) + readonly doc: QueryDocumentSnapshot; + // (undocumented) + readonly newIndex: number; + // (undocumented) + readonly oldIndex: number; + // (undocumented) + readonly type: DocumentChangeType; +} + +// @public (undocumented) +export type DocumentChangeType = 'added' | 'removed' | 'modified'; + +// @public (undocumented) +export interface DocumentData { + // (undocumented) + [field: string]: any; +} + +// @public (undocumented) +export function documentId(): FieldPath; + +// @public (undocumented) +export class DocumentReference { + // (undocumented) + readonly converter: FirestoreDataConverter | null; + // (undocumented) + readonly firestore: FirebaseFirestore; + // (undocumented) + readonly id: string; + // (undocumented) + get parent(): CollectionReference; + // (undocumented) + readonly path: string; + // (undocumented) + readonly type: 'document'; + // (undocumented) + withConverter(converter: FirestoreDataConverter): DocumentReference; +} + +// @public (undocumented) +export class DocumentSnapshot { + protected constructor(); + + // (undocumented) + data(options?: SnapshotOptions): T | undefined; + + // (undocumented) + exists(): this is QueryDocumentSnapshot; + + // (undocumented) + get(fieldPath: string | FieldPath, options?: SnapshotOptions): any; + + // (undocumented) + readonly id: string; + + // (undocumented) + readonly metadata: SnapshotMetadata; + + // (undocumented) + readonly ref: DocumentReference; +} + +// @public (undocumented) +export function enableIndexedDbPersistence( + firestore: FirebaseFirestore, + persistenceSettings?: PersistenceSettings +): Promise; + +// @public (undocumented) +export function enableMultiTabIndexedDbPersistence( + firestore: FirebaseFirestore +): Promise; + +// @public (undocumented) +export function enableNetwork(firestore: FirebaseFirestore): Promise; + +// @public (undocumented) +export function endAt(snapshot: DocumentSnapshot): QueryConstraint; + +// @public (undocumented) +export function endAt(...fieldValues: any[]): QueryConstraint; + +// @public (undocumented) +export function endBefore(snapshot: DocumentSnapshot): QueryConstraint; + +// @public (undocumented) +export function endBefore(...fieldValues: any[]): QueryConstraint; + +// @public (undocumented) +export class FieldPath { + constructor(...fieldNames: string[]); + // (undocumented) + isEqual(other: FieldPath): boolean; +} + +// @public (undocumented) +export class FieldValue { + // (undocumented) + isEqual(other: FieldValue): boolean; +} + +// @public (undocumented) +export class FirebaseFirestore { + // (undocumented) + readonly app: FirebaseApp; +} + +// @public (undocumented) +export interface FirestoreDataConverter { + // (undocumented) + fromFirestore( + snapshot: QueryDocumentSnapshot, + options?: SnapshotOptions + ): T; + // (undocumented) + toFirestore(modelObject: T): DocumentData; + // (undocumented) + toFirestore(modelObject: Partial, options: SetOptions): DocumentData; +} + +// @public (undocumented) +export interface FirestoreError { + // (undocumented) + code: FirestoreErrorCode; + // (undocumented) + message: string; + // (undocumented) + name: string; + // (undocumented) + stack?: string; +} + +// @public (undocumented) +export type FirestoreErrorCode = + | 'cancelled' + | 'unknown' + | 'invalid-argument' + | 'deadline-exceeded' + | 'not-found' + | 'already-exists' + | 'permission-denied' + | 'resource-exhausted' + | 'failed-precondition' + | 'aborted' + | 'out-of-range' + | 'unimplemented' + | 'internal' + | 'unavailable' + | 'data-loss' + | 'unauthenticated'; + +// @public (undocumented) +export class GeoPoint { + constructor(latitude: number, longitude: number); + + // (undocumented) + isEqual(other: GeoPoint): boolean; + + // (undocumented) + readonly latitude: number; + + // (undocumented) + readonly longitude: number; +} + +// @public (undocumented) +export function getDoc( + reference: DocumentReference +): Promise>; + +// @public (undocumented) +export function getDocFromCache( + reference: DocumentReference +): Promise>; + +// @public (undocumented) +export function getDocFromServer( + reference: DocumentReference +): Promise>; + +// @public (undocumented) +export function getDocs(query: Query): Promise>; + +// @public (undocumented) +export function getDocsFromCache(query: Query): Promise>; + +// @public (undocumented) +export function getDocsFromServer( + query: Query +): Promise>; + +// @public (undocumented) +export function getFirestore(app: FirebaseApp): FirebaseFirestore; + +// @public (undocumented) +export function increment(n: number): FieldValue; + +// @public (undocumented) +export function initializeFirestore( + app: FirebaseApp, + settings: Settings +): FirebaseFirestore; + +// @public (undocumented) +export function limit(limit: number): QueryConstraint; + +// @public (undocumented) +export function limitToLast(limit: number): QueryConstraint; + +// @public (undocumented) +export type LogLevel = + | 'debug' + | 'error' + | 'silent' + | 'warn' + | 'info' + | 'verbose'; + +// @public (undocumented) +export function onSnapshot( + reference: DocumentReference, + observer: { + next?: (snapshot: DocumentSnapshot) => void; + error?: (error: FirestoreError) => void; + complete?: () => void; + } +): () => void; + +// @public (undocumented) +export function onSnapshot( + reference: DocumentReference, + options: SnapshotListenOptions, + observer: { + next?: (snapshot: DocumentSnapshot) => void; + error?: (error: FirestoreError) => void; + complete?: () => void; + } +): () => void; + +// @public (undocumented) +export function onSnapshot( + reference: DocumentReference, + onNext: (snapshot: DocumentSnapshot) => void, + onError?: (error: FirestoreError) => void, + onCompletion?: () => void +): () => void; + +// @public (undocumented) +export function onSnapshot( + reference: DocumentReference, + options: SnapshotListenOptions, + onNext: (snapshot: DocumentSnapshot) => void, + onError?: (error: FirestoreError) => void, + onCompletion?: () => void +): () => void; + +// @public (undocumented) +export function onSnapshot( + query: Query, + observer: { + next?: (snapshot: QuerySnapshot) => void; + error?: (error: FirestoreError) => void; + complete?: () => void; + } +): () => void; + +// @public (undocumented) +export function onSnapshot( + query: Query, + options: SnapshotListenOptions, + observer: { + next?: (snapshot: QuerySnapshot) => void; + error?: (error: FirestoreError) => void; + complete?: () => void; + } +): () => void; + +// @public (undocumented) +export function onSnapshot( + query: Query, + onNext: (snapshot: QuerySnapshot) => void, + onError?: (error: FirestoreError) => void, + onCompletion?: () => void +): () => void; + +// @public (undocumented) +export function onSnapshot( + query: Query, + options: SnapshotListenOptions, + onNext: (snapshot: QuerySnapshot) => void, + onError?: (error: FirestoreError) => void, + onCompletion?: () => void +): () => void; + +// @public (undocumented) +export function onSnapshotsInSync( + firestore: FirebaseFirestore, + observer: { + next?: (value: void) => void; + error?: (error: FirestoreError) => void; + complete?: () => void; + } +): () => void; + +// @public (undocumented) +export function onSnapshotsInSync( + firestore: FirebaseFirestore, + onSync: () => void +): () => void; + +// @public (undocumented) +export function orderBy( + fieldPath: string | FieldPath, + directionStr?: OrderByDirection +): QueryConstraint; + +// @public (undocumented) +export type OrderByDirection = 'desc' | 'asc'; + +// @public (undocumented) +export interface PersistenceSettings { + // (undocumented) + forceOwnership?: boolean; +} + +// @public (undocumented) +export class Query { + protected constructor(); + // (undocumented) + readonly converter: FirestoreDataConverter | null; + // (undocumented) + readonly firestore: FirebaseFirestore; + // (undocumented) + readonly type: 'query' | 'collection'; + // (undocumented) + withConverter(converter: FirestoreDataConverter): Query; +} + +// @public (undocumented) +export function query( + query: CollectionReference | Query, + ...constraints: QueryConstraint[] +): Query; + +// @public (undocumented) +export class QueryConstraint { + // (undocumented) + readonly type: QueryConstraintType; +} + +// @public (undocumented) +export type QueryConstraintType = + | 'where' + | 'orderBy' + | 'limit' + | 'limitToLast' + | 'startAt' + | 'startAfter' + | 'endAt' + | 'endBefore'; + +// @public (undocumented) +export class QueryDocumentSnapshot extends DocumentSnapshot< + T +> { + // (undocumented) + data(options?: SnapshotOptions): T; +} + +// @public (undocumented) +export function queryEqual(left: Query, right: Query): boolean; + +// @public (undocumented) +export class QuerySnapshot { + // (undocumented) + docChanges(options?: SnapshotListenOptions): Array>; + // (undocumented) + readonly docs: Array>; + // (undocumented) + readonly empty: boolean; + // (undocumented) + forEach( + callback: (result: QueryDocumentSnapshot) => void, + thisArg?: any + ): void; + // (undocumented) + readonly metadata: SnapshotMetadata; + // (undocumented) + readonly query: Query; + // (undocumented) + readonly size: number; +} + +// @public (undocumented) +export function refEqual( + left: DocumentReference | CollectionReference, + right: DocumentReference | CollectionReference +): boolean; + +// @public (undocumented) +export function runTransaction( + firestore: FirebaseFirestore, + updateFunction: (transaction: Transaction) => Promise +): Promise; + +// @public (undocumented) +export function serverTimestamp(): FieldValue; + +// @public (undocumented) +export function setDoc( + reference: DocumentReference, + data: T +): Promise; + +// @public (undocumented) +export function setDoc( + reference: DocumentReference, + data: Partial, + options: SetOptions +): Promise; + +// @public (undocumented) +export function setLogLevel(logLevel: LogLevel): void; + +// @public (undocumented) +export type SetOptions = + | { + readonly merge?: boolean; + } + | { + readonly mergeFields?: Array; + }; + +// @public (undocumented) +export interface Settings { + // (undocumented) + cacheSizeBytes?: number; + // (undocumented) + host?: string; + // (undocumented) + ignoreUndefinedProperties?: boolean; + // (undocumented) + ssl?: boolean; +} + +// @public (undocumented) +export function snapshotEqual( + left: DocumentSnapshot | QuerySnapshot, + right: DocumentSnapshot | QuerySnapshot +): boolean; + +// @public (undocumented) +export interface SnapshotListenOptions { + // (undocumented) + readonly includeMetadataChanges?: boolean; +} + +// @public (undocumented) +export class SnapshotMetadata { + // (undocumented) + readonly fromCache: boolean; + + // (undocumented) + readonly hasPendingWrites: boolean; + + // (undocumented) + isEqual(other: SnapshotMetadata): boolean; +} + +// @public (undocumented) +export interface SnapshotOptions { + // (undocumented) + readonly serverTimestamps?: 'estimate' | 'previous' | 'none'; +} + +// @public (undocumented) +export function startAfter(snapshot: DocumentSnapshot): QueryConstraint; + +// @public (undocumented) +export function startAfter(...fieldValues: any[]): QueryConstraint; + +// @public (undocumented) +export function startAt(snapshot: DocumentSnapshot): QueryConstraint; + +// @public (undocumented) +export function startAt(...fieldValues: any[]): QueryConstraint; + +// @public (undocumented) +export function terminate(firestore: FirebaseFirestore): Promise; + +// @public (undocumented) +export class Timestamp { + constructor(seconds: number, nanoseconds: number); + + // (undocumented) + static fromDate(date: Date): Timestamp; + + // (undocumented) + static fromMillis(milliseconds: number): Timestamp; + + // (undocumented) + isEqual(other: Timestamp): boolean; + + // (undocumented) + readonly nanoseconds: number; + + // (undocumented) + static now(): Timestamp; + + // (undocumented) + readonly seconds: number; + + // (undocumented) + toDate(): Date; + + // (undocumented) + toMillis(): number; + + // (undocumented) + valueOf(): string; +} + +// @public (undocumented) +export class Transaction { + // (undocumented) + delete(documentRef: DocumentReference): Transaction; + + // (undocumented) + get(documentRef: DocumentReference): Promise>; + + // (undocumented) + set(documentRef: DocumentReference, data: T): Transaction; + + // (undocumented) + set( + documentRef: DocumentReference, + data: Partial, + options: SetOptions + ): Transaction; + + // (undocumented) + update(documentRef: DocumentReference, data: UpdateData): Transaction; + + // (undocumented) + update( + documentRef: DocumentReference, + field: string | FieldPath, + value: any, + ...moreFieldsAndValues: any[] + ): Transaction; +} + +// @public (undocumented) +export interface UpdateData { + // (undocumented) + [fieldPath: string]: any; +} + +// @public (undocumented) +export function updateDoc( + reference: DocumentReference, + data: UpdateData +): Promise; + +// @public (undocumented) +export function updateDoc( + reference: DocumentReference, + field: string | FieldPath, + value: any, + ...moreFieldsAndValues: any[] +): Promise; + +// @public (undocumented) +export function waitForPendingWrites( + firestore: FirebaseFirestore +): Promise; + +// @public (undocumented) +export function where( + fieldPath: string | FieldPath, + opStr: WhereFilterOp, + value: any +): QueryConstraint; + +// @public (undocumented) +export type WhereFilterOp = + | '<' + | '<=' + | '==' + | '!=' + | '>=' + | '>' + | 'array-contains' + | 'in' + | 'array-contains-any' + | 'not-in'; + +// @public (undocumented) +export class WriteBatch { + // (undocumented) + commit(): Promise; + + // (undocumented) + delete(documentRef: DocumentReference): WriteBatch; + + // (undocumented) + set(documentRef: DocumentReference, data: T): WriteBatch; + + // (undocumented) + set( + documentRef: DocumentReference, + data: Partial, + options: SetOptions + ): WriteBatch; + + // (undocumented) + update(documentRef: DocumentReference, data: UpdateData): WriteBatch; + + // (undocumented) + update( + documentRef: DocumentReference, + field: string | FieldPath, + value: any, + ...moreFieldsAndValues: any[] + ): WriteBatch; +} + +// @public (undocumented) +export function writeBatch(firestore: FirebaseFirestore): WriteBatch; + + +// (No @packageDocumentation comment for this package) + +``` diff --git a/common/api-review/firestore.lite.api.md b/common/api-review/firestore.lite.api.md new file mode 100644 index 00000000000..68387426991 --- /dev/null +++ b/common/api-review/firestore.lite.api.md @@ -0,0 +1,553 @@ +## API Report File for "@firebase/firestore/lite" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { FirebaseApp } from '@firebase/app-types-exp'; + +// @public (undocumented) +export function addDoc( + reference: CollectionReference, + data: T +): Promise>; + +// @public (undocumented) +export function arrayRemove(...elements: any[]): FieldValue; + +// @public (undocumented) +export function arrayUnion(...elements: any[]): FieldValue; + +// @public (undocumented) +export class Bytes { + // (undocumented) + static fromBase64String(base64: string): Blob; + + // (undocumented) + static fromUint8Array(array: Uint8Array): Blob; + + // (undocumented) + isEqual(other: Blob): boolean; + + // (undocumented) + toBase64(): string; + + // (undocumented) + toUint8Array(): Uint8Array; +} + +// @public (undocumented) +export function collection( + firestore: FirebaseFirestore, + path: string, + ...pathComponents: string[] +): CollectionReference; + +// @public (undocumented) +export function collection( + reference: CollectionReference, + path: string, + ...pathComponents: string[] +): CollectionReference; + +// @public (undocumented) +export function collection( + reference: DocumentReference, + path: string, + ...pathComponents: string[] +): CollectionReference; + +// @public (undocumented) +export function collectionGroup( + firestore: FirebaseFirestore, + collectionId: string +): Query; + +// @public (undocumented) +export class CollectionReference extends Query { + // (undocumented) + readonly id: string; + // (undocumented) + get parent(): DocumentReference | null; + // (undocumented) + readonly path: string; + // (undocumented) + readonly type: 'collection'; + // (undocumented) + withConverter( + converter: FirestoreDataConverter + ): CollectionReference; +} + +// @public (undocumented) +export function deleteDoc(reference: DocumentReference): Promise; + +// @public (undocumented) +export function deleteField(): FieldValue; + +// @public (undocumented) +export function doc( + firestore: FirebaseFirestore, + path: string, + ...pathComponents: string[] +): DocumentReference; + +// @public (undocumented) +export function doc( + reference: CollectionReference, + path?: string, + ...pathComponents: string[] +): DocumentReference; + +// @public (undocumented) +export function doc( + reference: DocumentReference, + path: string, + ...pathComponents: string[] +): DocumentReference; + +// @public (undocumented) +export interface DocumentData { + // (undocumented) + [field: string]: any; +} + +// @public (undocumented) +export function documentId(): FieldPath; + +// @public (undocumented) +export class DocumentReference { + // (undocumented) + readonly converter: FirestoreDataConverter | null; + // (undocumented) + readonly firestore: FirebaseFirestore; + // (undocumented) + readonly id: string; + // (undocumented) + get parent(): CollectionReference; + // (undocumented) + readonly path: string; + // (undocumented) + readonly type: 'document'; + // (undocumented) + withConverter(converter: FirestoreDataConverter): DocumentReference; +} + +// @public (undocumented) +export class DocumentSnapshot { + // (undocumented) + data(): T | undefined; + // (undocumented) + exists(): this is QueryDocumentSnapshot; + // (undocumented) + get(fieldPath: string | FieldPath): any; + // (undocumented) + readonly id: string; + // (undocumented) + readonly ref: DocumentReference; +} + +// @public (undocumented) +export function endAt(snapshot: DocumentSnapshot): QueryConstraint; + +// @public (undocumented) +export function endAt(...fieldValues: any[]): QueryConstraint; + +// @public (undocumented) +export function endBefore(snapshot: DocumentSnapshot): QueryConstraint; + +// @public (undocumented) +export function endBefore(...fieldValues: any[]): QueryConstraint; + +// @public (undocumented) +export class FieldPath { + constructor(...fieldNames: string[]); + // (undocumented) + isEqual(other: FieldPath): boolean; +} + +// @public (undocumented) +export class FieldValue { + // (undocumented) + isEqual(other: FieldValue): boolean; +} + +// @public (undocumented) +export class FirebaseFirestore { + // (undocumented) + readonly app: FirebaseApp; +} + +// @public (undocumented) +export interface FirestoreDataConverter { + // (undocumented) + fromFirestore(snapshot: QueryDocumentSnapshot): T; + // (undocumented) + toFirestore(modelObject: T): DocumentData; + // (undocumented) + toFirestore(modelObject: Partial, options: SetOptions): DocumentData; +} + +// @public (undocumented) +export interface FirestoreError { + // (undocumented) + code: FirestoreErrorCode; + // (undocumented) + message: string; + // (undocumented) + name: string; + // (undocumented) + stack?: string; +} + +// @public (undocumented) +export type FirestoreErrorCode = + | 'cancelled' + | 'unknown' + | 'invalid-argument' + | 'deadline-exceeded' + | 'not-found' + | 'already-exists' + | 'permission-denied' + | 'resource-exhausted' + | 'failed-precondition' + | 'aborted' + | 'out-of-range' + | 'unimplemented' + | 'internal' + | 'unavailable' + | 'data-loss' + | 'unauthenticated'; + +// @public (undocumented) +export class GeoPoint { + constructor(latitude: number, longitude: number); + + // (undocumented) + isEqual(other: GeoPoint): boolean; + + // (undocumented) + readonly latitude: number; + + // (undocumented) + readonly longitude: number; +} + +// @public (undocumented) +export function getDoc( + reference: DocumentReference +): Promise>; + +// @public (undocumented) +export function getDocs(query: Query): Promise>; + +// @public (undocumented) +export function getFirestore(app: FirebaseApp): FirebaseFirestore; + +// @public (undocumented) +export function increment(n: number): FieldValue; + +// @public (undocumented) +export function initializeFirestore( + app: FirebaseApp, + settings: Settings +): FirebaseFirestore; + +// @public (undocumented) +export function limit(limit: number): QueryConstraint; + +// @public (undocumented) +export function limitToLast(limit: number): QueryConstraint; + +// @public (undocumented) +export type LogLevel = + | 'debug' + | 'error' + | 'silent' + | 'warn' + | 'info' + | 'verbose'; + +// @public (undocumented) +export function orderBy( + fieldPath: string | FieldPath, + directionStr?: OrderByDirection +): QueryConstraint; + +// @public (undocumented) +export type OrderByDirection = 'desc' | 'asc'; + +// @public (undocumented) +export class Query { + protected constructor(); + // (undocumented) + readonly converter: FirestoreDataConverter | null; + // (undocumented) + readonly firestore: FirebaseFirestore; + // (undocumented) + readonly type: 'query' | 'collection'; + // (undocumented) + withConverter(converter: FirestoreDataConverter): Query; +} + +// @public (undocumented) +export function query( + query: CollectionReference | Query, + ...constraints: QueryConstraint[] +): Query; + +// @public (undocumented) +export class QueryConstraint { + // (undocumented) + readonly type: QueryConstraintType; +} + +// @public (undocumented) +export type QueryConstraintType = + | 'where' + | 'orderBy' + | 'limit' + | 'limitToLast' + | 'startAt' + | 'startAfter' + | 'endAt' + | 'endBefore'; + +// @public (undocumented) +export class QueryDocumentSnapshot extends DocumentSnapshot< + T +> { + // (undocumented) + data(): T; +} + +// @public (undocumented) +export function queryEqual(left: Query, right: Query): boolean; + +// @public (undocumented) +export class QuerySnapshot { + // (undocumented) + readonly docs: Array>; + // (undocumented) + readonly empty: boolean; + // (undocumented) + forEach( + callback: (result: QueryDocumentSnapshot) => void, + thisArg?: any + ): void; + // (undocumented) + readonly query: Query; + // (undocumented) + readonly size: number; +} + +// @public (undocumented) +export function refEqual( + left: DocumentReference | CollectionReference, + right: DocumentReference | CollectionReference +): boolean; + +// @public (undocumented) +export function runTransaction( + firestore: FirebaseFirestore, + updateFunction: (transaction: Transaction) => Promise +): Promise; + +// @public (undocumented) +export function serverTimestamp(): FieldValue; + +// @public (undocumented) +export function setDoc( + reference: DocumentReference, + data: T +): Promise; + +// @public (undocumented) +export function setDoc( + reference: DocumentReference, + data: Partial, + options: SetOptions +): Promise; + +// @public (undocumented) +export function setLogLevel(logLevel: LogLevel): void; + +// @public (undocumented) +export type SetOptions = + | { + readonly merge?: boolean; + } + | { + readonly mergeFields?: Array; + }; + +// @public (undocumented) +export interface Settings { + // (undocumented) + host?: string; + // (undocumented) + ignoreUndefinedProperties?: boolean; + // (undocumented) + ssl?: boolean; +} + +// @public (undocumented) +export function snapshotEqual( + left: DocumentSnapshot | QuerySnapshot, + right: DocumentSnapshot | QuerySnapshot +): boolean; + +// @public (undocumented) +export function startAfter(snapshot: DocumentSnapshot): QueryConstraint; + +// @public (undocumented) +export function startAfter(...fieldValues: any[]): QueryConstraint; + +// @public (undocumented) +export function startAt(snapshot: DocumentSnapshot): QueryConstraint; + +// @public (undocumented) +export function startAt(...fieldValues: any[]): QueryConstraint; + +// @public (undocumented) +export function terminate(firestore: FirebaseFirestore): Promise; + +// @public (undocumented) +export class Timestamp { + constructor(seconds: number, nanoseconds: number); + + // (undocumented) + static fromDate(date: Date): Timestamp; + + // (undocumented) + static fromMillis(milliseconds: number): Timestamp; + + // (undocumented) + isEqual(other: Timestamp): boolean; + + // (undocumented) + readonly nanoseconds: number; + + // (undocumented) + static now(): Timestamp; + + // (undocumented) + readonly seconds: number; + + // (undocumented) + toDate(): Date; + + // (undocumented) + toMillis(): number; + + // (undocumented) + valueOf(): string; +} + +// @public (undocumented) +export class Transaction { + // (undocumented) + delete(documentRef: DocumentReference): Transaction; + + // (undocumented) + get(documentRef: DocumentReference): Promise>; + + // (undocumented) + set(documentRef: DocumentReference, data: T): Transaction; + + // (undocumented) + set( + documentRef: DocumentReference, + data: Partial, + options: SetOptions + ): Transaction; + + // (undocumented) + update(documentRef: DocumentReference, data: UpdateData): Transaction; + + // (undocumented) + update( + documentRef: DocumentReference, + field: string | FieldPath, + value: any, + ...moreFieldsAndValues: any[] + ): Transaction; +} + +// @public (undocumented) +export interface UpdateData { + // (undocumented) + [fieldPath: string]: any; +} + +// @public (undocumented) +export function updateDoc( + reference: DocumentReference, + data: UpdateData +): Promise; + +// @public (undocumented) +export function updateDoc( + reference: DocumentReference, + field: string | FieldPath, + value: any, + ...moreFieldsAndValues: any[] +): Promise; + +// @public (undocumented) +export function where( + fieldPath: string | FieldPath, + opStr: WhereFilterOp, + value: any +): QueryConstraint; + +// @public (undocumented) +export type WhereFilterOp = + | '<' + | '<=' + | '==' + | '!=' + | '>=' + | '>' + | 'array-contains' + | 'in' + | 'array-contains-any' + | 'not-in'; + +// @public (undocumented) +export class WriteBatch { + // (undocumented) + commit(): Promise; + + // (undocumented) + delete(documentRef: DocumentReference): WriteBatch; + + // (undocumented) + set(documentRef: DocumentReference, data: T): WriteBatch; + + // (undocumented) + set( + documentRef: DocumentReference, + data: Partial, + options: SetOptions + ): WriteBatch; + + // (undocumented) + update(documentRef: DocumentReference, data: UpdateData): WriteBatch; + + // (undocumented) + update( + documentRef: DocumentReference, + field: string | FieldPath, + value: any, + ...moreFieldsAndValues: any[] + ): WriteBatch; +} + +// @public (undocumented) +export function writeBatch(firestore: FirebaseFirestore): WriteBatch; + + +// (No @packageDocumentation comment for this package) + +``` diff --git a/docs-exp/firestore_.collection.md b/docs-exp/firestore_.collection.md index bff81779aa8..ccf6b58ca26 100644 --- a/docs-exp/firestore_.collection.md +++ b/docs-exp/firestore_.collection.md @@ -9,7 +9,8 @@ ```typescript export function collection( firestore: FirebaseFirestore, - collectionPath: string + path: string, + ...pathComponents: string[] ): CollectionReference; ``` @@ -18,7 +19,8 @@ export function collection( | Parameter | Type | Description | | --- | --- | --- | | firestore | [FirebaseFirestore](./firestore_.firebasefirestore.md) | | -| collectionPath | string | | +| path | string | | +| pathComponents | string\[\] | | Returns: diff --git a/docs-exp/firestore_.collection_1.md b/docs-exp/firestore_.collection_1.md index dc4f299ad12..7a3cb4d1254 100644 --- a/docs-exp/firestore_.collection_1.md +++ b/docs-exp/firestore_.collection_1.md @@ -9,7 +9,8 @@ ```typescript export function collection( reference: CollectionReference, - collectionPath: string + path: string, + ...pathComponents: string[] ): CollectionReference; ``` @@ -18,7 +19,8 @@ export function collection( | Parameter | Type | Description | | --- | --- | --- | | reference | [CollectionReference](./firestore_.collectionreference.md)<unknown> | | -| collectionPath | string | | +| path | string | | +| pathComponents | string\[\] | | Returns: diff --git a/docs-exp/firestore_.collection_2.md b/docs-exp/firestore_.collection_2.md index 880268da15f..b3fb60d7510 100644 --- a/docs-exp/firestore_.collection_2.md +++ b/docs-exp/firestore_.collection_2.md @@ -9,7 +9,8 @@ ```typescript export function collection( reference: DocumentReference, - collectionPath: string + path: string, + ...pathComponents: string[] ): CollectionReference; ``` @@ -18,7 +19,8 @@ export function collection( | Parameter | Type | Description | | --- | --- | --- | | reference | [DocumentReference](./firestore_.documentreference.md) | | -| collectionPath | string | | +| path | string | | +| pathComponents | string\[\] | | Returns: diff --git a/docs-exp/firestore_.collectionreference.doc.md b/docs-exp/firestore_.collectionreference.doc.md deleted file mode 100644 index d8d47a73f7e..00000000000 --- a/docs-exp/firestore_.collectionreference.doc.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/firestore](./firestore.md) > [/](./firestore_.md) > [CollectionReference](./firestore_.collectionreference.md) > [doc](./firestore_.collectionreference.doc.md) - -## CollectionReference.doc() method - -Signature: - -```typescript -doc(documentPath?: string): DocumentReference; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| documentPath | string | | - -Returns: - -[DocumentReference](./firestore_.documentreference.md)<T> - diff --git a/docs-exp/firestore_.collectionreference.md b/docs-exp/firestore_.collectionreference.md index 787f5cf4fbc..faf4205c806 100644 --- a/docs-exp/firestore_.collectionreference.md +++ b/docs-exp/firestore_.collectionreference.md @@ -24,6 +24,5 @@ export class CollectionReference extends Query | Method | Modifiers | Description | | --- | --- | --- | -| [doc(documentPath)](./firestore_.collectionreference.doc.md) | | | | [withConverter(converter)](./firestore_.collectionreference.withconverter.md) | | | diff --git a/docs-exp/firestore_.doc.md b/docs-exp/firestore_.doc.md index e0b9e126225..4d4bd52cdf3 100644 --- a/docs-exp/firestore_.doc.md +++ b/docs-exp/firestore_.doc.md @@ -9,7 +9,8 @@ ```typescript export function doc( firestore: FirebaseFirestore, - documentPath: string + path: string, + ...pathComponents: string[] ): DocumentReference; ``` @@ -18,7 +19,8 @@ export function doc( | Parameter | Type | Description | | --- | --- | --- | | firestore | [FirebaseFirestore](./firestore_.firebasefirestore.md) | | -| documentPath | string | | +| path | string | | +| pathComponents | string\[\] | | Returns: diff --git a/docs-exp/firestore_.doc_1.md b/docs-exp/firestore_.doc_1.md index cb4022ad93c..3875983d974 100644 --- a/docs-exp/firestore_.doc_1.md +++ b/docs-exp/firestore_.doc_1.md @@ -9,7 +9,8 @@ ```typescript export function doc( reference: CollectionReference, - documentPath?: string + path?: string, + ...pathComponents: string[] ): DocumentReference; ``` @@ -18,7 +19,8 @@ export function doc( | Parameter | Type | Description | | --- | --- | --- | | reference | [CollectionReference](./firestore_.collectionreference.md)<T> | | -| documentPath | string | | +| path | string | | +| pathComponents | string\[\] | | Returns: diff --git a/docs-exp/firestore_.doc_2.md b/docs-exp/firestore_.doc_2.md index 9c6ebe61f13..ad13abf9d4a 100644 --- a/docs-exp/firestore_.doc_2.md +++ b/docs-exp/firestore_.doc_2.md @@ -9,7 +9,8 @@ ```typescript export function doc( reference: DocumentReference, - documentPath: string + path: string, + ...pathComponents: string[] ): DocumentReference; ``` @@ -18,7 +19,8 @@ export function doc( | Parameter | Type | Description | | --- | --- | --- | | reference | [DocumentReference](./firestore_.documentreference.md)<unknown> | | -| documentPath | string | | +| path | string | | +| pathComponents | string\[\] | | Returns: diff --git a/docs-exp/firestore_.documentreference.collection.md b/docs-exp/firestore_.documentreference.collection.md deleted file mode 100644 index 9d45e120984..00000000000 --- a/docs-exp/firestore_.documentreference.collection.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/firestore](./firestore.md) > [/](./firestore_.md) > [DocumentReference](./firestore_.documentreference.md) > [collection](./firestore_.documentreference.collection.md) - -## DocumentReference.collection() method - -Signature: - -```typescript -collection(collectionPath: string): CollectionReference; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| collectionPath | string | | - -Returns: - -[CollectionReference](./firestore_.collectionreference.md)<[DocumentData](./firestore_.documentdata.md)> - diff --git a/docs-exp/firestore_.documentreference.md b/docs-exp/firestore_.documentreference.md index 8207f1b73f8..14cb0677b12 100644 --- a/docs-exp/firestore_.documentreference.md +++ b/docs-exp/firestore_.documentreference.md @@ -25,6 +25,5 @@ export class DocumentReference | Method | Modifiers | Description | | --- | --- | --- | -| [collection(collectionPath)](./firestore_.documentreference.collection.md) | | | | [withConverter(converter)](./firestore_.documentreference.withconverter.md) | | | diff --git a/docs-exp/firestore_.documentsnapshot._constructor_.md b/docs-exp/firestore_.documentsnapshot._constructor_.md index e5b5168baa5..25f16edafa5 100644 --- a/docs-exp/firestore_.documentsnapshot._constructor_.md +++ b/docs-exp/firestore_.documentsnapshot._constructor_.md @@ -4,6 +4,8 @@ ## DocumentSnapshot.(constructor) +Constructs a new instance of the `DocumentSnapshot` class + Signature: ```typescript diff --git a/docs-exp/firestore_.documentsnapshot.md b/docs-exp/firestore_.documentsnapshot.md index 3a105cb4552..4a34cbaf591 100644 --- a/docs-exp/firestore_.documentsnapshot.md +++ b/docs-exp/firestore_.documentsnapshot.md @@ -14,7 +14,7 @@ export class DocumentSnapshot | Constructor | Modifiers | Description | | --- | --- | --- | -| [(constructor)()](./firestore_.documentsnapshot._constructor_.md) | | | +| [(constructor)()](./firestore_.documentsnapshot._constructor_.md) | | Constructs a new instance of the DocumentSnapshot class | ## Properties diff --git a/docs-exp/firestore_.enableindexeddbpersistence.md b/docs-exp/firestore_.enableindexeddbpersistence.md index 48d37be6622..0e9f235f430 100644 --- a/docs-exp/firestore_.enableindexeddbpersistence.md +++ b/docs-exp/firestore_.enableindexeddbpersistence.md @@ -8,7 +8,8 @@ ```typescript export function enableIndexedDbPersistence( - firestore: FirebaseFirestore + firestore: FirebaseFirestore, + persistenceSettings?: PersistenceSettings ): Promise; ``` @@ -17,6 +18,7 @@ export function enableIndexedDbPersistence( | Parameter | Type | Description | | --- | --- | --- | | firestore | [FirebaseFirestore](./firestore_.firebasefirestore.md) | | +| persistenceSettings | [PersistenceSettings](./firestore_.persistencesettings.md) | | Returns: diff --git a/docs-exp/firestore_.fieldpath._constructor_.md b/docs-exp/firestore_.fieldpath._constructor_.md index 7a344de5c88..cdf3e8fbcd9 100644 --- a/docs-exp/firestore_.fieldpath._constructor_.md +++ b/docs-exp/firestore_.fieldpath._constructor_.md @@ -4,6 +4,8 @@ ## FieldPath.(constructor) +Constructs a new instance of the `FieldPath` class + Signature: ```typescript diff --git a/docs-exp/firestore_.fieldpath.md b/docs-exp/firestore_.fieldpath.md index e911069af11..2f3bc81e06d 100644 --- a/docs-exp/firestore_.fieldpath.md +++ b/docs-exp/firestore_.fieldpath.md @@ -14,7 +14,7 @@ export class FieldPath | Constructor | Modifiers | Description | | --- | --- | --- | -| [(constructor)(fieldNames)](./firestore_.fieldpath._constructor_.md) | | | +| [(constructor)(fieldNames)](./firestore_.fieldpath._constructor_.md) | | Constructs a new instance of the FieldPath class | ## Methods diff --git a/docs-exp/firestore_.geopoint._constructor_.md b/docs-exp/firestore_.geopoint._constructor_.md index 4676f52a3c9..82dc9dcca9e 100644 --- a/docs-exp/firestore_.geopoint._constructor_.md +++ b/docs-exp/firestore_.geopoint._constructor_.md @@ -4,6 +4,8 @@ ## GeoPoint.(constructor) +Constructs a new instance of the `GeoPoint` class + Signature: ```typescript diff --git a/docs-exp/firestore_.geopoint.md b/docs-exp/firestore_.geopoint.md index bc24a5cbe54..8c4f8d0f02a 100644 --- a/docs-exp/firestore_.geopoint.md +++ b/docs-exp/firestore_.geopoint.md @@ -14,7 +14,7 @@ export class GeoPoint | Constructor | Modifiers | Description | | --- | --- | --- | -| [(constructor)(latitude, longitude)](./firestore_.geopoint._constructor_.md) | | | +| [(constructor)(latitude, longitude)](./firestore_.geopoint._constructor_.md) | | Constructs a new instance of the GeoPoint class | ## Properties diff --git a/docs-exp/firestore_.md b/docs-exp/firestore_.md index 6934c8a9a97..49ee4723d29 100644 --- a/docs-exp/firestore_.md +++ b/docs-exp/firestore_.md @@ -33,18 +33,18 @@ | [arrayRemove(elements)](./firestore_.arrayremove.md) | | | [arrayUnion(elements)](./firestore_.arrayunion.md) | | | [clearIndexedDbPersistence(firestore)](./firestore_.clearindexeddbpersistence.md) | | -| [collection(firestore, collectionPath)](./firestore_.collection.md) | | -| [collection(reference, collectionPath)](./firestore_.collection_1.md) | | -| [collection(reference, collectionPath)](./firestore_.collection_2.md) | | +| [collection(firestore, path, pathComponents)](./firestore_.collection.md) | | +| [collection(reference, path, pathComponents)](./firestore_.collection_1.md) | | +| [collection(reference, path, pathComponents)](./firestore_.collection_2.md) | | | [collectionGroup(firestore, collectionId)](./firestore_.collectiongroup.md) | | | [deleteDoc(reference)](./firestore_.deletedoc.md) | | | [deleteField()](./firestore_.deletefield.md) | | | [disableNetwork(firestore)](./firestore_.disablenetwork.md) | | -| [doc(firestore, documentPath)](./firestore_.doc.md) | | -| [doc(reference, documentPath)](./firestore_.doc_1.md) | | -| [doc(reference, documentPath)](./firestore_.doc_2.md) | | +| [doc(firestore, path, pathComponents)](./firestore_.doc.md) | | +| [doc(reference, path, pathComponents)](./firestore_.doc_1.md) | | +| [doc(reference, path, pathComponents)](./firestore_.doc_2.md) | | | [documentId()](./firestore_.documentid.md) | | -| [enableIndexedDbPersistence(firestore)](./firestore_.enableindexeddbpersistence.md) | | +| [enableIndexedDbPersistence(firestore, persistenceSettings)](./firestore_.enableindexeddbpersistence.md) | | | [enableMultiTabIndexedDbPersistence(firestore)](./firestore_.enablemultitabindexeddbpersistence.md) | | | [enableNetwork(firestore)](./firestore_.enablenetwork.md) | | | [endAt(snapshot)](./firestore_.endat.md) | | @@ -101,6 +101,7 @@ | [DocumentData](./firestore_.documentdata.md) | | | [FirestoreDataConverter](./firestore_.firestoredataconverter.md) | | | [FirestoreError](./firestore_.firestoreerror.md) | | +| [PersistenceSettings](./firestore_.persistencesettings.md) | | | [Settings](./firestore_.settings.md) | | | [SnapshotListenOptions](./firestore_.snapshotlistenoptions.md) | | | [SnapshotOptions](./firestore_.snapshotoptions.md) | | diff --git a/docs-exp/firestore_.persistencesettings.forceownership.md b/docs-exp/firestore_.persistencesettings.forceownership.md new file mode 100644 index 00000000000..ce5e770094a --- /dev/null +++ b/docs-exp/firestore_.persistencesettings.forceownership.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@firebase/firestore](./firestore.md) > [/](./firestore_.md) > [PersistenceSettings](./firestore_.persistencesettings.md) > [forceOwnership](./firestore_.persistencesettings.forceownership.md) + +## PersistenceSettings.forceOwnership property + +Signature: + +```typescript +forceOwnership?: boolean; +``` diff --git a/docs-exp/firestore_.persistencesettings.md b/docs-exp/firestore_.persistencesettings.md new file mode 100644 index 00000000000..3c08951ad78 --- /dev/null +++ b/docs-exp/firestore_.persistencesettings.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@firebase/firestore](./firestore.md) > [/](./firestore_.md) > [PersistenceSettings](./firestore_.persistencesettings.md) + +## PersistenceSettings interface + +Signature: + +```typescript +export interface PersistenceSettings +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [forceOwnership](./firestore_.persistencesettings.forceownership.md) | boolean | | + diff --git a/docs-exp/firestore_.query._constructor_.md b/docs-exp/firestore_.query._constructor_.md index ba6d9c296bf..ed6cd9a6546 100644 --- a/docs-exp/firestore_.query._constructor_.md +++ b/docs-exp/firestore_.query._constructor_.md @@ -4,6 +4,8 @@ ## Query.(constructor) +Constructs a new instance of the `Query` class + Signature: ```typescript diff --git a/docs-exp/firestore_.timestamp._constructor_.md b/docs-exp/firestore_.timestamp._constructor_.md index 876789f8215..48dedce89b0 100644 --- a/docs-exp/firestore_.timestamp._constructor_.md +++ b/docs-exp/firestore_.timestamp._constructor_.md @@ -4,6 +4,8 @@ ## Timestamp.(constructor) +Constructs a new instance of the `Timestamp` class + Signature: ```typescript diff --git a/docs-exp/firestore_.timestamp.md b/docs-exp/firestore_.timestamp.md index 96e0de5ffa0..a8ae331d985 100644 --- a/docs-exp/firestore_.timestamp.md +++ b/docs-exp/firestore_.timestamp.md @@ -14,7 +14,7 @@ export class Timestamp | Constructor | Modifiers | Description | | --- | --- | --- | -| [(constructor)(seconds, nanoseconds)](./firestore_.timestamp._constructor_.md) | | | +| [(constructor)(seconds, nanoseconds)](./firestore_.timestamp._constructor_.md) | | Constructs a new instance of the Timestamp class | ## Properties diff --git a/docs-exp/firestore_.wherefilterop.md b/docs-exp/firestore_.wherefilterop.md index bd8696cd955..135a2826179 100644 --- a/docs-exp/firestore_.wherefilterop.md +++ b/docs-exp/firestore_.wherefilterop.md @@ -11,9 +11,11 @@ export type WhereFilterOp = | '<' | '<=' | '==' + | '!=' | '>=' | '>' | 'array-contains' | 'in' - | 'array-contains-any'; + | 'array-contains-any' + | 'not-in'; ``` diff --git a/docs-exp/firestore_lite.collection.md b/docs-exp/firestore_lite.collection.md index d482c080904..e10a26ea76f 100644 --- a/docs-exp/firestore_lite.collection.md +++ b/docs-exp/firestore_lite.collection.md @@ -9,7 +9,8 @@ ```typescript export function collection( firestore: FirebaseFirestore, - collectionPath: string + path: string, + ...pathComponents: string[] ): CollectionReference; ``` @@ -18,7 +19,8 @@ export function collection( | Parameter | Type | Description | | --- | --- | --- | | firestore | [FirebaseFirestore](./firestore_lite.firebasefirestore.md) | | -| collectionPath | string | | +| path | string | | +| pathComponents | string\[\] | | Returns: diff --git a/docs-exp/firestore_lite.collection_1.md b/docs-exp/firestore_lite.collection_1.md index 29911512f75..ad7d6f89c1c 100644 --- a/docs-exp/firestore_lite.collection_1.md +++ b/docs-exp/firestore_lite.collection_1.md @@ -9,7 +9,8 @@ ```typescript export function collection( reference: CollectionReference, - collectionPath: string + path: string, + ...pathComponents: string[] ): CollectionReference; ``` @@ -18,7 +19,8 @@ export function collection( | Parameter | Type | Description | | --- | --- | --- | | reference | [CollectionReference](./firestore_lite.collectionreference.md)<unknown> | | -| collectionPath | string | | +| path | string | | +| pathComponents | string\[\] | | Returns: diff --git a/docs-exp/firestore_lite.collection_2.md b/docs-exp/firestore_lite.collection_2.md index fd5a2cee1e3..5fe13e26d7c 100644 --- a/docs-exp/firestore_lite.collection_2.md +++ b/docs-exp/firestore_lite.collection_2.md @@ -9,7 +9,8 @@ ```typescript export function collection( reference: DocumentReference, - collectionPath: string + path: string, + ...pathComponents: string[] ): CollectionReference; ``` @@ -18,7 +19,8 @@ export function collection( | Parameter | Type | Description | | --- | --- | --- | | reference | [DocumentReference](./firestore_lite.documentreference.md) | | -| collectionPath | string | | +| path | string | | +| pathComponents | string\[\] | | Returns: diff --git a/docs-exp/firestore_lite.collectionreference.doc.md b/docs-exp/firestore_lite.collectionreference.doc.md deleted file mode 100644 index 277c4ba35fd..00000000000 --- a/docs-exp/firestore_lite.collectionreference.doc.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/firestore](./firestore.md) > [lite](./firestore_lite.md) > [CollectionReference](./firestore_lite.collectionreference.md) > [doc](./firestore_lite.collectionreference.doc.md) - -## CollectionReference.doc() method - -Signature: - -```typescript -doc(documentPath?: string): DocumentReference; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| documentPath | string | | - -Returns: - -[DocumentReference](./firestore_lite.documentreference.md)<T> - diff --git a/docs-exp/firestore_lite.collectionreference.md b/docs-exp/firestore_lite.collectionreference.md index 77c5bf1c68f..60c59acd2b8 100644 --- a/docs-exp/firestore_lite.collectionreference.md +++ b/docs-exp/firestore_lite.collectionreference.md @@ -24,6 +24,5 @@ export class CollectionReference extends Query | Method | Modifiers | Description | | --- | --- | --- | -| [doc(documentPath)](./firestore_lite.collectionreference.doc.md) | | | | [withConverter(converter)](./firestore_lite.collectionreference.withconverter.md) | | | diff --git a/docs-exp/firestore_lite.doc.md b/docs-exp/firestore_lite.doc.md index a53b7377a7b..bdcc7890751 100644 --- a/docs-exp/firestore_lite.doc.md +++ b/docs-exp/firestore_lite.doc.md @@ -9,7 +9,8 @@ ```typescript export function doc( firestore: FirebaseFirestore, - documentPath: string + path: string, + ...pathComponents: string[] ): DocumentReference; ``` @@ -18,7 +19,8 @@ export function doc( | Parameter | Type | Description | | --- | --- | --- | | firestore | [FirebaseFirestore](./firestore_lite.firebasefirestore.md) | | -| documentPath | string | | +| path | string | | +| pathComponents | string\[\] | | Returns: diff --git a/docs-exp/firestore_lite.doc_1.md b/docs-exp/firestore_lite.doc_1.md index 2dc484f0aee..54d5d8c50d5 100644 --- a/docs-exp/firestore_lite.doc_1.md +++ b/docs-exp/firestore_lite.doc_1.md @@ -9,7 +9,8 @@ ```typescript export function doc( reference: CollectionReference, - documentPath?: string + path?: string, + ...pathComponents: string[] ): DocumentReference; ``` @@ -18,7 +19,8 @@ export function doc( | Parameter | Type | Description | | --- | --- | --- | | reference | [CollectionReference](./firestore_lite.collectionreference.md)<T> | | -| documentPath | string | | +| path | string | | +| pathComponents | string\[\] | | Returns: diff --git a/docs-exp/firestore_lite.doc_2.md b/docs-exp/firestore_lite.doc_2.md index 8da69a9c466..7f911ca7fac 100644 --- a/docs-exp/firestore_lite.doc_2.md +++ b/docs-exp/firestore_lite.doc_2.md @@ -9,7 +9,8 @@ ```typescript export function doc( reference: DocumentReference, - documentPath: string + path: string, + ...pathComponents: string[] ): DocumentReference; ``` @@ -18,7 +19,8 @@ export function doc( | Parameter | Type | Description | | --- | --- | --- | | reference | [DocumentReference](./firestore_lite.documentreference.md)<unknown> | | -| documentPath | string | | +| path | string | | +| pathComponents | string\[\] | | Returns: diff --git a/docs-exp/firestore_lite.documentreference.collection.md b/docs-exp/firestore_lite.documentreference.collection.md deleted file mode 100644 index 9bbc06863e5..00000000000 --- a/docs-exp/firestore_lite.documentreference.collection.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@firebase/firestore](./firestore.md) > [lite](./firestore_lite.md) > [DocumentReference](./firestore_lite.documentreference.md) > [collection](./firestore_lite.documentreference.collection.md) - -## DocumentReference.collection() method - -Signature: - -```typescript -collection(collectionPath: string): CollectionReference; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| collectionPath | string | | - -Returns: - -[CollectionReference](./firestore_lite.collectionreference.md)<[DocumentData](./firestore_lite.documentdata.md)> - diff --git a/docs-exp/firestore_lite.documentreference.md b/docs-exp/firestore_lite.documentreference.md index 41a407e5c8a..b58f0acedbe 100644 --- a/docs-exp/firestore_lite.documentreference.md +++ b/docs-exp/firestore_lite.documentreference.md @@ -25,6 +25,5 @@ export class DocumentReference | Method | Modifiers | Description | | --- | --- | --- | -| [collection(collectionPath)](./firestore_lite.documentreference.collection.md) | | | | [withConverter(converter)](./firestore_lite.documentreference.withconverter.md) | | | diff --git a/docs-exp/firestore_lite.fieldpath._constructor_.md b/docs-exp/firestore_lite.fieldpath._constructor_.md index aee1913d910..bc81513df35 100644 --- a/docs-exp/firestore_lite.fieldpath._constructor_.md +++ b/docs-exp/firestore_lite.fieldpath._constructor_.md @@ -4,6 +4,8 @@ ## FieldPath.(constructor) +Constructs a new instance of the `FieldPath` class + Signature: ```typescript diff --git a/docs-exp/firestore_lite.fieldpath.md b/docs-exp/firestore_lite.fieldpath.md index 91c6ec29fa2..57dae3dcd31 100644 --- a/docs-exp/firestore_lite.fieldpath.md +++ b/docs-exp/firestore_lite.fieldpath.md @@ -14,7 +14,7 @@ export class FieldPath | Constructor | Modifiers | Description | | --- | --- | --- | -| [(constructor)(fieldNames)](./firestore_lite.fieldpath._constructor_.md) | | | +| [(constructor)(fieldNames)](./firestore_lite.fieldpath._constructor_.md) | | Constructs a new instance of the FieldPath class | ## Methods diff --git a/docs-exp/firestore_lite.geopoint._constructor_.md b/docs-exp/firestore_lite.geopoint._constructor_.md index 28d61d1288c..993c771707a 100644 --- a/docs-exp/firestore_lite.geopoint._constructor_.md +++ b/docs-exp/firestore_lite.geopoint._constructor_.md @@ -4,6 +4,8 @@ ## GeoPoint.(constructor) +Constructs a new instance of the `GeoPoint` class + Signature: ```typescript diff --git a/docs-exp/firestore_lite.geopoint.md b/docs-exp/firestore_lite.geopoint.md index c8f82dfac92..acda0dc9d97 100644 --- a/docs-exp/firestore_lite.geopoint.md +++ b/docs-exp/firestore_lite.geopoint.md @@ -14,7 +14,7 @@ export class GeoPoint | Constructor | Modifiers | Description | | --- | --- | --- | -| [(constructor)(latitude, longitude)](./firestore_lite.geopoint._constructor_.md) | | | +| [(constructor)(latitude, longitude)](./firestore_lite.geopoint._constructor_.md) | | Constructs a new instance of the GeoPoint class | ## Properties diff --git a/docs-exp/firestore_lite.md b/docs-exp/firestore_lite.md index 5e683a5d9a8..e4342f01114 100644 --- a/docs-exp/firestore_lite.md +++ b/docs-exp/firestore_lite.md @@ -31,15 +31,15 @@ | [addDoc(reference, data)](./firestore_lite.adddoc.md) | | | [arrayRemove(elements)](./firestore_lite.arrayremove.md) | | | [arrayUnion(elements)](./firestore_lite.arrayunion.md) | | -| [collection(firestore, collectionPath)](./firestore_lite.collection.md) | | -| [collection(reference, collectionPath)](./firestore_lite.collection_1.md) | | -| [collection(reference, collectionPath)](./firestore_lite.collection_2.md) | | +| [collection(firestore, path, pathComponents)](./firestore_lite.collection.md) | | +| [collection(reference, path, pathComponents)](./firestore_lite.collection_1.md) | | +| [collection(reference, path, pathComponents)](./firestore_lite.collection_2.md) | | | [collectionGroup(firestore, collectionId)](./firestore_lite.collectiongroup.md) | | | [deleteDoc(reference)](./firestore_lite.deletedoc.md) | | | [deleteField()](./firestore_lite.deletefield.md) | | -| [doc(firestore, documentPath)](./firestore_lite.doc.md) | | -| [doc(reference, documentPath)](./firestore_lite.doc_1.md) | | -| [doc(reference, documentPath)](./firestore_lite.doc_2.md) | | +| [doc(firestore, path, pathComponents)](./firestore_lite.doc.md) | | +| [doc(reference, path, pathComponents)](./firestore_lite.doc_1.md) | | +| [doc(reference, path, pathComponents)](./firestore_lite.doc_2.md) | | | [documentId()](./firestore_lite.documentid.md) | | | [endAt(snapshot)](./firestore_lite.endat.md) | | | [endAt(fieldValues)](./firestore_lite.endat_1.md) | | diff --git a/docs-exp/firestore_lite.query._constructor_.md b/docs-exp/firestore_lite.query._constructor_.md index 2e9b0b75b75..14db3945115 100644 --- a/docs-exp/firestore_lite.query._constructor_.md +++ b/docs-exp/firestore_lite.query._constructor_.md @@ -4,6 +4,8 @@ ## Query.(constructor) +Constructs a new instance of the `Query` class + Signature: ```typescript diff --git a/docs-exp/firestore_lite.timestamp._constructor_.md b/docs-exp/firestore_lite.timestamp._constructor_.md index 38a9074a800..e7e93937789 100644 --- a/docs-exp/firestore_lite.timestamp._constructor_.md +++ b/docs-exp/firestore_lite.timestamp._constructor_.md @@ -4,6 +4,8 @@ ## Timestamp.(constructor) +Constructs a new instance of the `Timestamp` class + Signature: ```typescript diff --git a/docs-exp/firestore_lite.timestamp.md b/docs-exp/firestore_lite.timestamp.md index 5ff29ab6959..6812715b5ff 100644 --- a/docs-exp/firestore_lite.timestamp.md +++ b/docs-exp/firestore_lite.timestamp.md @@ -14,7 +14,7 @@ export class Timestamp | Constructor | Modifiers | Description | | --- | --- | --- | -| [(constructor)(seconds, nanoseconds)](./firestore_lite.timestamp._constructor_.md) | | | +| [(constructor)(seconds, nanoseconds)](./firestore_lite.timestamp._constructor_.md) | | Constructs a new instance of the Timestamp class | ## Properties diff --git a/docs-exp/firestore_lite.wherefilterop.md b/docs-exp/firestore_lite.wherefilterop.md index 907dca9e45d..4adf2be9398 100644 --- a/docs-exp/firestore_lite.wherefilterop.md +++ b/docs-exp/firestore_lite.wherefilterop.md @@ -11,9 +11,11 @@ export type WhereFilterOp = | '<' | '<=' | '==' + | '!=' | '>=' | '>' | 'array-contains' | 'in' - | 'array-contains-any'; + | 'array-contains-any' + | 'not-in'; ``` diff --git a/docs-exp/functions.md b/docs-exp/functions.md index 83f644746ad..42c444d2c5c 100644 --- a/docs-exp/functions.md +++ b/docs-exp/functions.md @@ -10,5 +10,5 @@ | --- | --- | | [getFunctions(app, regionOrCustomDomain)](./functions.getfunctions.md) | Returns a Functions instance for the given app. | | [httpsCallable(functionsInstance, name, options)](./functions.httpscallable.md) | Returns a reference to the callable https trigger with the given name. | -| [useFunctionsEmulator(functionsInstance, origin)](./functions.usefunctionsemulator.md) | Changes this instance to point to a Cloud Functions emulator running locally. See https://firebase.google.com/docs/functions/local-emulator | +| [useFunctionsEmulator(functionsInstance, host, port)](./functions.usefunctionsemulator.md) | Modify this instance to communicate with the Cloud Functions emulator.Note: this must be called before this instance has been used to do any operations. | diff --git a/docs-exp/functions.usefunctionsemulator.md b/docs-exp/functions.usefunctionsemulator.md index b7798ce9a13..c2d6780f97f 100644 --- a/docs-exp/functions.usefunctionsemulator.md +++ b/docs-exp/functions.usefunctionsemulator.md @@ -4,12 +4,14 @@ ## useFunctionsEmulator() function -Changes this instance to point to a Cloud Functions emulator running locally. See https://firebase.google.com/docs/functions/local-emulator +Modify this instance to communicate with the Cloud Functions emulator. + +Note: this must be called before this instance has been used to do any operations. Signature: ```typescript -export declare function useFunctionsEmulator(functionsInstance: Functions, origin: string): void; +export declare function useFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void; ``` ## Parameters @@ -17,7 +19,8 @@ export declare function useFunctionsEmulator(functionsInstance: Functions, origi | Parameter | Type | Description | | --- | --- | --- | | functionsInstance | [Functions](./functions-types.functions.md) | | -| origin | string | The origin of the local emulator, such as "http://localhost:5005". | +| host | string | The emulator host (ex: localhost) | +| port | number | The emulator port (ex: 5001) | Returns: diff --git a/docs-exp/index.md b/docs-exp/index.md index 528eb181002..10679e82cf2 100644 --- a/docs-exp/index.md +++ b/docs-exp/index.md @@ -12,6 +12,7 @@ | [@firebase/app-types](./app-types.md) | | | [@firebase/auth](./auth.md) | | | [@firebase/auth-types](./auth-types.md) | | +| [@firebase/firestore](./firestore.md) | | | [@firebase/functions](./functions.md) | | | [@firebase/functions-types](./functions-types.md) | | | [@firebase/installations](./installations.md) | | diff --git a/package.json b/package.json index cf5dc36aa85..2a5043cb372 100644 --- a/package.json +++ b/package.json @@ -49,7 +49,7 @@ "lint": "lerna run --scope @firebase/* --scope rxfire lint", "size-report": "ts-node-script scripts/size_report/report_binary_size.ts", "modular-export-size-report": "ts-node-script scripts/size_report/report_modular_export_binary_size.ts", - "api-report": "lerna run --scope @firebase/*-exp api-report", + "api-report": "lerna run --scope @firebase/*-exp --scope @firebase/firestore api-report", "docgen:exp": "ts-node-script scripts/exp/docgen.ts", "postinstall": "yarn --cwd repo-scripts/changelog-generator build", "sa": "ts-node-script repo-scripts/size-analysis/cli.ts" diff --git a/packages/firestore/api-extractor.json b/packages/firestore/api-extractor.json new file mode 100644 index 00000000000..11e387714ca --- /dev/null +++ b/packages/firestore/api-extractor.json @@ -0,0 +1,11 @@ +{ + "extends": "../../config/api-extractor.json", + // Point it to your entry point d.ts file. + "mainEntryPointFilePath": "/exp-types/index.d.ts", + "additionalEntryPoints": [ + { + "modulePath": "lite", + "filePath": "lite-types/index.d.ts" + } + ] +} \ No newline at end of file diff --git a/packages/firestore/package.json b/packages/firestore/package.json index f757bb58b92..ba8398a0208 100644 --- a/packages/firestore/package.json +++ b/packages/firestore/package.json @@ -46,7 +46,10 @@ "test:node:persistence:prod": "node ./scripts/run-tests.js --main=index.node.ts --persistence 'test/{,!(browser)/**/}*.test.ts'", "test:travis": "ts-node --compiler-options='{\"module\":\"commonjs\"}' ../../scripts/emulator-testing/firestore-test-runner.ts", "test:minified": "(cd ../../integration/firestore ; yarn test)", - "prepare": "yarn build:release" + "prepare": "yarn build:release", + "api-report": "api-extractor run --local --verbose", + "predoc": "node ../../scripts/exp/remove-exp.js temp", + "doc": "api-documenter markdown --input temp --output docs" }, "main": "dist/index.node.cjs.js", "main-esm2017": "dist/index.node.esm2017.js", From 8922f543c5496a00aa328b35e5392e4f54c44344 Mon Sep 17 00:00:00 2001 From: Sebastian Schmidt Date: Tue, 27 Oct 2020 16:24:12 -0700 Subject: [PATCH 043/624] Using Compat-Layer for IndexedDB persistence (v2) (#3974) --- packages/firestore/exp/dependencies.json | 839 +++++++++--------- packages/firestore/exp/src/api/components.ts | 205 ----- packages/firestore/exp/src/api/database.ts | 199 +---- packages/firestore/exp/src/api/reference.ts | 57 +- packages/firestore/exp/src/api/transaction.ts | 7 +- packages/firestore/exp/src/api/write_batch.ts | 3 +- packages/firestore/lite/dependencies.json | 423 ++++----- packages/firestore/lite/src/api/components.ts | 16 +- packages/firestore/lite/src/api/database.ts | 130 ++- packages/firestore/src/api/database.ts | 369 +++----- .../firestore/src/core/firestore_client.ts | 531 +++++------ .../src/local/lru_garbage_collector.ts | 17 +- packages/firestore/src/util/async_queue.ts | 3 +- .../integration/api_internal/database.test.ts | 2 +- .../test/integration/util/helpers.ts | 10 +- .../firestore/test/unit/api/database.test.ts | 44 +- packages/firestore/test/util/api_helpers.ts | 23 +- 17 files changed, 1195 insertions(+), 1683 deletions(-) delete mode 100644 packages/firestore/exp/src/api/components.ts diff --git a/packages/firestore/exp/dependencies.json b/packages/firestore/exp/dependencies.json index 95fbbe8d650..01e13786a0d 100644 --- a/packages/firestore/exp/dependencies.json +++ b/packages/firestore/exp/dependencies.json @@ -4,6 +4,7 @@ "functions": [ "argToString", "binaryStringFromUint8Array", + "configureFirestore", "decodeBase64", "encodeBase64", "fail", @@ -17,8 +18,8 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", "uint8ArrayFromBinaryString", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -34,18 +35,21 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User" ], "variables": [] }, - "sizeInBytes": 18596 + "sizeInBytes": 20394 }, "CollectionReference": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "fail", "formatJSON", "getMessageOrStack", @@ -58,7 +62,7 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -76,7 +80,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "Query", "QueryImpl", @@ -86,12 +92,13 @@ ], "variables": [] }, - "sizeInBytes": 21609 + "sizeInBytes": 23411 }, "DocumentReference": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "fail", "formatJSON", "getMessageOrStack", @@ -104,7 +111,7 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -122,7 +129,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "Query", "QueryImpl", @@ -132,13 +141,14 @@ ], "variables": [] }, - "sizeInBytes": 21607 + "sizeInBytes": 23409 }, "DocumentSnapshot": { "dependencies": { "functions": [ "argToString", "binaryStringFromUint8Array", + "configureFirestore", "createError", "decodeBase64", "encodeBase64", @@ -148,15 +158,12 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "getLocalWriteTime", "getMessageOrStack", "getPreviousValue", "hardAssert", - "invalidClassError", "isIndexedDbTransactionError", - "isPlainObject", "isServerTimestamp", "isValidResourceName", "logDebug", @@ -165,20 +172,13 @@ "normalizeByteString", "normalizeNumber", "normalizeTimestamp", - "ordinal", "primitiveComparator", "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", - "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", - "validateType", - "valueDescription", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -202,7 +202,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "OAuthToken", "Query", @@ -218,32 +220,25 @@ ], "variables": [] }, - "sizeInBytes": 40021 + "sizeInBytes": 38662 }, "FieldPath": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "fail", "formatJSON", - "formatPlural", "getMessageOrStack", "hardAssert", "isIndexedDbTransactionError", - "isPlainObject", "logDebug", "logError", - "ordinal", "primitiveComparator", "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", - "tryGetCustomObjectType", - "validateArgType", - "validateNamedArrayAtLeastNumberOfElements", - "validateType", - "valueDescription", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -260,19 +255,22 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User", "_BaseFieldPath" ], "variables": [] }, - "sizeInBytes": 22777 + "sizeInBytes": 22332 }, "FieldValue": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "fail", "formatJSON", "getMessageOrStack", @@ -284,7 +282,7 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -299,18 +297,21 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User" ], "variables": [] }, - "sizeInBytes": 16808 + "sizeInBytes": 18606 }, "FirebaseFirestore": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "fail", "formatJSON", "getMessageOrStack", @@ -322,7 +323,7 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -336,38 +337,33 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User" ], "variables": [] }, - "sizeInBytes": 16766 + "sizeInBytes": 18564 }, "GeoPoint": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "fail", "formatJSON", - "formatPlural", "getMessageOrStack", "hardAssert", "isIndexedDbTransactionError", - "isPlainObject", "logDebug", "logError", - "ordinal", "primitiveComparator", "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", - "tryGetCustomObjectType", - "validateArgType", - "validateExactNumberOfArgs", - "validateType", - "valueDescription", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -381,19 +377,22 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "OAuthToken", "User" ], "variables": [] }, - "sizeInBytes": 19667 + "sizeInBytes": 19267 }, "Query": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "fail", "formatJSON", "getMessageOrStack", @@ -405,7 +404,7 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -419,19 +418,22 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "Query", "User" ], "variables": [] }, - "sizeInBytes": 16954 + "sizeInBytes": 18752 }, "QueryConstraint": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "fail", "formatJSON", "getMessageOrStack", @@ -443,7 +445,7 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -457,20 +459,23 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "QueryConstraint", "User" ], "variables": [] }, - "sizeInBytes": 16764 + "sizeInBytes": 18562 }, "QueryDocumentSnapshot": { "dependencies": { "functions": [ "argToString", "binaryStringFromUint8Array", + "configureFirestore", "createError", "decodeBase64", "encodeBase64", @@ -480,15 +485,12 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "getLocalWriteTime", "getMessageOrStack", "getPreviousValue", "hardAssert", - "invalidClassError", "isIndexedDbTransactionError", - "isPlainObject", "isServerTimestamp", "isValidResourceName", "logDebug", @@ -497,20 +499,13 @@ "normalizeByteString", "normalizeNumber", "normalizeTimestamp", - "ordinal", "primitiveComparator", "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", - "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", - "validateType", - "valueDescription", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -534,7 +529,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "OAuthToken", "Query", @@ -550,7 +547,7 @@ ], "variables": [] }, - "sizeInBytes": 40031 + "sizeInBytes": 38672 }, "QuerySnapshot": { "dependencies": { @@ -558,6 +555,7 @@ "argToString", "binaryStringFromUint8Array", "changesFromSnapshot", + "configureFirestore", "createError", "decodeBase64", "encodeBase64", @@ -567,15 +565,12 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "getLocalWriteTime", "getMessageOrStack", "getPreviousValue", "hardAssert", - "invalidClassError", "isIndexedDbTransactionError", - "isPlainObject", "isServerTimestamp", "isValidResourceName", "logDebug", @@ -584,21 +579,14 @@ "normalizeByteString", "normalizeNumber", "normalizeTimestamp", - "ordinal", "primitiveComparator", "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", "resultChangeType", - "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", - "validateType", - "valueDescription", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -622,7 +610,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "OAuthToken", "Query", @@ -640,12 +630,13 @@ ], "variables": [] }, - "sizeInBytes": 42663 + "sizeInBytes": 41314 }, "SnapshotMetadata": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "fail", "formatJSON", "getMessageOrStack", @@ -657,7 +648,7 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -671,19 +662,22 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "SnapshotMetadata", "User" ], "variables": [] }, - "sizeInBytes": 16973 + "sizeInBytes": 18771 }, "Timestamp": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "fail", "formatJSON", "getMessageOrStack", @@ -695,7 +689,7 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -709,14 +703,16 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "Timestamp", "User" ], "variables": [] }, - "sizeInBytes": 18359 + "sizeInBytes": 20157 }, "Transaction": { "dependencies": { @@ -726,6 +722,7 @@ "arrayEquals", "binaryStringFromUint8Array", "blobEquals", + "configureFirestore", "createError", "decodeBase64", "encodeBase64", @@ -737,7 +734,6 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fullyQualifiedPrefixPath", "geoPointEquals", @@ -745,7 +741,6 @@ "getMessageOrStack", "getPreviousValue", "hardAssert", - "invalidClassError", "isEmpty", "isIndexedDbTransactionError", "isMapValue", @@ -767,7 +762,6 @@ "numberEquals", "objectEquals", "objectSize", - "ordinal", "parseArray", "parseData", "parseObject", @@ -780,7 +774,6 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", "timestampEquals", "toBytes", "toDouble", @@ -791,12 +784,9 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validatePlainObject", "validateReference", - "validateType", "valueDescription", "valueEquals", "wrapInUserErrorIfRecoverable" @@ -828,7 +818,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "JsonProtoSerializer", "MaybeDocument", @@ -861,7 +853,7 @@ ], "variables": [] }, - "sizeInBytes": 63765 + "sizeInBytes": 63423 }, "WriteBatch": { "dependencies": { @@ -871,6 +863,7 @@ "arrayEquals", "binaryStringFromUint8Array", "blobEquals", + "configureFirestore", "createError", "decodeBase64", "encodeBase64", @@ -881,14 +874,12 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fullyQualifiedPrefixPath", "geoPointEquals", "getLocalWriteTime", "getMessageOrStack", "hardAssert", - "invalidClassError", "isEmpty", "isIndexedDbTransactionError", "isMapValue", @@ -908,7 +899,6 @@ "numberEquals", "objectEquals", "objectSize", - "ordinal", "parseArray", "parseData", "parseObject", @@ -921,7 +911,6 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", "timestampEquals", "toBytes", "toDouble", @@ -932,12 +921,9 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validatePlainObject", "validateReference", - "validateType", "valueDescription", "valueEquals", "wrapInUserErrorIfRecoverable" @@ -964,7 +950,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "JsonProtoSerializer", "Mutation", @@ -988,7 +976,7 @@ ], "variables": [] }, - "sizeInBytes": 54009 + "sizeInBytes": 53821 }, "addDoc": { "dependencies": { @@ -1050,6 +1038,7 @@ "compareReferences", "compareTimestamps", "computeTransformOperationBaseValue", + "configureFirestore", "createError", "createMetadata", "debugCast", @@ -1064,6 +1053,9 @@ "emitNewSnapsAndNotifyLocalStore", "enableNetworkInternal", "encodeBase64", + "ensureFirestoreConfigured", + "ensureOfflineComponents", + "ensureOnlineComponents", "ensureWriteCallbacks", "ensureWriteStream", "errorMessage", @@ -1079,9 +1071,9 @@ "fieldTransformEquals", "fillWritePipeline", "filterEquals", + "firestoreClientWrite", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fromTimestamp", "fromVersion", @@ -1096,8 +1088,6 @@ "getLocalWriteTime", "getLogLevel", "getMessageOrStack", - "getOfflineComponentProvider", - "getOnlineComponentProvider", "getPostMutationVersion", "getSyncEngine", "handleUserChange", @@ -1106,7 +1096,6 @@ "hasLimitToFirst", "hasLimitToLast", "ignoreIfPrimaryLeaseLoss", - "invalidClassError", "isArray", "isCollectionGroupQuery", "isDocumentQuery", @@ -1140,6 +1129,7 @@ "newDatastore", "newEventManager", "newLocalStore", + "newMemoryRemoteDocumentCache", "newPersistentWriteStream", "newQueryComparator", "newQueryForPath", @@ -1163,7 +1153,6 @@ "onWriteStreamClose", "onWriteStreamOpen", "orderByEquals", - "ordinal", "parseArray", "parseData", "parseObject", @@ -1193,7 +1182,6 @@ "remoteStoreHandleCredentialChange", "remoteStoreShutdown", "removeComponents", - "removeComponents$1", "requireDocument", "restartNetwork", "serverTimestamp", @@ -1231,13 +1219,10 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", "validateDocumentPath", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validateNonEmptyArgument", "validatePlainObject", - "validateType", "valueCompare", "valueDescription", "valueEquals", @@ -1274,7 +1259,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "GrpcConnection", "IndexFreeQueryEngine", @@ -1293,7 +1280,8 @@ "MemoryMutationQueue", "MemoryOfflineComponentProvider", "MemoryPersistence", - "MemoryRemoteDocumentCache", + "MemoryRemoteDocumentCacheImpl", + "MemoryRemoteDocumentChangeBuffer", "MemorySharedClientState", "MemoryTargetCache", "MemoryTransaction", @@ -1348,7 +1336,7 @@ ], "variables": [] }, - "sizeInBytes": 167169 + "sizeInBytes": 167263 }, "arrayRemove": { "dependencies": { @@ -1356,6 +1344,7 @@ "argToString", "arrayRemove", "binaryStringFromUint8Array", + "configureFirestore", "createError", "createSentinelChildContext", "decodeBase64", @@ -1363,7 +1352,6 @@ "fail", "forEach", "formatJSON", - "formatPlural", "fullyQualifiedPrefixPath", "getMessageOrStack", "hardAssert", @@ -1376,7 +1364,6 @@ "logDebug", "logError", "looksLikeJsonObject", - "ordinal", "parseArray", "parseData", "parseObject", @@ -1386,7 +1373,6 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", "toBytes", "toDouble", "toInteger", @@ -1395,11 +1381,8 @@ "toTimestamp", "tryGetCustomObjectType", "uint8ArrayFromBinaryString", - "validateArgType", - "validateAtLeastNumberOfArgs", - "validateExactNumberOfArgs", + "validateIsNotUsedTogether", "validatePlainObject", - "validateType", "valueDescription", "wrapInUserErrorIfRecoverable" ], @@ -1422,7 +1405,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "OAuthToken", "ParseContext", @@ -1434,7 +1419,7 @@ ], "variables": [] }, - "sizeInBytes": 35084 + "sizeInBytes": 35326 }, "arrayUnion": { "dependencies": { @@ -1442,6 +1427,7 @@ "argToString", "arrayUnion", "binaryStringFromUint8Array", + "configureFirestore", "createError", "createSentinelChildContext", "decodeBase64", @@ -1449,7 +1435,6 @@ "fail", "forEach", "formatJSON", - "formatPlural", "fullyQualifiedPrefixPath", "getMessageOrStack", "hardAssert", @@ -1462,7 +1447,6 @@ "logDebug", "logError", "looksLikeJsonObject", - "ordinal", "parseArray", "parseData", "parseObject", @@ -1472,7 +1456,6 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", "toBytes", "toDouble", "toInteger", @@ -1481,11 +1464,8 @@ "toTimestamp", "tryGetCustomObjectType", "uint8ArrayFromBinaryString", - "validateArgType", - "validateAtLeastNumberOfArgs", - "validateExactNumberOfArgs", + "validateIsNotUsedTogether", "validatePlainObject", - "validateType", "valueDescription", "wrapInUserErrorIfRecoverable" ], @@ -1508,7 +1488,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "OAuthToken", "ParseContext", @@ -1520,7 +1502,7 @@ ], "variables": [] }, - "sizeInBytes": 35076 + "sizeInBytes": 35319 }, "clearIndexedDbPersistence": { "dependencies": { @@ -1528,6 +1510,7 @@ "argToString", "checkForAndReportiOSError", "clearIndexedDbPersistence", + "configureFirestore", "fail", "formatJSON", "getMessageOrStack", @@ -1541,7 +1524,7 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable", "wrapRequest" ], @@ -1556,7 +1539,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "IndexedDbTransactionError", "IterationController", "OAuthToken", @@ -1568,13 +1553,14 @@ ], "variables": [] }, - "sizeInBytes": 29742 + "sizeInBytes": 31730 }, "collection": { "dependencies": { "functions": [ "argToString", "collection", + "configureFirestore", "fail", "formatJSON", "getMessageOrStack", @@ -1587,8 +1573,8 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", "validateCollectionPath", + "validateIsNotUsedTogether", "validateNonEmptyArgument", "wrapInUserErrorIfRecoverable" ], @@ -1607,7 +1593,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "Query", "QueryImpl", @@ -1617,13 +1605,14 @@ ], "variables": [] }, - "sizeInBytes": 22828 + "sizeInBytes": 24624 }, "collectionGroup": { "dependencies": { "functions": [ "argToString", "collectionGroup", + "configureFirestore", "fail", "formatJSON", "getMessageOrStack", @@ -1636,7 +1625,7 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", + "validateIsNotUsedTogether", "validateNonEmptyArgument", "wrapInUserErrorIfRecoverable" ], @@ -1652,7 +1641,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "Query", "QueryImpl", @@ -1661,7 +1652,7 @@ ], "variables": [] }, - "sizeInBytes": 20417 + "sizeInBytes": 22219 }, "deleteDoc": { "dependencies": { @@ -1721,6 +1712,7 @@ "compareReferences", "compareTimestamps", "computeTransformOperationBaseValue", + "configureFirestore", "createMetadata", "debugCast", "decodeBase64", @@ -1734,6 +1726,9 @@ "emitNewSnapsAndNotifyLocalStore", "enableNetworkInternal", "encodeBase64", + "ensureFirestoreConfigured", + "ensureOfflineComponents", + "ensureOnlineComponents", "ensureWriteCallbacks", "ensureWriteStream", "eventManagerOnOnlineStateChange", @@ -1746,6 +1741,7 @@ "fieldTransformEquals", "fillWritePipeline", "filterEquals", + "firestoreClientWrite", "forEach", "formatJSON", "fromTimestamp", @@ -1761,8 +1757,6 @@ "getLocalWriteTime", "getLogLevel", "getMessageOrStack", - "getOfflineComponentProvider", - "getOnlineComponentProvider", "getPostMutationVersion", "getSyncEngine", "handleUserChange", @@ -1800,6 +1794,7 @@ "newDatastore", "newEventManager", "newLocalStore", + "newMemoryRemoteDocumentCache", "newPersistentWriteStream", "newQueryComparator", "newRemoteStore", @@ -1844,7 +1839,6 @@ "remoteStoreHandleCredentialChange", "remoteStoreShutdown", "removeComponents", - "removeComponents$1", "requireDocument", "restartNetwork", "serverTimestamp", @@ -1877,9 +1871,12 @@ "transformObject", "transformOperationEquals", "triggerPendingWritesCallbacks", + "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", + "validateIsNotUsedTogether", "valueCompare", + "valueDescription", "valueEquals", "wrapInUserErrorIfRecoverable" ], @@ -1908,7 +1905,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GrpcConnection", "IndexFreeQueryEngine", "JsonProtoSerializer", @@ -1926,7 +1925,8 @@ "MemoryMutationQueue", "MemoryOfflineComponentProvider", "MemoryPersistence", - "MemoryRemoteDocumentCache", + "MemoryRemoteDocumentCacheImpl", + "MemoryRemoteDocumentChangeBuffer", "MemorySharedClientState", "MemoryTargetCache", "MemoryTransaction", @@ -1975,12 +1975,13 @@ ], "variables": [] }, - "sizeInBytes": 148806 + "sizeInBytes": 151734 }, "deleteField": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "deleteField", "fail", "formatJSON", @@ -1993,7 +1994,7 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -2009,13 +2010,15 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User" ], "variables": [] }, - "sizeInBytes": 17342 + "sizeInBytes": 19140 }, "disableNetwork": { "dependencies": { @@ -2068,6 +2071,7 @@ "compareReferences", "compareTimestamps", "computeTransformOperationBaseValue", + "configureFirestore", "createMetadata", "debugCast", "decodeBase64", @@ -2079,10 +2083,14 @@ "emitNewSnapsAndNotifyLocalStore", "enableNetworkInternal", "encodeBase64", + "ensureFirestoreConfigured", + "ensureOfflineComponents", + "ensureOnlineComponents", "eventManagerOnOnlineStateChange", "fail", "fieldTransformEquals", "filterEquals", + "firestoreClientDisableNetwork", "forEach", "formatJSON", "geoPointEquals", @@ -2091,8 +2099,6 @@ "getLocalWriteTime", "getLogLevel", "getMessageOrStack", - "getOfflineComponentProvider", - "getOnlineComponentProvider", "getPersistence", "getPostMutationVersion", "getRemoteStore", @@ -2126,6 +2132,7 @@ "newDatastore", "newEventManager", "newLocalStore", + "newMemoryRemoteDocumentCache", "newQueryComparator", "newRemoteStore", "newSerializer", @@ -2162,7 +2169,6 @@ "remoteStoreHandleCredentialChange", "remoteStoreShutdown", "removeComponents", - "removeComponents$1", "requireDocument", "restartNetwork", "serverTimestamp", @@ -2184,6 +2190,7 @@ "transformOperationEquals", "typeOrder", "uint8ArrayFromBinaryString", + "validateIsNotUsedTogether", "valueCompare", "valueEquals", "wrapInUserErrorIfRecoverable" @@ -2211,7 +2218,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GrpcConnection", "IndexFreeQueryEngine", "JsonProtoSerializer", @@ -2229,7 +2238,8 @@ "MemoryMutationQueue", "MemoryOfflineComponentProvider", "MemoryPersistence", - "MemoryRemoteDocumentCache", + "MemoryRemoteDocumentCacheImpl", + "MemoryRemoteDocumentChangeBuffer", "MemorySharedClientState", "MemoryTargetCache", "MemoryTransaction", @@ -2273,12 +2283,13 @@ ], "variables": [] }, - "sizeInBytes": 126383 + "sizeInBytes": 128311 }, "doc": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "doc", "fail", "formatJSON", @@ -2292,8 +2303,8 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", "validateDocumentPath", + "validateIsNotUsedTogether", "validateNonEmptyArgument", "wrapInUserErrorIfRecoverable" ], @@ -2312,7 +2323,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "Query", "QueryImpl", @@ -2322,33 +2335,26 @@ ], "variables": [] }, - "sizeInBytes": 22872 + "sizeInBytes": 24668 }, "documentId": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "documentId", "fail", "formatJSON", - "formatPlural", "getMessageOrStack", "hardAssert", "isIndexedDbTransactionError", - "isPlainObject", "logDebug", "logError", - "ordinal", "primitiveComparator", "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", - "tryGetCustomObjectType", - "validateArgType", - "validateNamedArrayAtLeastNumberOfElements", - "validateType", - "valueDescription", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -2365,14 +2371,16 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User", "_BaseFieldPath" ], "variables": [] }, - "sizeInBytes": 22827 + "sizeInBytes": 22382 }, "enableIndexedDbPersistence": { "dependencies": { @@ -2408,6 +2416,7 @@ "boundEquals", "bufferEntryComparator", "canAddToWritePipeline", + "canFallbackFromIndexedDbError", "canUseNetwork", "canonicalId", "canonifyArray", @@ -2436,6 +2445,7 @@ "compareReferences", "compareTimestamps", "computeTransformOperationBaseValue", + "configureFirestore", "createClientMetadataStore", "createDocumentGlobalStore", "createMetadata", @@ -2467,6 +2477,8 @@ "encodeResourcePath", "encodeSegment", "encodeSeparator", + "ensureFirestoreConfigured", + "ensureOfflineComponents", "ensureWriteCallbacks", "ensureWriteStream", "eventManagerOnOnlineStateChange", @@ -2518,7 +2530,6 @@ "getLocalWriteTime", "getLogLevel", "getMessageOrStack", - "getOfflineComponentProvider", "getPostMutationVersion", "getWindow", "globalTargetStore", @@ -2529,7 +2540,6 @@ "hasLimitToLast", "ignoreIfPrimaryLeaseLoss", "immediateSuccessor", - "indexedDbClearPersistence", "indexedDbStoragePrefix", "isArray", "isCollectionGroupQuery", @@ -2567,7 +2577,9 @@ "newConnectivityMonitor", "newDatastore", "newEventManager", + "newIndexedDbRemoteDocumentCache", "newLocalStore", + "newMemoryRemoteDocumentCache", "newPersistentWriteStream", "newQuery", "newQueryComparator", @@ -2611,12 +2623,12 @@ "rejectBatch", "rejectFailedWrite", "rejectOutstandingPendingWritesCallbacks", + "remoteDocumentCacheGetLastReadTime", "remoteDocumentsStore", "remoteStoreApplyPrimaryState", "remoteStoreHandleCredentialChange", "remoteStoreShutdown", "removeComponents", - "removeComponents$1", "removeMutationBatch", "requireDocument", "restartNetwork", @@ -2627,6 +2639,7 @@ "serverTransformResults", "setOfflineComponentProvider", "setOnlineComponentProvider", + "setPersistenceProviders", "shouldStartWriteStream", "sortsBeforeDocument", "startWriteStream", @@ -2675,6 +2688,7 @@ "typeOrder", "uint8ArrayFromBinaryString", "upgradeMutationBatchSchemaAndMigrateData", + "validateIsNotUsedTogether", "valueCompare", "valueEquals", "verifyNotInitialized", @@ -2727,7 +2741,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GrpcConnection", "InFilter", "IndexFreeQueryEngine", @@ -2736,7 +2752,8 @@ "IndexedDbMutationQueue", "IndexedDbOfflineComponentProvider", "IndexedDbPersistence", - "IndexedDbRemoteDocumentCache", + "IndexedDbRemoteDocumentCacheImpl", + "IndexedDbRemoteDocumentChangeBuffer", "IndexedDbTargetCache", "IndexedDbTransaction", "IndexedDbTransactionError", @@ -2763,7 +2780,8 @@ "MemoryMutationQueue", "MemoryOfflineComponentProvider", "MemoryPersistence", - "MemoryRemoteDocumentCache", + "MemoryRemoteDocumentCacheImpl", + "MemoryRemoteDocumentChangeBuffer", "MemorySharedClientState", "MemoryTargetCache", "MemoryTransaction", @@ -2819,7 +2837,7 @@ ], "variables": [] }, - "sizeInBytes": 235442 + "sizeInBytes": 239289 }, "enableMultiTabIndexedDbPersistence": { "dependencies": { @@ -2863,6 +2881,7 @@ "boundEquals", "bufferEntryComparator", "canAddToWritePipeline", + "canFallbackFromIndexedDbError", "canUseNetwork", "canonicalId", "canonifyArray", @@ -2893,6 +2912,7 @@ "compareReferences", "compareTimestamps", "computeTransformOperationBaseValue", + "configureFirestore", "createClientMetadataStore", "createDocumentGlobalStore", "createMetadata", @@ -2930,6 +2950,8 @@ "encodeResourcePath", "encodeSegment", "encodeSeparator", + "ensureFirestoreConfigured", + "ensureOfflineComponents", "ensureWatchCallbacks", "ensureWatchStream", "ensureWriteCallbacks", @@ -2996,7 +3018,6 @@ "getLogLevel", "getMessageOrStack", "getNewDocumentChanges", - "getOfflineComponentProvider", "getPostMutationVersion", "getRemoteKeysForTarget", "getWindow", @@ -3009,7 +3030,6 @@ "hasLimitToLast", "ignoreIfPrimaryLeaseLoss", "immediateSuccessor", - "indexedDbClearPersistence", "indexedDbStoragePrefix", "initializeViewAndComputeSnapshot", "isArray", @@ -3050,7 +3070,9 @@ "newConnectivityMonitor", "newDatastore", "newEventManager", + "newIndexedDbRemoteDocumentCache", "newLocalStore", + "newMemoryRemoteDocumentCache", "newPersistentWatchStream", "newPersistentWriteStream", "newQuery", @@ -3102,6 +3124,8 @@ "rejectListen", "rejectOutstandingPendingWritesCallbacks", "releaseTarget", + "remoteDocumentCacheGetLastReadTime", + "remoteDocumentCacheGetNewDocumentChanges", "remoteDocumentsStore", "remoteStoreApplyPrimaryState", "remoteStoreHandleCredentialChange", @@ -3111,7 +3135,6 @@ "removeAndCleanupTarget", "removeCachedMutationBatchMetadata", "removeComponents", - "removeComponents$1", "removeLimboTarget", "removeMutationBatch", "requireDocument", @@ -3126,6 +3149,7 @@ "serverTransformResults", "setOfflineComponentProvider", "setOnlineComponentProvider", + "setPersistenceProviders", "shouldPersistTargetData", "shouldStartWatchStream", "shouldStartWriteStream", @@ -3187,6 +3211,7 @@ "uint8ArrayFromBinaryString", "updateTrackedLimbos", "upgradeMutationBatchSchemaAndMigrateData", + "validateIsNotUsedTogether", "valueCompare", "valueEquals", "verifyNotInitialized", @@ -3246,7 +3271,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GrpcConnection", "InFilter", "IndexFreeQueryEngine", @@ -3255,7 +3282,8 @@ "IndexedDbMutationQueue", "IndexedDbOfflineComponentProvider", "IndexedDbPersistence", - "IndexedDbRemoteDocumentCache", + "IndexedDbRemoteDocumentCacheImpl", + "IndexedDbRemoteDocumentChangeBuffer", "IndexedDbTargetCache", "IndexedDbTransaction", "IndexedDbTransactionError", @@ -3283,7 +3311,8 @@ "MemoryMutationQueue", "MemoryOfflineComponentProvider", "MemoryPersistence", - "MemoryRemoteDocumentCache", + "MemoryRemoteDocumentCacheImpl", + "MemoryRemoteDocumentChangeBuffer", "MemorySharedClientState", "MemoryTargetCache", "MemoryTransaction", @@ -3355,7 +3384,7 @@ ], "variables": [] }, - "sizeInBytes": 303115 + "sizeInBytes": 307870 }, "enableNetwork": { "dependencies": { @@ -3408,6 +3437,7 @@ "compareReferences", "compareTimestamps", "computeTransformOperationBaseValue", + "configureFirestore", "createMetadata", "debugCast", "decodeBase64", @@ -3419,10 +3449,14 @@ "enableNetwork", "enableNetworkInternal", "encodeBase64", + "ensureFirestoreConfigured", + "ensureOfflineComponents", + "ensureOnlineComponents", "eventManagerOnOnlineStateChange", "fail", "fieldTransformEquals", "filterEquals", + "firestoreClientEnableNetwork", "forEach", "formatJSON", "geoPointEquals", @@ -3431,8 +3465,6 @@ "getLocalWriteTime", "getLogLevel", "getMessageOrStack", - "getOfflineComponentProvider", - "getOnlineComponentProvider", "getPersistence", "getPostMutationVersion", "getRemoteStore", @@ -3466,6 +3498,7 @@ "newDatastore", "newEventManager", "newLocalStore", + "newMemoryRemoteDocumentCache", "newQueryComparator", "newRemoteStore", "newSerializer", @@ -3502,7 +3535,6 @@ "remoteStoreHandleCredentialChange", "remoteStoreShutdown", "removeComponents", - "removeComponents$1", "requireDocument", "restartNetwork", "serverTimestamp", @@ -3524,6 +3556,7 @@ "transformOperationEquals", "typeOrder", "uint8ArrayFromBinaryString", + "validateIsNotUsedTogether", "valueCompare", "valueEquals", "wrapInUserErrorIfRecoverable" @@ -3551,7 +3584,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GrpcConnection", "IndexFreeQueryEngine", "JsonProtoSerializer", @@ -3569,7 +3604,8 @@ "MemoryMutationQueue", "MemoryOfflineComponentProvider", "MemoryPersistence", - "MemoryRemoteDocumentCache", + "MemoryRemoteDocumentCacheImpl", + "MemoryRemoteDocumentChangeBuffer", "MemorySharedClientState", "MemoryTargetCache", "MemoryTransaction", @@ -3613,13 +3649,14 @@ ], "variables": [] }, - "sizeInBytes": 126325 + "sizeInBytes": 128251 }, "endAt": { "dependencies": { "functions": [ "argToString", "binaryStringFromUint8Array", + "configureFirestore", "createError", "debugCast", "decodeBase64", @@ -3631,7 +3668,6 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fullyQualifiedPrefixPath", "getFirstOrderByField", @@ -3640,7 +3676,6 @@ "getMessageOrStack", "getPreviousValue", "hardAssert", - "invalidClassError", "isCollectionGroupQuery", "isEmpty", "isIndexedDbTransactionError", @@ -3662,7 +3697,6 @@ "normalizeByteString", "normalizeNumber", "normalizeTimestamp", - "ordinal", "parseArray", "parseData", "parseObject", @@ -3676,7 +3710,6 @@ "refValue", "registerFirestore", "removeComponents", - "removeComponents$1", "toBytes", "toDouble", "toInteger", @@ -3686,11 +3719,8 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validatePlainObject", - "validateType", "valueDescription", "wrapInUserErrorIfRecoverable" ], @@ -3717,7 +3747,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "JsonProtoSerializer", "OAuthToken", @@ -3738,13 +3770,14 @@ ], "variables": [] }, - "sizeInBytes": 52360 + "sizeInBytes": 51952 }, "endBefore": { "dependencies": { "functions": [ "argToString", "binaryStringFromUint8Array", + "configureFirestore", "createError", "debugCast", "decodeBase64", @@ -3756,7 +3789,6 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fullyQualifiedPrefixPath", "getFirstOrderByField", @@ -3765,7 +3797,6 @@ "getMessageOrStack", "getPreviousValue", "hardAssert", - "invalidClassError", "isCollectionGroupQuery", "isEmpty", "isIndexedDbTransactionError", @@ -3787,7 +3818,6 @@ "normalizeByteString", "normalizeNumber", "normalizeTimestamp", - "ordinal", "parseArray", "parseData", "parseObject", @@ -3801,7 +3831,6 @@ "refValue", "registerFirestore", "removeComponents", - "removeComponents$1", "toBytes", "toDouble", "toInteger", @@ -3811,11 +3840,8 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validatePlainObject", - "validateType", "valueDescription", "wrapInUserErrorIfRecoverable" ], @@ -3842,7 +3868,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "JsonProtoSerializer", "OAuthToken", @@ -3863,7 +3891,7 @@ ], "variables": [] }, - "sizeInBytes": 52371 + "sizeInBytes": 51963 }, "getDoc": { "dependencies": { @@ -3924,6 +3952,7 @@ "compareReferences", "compareTimestamps", "computeTransformOperationBaseValue", + "configureFirestore", "convertToDocSnapshot", "createError", "createMetadata", @@ -3938,6 +3967,9 @@ "emitNewSnapsAndNotifyLocalStore", "enableNetworkInternal", "encodeBase64", + "ensureFirestoreConfigured", + "ensureOfflineComponents", + "ensureOnlineComponents", "ensureWatchCallbacks", "ensureWatchStream", "errorMessage", @@ -3955,7 +3987,6 @@ "filterEquals", "forEach", "formatJSON", - "formatPlural", "fromBytes", "fromDotSeparatedString", "fromName", @@ -3977,8 +4008,6 @@ "getLocalWriteTime", "getLogLevel", "getMessageOrStack", - "getOfflineComponentProvider", - "getOnlineComponentProvider", "getPostMutationVersion", "getPreviousValue", "getRemoteKeysForTarget", @@ -3989,7 +4018,6 @@ "hasLimitToLast", "ignoreIfPrimaryLeaseLoss", "initializeViewAndComputeSnapshot", - "invalidClassError", "isArray", "isCollectionGroupQuery", "isDocumentQuery", @@ -4004,7 +4032,6 @@ "isNullOrUndefined", "isNullValue", "isNumber", - "isPlainObject", "isServerTimestamp", "isValidResourceName", "loadProtos", @@ -4021,6 +4048,7 @@ "newDatastore", "newEventManager", "newLocalStore", + "newMemoryRemoteDocumentCache", "newPersistentWatchStream", "newQueryComparator", "newQueryForPath", @@ -4041,7 +4069,6 @@ "onWatchStreamClose", "onWatchStreamOpen", "orderByEquals", - "ordinal", "patchDocument", "patchObject", "preconditionIsValidForDocument", @@ -4070,7 +4097,6 @@ "remoteStoreUnlisten", "removeAndCleanupTarget", "removeComponents", - "removeComponents$1", "removeLimboTarget", "requireDocument", "restartNetwork", @@ -4121,10 +4147,7 @@ "typeOrder", "uint8ArrayFromBinaryString", "updateTrackedLimbos", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", - "validateType", + "validateIsNotUsedTogether", "valueCompare", "valueDescription", "valueEquals", @@ -4167,7 +4190,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "GrpcConnection", "IndexFreeQueryEngine", @@ -4187,7 +4212,8 @@ "MemoryMutationQueue", "MemoryOfflineComponentProvider", "MemoryPersistence", - "MemoryRemoteDocumentCache", + "MemoryRemoteDocumentCacheImpl", + "MemoryRemoteDocumentChangeBuffer", "MemorySharedClientState", "MemoryTargetCache", "MemoryTransaction", @@ -4252,7 +4278,7 @@ ], "variables": [] }, - "sizeInBytes": 201013 + "sizeInBytes": 200807 }, "getDocFromCache": { "dependencies": { @@ -4303,6 +4329,7 @@ "compareReferences", "compareTimestamps", "computeTransformOperationBaseValue", + "configureFirestore", "createError", "debugCast", "decodeBase64", @@ -4310,6 +4337,8 @@ "documentKeySet", "documentMap", "encodeBase64", + "ensureFirestoreConfigured", + "ensureOfflineComponents", "errorMessage", "fail", "fieldPathFromArgument$1", @@ -4318,7 +4347,6 @@ "filterEquals", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "geoPointEquals", "getDocFromCache", @@ -4328,14 +4356,12 @@ "getLocalWriteTime", "getLogLevel", "getMessageOrStack", - "getOfflineComponentProvider", "getPostMutationVersion", "getPreviousValue", "handleUserChange", "hardAssert", "hasLimitToFirst", "hasLimitToLast", - "invalidClassError", "isArray", "isCollectionGroupQuery", "isDocumentQuery", @@ -4347,7 +4373,6 @@ "isNegativeZero", "isNullOrUndefined", "isNumber", - "isPlainObject", "isServerTimestamp", "isValidResourceName", "localTransformResults", @@ -4357,6 +4382,7 @@ "maybeDocumentMap", "mutationEquals", "newLocalStore", + "newMemoryRemoteDocumentCache", "newQueryComparator", "newQueryForPath", "newTarget", @@ -4368,7 +4394,6 @@ "objectEquals", "objectSize", "orderByEquals", - "ordinal", "patchDocument", "patchObject", "preconditionIsValidForDocument", @@ -4385,7 +4410,6 @@ "readLocalDocument", "registerFirestore", "removeComponents", - "removeComponents$1", "requireDocument", "serverTimestamp", "serverTransformResults", @@ -4405,10 +4429,7 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", - "validateType", + "validateIsNotUsedTogether", "valueCompare", "valueDescription", "valueEquals", @@ -4440,7 +4461,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "IndexFreeQueryEngine", "LLRBEmptyNode", @@ -4456,7 +4479,8 @@ "MemoryMutationQueue", "MemoryOfflineComponentProvider", "MemoryPersistence", - "MemoryRemoteDocumentCache", + "MemoryRemoteDocumentCacheImpl", + "MemoryRemoteDocumentChangeBuffer", "MemorySharedClientState", "MemoryTargetCache", "MemoryTransaction", @@ -4501,7 +4525,7 @@ ], "variables": [] }, - "sizeInBytes": 119815 + "sizeInBytes": 119465 }, "getDocFromServer": { "dependencies": { @@ -4562,6 +4586,7 @@ "compareReferences", "compareTimestamps", "computeTransformOperationBaseValue", + "configureFirestore", "convertToDocSnapshot", "createError", "createMetadata", @@ -4576,6 +4601,9 @@ "emitNewSnapsAndNotifyLocalStore", "enableNetworkInternal", "encodeBase64", + "ensureFirestoreConfigured", + "ensureOfflineComponents", + "ensureOnlineComponents", "ensureWatchCallbacks", "ensureWatchStream", "errorMessage", @@ -4593,7 +4621,6 @@ "filterEquals", "forEach", "formatJSON", - "formatPlural", "fromBytes", "fromDotSeparatedString", "fromName", @@ -4615,8 +4642,6 @@ "getLocalWriteTime", "getLogLevel", "getMessageOrStack", - "getOfflineComponentProvider", - "getOnlineComponentProvider", "getPostMutationVersion", "getPreviousValue", "getRemoteKeysForTarget", @@ -4627,7 +4652,6 @@ "hasLimitToLast", "ignoreIfPrimaryLeaseLoss", "initializeViewAndComputeSnapshot", - "invalidClassError", "isArray", "isCollectionGroupQuery", "isDocumentQuery", @@ -4642,7 +4666,6 @@ "isNullOrUndefined", "isNullValue", "isNumber", - "isPlainObject", "isServerTimestamp", "isValidResourceName", "loadProtos", @@ -4659,6 +4682,7 @@ "newDatastore", "newEventManager", "newLocalStore", + "newMemoryRemoteDocumentCache", "newPersistentWatchStream", "newQueryComparator", "newQueryForPath", @@ -4679,7 +4703,6 @@ "onWatchStreamClose", "onWatchStreamOpen", "orderByEquals", - "ordinal", "patchDocument", "patchObject", "preconditionIsValidForDocument", @@ -4708,7 +4731,6 @@ "remoteStoreUnlisten", "removeAndCleanupTarget", "removeComponents", - "removeComponents$1", "removeLimboTarget", "requireDocument", "restartNetwork", @@ -4759,10 +4781,7 @@ "typeOrder", "uint8ArrayFromBinaryString", "updateTrackedLimbos", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", - "validateType", + "validateIsNotUsedTogether", "valueCompare", "valueDescription", "valueEquals", @@ -4805,7 +4824,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "GrpcConnection", "IndexFreeQueryEngine", @@ -4825,7 +4846,8 @@ "MemoryMutationQueue", "MemoryOfflineComponentProvider", "MemoryPersistence", - "MemoryRemoteDocumentCache", + "MemoryRemoteDocumentCacheImpl", + "MemoryRemoteDocumentChangeBuffer", "MemorySharedClientState", "MemoryTargetCache", "MemoryTransaction", @@ -4890,7 +4912,7 @@ ], "variables": [] }, - "sizeInBytes": 201032 + "sizeInBytes": 200826 }, "getDocs": { "dependencies": { @@ -4952,6 +4974,7 @@ "compareReferences", "compareTimestamps", "computeTransformOperationBaseValue", + "configureFirestore", "createError", "createMetadata", "debugCast", @@ -4965,6 +4988,9 @@ "emitNewSnapsAndNotifyLocalStore", "enableNetworkInternal", "encodeBase64", + "ensureFirestoreConfigured", + "ensureOfflineComponents", + "ensureOnlineComponents", "ensureWatchCallbacks", "ensureWatchStream", "errorMessage", @@ -4983,7 +5009,6 @@ "filterEquals", "forEach", "formatJSON", - "formatPlural", "fromBytes", "fromDotSeparatedString", "fromName", @@ -5005,8 +5030,6 @@ "getLocalWriteTime", "getLogLevel", "getMessageOrStack", - "getOfflineComponentProvider", - "getOnlineComponentProvider", "getPostMutationVersion", "getPreviousValue", "getRemoteKeysForTarget", @@ -5017,7 +5040,6 @@ "hasLimitToLast", "ignoreIfPrimaryLeaseLoss", "initializeViewAndComputeSnapshot", - "invalidClassError", "isArray", "isCollectionGroupQuery", "isDocumentQuery", @@ -5032,7 +5054,6 @@ "isNullOrUndefined", "isNullValue", "isNumber", - "isPlainObject", "isServerTimestamp", "isValidResourceName", "loadProtos", @@ -5049,6 +5070,7 @@ "newDatastore", "newEventManager", "newLocalStore", + "newMemoryRemoteDocumentCache", "newPersistentWatchStream", "newQueryComparator", "newQueryForPath", @@ -5069,7 +5091,6 @@ "onWatchStreamClose", "onWatchStreamOpen", "orderByEquals", - "ordinal", "patchDocument", "patchObject", "preconditionIsValidForDocument", @@ -5097,7 +5118,6 @@ "remoteStoreUnlisten", "removeAndCleanupTarget", "removeComponents", - "removeComponents$1", "removeLimboTarget", "requireDocument", "restartNetwork", @@ -5149,11 +5169,8 @@ "typeOrder", "uint8ArrayFromBinaryString", "updateTrackedLimbos", - "validateArgType", - "validateExactNumberOfArgs", "validateHasExplicitOrderByForLimitToLast", - "validateNamedArrayAtLeastNumberOfElements", - "validateType", + "validateIsNotUsedTogether", "valueCompare", "valueDescription", "valueEquals", @@ -5196,7 +5213,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "GrpcConnection", "IndexFreeQueryEngine", @@ -5216,7 +5235,8 @@ "MemoryMutationQueue", "MemoryOfflineComponentProvider", "MemoryPersistence", - "MemoryRemoteDocumentCache", + "MemoryRemoteDocumentCacheImpl", + "MemoryRemoteDocumentChangeBuffer", "MemorySharedClientState", "MemoryTargetCache", "MemoryTransaction", @@ -5282,7 +5302,7 @@ ], "variables": [] }, - "sizeInBytes": 203304 + "sizeInBytes": 203108 }, "getDocsFromCache": { "dependencies": { @@ -5335,6 +5355,7 @@ "compareReferences", "compareTimestamps", "computeTransformOperationBaseValue", + "configureFirestore", "createError", "debugCast", "decodeBase64", @@ -5342,6 +5363,8 @@ "documentKeySet", "documentMap", "encodeBase64", + "ensureFirestoreConfigured", + "ensureOfflineComponents", "errorMessage", "executeQuery", "executeQueryFromCache", @@ -5352,7 +5375,6 @@ "filterEquals", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "geoPointEquals", "getDocsFromCache", @@ -5363,14 +5385,12 @@ "getLocalWriteTime", "getLogLevel", "getMessageOrStack", - "getOfflineComponentProvider", "getPostMutationVersion", "getPreviousValue", "handleUserChange", "hardAssert", "hasLimitToFirst", "hasLimitToLast", - "invalidClassError", "isArray", "isCollectionGroupQuery", "isDocumentQuery", @@ -5382,7 +5402,6 @@ "isNegativeZero", "isNullOrUndefined", "isNumber", - "isPlainObject", "isServerTimestamp", "isValidResourceName", "localTransformResults", @@ -5392,6 +5411,7 @@ "maybeDocumentMap", "mutationEquals", "newLocalStore", + "newMemoryRemoteDocumentCache", "newQueryComparator", "newQueryForPath", "newTarget", @@ -5403,7 +5423,6 @@ "objectEquals", "objectSize", "orderByEquals", - "ordinal", "patchDocument", "patchObject", "preconditionIsValidForDocument", @@ -5419,7 +5438,6 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", "requireDocument", "resultChangeType", "serverTimestamp", @@ -5440,10 +5458,7 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", - "validateType", + "validateIsNotUsedTogether", "valueCompare", "valueDescription", "valueEquals", @@ -5478,7 +5493,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "IndexFreeQueryEngine", "LLRBEmptyNode", @@ -5494,7 +5511,8 @@ "MemoryMutationQueue", "MemoryOfflineComponentProvider", "MemoryPersistence", - "MemoryRemoteDocumentCache", + "MemoryRemoteDocumentCacheImpl", + "MemoryRemoteDocumentChangeBuffer", "MemorySharedClientState", "MemoryTargetCache", "MemoryTransaction", @@ -5543,7 +5561,7 @@ ], "variables": [] }, - "sizeInBytes": 132741 + "sizeInBytes": 132433 }, "getDocsFromServer": { "dependencies": { @@ -5605,6 +5623,7 @@ "compareReferences", "compareTimestamps", "computeTransformOperationBaseValue", + "configureFirestore", "createError", "createMetadata", "debugCast", @@ -5618,6 +5637,9 @@ "emitNewSnapsAndNotifyLocalStore", "enableNetworkInternal", "encodeBase64", + "ensureFirestoreConfigured", + "ensureOfflineComponents", + "ensureOnlineComponents", "ensureWatchCallbacks", "ensureWatchStream", "errorMessage", @@ -5636,7 +5658,6 @@ "filterEquals", "forEach", "formatJSON", - "formatPlural", "fromBytes", "fromDotSeparatedString", "fromName", @@ -5658,8 +5679,6 @@ "getLocalWriteTime", "getLogLevel", "getMessageOrStack", - "getOfflineComponentProvider", - "getOnlineComponentProvider", "getPostMutationVersion", "getPreviousValue", "getRemoteKeysForTarget", @@ -5670,7 +5689,6 @@ "hasLimitToLast", "ignoreIfPrimaryLeaseLoss", "initializeViewAndComputeSnapshot", - "invalidClassError", "isArray", "isCollectionGroupQuery", "isDocumentQuery", @@ -5685,7 +5703,6 @@ "isNullOrUndefined", "isNullValue", "isNumber", - "isPlainObject", "isServerTimestamp", "isValidResourceName", "loadProtos", @@ -5702,6 +5719,7 @@ "newDatastore", "newEventManager", "newLocalStore", + "newMemoryRemoteDocumentCache", "newPersistentWatchStream", "newQueryComparator", "newQueryForPath", @@ -5722,7 +5740,6 @@ "onWatchStreamClose", "onWatchStreamOpen", "orderByEquals", - "ordinal", "patchDocument", "patchObject", "preconditionIsValidForDocument", @@ -5750,7 +5767,6 @@ "remoteStoreUnlisten", "removeAndCleanupTarget", "removeComponents", - "removeComponents$1", "removeLimboTarget", "requireDocument", "restartNetwork", @@ -5802,10 +5818,7 @@ "typeOrder", "uint8ArrayFromBinaryString", "updateTrackedLimbos", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", - "validateType", + "validateIsNotUsedTogether", "valueCompare", "valueDescription", "valueEquals", @@ -5848,7 +5861,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "GrpcConnection", "IndexFreeQueryEngine", @@ -5868,7 +5883,8 @@ "MemoryMutationQueue", "MemoryOfflineComponentProvider", "MemoryPersistence", - "MemoryRemoteDocumentCache", + "MemoryRemoteDocumentCacheImpl", + "MemoryRemoteDocumentChangeBuffer", "MemorySharedClientState", "MemoryTargetCache", "MemoryTransaction", @@ -5934,12 +5950,13 @@ ], "variables": [] }, - "sizeInBytes": 203032 + "sizeInBytes": 202836 }, "getFirestore": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "fail", "formatJSON", "getFirestore", @@ -5952,7 +5969,7 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -5966,18 +5983,21 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User" ], "variables": [] }, - "sizeInBytes": 16834 + "sizeInBytes": 18632 }, "increment": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "fail", "formatJSON", "getMessageOrStack", @@ -5992,10 +6012,10 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", "toDouble", "toInteger", "toNumber", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -6011,7 +6031,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "NumericIncrementFieldValueImpl", "NumericIncrementTransformOperation", "OAuthToken", @@ -6020,12 +6042,13 @@ ], "variables": [] }, - "sizeInBytes": 18248 + "sizeInBytes": 20046 }, "initializeFirestore": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "fail", "formatJSON", "getMessageOrStack", @@ -6038,7 +6061,7 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -6052,19 +6075,22 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "LruParams", "OAuthToken", "User" ], "variables": [] }, - "sizeInBytes": 18138 + "sizeInBytes": 19962 }, "limit": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "fail", "formatJSON", "getMessageOrStack", @@ -6073,13 +6099,12 @@ "limit", "logDebug", "logError", - "ordinal", "primitiveComparator", "queryWithLimit", "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", + "validateIsNotUsedTogether", "validatePositiveNumber", "wrapInUserErrorIfRecoverable" ], @@ -6094,7 +6119,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "Query", "QueryConstraint", @@ -6104,12 +6131,13 @@ ], "variables": [] }, - "sizeInBytes": 18315 + "sizeInBytes": 19951 }, "limitToLast": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "fail", "formatJSON", "getMessageOrStack", @@ -6118,13 +6146,12 @@ "limitToLast", "logDebug", "logError", - "ordinal", "primitiveComparator", "queryWithLimit", "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", + "validateIsNotUsedTogether", "validatePositiveNumber", "wrapInUserErrorIfRecoverable" ], @@ -6139,7 +6166,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "Query", "QueryConstraint", @@ -6149,7 +6178,7 @@ ], "variables": [] }, - "sizeInBytes": 18339 + "sizeInBytes": 19975 }, "onSnapshot": { "dependencies": { @@ -6211,6 +6240,7 @@ "compareReferences", "compareTimestamps", "computeTransformOperationBaseValue", + "configureFirestore", "convertToDocSnapshot", "createError", "createMetadata", @@ -6225,6 +6255,9 @@ "emitNewSnapsAndNotifyLocalStore", "enableNetworkInternal", "encodeBase64", + "ensureFirestoreConfigured", + "ensureOfflineComponents", + "ensureOnlineComponents", "ensureWatchCallbacks", "ensureWatchStream", "errorMessage", @@ -6242,7 +6275,6 @@ "filterEquals", "forEach", "formatJSON", - "formatPlural", "fromBytes", "fromDotSeparatedString", "fromName", @@ -6263,8 +6295,6 @@ "getLocalWriteTime", "getLogLevel", "getMessageOrStack", - "getOfflineComponentProvider", - "getOnlineComponentProvider", "getPostMutationVersion", "getPreviousValue", "getRemoteKeysForTarget", @@ -6276,7 +6306,6 @@ "ignoreIfPrimaryLeaseLoss", "implementsAnyMethods", "initializeViewAndComputeSnapshot", - "invalidClassError", "isArray", "isCollectionGroupQuery", "isDocumentQuery", @@ -6292,7 +6321,6 @@ "isNullValue", "isNumber", "isPartialObserver", - "isPlainObject", "isServerTimestamp", "isValidResourceName", "loadProtos", @@ -6309,6 +6337,7 @@ "newDatastore", "newEventManager", "newLocalStore", + "newMemoryRemoteDocumentCache", "newPersistentWatchStream", "newQueryComparator", "newQueryForPath", @@ -6330,7 +6359,6 @@ "onWatchStreamClose", "onWatchStreamOpen", "orderByEquals", - "ordinal", "patchDocument", "patchObject", "preconditionIsValidForDocument", @@ -6358,7 +6386,6 @@ "remoteStoreUnlisten", "removeAndCleanupTarget", "removeComponents", - "removeComponents$1", "removeLimboTarget", "requireDocument", "restartNetwork", @@ -6410,11 +6437,8 @@ "typeOrder", "uint8ArrayFromBinaryString", "updateTrackedLimbos", - "validateArgType", - "validateExactNumberOfArgs", "validateHasExplicitOrderByForLimitToLast", - "validateNamedArrayAtLeastNumberOfElements", - "validateType", + "validateIsNotUsedTogether", "valueCompare", "valueDescription", "valueEquals", @@ -6457,7 +6481,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "GrpcConnection", "IndexFreeQueryEngine", @@ -6477,7 +6503,8 @@ "MemoryMutationQueue", "MemoryOfflineComponentProvider", "MemoryPersistence", - "MemoryRemoteDocumentCache", + "MemoryRemoteDocumentCacheImpl", + "MemoryRemoteDocumentChangeBuffer", "MemorySharedClientState", "MemoryTargetCache", "MemoryTransaction", @@ -6543,7 +6570,7 @@ ], "variables": [] }, - "sizeInBytes": 204416 + "sizeInBytes": 204215 }, "onSnapshotsInSync": { "dependencies": { @@ -6604,6 +6631,7 @@ "compareReferences", "compareTimestamps", "computeTransformOperationBaseValue", + "configureFirestore", "createMetadata", "debugCast", "decodeBase64", @@ -6616,6 +6644,9 @@ "emitNewSnapsAndNotifyLocalStore", "enableNetworkInternal", "encodeBase64", + "ensureFirestoreConfigured", + "ensureOfflineComponents", + "ensureOnlineComponents", "ensureWatchCallbacks", "ensureWatchStream", "eventManagerOnOnlineStateChange", @@ -6647,8 +6678,6 @@ "getLocalWriteTime", "getLogLevel", "getMessageOrStack", - "getOfflineComponentProvider", - "getOnlineComponentProvider", "getPostMutationVersion", "getRemoteKeysForTarget", "handleTargetError", @@ -6690,6 +6719,7 @@ "newDatastore", "newEventManager", "newLocalStore", + "newMemoryRemoteDocumentCache", "newPersistentWatchStream", "newQueryComparator", "newQueryForPath", @@ -6738,7 +6768,6 @@ "remoteStoreUnlisten", "removeAndCleanupTarget", "removeComponents", - "removeComponents$1", "removeLimboTarget", "removeSnapshotsInSyncListener", "requireDocument", @@ -6789,6 +6818,7 @@ "typeOrder", "uint8ArrayFromBinaryString", "updateTrackedLimbos", + "validateIsNotUsedTogether", "valueCompare", "valueEquals", "versionFromListenResponse", @@ -6824,7 +6854,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GrpcConnection", "IndexFreeQueryEngine", "JsonProtoSerializer", @@ -6843,7 +6875,8 @@ "MemoryMutationQueue", "MemoryOfflineComponentProvider", "MemoryPersistence", - "MemoryRemoteDocumentCache", + "MemoryRemoteDocumentCacheImpl", + "MemoryRemoteDocumentChangeBuffer", "MemorySharedClientState", "MemoryTargetCache", "MemoryTransaction", @@ -6899,45 +6932,37 @@ ], "variables": [] }, - "sizeInBytes": 183839 + "sizeInBytes": 185926 }, "orderBy": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "createError", "errorMessage", "fail", "fieldPathFromArgument$1", "fieldPathFromDotSeparatedString", "formatJSON", - "formatPlural", "fromDotSeparatedString", "getFirstOrderByField", "getInequalityFilterField", "getMessageOrStack", "hardAssert", - "invalidClassError", "isIndexedDbTransactionError", - "isPlainObject", "logDebug", "logError", "newQueryOrderBy", "orderBy", - "ordinal", "primitiveComparator", "queryWithAddedOrderBy", "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", - "tryGetCustomObjectType", - "validateArgType", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validateNewOrderBy", "validateOrderByAndInequalityMatch", - "validateType", - "valueDescription", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -6954,7 +6979,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "OrderBy", "Query", @@ -6966,12 +6993,13 @@ ], "variables": [] }, - "sizeInBytes": 27572 + "sizeInBytes": 26806 }, "query": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "fail", "formatJSON", "getMessageOrStack", @@ -6984,7 +7012,7 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -6998,13 +7026,15 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User" ], "variables": [] }, - "sizeInBytes": 16859 + "sizeInBytes": 18657 }, "queryEqual": { "dependencies": { @@ -7014,6 +7044,7 @@ "binaryStringFromUint8Array", "blobEquals", "boundEquals", + "configureFirestore", "debugCast", "decodeBase64", "encodeBase64", @@ -7047,11 +7078,11 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", "targetEquals", "timestampEquals", "typeOrder", "uint8ArrayFromBinaryString", + "validateIsNotUsedTogether", "valueEquals", "wrapInUserErrorIfRecoverable" ], @@ -7070,7 +7101,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "OrderBy", "Query", @@ -7080,12 +7113,13 @@ ], "variables": [] }, - "sizeInBytes": 31992 + "sizeInBytes": 33796 }, "refEqual": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "fail", "formatJSON", "getMessageOrStack", @@ -7099,7 +7133,7 @@ "refEqual", "registerFirestore", "removeComponents", - "removeComponents$1", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -7117,7 +7151,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "Query", "QueryImpl", @@ -7127,7 +7163,7 @@ ], "variables": [] }, - "sizeInBytes": 21894 + "sizeInBytes": 23696 }, "runTransaction": { "dependencies": { @@ -7138,11 +7174,13 @@ "assertPresent", "binaryStringFromUint8Array", "blobEquals", + "configureFirestore", "createError", "createMetadata", "debugCast", "decodeBase64", "encodeBase64", + "ensureFirestoreConfigured", "errorMessage", "extractLocalPathFromResourceName", "fail", @@ -7152,7 +7190,6 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fromFound", "fromMaybeDocument", @@ -7169,7 +7206,6 @@ "getMessageOrStack", "getPreviousValue", "hardAssert", - "invalidClassError", "invokeBatchGetDocumentsRpc", "invokeCommitRpc", "isEmpty", @@ -7188,6 +7224,7 @@ "logError", "logWarn", "looksLikeJsonObject", + "makeDatabaseInfo", "mapCodeFromRpcCode", "newConnection", "newDatastore", @@ -7201,7 +7238,6 @@ "numberEquals", "objectEquals", "objectSize", - "ordinal", "parseArray", "parseData", "parseObject", @@ -7214,7 +7250,6 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", "runTransaction", "timestampEquals", "toBytes", @@ -7233,12 +7268,9 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validatePlainObject", "validateReference", - "validateType", "valueDescription", "valueEquals", "wrapInUserErrorIfRecoverable" @@ -7275,7 +7307,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "GrpcConnection", "JsonProtoSerializer", @@ -7317,12 +7351,13 @@ ], "variables": [] }, - "sizeInBytes": 82754 + "sizeInBytes": 82843 }, "serverTimestamp": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "fail", "formatJSON", "getMessageOrStack", @@ -7334,8 +7369,8 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", "serverTimestamp$1", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -7351,7 +7386,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "ServerTimestampFieldValueImpl", "ServerTimestampTransform", @@ -7360,7 +7397,7 @@ ], "variables": [] }, - "sizeInBytes": 17353 + "sizeInBytes": 19151 }, "setDoc": { "dependencies": { @@ -7421,6 +7458,7 @@ "compareReferences", "compareTimestamps", "computeTransformOperationBaseValue", + "configureFirestore", "createError", "createMetadata", "debugCast", @@ -7434,6 +7472,9 @@ "emitNewSnapsAndNotifyLocalStore", "enableNetworkInternal", "encodeBase64", + "ensureFirestoreConfigured", + "ensureOfflineComponents", + "ensureOnlineComponents", "ensureWriteCallbacks", "ensureWriteStream", "errorMessage", @@ -7449,9 +7490,9 @@ "fieldTransformEquals", "fillWritePipeline", "filterEquals", + "firestoreClientWrite", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fromTimestamp", "fromVersion", @@ -7466,8 +7507,6 @@ "getLocalWriteTime", "getLogLevel", "getMessageOrStack", - "getOfflineComponentProvider", - "getOnlineComponentProvider", "getPostMutationVersion", "getSyncEngine", "handleUserChange", @@ -7476,7 +7515,6 @@ "hasLimitToFirst", "hasLimitToLast", "ignoreIfPrimaryLeaseLoss", - "invalidClassError", "isArray", "isCollectionGroupQuery", "isDocumentQuery", @@ -7510,6 +7548,7 @@ "newDatastore", "newEventManager", "newLocalStore", + "newMemoryRemoteDocumentCache", "newPersistentWriteStream", "newQueryComparator", "newRemoteStore", @@ -7532,7 +7571,6 @@ "onWriteStreamClose", "onWriteStreamOpen", "orderByEquals", - "ordinal", "parseArray", "parseData", "parseObject", @@ -7562,7 +7600,6 @@ "remoteStoreHandleCredentialChange", "remoteStoreShutdown", "removeComponents", - "removeComponents$1", "requireDocument", "restartNetwork", "serverTimestamp", @@ -7601,11 +7638,8 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validatePlainObject", - "validateType", "valueCompare", "valueDescription", "valueEquals", @@ -7640,7 +7674,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "GrpcConnection", "IndexFreeQueryEngine", @@ -7659,7 +7695,8 @@ "MemoryMutationQueue", "MemoryOfflineComponentProvider", "MemoryPersistence", - "MemoryRemoteDocumentCache", + "MemoryRemoteDocumentCacheImpl", + "MemoryRemoteDocumentChangeBuffer", "MemorySharedClientState", "MemoryTargetCache", "MemoryTransaction", @@ -7713,12 +7750,13 @@ ], "variables": [] }, - "sizeInBytes": 164530 + "sizeInBytes": 164628 }, "setLogLevel": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "fail", "formatJSON", "getMessageOrStack", @@ -7730,8 +7768,8 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", "setLogLevel", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -7745,13 +7783,15 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User" ], "variables": [] }, - "sizeInBytes": 16800 + "sizeInBytes": 18598 }, "snapshotEqual": { "dependencies": { @@ -7762,6 +7802,7 @@ "blobEquals", "boundEquals", "changesFromSnapshot", + "configureFirestore", "createError", "debugCast", "decodeBase64", @@ -7773,7 +7814,6 @@ "filterEquals", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "geoPointEquals", "getFirstOrderByField", @@ -7782,10 +7822,8 @@ "getMessageOrStack", "getPreviousValue", "hardAssert", - "invalidClassError", "isIndexedDbTransactionError", "isNegativeZero", - "isPlainObject", "isServerTimestamp", "isValidResourceName", "logDebug", @@ -7799,7 +7837,6 @@ "objectEquals", "objectSize", "orderByEquals", - "ordinal", "primitiveComparator", "queryEqual", "queryEquals", @@ -7808,19 +7845,13 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", "resultChangeType", "snapshotEqual", "targetEquals", "timestampEquals", - "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", - "validateType", - "valueDescription", + "validateIsNotUsedTogether", "valueEquals", "wrapInUserErrorIfRecoverable" ], @@ -7846,7 +7877,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "OAuthToken", "OrderBy", @@ -7866,13 +7899,14 @@ ], "variables": [] }, - "sizeInBytes": 50005 + "sizeInBytes": 48658 }, "startAfter": { "dependencies": { "functions": [ "argToString", "binaryStringFromUint8Array", + "configureFirestore", "createError", "debugCast", "decodeBase64", @@ -7883,7 +7917,6 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fullyQualifiedPrefixPath", "getFirstOrderByField", @@ -7892,7 +7925,6 @@ "getMessageOrStack", "getPreviousValue", "hardAssert", - "invalidClassError", "isCollectionGroupQuery", "isEmpty", "isIndexedDbTransactionError", @@ -7914,7 +7946,6 @@ "normalizeByteString", "normalizeNumber", "normalizeTimestamp", - "ordinal", "parseArray", "parseData", "parseObject", @@ -7928,7 +7959,6 @@ "refValue", "registerFirestore", "removeComponents", - "removeComponents$1", "startAfter", "toBytes", "toDouble", @@ -7939,11 +7969,8 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validatePlainObject", - "validateType", "valueDescription", "wrapInUserErrorIfRecoverable" ], @@ -7970,7 +7997,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "JsonProtoSerializer", "OAuthToken", @@ -7991,13 +8020,14 @@ ], "variables": [] }, - "sizeInBytes": 52381 + "sizeInBytes": 51973 }, "startAt": { "dependencies": { "functions": [ "argToString", "binaryStringFromUint8Array", + "configureFirestore", "createError", "debugCast", "decodeBase64", @@ -8008,7 +8038,6 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fullyQualifiedPrefixPath", "getFirstOrderByField", @@ -8017,7 +8046,6 @@ "getMessageOrStack", "getPreviousValue", "hardAssert", - "invalidClassError", "isCollectionGroupQuery", "isEmpty", "isIndexedDbTransactionError", @@ -8039,7 +8067,6 @@ "normalizeByteString", "normalizeNumber", "normalizeTimestamp", - "ordinal", "parseArray", "parseData", "parseObject", @@ -8053,7 +8080,6 @@ "refValue", "registerFirestore", "removeComponents", - "removeComponents$1", "startAt", "toBytes", "toDouble", @@ -8064,11 +8090,8 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validatePlainObject", - "validateType", "valueDescription", "wrapInUserErrorIfRecoverable" ], @@ -8095,7 +8118,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "JsonProtoSerializer", "OAuthToken", @@ -8116,12 +8141,13 @@ ], "variables": [] }, - "sizeInBytes": 52371 + "sizeInBytes": 51963 }, "terminate": { "dependencies": { "functions": [ "argToString", + "configureFirestore", "fail", "formatJSON", "getMessageOrStack", @@ -8133,8 +8159,8 @@ "randomBytes", "registerFirestore", "removeComponents", - "removeComponents$1", "terminate", + "validateIsNotUsedTogether", "wrapInUserErrorIfRecoverable" ], "classes": [ @@ -8148,13 +8174,15 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User" ], "variables": [] }, - "sizeInBytes": 16869 + "sizeInBytes": 18667 }, "updateDoc": { "dependencies": { @@ -8214,6 +8242,7 @@ "compareReferences", "compareTimestamps", "computeTransformOperationBaseValue", + "configureFirestore", "createError", "createMetadata", "debugCast", @@ -8227,6 +8256,9 @@ "emitNewSnapsAndNotifyLocalStore", "enableNetworkInternal", "encodeBase64", + "ensureFirestoreConfigured", + "ensureOfflineComponents", + "ensureOnlineComponents", "ensureWriteCallbacks", "ensureWriteStream", "errorMessage", @@ -8243,9 +8275,9 @@ "fieldTransformEquals", "fillWritePipeline", "filterEquals", + "firestoreClientWrite", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fromTimestamp", "fromVersion", @@ -8260,8 +8292,6 @@ "getLocalWriteTime", "getLogLevel", "getMessageOrStack", - "getOfflineComponentProvider", - "getOnlineComponentProvider", "getPostMutationVersion", "getSyncEngine", "handleUserChange", @@ -8270,7 +8300,6 @@ "hasLimitToFirst", "hasLimitToLast", "ignoreIfPrimaryLeaseLoss", - "invalidClassError", "isArray", "isCollectionGroupQuery", "isDocumentQuery", @@ -8304,6 +8333,7 @@ "newDatastore", "newEventManager", "newLocalStore", + "newMemoryRemoteDocumentCache", "newPersistentWriteStream", "newQueryComparator", "newRemoteStore", @@ -8326,7 +8356,6 @@ "onWriteStreamClose", "onWriteStreamOpen", "orderByEquals", - "ordinal", "parseArray", "parseData", "parseObject", @@ -8357,7 +8386,6 @@ "remoteStoreHandleCredentialChange", "remoteStoreShutdown", "removeComponents", - "removeComponents$1", "requireDocument", "restartNetwork", "serverTimestamp", @@ -8396,11 +8424,8 @@ "typeOrder", "uint8ArrayFromBinaryString", "updateDoc", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validatePlainObject", - "validateType", "valueCompare", "valueDescription", "valueEquals", @@ -8437,7 +8462,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "GrpcConnection", "IndexFreeQueryEngine", @@ -8456,7 +8483,8 @@ "MemoryMutationQueue", "MemoryOfflineComponentProvider", "MemoryPersistence", - "MemoryRemoteDocumentCache", + "MemoryRemoteDocumentCacheImpl", + "MemoryRemoteDocumentChangeBuffer", "MemorySharedClientState", "MemoryTargetCache", "MemoryTransaction", @@ -8510,7 +8538,7 @@ ], "variables": [] }, - "sizeInBytes": 165962 + "sizeInBytes": 166060 }, "waitForPendingWrites": { "dependencies": { @@ -8563,6 +8591,7 @@ "compareReferences", "compareTimestamps", "computeTransformOperationBaseValue", + "configureFirestore", "createMetadata", "debugCast", "decodeBase64", @@ -8573,10 +8602,14 @@ "emitNewSnapsAndNotifyLocalStore", "enableNetworkInternal", "encodeBase64", + "ensureFirestoreConfigured", + "ensureOfflineComponents", + "ensureOnlineComponents", "eventManagerOnOnlineStateChange", "fail", "fieldTransformEquals", "filterEquals", + "firestoreClientWaitForPendingWrites", "forEach", "formatJSON", "geoPointEquals", @@ -8586,8 +8619,6 @@ "getLocalWriteTime", "getLogLevel", "getMessageOrStack", - "getOfflineComponentProvider", - "getOnlineComponentProvider", "getPostMutationVersion", "getSyncEngine", "handleUserChange", @@ -8620,6 +8651,7 @@ "newDatastore", "newEventManager", "newLocalStore", + "newMemoryRemoteDocumentCache", "newQueryComparator", "newRemoteStore", "newSerializer", @@ -8656,7 +8688,6 @@ "remoteStoreHandleCredentialChange", "remoteStoreShutdown", "removeComponents", - "removeComponents$1", "requireDocument", "restartNetwork", "serverTimestamp", @@ -8678,6 +8709,7 @@ "transformOperationEquals", "typeOrder", "uint8ArrayFromBinaryString", + "validateIsNotUsedTogether", "valueCompare", "valueEquals", "waitForPendingWrites", @@ -8706,7 +8738,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GrpcConnection", "IndexFreeQueryEngine", "JsonProtoSerializer", @@ -8724,7 +8758,8 @@ "MemoryMutationQueue", "MemoryOfflineComponentProvider", "MemoryPersistence", - "MemoryRemoteDocumentCache", + "MemoryRemoteDocumentCacheImpl", + "MemoryRemoteDocumentChangeBuffer", "MemorySharedClientState", "MemoryTargetCache", "MemoryTransaction", @@ -8768,7 +8803,7 @@ ], "variables": [] }, - "sizeInBytes": 127059 + "sizeInBytes": 129030 }, "where": { "dependencies": { @@ -8785,6 +8820,7 @@ "compareNumbers", "compareReferences", "compareTimestamps", + "configureFirestore", "conflictingOps", "createError", "decodeBase64", @@ -8797,7 +8833,6 @@ "findFilterOperator", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fullyQualifiedPrefixPath", "geoPointEquals", @@ -8806,14 +8841,11 @@ "getLocalWriteTime", "getMessageOrStack", "hardAssert", - "invalidClassError", "isArray", "isCollectionGroupQuery", "isEmpty", "isIndexedDbTransactionError", - "isNanValue", "isNegativeZero", - "isNullValue", "isPlainObject", "isSafeInteger", "isServerTimestamp", @@ -8830,7 +8862,6 @@ "numberEquals", "objectEquals", "objectSize", - "ordinal", "parseArray", "parseData", "parseDocumentIdValue", @@ -8844,7 +8875,6 @@ "refValue", "registerFirestore", "removeComponents", - "removeComponents$1", "timestampEquals", "toBytes", "toDouble", @@ -8855,14 +8885,11 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", "validateDisjunctiveFilterElements", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validateNewFilter", "validateOrderByAndInequalityMatch", "validatePlainObject", - "validateType", "valueCompare", "valueDescription", "valueEquals", @@ -8892,7 +8919,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "InFilter", "JsonProtoSerializer", @@ -8915,7 +8944,7 @@ ], "variables": [] }, - "sizeInBytes": 58213 + "sizeInBytes": 57038 }, "writeBatch": { "dependencies": { @@ -8975,6 +9004,7 @@ "compareReferences", "compareTimestamps", "computeTransformOperationBaseValue", + "configureFirestore", "createError", "createMetadata", "debugCast", @@ -8988,6 +9018,9 @@ "emitNewSnapsAndNotifyLocalStore", "enableNetworkInternal", "encodeBase64", + "ensureFirestoreConfigured", + "ensureOfflineComponents", + "ensureOnlineComponents", "ensureWriteCallbacks", "ensureWriteStream", "errorMessage", @@ -9004,9 +9037,9 @@ "fieldTransformEquals", "fillWritePipeline", "filterEquals", + "firestoreClientWrite", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fromTimestamp", "fromVersion", @@ -9021,8 +9054,6 @@ "getLocalWriteTime", "getLogLevel", "getMessageOrStack", - "getOfflineComponentProvider", - "getOnlineComponentProvider", "getPostMutationVersion", "getSyncEngine", "handleUserChange", @@ -9031,7 +9062,6 @@ "hasLimitToFirst", "hasLimitToLast", "ignoreIfPrimaryLeaseLoss", - "invalidClassError", "isArray", "isCollectionGroupQuery", "isDocumentQuery", @@ -9065,6 +9095,7 @@ "newDatastore", "newEventManager", "newLocalStore", + "newMemoryRemoteDocumentCache", "newPersistentWriteStream", "newQueryComparator", "newRemoteStore", @@ -9087,7 +9118,6 @@ "onWriteStreamClose", "onWriteStreamOpen", "orderByEquals", - "ordinal", "parseArray", "parseData", "parseObject", @@ -9119,7 +9149,6 @@ "remoteStoreHandleCredentialChange", "remoteStoreShutdown", "removeComponents", - "removeComponents$1", "requireDocument", "restartNetwork", "serverTimestamp", @@ -9157,12 +9186,9 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validatePlainObject", "validateReference", - "validateType", "valueCompare", "valueDescription", "valueEquals", @@ -9200,7 +9226,9 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirebaseFirestore$1", + "FirestoreClient", "FirestoreError", + "FirestoreSettings", "GeoPoint", "GrpcConnection", "IndexFreeQueryEngine", @@ -9219,7 +9247,8 @@ "MemoryMutationQueue", "MemoryOfflineComponentProvider", "MemoryPersistence", - "MemoryRemoteDocumentCache", + "MemoryRemoteDocumentCacheImpl", + "MemoryRemoteDocumentChangeBuffer", "MemorySharedClientState", "MemoryTargetCache", "MemoryTransaction", @@ -9275,6 +9304,6 @@ ], "variables": [] }, - "sizeInBytes": 169138 + "sizeInBytes": 169242 } } \ No newline at end of file diff --git a/packages/firestore/exp/src/api/components.ts b/packages/firestore/exp/src/api/components.ts deleted file mode 100644 index 9cf1d7b5225..00000000000 --- a/packages/firestore/exp/src/api/components.ts +++ /dev/null @@ -1,205 +0,0 @@ -/** - * @license - * Copyright 2020 Google LLC - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -import { FirebaseFirestore } from './database'; -import { - MemoryOfflineComponentProvider, - OfflineComponentProvider, - OnlineComponentProvider -} from '../../../src/core/component_provider'; -import { handleUserChange, LocalStore } from '../../../src/local/local_store'; -import { logDebug } from '../../../src/util/log'; -import { - RemoteStore, - remoteStoreHandleCredentialChange -} from '../../../src/remote/remote_store'; -import { - SyncEngine, - syncEngineListen, - syncEngineUnlisten -} from '../../../src/core/sync_engine'; -import { Persistence } from '../../../src/local/persistence'; -import { EventManager } from '../../../src/core/event_manager'; - -const LOG_TAG = 'ComponentProvider'; - -// The components module manages the lifetime of dependencies of the Firestore -// client. Dependencies can be lazily constructed and only one exists per -// Firestore instance. - -// Instance maps that ensure that only one component provider exists per -// Firestore instance. -const offlineComponentProviders = new Map< - FirebaseFirestore, - OfflineComponentProvider ->(); -const onlineComponentProviders = new Map< - FirebaseFirestore, - OnlineComponentProvider ->(); - -export async function setOfflineComponentProvider( - firestore: FirebaseFirestore, - offlineComponentProvider: OfflineComponentProvider -): Promise { - logDebug(LOG_TAG, 'Initializing OfflineComponentProvider'); - const configuration = await firestore._getConfiguration(); - await offlineComponentProvider.initialize(configuration); - firestore._setCredentialChangeListener(user => - // TODO(firestorexp): This should be a retryable IndexedDB operation - firestore._queue.enqueueAndForget(() => - // TODO(firestorexp): Make sure handleUserChange is a no-op if user - // didn't change - handleUserChange(offlineComponentProvider.localStore, user) - ) - ); - // When a user calls clearPersistence() in one client, all other clients - // need to be terminated to allow the delete to succeed. - offlineComponentProvider.persistence.setDatabaseDeletedListener(() => - firestore._delete() - ); - - offlineComponentProviders.set(firestore, offlineComponentProvider); -} - -export async function setOnlineComponentProvider( - firestore: FirebaseFirestore, - onlineComponentProvider: OnlineComponentProvider -): Promise { - firestore._queue.verifyOperationInProgress(); - - const configuration = await firestore._getConfiguration(); - const offlineComponentProvider = await getOfflineComponentProvider(firestore); - - logDebug(LOG_TAG, 'Initializing OnlineComponentProvider'); - await onlineComponentProvider.initialize( - offlineComponentProvider, - configuration - ); - // The CredentialChangeListener of the online component provider takes - // precedence over the offline component provider. - firestore._setCredentialChangeListener(user => - // TODO(firestoreexp): This should be enqueueRetryable. - firestore._queue.enqueueAndForget(() => - remoteStoreHandleCredentialChange( - onlineComponentProvider.remoteStore, - user - ) - ) - ); - - onlineComponentProviders.set(firestore, onlineComponentProvider); -} - -async function getOfflineComponentProvider( - firestore: FirebaseFirestore -): Promise { - firestore._queue.verifyOperationInProgress(); - - if (!offlineComponentProviders.has(firestore)) { - logDebug(LOG_TAG, 'Using default OfflineComponentProvider'); - await setOfflineComponentProvider( - firestore, - new MemoryOfflineComponentProvider() - ); - } - - return offlineComponentProviders.get(firestore)!; -} - -async function getOnlineComponentProvider( - firestore: FirebaseFirestore -): Promise { - firestore._queue.verifyOperationInProgress(); - - if (!onlineComponentProviders.has(firestore)) { - logDebug(LOG_TAG, 'Using default OnlineComponentProvider'); - await setOnlineComponentProvider(firestore, new OnlineComponentProvider()); - } - - return onlineComponentProviders.get(firestore)!; -} - -export async function getSyncEngine( - firestore: FirebaseFirestore -): Promise { - const onlineComponentProvider = await getOnlineComponentProvider(firestore); - return onlineComponentProvider.syncEngine; -} - -export async function getRemoteStore( - firestore: FirebaseFirestore -): Promise { - const onlineComponentProvider = await getOnlineComponentProvider(firestore); - return onlineComponentProvider.remoteStore; -} - -export async function getEventManager( - firestore: FirebaseFirestore -): Promise { - const onlineComponentProvider = await getOnlineComponentProvider(firestore); - const eventManager = onlineComponentProvider.eventManager; - eventManager.onListen = syncEngineListen.bind( - null, - onlineComponentProvider.syncEngine - ); - eventManager.onUnlisten = syncEngineUnlisten.bind( - null, - onlineComponentProvider.syncEngine - ); - return eventManager; -} - -export async function getPersistence( - firestore: FirebaseFirestore -): Promise { - const offlineComponentProvider = await getOfflineComponentProvider(firestore); - return offlineComponentProvider.persistence; -} - -export async function getLocalStore( - firestore: FirebaseFirestore -): Promise { - const offlineComponentProvider = await getOfflineComponentProvider(firestore); - return offlineComponentProvider.localStore; -} - -/** - * Removes all components associated with the provided instance. Must be called - * when the Firestore instance is terminated. - */ -export async function removeComponents( - firestore: FirebaseFirestore -): Promise { - const onlineComponentProviderPromise = onlineComponentProviders.get( - firestore - ); - if (onlineComponentProviderPromise) { - logDebug(LOG_TAG, 'Removing OnlineComponentProvider'); - onlineComponentProviders.delete(firestore); - await (await onlineComponentProviderPromise).terminate(); - } - - const offlineComponentProviderPromise = offlineComponentProviders.get( - firestore - ); - if (offlineComponentProviderPromise) { - logDebug(LOG_TAG, 'Removing OfflineComponentProvider'); - offlineComponentProviders.delete(firestore); - await (await offlineComponentProviderPromise).terminate(); - } -} diff --git a/packages/firestore/exp/src/api/database.ts b/packages/firestore/exp/src/api/database.ts index ce06cd55e08..b14cd855a7f 100644 --- a/packages/firestore/exp/src/api/database.ts +++ b/packages/firestore/exp/src/api/database.ts @@ -20,13 +20,16 @@ import { _FirebaseService, FirebaseApp } from '@firebase/app-types-exp'; import { Provider } from '@firebase/component'; import { FirebaseAuthInternalName } from '@firebase/auth-interop-types'; -import { MAX_CONCURRENT_LIMBO_RESOLUTIONS } from '../../../src/core/firestore_client'; import { - AsyncQueue, - wrapInUserErrorIfRecoverable -} from '../../../src/util/async_queue'; + FirestoreClient, + firestoreClientDisableNetwork, + firestoreClientEnableNetwork, + firestoreClientWaitForPendingWrites, + setOfflineComponentProvider, + setOnlineComponentProvider +} from '../../../src/core/firestore_client'; +import { AsyncQueue } from '../../../src/util/async_queue'; import { - ComponentConfiguration, IndexedDbOfflineComponentProvider, MultiTabOfflineComponentProvider, OfflineComponentProvider, @@ -38,35 +41,19 @@ import { } from '../../../lite/src/api/database'; import { Code, FirestoreError } from '../../../src/util/error'; import { Deferred } from '../../../src/util/promise'; -import { LruParams } from '../../../src/local/lru_garbage_collector'; -import { CACHE_SIZE_UNLIMITED } from '../../../src/api/database'; +import { LRU_MINIMUM_CACHE_SIZE_BYTES } from '../../../src/local/lru_garbage_collector'; +import { + CACHE_SIZE_UNLIMITED, + configureFirestore, + ensureFirestoreConfigured, + FirestoreCompat +} from '../../../src/api/database'; import { indexedDbClearPersistence, indexedDbStoragePrefix } from '../../../src/local/indexeddb_persistence'; -import { - getPersistence, - getRemoteStore, - getSyncEngine, - removeComponents, - setOfflineComponentProvider, - setOnlineComponentProvider -} from './components'; -import { DEFAULT_HOST, DEFAULT_SSL } from '../../../lite/src/api/components'; -import { DatabaseInfo } from '../../../src/core/database_info'; -import { AutoId } from '../../../src/util/misc'; -import { User } from '../../../src/auth/user'; -import { CredentialChangeListener } from '../../../src/api/credentials'; -import { logDebug } from '../../../src/util/log'; -import { registerPendingWritesCallback } from '../../../src/core/sync_engine'; -import { - remoteStoreDisableNetwork, - remoteStoreEnableNetwork -} from '../../../src/remote/remote_store'; import { PersistenceSettings } from '../../../exp-types'; -const LOG_TAG = 'Firestore'; - /** DOMException error code constants. */ const DOM_EXCEPTION_INVALID_STATE = 11; const DOM_EXCEPTION_ABORTED = 20; @@ -83,18 +70,11 @@ export interface Settings extends LiteSettings { */ export class FirebaseFirestore extends LiteFirestore - implements _FirebaseService { + implements _FirebaseService, FirestoreCompat { readonly _queue = new AsyncQueue(); readonly _persistenceKey: string; - readonly _clientId = AutoId.newId(); - - private readonly _receivedInitialUser = new Deferred(); - private _user = User.UNAUTHENTICATED; - private _credentialListener: CredentialChangeListener = () => {}; - // We override the Settings property of the Lite SDK since the full Firestore - // SDK supports more settings. - protected _settings?: Settings; + _firestoreClient: FirestoreClient | undefined; constructor( app: FirebaseApp, @@ -102,80 +82,15 @@ export class FirebaseFirestore ) { super(app, authProvider); this._persistenceKey = app.name; - this._credentials.setChangeListener(user => { - this._user = user; - this._receivedInitialUser.resolve(); - }); - } - - _setCredentialChangeListener( - credentialListener: CredentialChangeListener - ): void { - logDebug(LOG_TAG, 'Registering credential change listener'); - this._credentialListener = credentialListener; - // eslint-disable-next-line @typescript-eslint/no-floating-promises - this._receivedInitialUser.promise.then(() => - this._credentialListener(this._user) - ); - } - - async _getConfiguration(): Promise { - const settings = this._getSettings(); - await this._receivedInitialUser.promise; - const databaseInfo = new DatabaseInfo( - this._databaseId, - this._persistenceKey, - settings.host ?? DEFAULT_HOST, - settings.ssl ?? DEFAULT_SSL, - /* forceLongPolling= */ false, - /* forceAutoDetectLongPolling= */ true - ); - return { - asyncQueue: this._queue, - databaseInfo, - clientId: this._clientId, - credentials: this._credentials, - initialUser: this._user, - maxConcurrentLimboResolutions: MAX_CONCURRENT_LIMBO_RESOLUTIONS - }; - } - - _getSettings(): Settings { - return super._getSettings(); } _terminate(): Promise { - this._queue.enterRestrictedMode(); - const deferred = new Deferred(); - this._queue.enqueueAndForgetEvenWhileRestricted(async () => { - try { - await super._terminate(); - await removeComponents(this); - - // `removeChangeListener` must be called after shutting down the - // RemoteStore as it will prevent the RemoteStore from retrieving - // auth tokens. - this._credentials.removeChangeListener(); - - deferred.resolve(); - } catch (e) { - const firestoreError = wrapInUserErrorIfRecoverable( - e, - `Failed to shutdown persistence` - ); - deferred.reject(firestoreError); - } - }); - return deferred.promise; - } - - _verifyNotTerminated(): void { - if (this._terminated) { - throw new FirestoreError( - Code.FAILED_PRECONDITION, - 'The client has already been terminated.' - ); + if (!this._firestoreClient) { + // The client must be initialized to ensure that all subsequent API + // usage throws an exception. + configureFirestore(this); } + return this._firestoreClient!.terminate(); } } @@ -202,15 +117,15 @@ export function initializeFirestore( if ( settings.cacheSizeBytes !== undefined && settings.cacheSizeBytes !== CACHE_SIZE_UNLIMITED && - settings.cacheSizeBytes < LruParams.MINIMUM_CACHE_SIZE_BYTES + settings.cacheSizeBytes < LRU_MINIMUM_CACHE_SIZE_BYTES ) { throw new FirestoreError( Code.INVALID_ARGUMENT, - `cacheSizeBytes must be at least ${LruParams.MINIMUM_CACHE_SIZE_BYTES}` + `cacheSizeBytes must be at least ${LRU_MINIMUM_CACHE_SIZE_BYTES}` ); } - firestore._configureClient(settings); + firestore._setSettings(settings); return firestore; } @@ -250,15 +165,12 @@ export function getFirestore(app: FirebaseApp): FirebaseFirestore { * @return A promise that represents successfully enabling persistent storage. */ export function enableIndexedDbPersistence( - firestore: FirebaseFirestore, + firestore: FirestoreCompat, persistenceSettings?: PersistenceSettings ): Promise { verifyNotInitialized(firestore); - // `_getSettings()` freezes the client settings and prevents further changes - // to the components (as `verifyNotInitialized()` would fail). Components can - // then be accessed via `getOfflineComponentProvider()` and - // `getOnlineComponentProvider()` + const client = ensureFirestoreConfigured(firestore); const settings = firestore._getSettings(); const onlineComponentProvider = new OnlineComponentProvider(); @@ -268,7 +180,7 @@ export function enableIndexedDbPersistence( persistenceSettings?.forceOwnership ); return setPersistenceProviders( - firestore, + client, onlineComponentProvider, offlineComponentProvider ); @@ -297,14 +209,11 @@ export function enableIndexedDbPersistence( * storage. */ export function enableMultiTabIndexedDbPersistence( - firestore: FirebaseFirestore + firestore: FirestoreCompat ): Promise { verifyNotInitialized(firestore); - // `_getSettings()` freezes the client settings and prevents further changes - // to the components (as `verifyNotInitialized()` would fail). Components can - // then be accessed via `getOfflineComponentProvider()` and - // `getOnlineComponentProvider()` + const client = ensureFirestoreConfigured(firestore); const settings = firestore._getSettings(); const onlineComponentProvider = new OnlineComponentProvider(); @@ -313,7 +222,7 @@ export function enableMultiTabIndexedDbPersistence( settings.cacheSizeBytes ); return setPersistenceProviders( - firestore, + client, onlineComponentProvider, offlineComponentProvider ); @@ -326,16 +235,16 @@ export function enableMultiTabIndexedDbPersistence( * but the client remains usable. */ function setPersistenceProviders( - firestore: FirebaseFirestore, + client: FirestoreClient, onlineComponentProvider: OnlineComponentProvider, offlineComponentProvider: OfflineComponentProvider ): Promise { const persistenceResult = new Deferred(); - return firestore._queue + return client.asyncQueue .enqueue(async () => { try { - await setOfflineComponentProvider(firestore, offlineComponentProvider); - await setOnlineComponentProvider(firestore, onlineComponentProvider); + await setOfflineComponentProvider(client, offlineComponentProvider); + await setOnlineComponentProvider(client, onlineComponentProvider); persistenceResult.resolve(); } catch (e) { if (!canFallbackFromIndexedDbError(e)) { @@ -356,9 +265,7 @@ function setPersistenceProviders( * Decides whether the provided error allows us to gracefully disable * persistence (as opposed to crashing the client). */ -// TODO(schmidt-sebastian): Remove `export` in -// https://github.com/firebase/firebase-js-sdk/pull/3901 -export function canFallbackFromIndexedDbError( +function canFallbackFromIndexedDbError( error: FirestoreError | DOMException ): boolean { if (error.name === 'FirebaseError') { @@ -415,7 +322,7 @@ export function canFallbackFromIndexedDbError( * cleared. Otherwise, the promise is rejected with an error. */ export function clearIndexedDbPersistence( - firestore: FirebaseFirestore + firestore: FirestoreCompat ): Promise { if (firestore._initialized && !firestore._terminated) { throw new FirestoreError( @@ -458,14 +365,8 @@ export function clearIndexedDbPersistence( export function waitForPendingWrites( firestore: FirebaseFirestore ): Promise { - firestore._verifyNotTerminated(); - - const deferred = new Deferred(); - firestore._queue.enqueueAndForget(async () => { - const syncEngine = await getSyncEngine(firestore); - return registerPendingWritesCallback(syncEngine, deferred); - }); - return deferred.promise; + const client = ensureFirestoreConfigured(firestore); + return firestoreClientWaitForPendingWrites(client); } /** @@ -475,14 +376,8 @@ export function waitForPendingWrites( * @return A promise that is resolved once the network has been enabled. */ export function enableNetwork(firestore: FirebaseFirestore): Promise { - firestore._verifyNotTerminated(); - - return firestore._queue.enqueue(async () => { - const remoteStore = await getRemoteStore(firestore); - const persistence = await getPersistence(firestore); - persistence.setNetworkEnabled(true); - return remoteStoreEnableNetwork(remoteStore); - }); + const client = ensureFirestoreConfigured(firestore); + return firestoreClientEnableNetwork(client); } /** @@ -494,14 +389,8 @@ export function enableNetwork(firestore: FirebaseFirestore): Promise { * @return A promise that is resolved once the network has been disabled. */ export function disableNetwork(firestore: FirebaseFirestore): Promise { - firestore._verifyNotTerminated(); - - return firestore._queue.enqueue(async () => { - const remoteStore = await getRemoteStore(firestore); - const persistence = await getPersistence(firestore); - persistence.setNetworkEnabled(false); - return remoteStoreDisableNetwork(remoteStore); - }); + const client = ensureFirestoreConfigured(firestore); + return firestoreClientDisableNetwork(client); } /** @@ -531,7 +420,7 @@ export function terminate(firestore: FirebaseFirestore): Promise { return firestore._delete(); } -function verifyNotInitialized(firestore: FirebaseFirestore): void { +function verifyNotInitialized(firestore: FirestoreCompat): void { if (firestore._initialized || firestore._terminated) { throw new FirestoreError( Code.FAILED_PRECONDITION, diff --git a/packages/firestore/exp/src/api/reference.ts b/packages/firestore/exp/src/api/reference.ts index e211ff9f5e6..06cc7a5094c 100644 --- a/packages/firestore/exp/src/api/reference.ts +++ b/packages/firestore/exp/src/api/reference.ts @@ -28,6 +28,7 @@ import { cast } from '../../../src/util/input_validation'; import { DocumentSnapshot, QuerySnapshot } from './snapshot'; import { applyFirestoreDataConverter, + ensureFirestoreConfigured, SnapshotMetadata, validateHasExplicitOrderByForLimitToLast } from '../../../src/api/database'; @@ -56,19 +57,20 @@ import { PartialObserver, Unsubscribe } from '../../../src/api/observer'; -import { getEventManager, getLocalStore, getSyncEngine } from './components'; import { + getEventManager, executeQueryFromCache, executeQueryViaSnapshotListener, readDocumentFromCache, - readDocumentViaSnapshotListener + readDocumentViaSnapshotListener, + getLocalStore, + firestoreClientWrite } from '../../../src/core/firestore_client'; import { newQueryForPath, Query as InternalQuery } from '../../../src/core/query'; import { Deferred } from '../../../src/util/promise'; -import { syncEngineWrite } from '../../../src/core/sync_engine'; import { AsyncObserver } from '../../../src/util/async_observer'; import { addSnapshotsInSyncListener, @@ -108,11 +110,11 @@ export function getDoc( reference: DocumentReference ): Promise> { const firestore = cast(reference.firestore, FirebaseFirestore); - firestore._verifyNotTerminated(); + const client = ensureFirestoreConfigured(firestore); const deferred = new Deferred(); firestore._queue.enqueueAndForget(async () => { - const eventManager = await getEventManager(firestore); + const eventManager = await getEventManager(client); await readDocumentViaSnapshotListener( eventManager, firestore._queue, @@ -137,11 +139,11 @@ export function getDocFromCache( reference: DocumentReference ): Promise> { const firestore = cast(reference.firestore, FirebaseFirestore); - firestore._verifyNotTerminated(); + const client = ensureFirestoreConfigured(firestore); const deferred = new Deferred(); firestore._queue.enqueueAndForget(async () => { - const localStore = await getLocalStore(firestore); + const localStore = await getLocalStore(client); await readDocumentFromCache(localStore, reference._key, deferred); }); return deferred.promise.then( @@ -170,11 +172,11 @@ export function getDocFromServer( reference: DocumentReference ): Promise> { const firestore = cast(reference.firestore, FirebaseFirestore); - firestore._verifyNotTerminated(); + const client = ensureFirestoreConfigured(firestore); const deferred = new Deferred(); firestore._queue.enqueueAndForget(async () => { - const eventManager = await getEventManager(firestore); + const eventManager = await getEventManager(client); await readDocumentViaSnapshotListener( eventManager, firestore._queue, @@ -200,13 +202,13 @@ export function getDocFromServer( */ export function getDocs(query: Query): Promise> { const firestore = cast(query.firestore, FirebaseFirestore); - firestore._verifyNotTerminated(); + const client = ensureFirestoreConfigured(firestore); validateHasExplicitOrderByForLimitToLast(query._query); const deferred = new Deferred(); firestore._queue.enqueueAndForget(async () => { - const eventManager = await getEventManager(firestore); + const eventManager = await getEventManager(client); await executeQueryViaSnapshotListener( eventManager, firestore._queue, @@ -230,11 +232,11 @@ export function getDocsFromCache( query: Query ): Promise> { const firestore = cast(query.firestore, FirebaseFirestore); - firestore._verifyNotTerminated(); + const client = ensureFirestoreConfigured(firestore); const deferred = new Deferred(); firestore._queue.enqueueAndForget(async () => { - const localStore = await getLocalStore(firestore); + const localStore = await getLocalStore(client); await executeQueryFromCache(localStore, query._query, deferred); }); return deferred.promise.then( @@ -252,11 +254,11 @@ export function getDocsFromServer( query: Query ): Promise> { const firestore = cast(query.firestore, FirebaseFirestore); - firestore._verifyNotTerminated(); + const client = ensureFirestoreConfigured(firestore); const deferred = new Deferred(); firestore._queue.enqueueAndForget(async () => { - const eventManager = await getEventManager(firestore); + const eventManager = await getEventManager(client); await executeQueryViaSnapshotListener( eventManager, firestore._queue, @@ -305,7 +307,6 @@ export function setDoc( options?: SetOptions ): Promise { const firestore = cast(reference.firestore, FirebaseFirestore); - firestore._verifyNotTerminated(); const convertedValue = applyFirestoreDataConverter( reference._converter, @@ -370,7 +371,6 @@ export function updateDoc( ...moreFieldsAndValues: unknown[] ): Promise { const firestore = cast(reference.firestore, FirebaseFirestore); - firestore._verifyNotTerminated(); const dataReader = newUserDataReader(firestore); @@ -414,8 +414,6 @@ export function deleteDoc( reference: DocumentReference ): Promise { const firestore = cast(reference.firestore, FirebaseFirestore); - firestore._verifyNotTerminated(); - const mutations = [new DeleteMutation(reference._key, Precondition.none())]; return executeWrite(firestore, mutations); } @@ -435,7 +433,6 @@ export function addDoc( data: T ): Promise> { const firestore = cast(reference.firestore, FirebaseFirestore); - firestore._verifyNotTerminated(); const docRef = doc(reference); const convertedValue = applyFirestoreDataConverter( @@ -714,7 +711,7 @@ export function onSnapshot( validateHasExplicitOrderByForLimitToLast(reference._query); } - firestore._verifyNotTerminated(); + const client = ensureFirestoreConfigured(firestore); const wrappedObserver = new AsyncObserver(observer); const listener = new QueryListener( @@ -723,14 +720,14 @@ export function onSnapshot( internalOptions ); firestore._queue.enqueueAndForget(async () => { - const eventManager = await getEventManager(firestore); + const eventManager = await getEventManager(client); return eventManagerListen(eventManager, listener); }); return () => { wrappedObserver.mute(); firestore._queue.enqueueAndForget(async () => { - const eventManager = await getEventManager(firestore); + const eventManager = await getEventManager(client); return eventManagerUnlisten(eventManager, listener); }); }; @@ -786,7 +783,7 @@ export function onSnapshotsInSync( firestore: FirebaseFirestore, arg: unknown ): Unsubscribe { - firestore._verifyNotTerminated(); + const client = ensureFirestoreConfigured(firestore); const observer = isPartialObserver(arg) ? (arg as PartialObserver) @@ -796,14 +793,14 @@ export function onSnapshotsInSync( const wrappedObserver = new AsyncObserver(observer); firestore._queue.enqueueAndForget(async () => { - const eventManager = await getEventManager(firestore); + const eventManager = await getEventManager(client); addSnapshotsInSyncListener(eventManager, wrappedObserver); }); return () => { wrappedObserver.mute(); firestore._queue.enqueueAndForget(async () => { - const eventManager = await getEventManager(firestore); + const eventManager = await getEventManager(client); removeSnapshotsInSyncListener(eventManager, wrappedObserver); }); }; @@ -814,12 +811,8 @@ export function executeWrite( firestore: FirebaseFirestore, mutations: Mutation[] ): Promise { - const deferred = new Deferred(); - firestore._queue.enqueueAndForget(async () => { - const syncEngine = await getSyncEngine(firestore); - return syncEngineWrite(syncEngine, mutations, deferred); - }); - return deferred.promise; + const client = ensureFirestoreConfigured(firestore); + return firestoreClientWrite(client, mutations); } /** diff --git a/packages/firestore/exp/src/api/transaction.ts b/packages/firestore/exp/src/api/transaction.ts index 6e93d44f079..557f74ebc32 100644 --- a/packages/firestore/exp/src/api/transaction.ts +++ b/packages/firestore/exp/src/api/transaction.ts @@ -21,7 +21,10 @@ import { TransactionRunner } from '../../../src/core/transaction_runner'; import { AsyncQueue } from '../../../src/util/async_queue'; import { FirebaseFirestore } from './database'; import { Deferred } from '../../../src/util/promise'; -import { SnapshotMetadata } from '../../../src/api/database'; +import { + ensureFirestoreConfigured, + SnapshotMetadata +} from '../../../src/api/database'; import { Transaction as InternalTransaction } from '../../../src/core/transaction'; import { validateReference } from '../../../lite/src/api/write_batch'; import { getDatastore } from '../../../lite/src/api/components'; @@ -91,7 +94,7 @@ export function runTransaction( firestore: FirebaseFirestore, updateFunction: (transaction: Transaction) => Promise ): Promise { - firestore._verifyNotTerminated(); + ensureFirestoreConfigured(firestore); const deferred = new Deferred(); firestore._queue.enqueueAndForget(async () => { diff --git a/packages/firestore/exp/src/api/write_batch.ts b/packages/firestore/exp/src/api/write_batch.ts index 4bf887696b5..9296026d7b3 100644 --- a/packages/firestore/exp/src/api/write_batch.ts +++ b/packages/firestore/exp/src/api/write_batch.ts @@ -18,6 +18,7 @@ import { WriteBatch } from '../../../lite/src/api/write_batch'; import { FirebaseFirestore } from './database'; import { executeWrite } from './reference'; +import { ensureFirestoreConfigured } from '../../../src/api/database'; /** * Creates a write batch, used for performing multiple writes as a single @@ -31,7 +32,7 @@ import { executeWrite } from './reference'; * writes. */ export function writeBatch(firestore: FirebaseFirestore): WriteBatch { - firestore._verifyNotTerminated(); + ensureFirestoreConfigured(firestore); return new WriteBatch(firestore, mutations => executeWrite(firestore, mutations) ); diff --git a/packages/firestore/lite/dependencies.json b/packages/firestore/lite/dependencies.json index 7d6d129d910..a7511b2eb37 100644 --- a/packages/firestore/lite/dependencies.json +++ b/packages/firestore/lite/dependencies.json @@ -14,7 +14,8 @@ "primitiveComparator", "registerFirestore", "removeComponents", - "uint8ArrayFromBinaryString" + "uint8ArrayFromBinaryString", + "validateIsNotUsedTogether" ], "classes": [ "ByteString", @@ -23,12 +24,13 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User" ], "variables": [] }, - "sizeInBytes": 9261 + "sizeInBytes": 11267 }, "CollectionReference": { "dependencies": { @@ -42,7 +44,8 @@ "newQueryForPath", "primitiveComparator", "registerFirestore", - "removeComponents" + "removeComponents", + "validateIsNotUsedTogether" ], "classes": [ "BasePath", @@ -53,6 +56,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "Query", "QueryImpl", @@ -62,7 +66,7 @@ ], "variables": [] }, - "sizeInBytes": 12275 + "sizeInBytes": 14284 }, "DocumentReference": { "dependencies": { @@ -76,7 +80,8 @@ "newQueryForPath", "primitiveComparator", "registerFirestore", - "removeComponents" + "removeComponents", + "validateIsNotUsedTogether" ], "classes": [ "BasePath", @@ -87,6 +92,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "Query", "QueryImpl", @@ -96,7 +102,7 @@ ], "variables": [] }, - "sizeInBytes": 12273 + "sizeInBytes": 14282 }, "DocumentSnapshot": { "dependencies": { @@ -112,13 +118,10 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "getLocalWriteTime", "getPreviousValue", "hardAssert", - "invalidClassError", - "isPlainObject", "isServerTimestamp", "isValidResourceName", "logDebug", @@ -127,18 +130,12 @@ "normalizeByteString", "normalizeNumber", "normalizeTimestamp", - "ordinal", "primitiveComparator", "registerFirestore", "removeComponents", - "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", - "validateType", - "valueDescription" + "validateIsNotUsedTogether" ], "classes": [ "BasePath", @@ -154,6 +151,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GeoPoint", "OAuthToken", "Query", @@ -168,7 +166,7 @@ ], "variables": [] }, - "sizeInBytes": 29240 + "sizeInBytes": 28090 }, "FieldPath": { "dependencies": { @@ -176,20 +174,13 @@ "argToString", "fail", "formatJSON", - "formatPlural", "hardAssert", - "isPlainObject", "logDebug", "logError", - "ordinal", "primitiveComparator", "registerFirestore", "removeComponents", - "tryGetCustomObjectType", - "validateArgType", - "validateNamedArrayAtLeastNumberOfElements", - "validateType", - "valueDescription" + "validateIsNotUsedTogether" ], "classes": [ "BasePath", @@ -199,13 +190,14 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User", "_BaseFieldPath" ], "variables": [] }, - "sizeInBytes": 13442 + "sizeInBytes": 13205 }, "FieldValue": { "dependencies": { @@ -218,7 +210,8 @@ "logError", "primitiveComparator", "registerFirestore", - "removeComponents" + "removeComponents", + "validateIsNotUsedTogether" ], "classes": [ "DatabaseId", @@ -226,12 +219,13 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User" ], "variables": [] }, - "sizeInBytes": 7473 + "sizeInBytes": 9479 }, "FirebaseFirestore": { "dependencies": { @@ -244,19 +238,21 @@ "logError", "primitiveComparator", "registerFirestore", - "removeComponents" + "removeComponents", + "validateIsNotUsedTogether" ], "classes": [ "DatabaseId", "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User" ], "variables": [] }, - "sizeInBytes": 7408 + "sizeInBytes": 9414 }, "GeoPoint": { "dependencies": { @@ -264,33 +260,27 @@ "argToString", "fail", "formatJSON", - "formatPlural", "hardAssert", - "isPlainObject", "logDebug", "logError", - "ordinal", "primitiveComparator", "registerFirestore", "removeComponents", - "tryGetCustomObjectType", - "validateArgType", - "validateExactNumberOfArgs", - "validateType", - "valueDescription" + "validateIsNotUsedTogether" ], "classes": [ "DatabaseId", "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GeoPoint", "OAuthToken", "User" ], "variables": [] }, - "sizeInBytes": 10332 + "sizeInBytes": 10140 }, "Query": { "dependencies": { @@ -303,20 +293,22 @@ "logError", "primitiveComparator", "registerFirestore", - "removeComponents" + "removeComponents", + "validateIsNotUsedTogether" ], "classes": [ "DatabaseId", "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "Query", "User" ], "variables": [] }, - "sizeInBytes": 7619 + "sizeInBytes": 9625 }, "QueryConstraint": { "dependencies": { @@ -329,20 +321,22 @@ "logError", "primitiveComparator", "registerFirestore", - "removeComponents" + "removeComponents", + "validateIsNotUsedTogether" ], "classes": [ "DatabaseId", "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "QueryConstraint", "User" ], "variables": [] }, - "sizeInBytes": 7429 + "sizeInBytes": 9435 }, "QueryDocumentSnapshot": { "dependencies": { @@ -358,13 +352,10 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "getLocalWriteTime", "getPreviousValue", "hardAssert", - "invalidClassError", - "isPlainObject", "isServerTimestamp", "isValidResourceName", "logDebug", @@ -373,18 +364,12 @@ "normalizeByteString", "normalizeNumber", "normalizeTimestamp", - "ordinal", "primitiveComparator", "registerFirestore", "removeComponents", - "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", - "validateType", - "valueDescription" + "validateIsNotUsedTogether" ], "classes": [ "BasePath", @@ -400,6 +385,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GeoPoint", "OAuthToken", "Query", @@ -414,7 +400,7 @@ ], "variables": [] }, - "sizeInBytes": 29245 + "sizeInBytes": 28095 }, "QuerySnapshot": { "dependencies": { @@ -427,20 +413,22 @@ "logError", "primitiveComparator", "registerFirestore", - "removeComponents" + "removeComponents", + "validateIsNotUsedTogether" ], "classes": [ "DatabaseId", "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "QuerySnapshot", "User" ], "variables": [] }, - "sizeInBytes": 7655 + "sizeInBytes": 9663 }, "Timestamp": { "dependencies": { @@ -453,20 +441,22 @@ "logError", "primitiveComparator", "registerFirestore", - "removeComponents" + "removeComponents", + "validateIsNotUsedTogether" ], "classes": [ "DatabaseId", "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "Timestamp", "User" ], "variables": [] }, - "sizeInBytes": 9024 + "sizeInBytes": 11030 }, "Transaction": { "dependencies": { @@ -487,14 +477,12 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fullyQualifiedPrefixPath", "geoPointEquals", "getLocalWriteTime", "getPreviousValue", "hardAssert", - "invalidClassError", "isEmpty", "isMapValue", "isNegativeZero", @@ -515,7 +503,6 @@ "numberEquals", "objectEquals", "objectSize", - "ordinal", "parseArray", "parseData", "parseObject", @@ -537,12 +524,9 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validatePlainObject", "validateReference", - "validateType", "valueDescription", "valueEquals" ], @@ -566,6 +550,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GeoPoint", "JsonProtoSerializer", "MaybeDocument", @@ -595,7 +580,7 @@ ], "variables": [] }, - "sizeInBytes": 52376 + "sizeInBytes": 52241 }, "WriteBatch": { "dependencies": { @@ -615,13 +600,11 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fullyQualifiedPrefixPath", "geoPointEquals", "getLocalWriteTime", "hardAssert", - "invalidClassError", "isEmpty", "isMapValue", "isNegativeZero", @@ -640,7 +623,6 @@ "numberEquals", "objectEquals", "objectSize", - "ordinal", "parseArray", "parseData", "parseObject", @@ -662,12 +644,9 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validatePlainObject", "validateReference", - "validateType", "valueDescription", "valueEquals" ], @@ -687,6 +666,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GeoPoint", "JsonProtoSerializer", "Mutation", @@ -710,7 +690,7 @@ ], "variables": [] }, - "sizeInBytes": 44675 + "sizeInBytes": 44694 }, "addDoc": { "dependencies": { @@ -733,7 +713,6 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fullyQualifiedPrefixPath", "geoPointEquals", @@ -741,7 +720,6 @@ "getEncodedDatabaseId", "getLocalWriteTime", "hardAssert", - "invalidClassError", "invokeCommitRpc", "isEmpty", "isMapValue", @@ -755,6 +733,7 @@ "logError", "logWarn", "looksLikeJsonObject", + "makeDatabaseInfo", "mapCodeFromRpcCode", "newConnection", "newDatastore", @@ -768,7 +747,6 @@ "numberEquals", "objectEquals", "objectSize", - "ordinal", "parseArray", "parseData", "parseObject", @@ -796,13 +774,10 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", "validateDocumentPath", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validateNonEmptyArgument", "validatePlainObject", - "validateType", "valueDescription", "valueEquals" ], @@ -830,6 +805,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GeoPoint", "GrpcConnection", "JsonProtoSerializer", @@ -858,7 +834,7 @@ ], "variables": [] }, - "sizeInBytes": 53971 + "sizeInBytes": 54194 }, "arrayRemove": { "dependencies": { @@ -873,7 +849,6 @@ "fail", "forEach", "formatJSON", - "formatPlural", "fullyQualifiedPrefixPath", "hardAssert", "isEmpty", @@ -884,7 +859,6 @@ "logDebug", "logError", "looksLikeJsonObject", - "ordinal", "parseArray", "parseData", "parseObject", @@ -901,11 +875,8 @@ "toTimestamp", "tryGetCustomObjectType", "uint8ArrayFromBinaryString", - "validateArgType", - "validateAtLeastNumberOfArgs", - "validateExactNumberOfArgs", + "validateIsNotUsedTogether", "validatePlainObject", - "validateType", "valueDescription" ], "classes": [ @@ -921,6 +892,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GeoPoint", "OAuthToken", "ParseContext", @@ -932,7 +904,7 @@ ], "variables": [] }, - "sizeInBytes": 25750 + "sizeInBytes": 26199 }, "arrayUnion": { "dependencies": { @@ -947,7 +919,6 @@ "fail", "forEach", "formatJSON", - "formatPlural", "fullyQualifiedPrefixPath", "hardAssert", "isEmpty", @@ -958,7 +929,6 @@ "logDebug", "logError", "looksLikeJsonObject", - "ordinal", "parseArray", "parseData", "parseObject", @@ -975,11 +945,8 @@ "toTimestamp", "tryGetCustomObjectType", "uint8ArrayFromBinaryString", - "validateArgType", - "validateAtLeastNumberOfArgs", - "validateExactNumberOfArgs", + "validateIsNotUsedTogether", "validatePlainObject", - "validateType", "valueDescription" ], "classes": [ @@ -995,6 +962,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GeoPoint", "OAuthToken", "ParseContext", @@ -1006,7 +974,7 @@ ], "variables": [] }, - "sizeInBytes": 25742 + "sizeInBytes": 26192 }, "collection": { "dependencies": { @@ -1023,6 +991,7 @@ "registerFirestore", "removeComponents", "validateCollectionPath", + "validateIsNotUsedTogether", "validateNonEmptyArgument" ], "classes": [ @@ -1034,6 +1003,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "Query", "QueryImpl", @@ -1043,7 +1013,7 @@ ], "variables": [] }, - "sizeInBytes": 13494 + "sizeInBytes": 15497 }, "collectionGroup": { "dependencies": { @@ -1059,6 +1029,7 @@ "primitiveComparator", "registerFirestore", "removeComponents", + "validateIsNotUsedTogether", "validateNonEmptyArgument" ], "classes": [ @@ -1067,6 +1038,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "Query", "QueryImpl", @@ -1075,7 +1047,7 @@ ], "variables": [] }, - "sizeInBytes": 11083 + "sizeInBytes": 13092 }, "deleteDoc": { "dependencies": { @@ -1095,6 +1067,7 @@ "logDebug", "logError", "logWarn", + "makeDatabaseInfo", "mapCodeFromRpcCode", "newConnection", "newDatastore", @@ -1111,7 +1084,8 @@ "toPrecondition", "toResourceName", "toTimestamp", - "toVersion" + "toVersion", + "validateIsNotUsedTogether" ], "classes": [ "ArrayRemoveTransformOperation", @@ -1126,6 +1100,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GrpcConnection", "JsonProtoSerializer", "Mutation", @@ -1144,7 +1119,7 @@ ], "variables": [] }, - "sizeInBytes": 23539 + "sizeInBytes": 25758 }, "deleteField": { "dependencies": { @@ -1158,7 +1133,8 @@ "logError", "primitiveComparator", "registerFirestore", - "removeComponents" + "removeComponents", + "validateIsNotUsedTogether" ], "classes": [ "DatabaseId", @@ -1167,12 +1143,13 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User" ], "variables": [] }, - "sizeInBytes": 8007 + "sizeInBytes": 10013 }, "doc": { "dependencies": { @@ -1190,6 +1167,7 @@ "registerFirestore", "removeComponents", "validateDocumentPath", + "validateIsNotUsedTogether", "validateNonEmptyArgument" ], "classes": [ @@ -1202,6 +1180,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "Query", "QueryImpl", @@ -1211,7 +1190,7 @@ ], "variables": [] }, - "sizeInBytes": 14039 + "sizeInBytes": 16042 }, "documentId": { "dependencies": { @@ -1220,20 +1199,13 @@ "documentId", "fail", "formatJSON", - "formatPlural", "hardAssert", - "isPlainObject", "logDebug", "logError", - "ordinal", "primitiveComparator", "registerFirestore", "removeComponents", - "tryGetCustomObjectType", - "validateArgType", - "validateNamedArrayAtLeastNumberOfElements", - "validateType", - "valueDescription" + "validateIsNotUsedTogether" ], "classes": [ "BasePath", @@ -1243,13 +1215,14 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User", "_BaseFieldPath" ], "variables": [] }, - "sizeInBytes": 13492 + "sizeInBytes": 13255 }, "endAt": { "dependencies": { @@ -1267,7 +1240,6 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fullyQualifiedPrefixPath", "getFirstOrderByField", @@ -1275,7 +1247,6 @@ "getLocalWriteTime", "getPreviousValue", "hardAssert", - "invalidClassError", "isCollectionGroupQuery", "isEmpty", "isNegativeZero", @@ -1296,7 +1267,6 @@ "normalizeByteString", "normalizeNumber", "normalizeTimestamp", - "ordinal", "parseArray", "parseData", "parseObject", @@ -1318,11 +1288,8 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validatePlainObject", - "validateType", "valueDescription" ], "classes": [ @@ -1342,6 +1309,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GeoPoint", "JsonProtoSerializer", "OAuthToken", @@ -1362,7 +1330,7 @@ ], "variables": [] }, - "sizeInBytes": 43026 + "sizeInBytes": 42825 }, "endBefore": { "dependencies": { @@ -1380,7 +1348,6 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fullyQualifiedPrefixPath", "getFirstOrderByField", @@ -1388,7 +1355,6 @@ "getLocalWriteTime", "getPreviousValue", "hardAssert", - "invalidClassError", "isCollectionGroupQuery", "isEmpty", "isNegativeZero", @@ -1409,7 +1375,6 @@ "normalizeByteString", "normalizeNumber", "normalizeTimestamp", - "ordinal", "parseArray", "parseData", "parseObject", @@ -1431,11 +1396,8 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validatePlainObject", - "validateType", "valueDescription" ], "classes": [ @@ -1455,6 +1417,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GeoPoint", "JsonProtoSerializer", "OAuthToken", @@ -1475,7 +1438,7 @@ ], "variables": [] }, - "sizeInBytes": 43037 + "sizeInBytes": 42836 }, "getDoc": { "dependencies": { @@ -1497,7 +1460,6 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fromFound", "fromMaybeDocument", @@ -1514,17 +1476,16 @@ "getLocalWriteTime", "getPreviousValue", "hardAssert", - "invalidClassError", "invokeBatchGetDocumentsRpc", "isMapValue", "isNegativeZero", - "isPlainObject", "isServerTimestamp", "isValidResourceName", "loadProtos", "logDebug", "logError", "logWarn", + "makeDatabaseInfo", "mapCodeFromRpcCode", "newConnection", "newDatastore", @@ -1537,21 +1498,15 @@ "numberEquals", "objectEquals", "objectSize", - "ordinal", "primitiveComparator", "registerFirestore", "removeComponents", "timestampEquals", "toName", "toResourceName", - "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", - "validateType", - "valueDescription", + "validateIsNotUsedTogether", "valueEquals" ], "classes": [ @@ -1573,6 +1528,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GeoPoint", "GrpcConnection", "JsonProtoSerializer", @@ -1594,7 +1550,7 @@ ], "variables": [] }, - "sizeInBytes": 45827 + "sizeInBytes": 44891 }, "getDocs": { "dependencies": { @@ -1615,7 +1571,6 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDocument", "fromDotSeparatedString", "fromName", @@ -1632,20 +1587,19 @@ "getPreviousValue", "hardAssert", "hasLimitToLast", - "invalidClassError", "invokeRunQueryRpc", "isMapValue", "isNanValue", "isNegativeZero", "isNullOrUndefined", "isNullValue", - "isPlainObject", "isServerTimestamp", "isValidResourceName", "loadProtos", "logDebug", "logError", "logWarn", + "makeDatabaseInfo", "mapCodeFromRpcCode", "newConnection", "newDatastore", @@ -1659,7 +1613,6 @@ "numberEquals", "objectEquals", "objectSize", - "ordinal", "primitiveComparator", "queryOrderBy", "queryToTarget", @@ -1678,15 +1631,10 @@ "toQueryTarget", "toResourceName", "toUnaryOrFieldFilter", - "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", "validateHasExplicitOrderByForLimitToLast", - "validateNamedArrayAtLeastNumberOfElements", - "validateType", - "valueDescription", + "validateIsNotUsedTogether", "valueEquals" ], "classes": [ @@ -1709,6 +1657,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GeoPoint", "GrpcConnection", "JsonProtoSerializer", @@ -1732,7 +1681,7 @@ ], "variables": [] }, - "sizeInBytes": 50665 + "sizeInBytes": 49735 }, "getFirestore": { "dependencies": { @@ -1746,19 +1695,21 @@ "logError", "primitiveComparator", "registerFirestore", - "removeComponents" + "removeComponents", + "validateIsNotUsedTogether" ], "classes": [ "DatabaseId", "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User" ], "variables": [] }, - "sizeInBytes": 7500 + "sizeInBytes": 9506 }, "increment": { "dependencies": { @@ -1777,7 +1728,8 @@ "removeComponents", "toDouble", "toInteger", - "toNumber" + "toNumber", + "validateIsNotUsedTogether" ], "classes": [ "DatabaseId", @@ -1786,6 +1738,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "NumericIncrementFieldValueImpl", "NumericIncrementTransformOperation", "OAuthToken", @@ -1794,7 +1747,7 @@ ], "variables": [] }, - "sizeInBytes": 8913 + "sizeInBytes": 10919 }, "initializeFirestore": { "dependencies": { @@ -1808,19 +1761,21 @@ "logError", "primitiveComparator", "registerFirestore", - "removeComponents" + "removeComponents", + "validateIsNotUsedTogether" ], "classes": [ "DatabaseId", "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User" ], "variables": [] }, - "sizeInBytes": 7586 + "sizeInBytes": 9588 }, "limit": { "dependencies": { @@ -1832,11 +1787,11 @@ "limit", "logDebug", "logError", - "ordinal", "primitiveComparator", "queryWithLimit", "registerFirestore", "removeComponents", + "validateIsNotUsedTogether", "validatePositiveNumber" ], "classes": [ @@ -1844,6 +1799,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "Query", "QueryConstraint", @@ -1853,7 +1809,7 @@ ], "variables": [] }, - "sizeInBytes": 8980 + "sizeInBytes": 10824 }, "limitToLast": { "dependencies": { @@ -1865,11 +1821,11 @@ "limitToLast", "logDebug", "logError", - "ordinal", "primitiveComparator", "queryWithLimit", "registerFirestore", "removeComponents", + "validateIsNotUsedTogether", "validatePositiveNumber" ], "classes": [ @@ -1877,6 +1833,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "Query", "QueryConstraint", @@ -1886,7 +1843,7 @@ ], "variables": [] }, - "sizeInBytes": 9004 + "sizeInBytes": 10848 }, "orderBy": { "dependencies": { @@ -1898,29 +1855,21 @@ "fieldPathFromArgument$1", "fieldPathFromDotSeparatedString", "formatJSON", - "formatPlural", "fromDotSeparatedString", "getFirstOrderByField", "getInequalityFilterField", "hardAssert", - "invalidClassError", - "isPlainObject", "logDebug", "logError", "newQueryOrderBy", "orderBy", - "ordinal", "primitiveComparator", "queryWithAddedOrderBy", "registerFirestore", "removeComponents", - "tryGetCustomObjectType", - "validateArgType", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validateNewOrderBy", - "validateOrderByAndInequalityMatch", - "validateType", - "valueDescription" + "validateOrderByAndInequalityMatch" ], "classes": [ "BasePath", @@ -1930,6 +1879,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "OrderBy", "Query", @@ -1941,7 +1891,7 @@ ], "variables": [] }, - "sizeInBytes": 18237 + "sizeInBytes": 17679 }, "query": { "dependencies": { @@ -1955,19 +1905,21 @@ "primitiveComparator", "query", "registerFirestore", - "removeComponents" + "removeComponents", + "validateIsNotUsedTogether" ], "classes": [ "DatabaseId", "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User" ], "variables": [] }, - "sizeInBytes": 7524 + "sizeInBytes": 9530 }, "queryEqual": { "dependencies": { @@ -2011,6 +1963,7 @@ "timestampEquals", "typeOrder", "uint8ArrayFromBinaryString", + "validateIsNotUsedTogether", "valueEquals" ], "classes": [ @@ -2022,6 +1975,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "OrderBy", "Query", @@ -2031,7 +1985,7 @@ ], "variables": [] }, - "sizeInBytes": 22657 + "sizeInBytes": 24669 }, "refEqual": { "dependencies": { @@ -2046,7 +2000,8 @@ "primitiveComparator", "refEqual", "registerFirestore", - "removeComponents" + "removeComponents", + "validateIsNotUsedTogether" ], "classes": [ "BasePath", @@ -2057,6 +2012,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "Query", "QueryImpl", @@ -2066,7 +2022,7 @@ ], "variables": [] }, - "sizeInBytes": 12560 + "sizeInBytes": 14569 }, "runTransaction": { "dependencies": { @@ -2091,7 +2047,6 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fromFound", "fromMaybeDocument", @@ -2108,7 +2063,6 @@ "getMessageOrStack", "getPreviousValue", "hardAssert", - "invalidClassError", "invokeBatchGetDocumentsRpc", "invokeCommitRpc", "isEmpty", @@ -2127,6 +2081,7 @@ "logError", "logWarn", "looksLikeJsonObject", + "makeDatabaseInfo", "mapCodeFromRpcCode", "newConnection", "newDatastore", @@ -2140,7 +2095,6 @@ "numberEquals", "objectEquals", "objectSize", - "ordinal", "parseArray", "parseData", "parseObject", @@ -2170,12 +2124,9 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validatePlainObject", "validateReference", - "validateType", "valueDescription", "valueEquals" ], @@ -2209,6 +2160,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GeoPoint", "GrpcConnection", "JsonProtoSerializer", @@ -2247,7 +2199,7 @@ ], "variables": [] }, - "sizeInBytes": 77402 + "sizeInBytes": 77542 }, "serverTimestamp": { "dependencies": { @@ -2261,7 +2213,8 @@ "primitiveComparator", "registerFirestore", "removeComponents", - "serverTimestamp" + "serverTimestamp", + "validateIsNotUsedTogether" ], "classes": [ "DatabaseId", @@ -2270,6 +2223,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "ServerTimestampFieldValueImpl", "ServerTimestampTransform", @@ -2278,7 +2232,7 @@ ], "variables": [] }, - "sizeInBytes": 7995 + "sizeInBytes": 10001 }, "setDoc": { "dependencies": { @@ -2299,7 +2253,6 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fullyQualifiedPrefixPath", "geoPointEquals", @@ -2307,7 +2260,6 @@ "getEncodedDatabaseId", "getLocalWriteTime", "hardAssert", - "invalidClassError", "invokeCommitRpc", "isEmpty", "isMapValue", @@ -2321,6 +2273,7 @@ "logError", "logWarn", "looksLikeJsonObject", + "makeDatabaseInfo", "mapCodeFromRpcCode", "newConnection", "newDatastore", @@ -2333,7 +2286,6 @@ "numberEquals", "objectEquals", "objectSize", - "ordinal", "parseArray", "parseData", "parseObject", @@ -2361,11 +2313,8 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validatePlainObject", - "validateType", "valueDescription", "valueEquals" ], @@ -2389,6 +2338,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GeoPoint", "GrpcConnection", "JsonProtoSerializer", @@ -2415,7 +2365,7 @@ ], "variables": [] }, - "sizeInBytes": 49773 + "sizeInBytes": 50000 }, "setLogLevel": { "dependencies": { @@ -2429,19 +2379,21 @@ "primitiveComparator", "registerFirestore", "removeComponents", - "setLogLevel" + "setLogLevel", + "validateIsNotUsedTogether" ], "classes": [ "DatabaseId", "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User" ], "variables": [] }, - "sizeInBytes": 7465 + "sizeInBytes": 9471 }, "snapshotEqual": { "dependencies": { @@ -2462,7 +2414,6 @@ "filterEquals", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "geoPointEquals", "getFirstOrderByField", @@ -2470,9 +2421,7 @@ "getLocalWriteTime", "getPreviousValue", "hardAssert", - "invalidClassError", "isNegativeZero", - "isPlainObject", "isServerTimestamp", "isValidResourceName", "logDebug", @@ -2486,7 +2435,6 @@ "objectEquals", "objectSize", "orderByEquals", - "ordinal", "primitiveComparator", "queryEqual", "queryEquals", @@ -2497,14 +2445,9 @@ "snapshotEqual", "targetEquals", "timestampEquals", - "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", - "validateType", - "valueDescription", + "validateIsNotUsedTogether", "valueEquals" ], "classes": [ @@ -2522,6 +2465,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GeoPoint", "OAuthToken", "OrderBy", @@ -2539,7 +2483,7 @@ ], "variables": [] }, - "sizeInBytes": 36759 + "sizeInBytes": 35613 }, "startAfter": { "dependencies": { @@ -2556,7 +2500,6 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fullyQualifiedPrefixPath", "getFirstOrderByField", @@ -2564,7 +2507,6 @@ "getLocalWriteTime", "getPreviousValue", "hardAssert", - "invalidClassError", "isCollectionGroupQuery", "isEmpty", "isNegativeZero", @@ -2585,7 +2527,6 @@ "normalizeByteString", "normalizeNumber", "normalizeTimestamp", - "ordinal", "parseArray", "parseData", "parseObject", @@ -2608,11 +2549,8 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validatePlainObject", - "validateType", "valueDescription" ], "classes": [ @@ -2632,6 +2570,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GeoPoint", "JsonProtoSerializer", "OAuthToken", @@ -2652,7 +2591,7 @@ ], "variables": [] }, - "sizeInBytes": 43047 + "sizeInBytes": 42846 }, "startAt": { "dependencies": { @@ -2669,7 +2608,6 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fullyQualifiedPrefixPath", "getFirstOrderByField", @@ -2677,7 +2615,6 @@ "getLocalWriteTime", "getPreviousValue", "hardAssert", - "invalidClassError", "isCollectionGroupQuery", "isEmpty", "isNegativeZero", @@ -2698,7 +2635,6 @@ "normalizeByteString", "normalizeNumber", "normalizeTimestamp", - "ordinal", "parseArray", "parseData", "parseObject", @@ -2721,11 +2657,8 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validatePlainObject", - "validateType", "valueDescription" ], "classes": [ @@ -2745,6 +2678,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GeoPoint", "JsonProtoSerializer", "OAuthToken", @@ -2765,7 +2699,7 @@ ], "variables": [] }, - "sizeInBytes": 43037 + "sizeInBytes": 42836 }, "terminate": { "dependencies": { @@ -2779,19 +2713,21 @@ "primitiveComparator", "registerFirestore", "removeComponents", - "terminate" + "terminate", + "validateIsNotUsedTogether" ], "classes": [ "DatabaseId", "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "OAuthToken", "User" ], "variables": [] }, - "sizeInBytes": 7535 + "sizeInBytes": 9541 }, "updateDoc": { "dependencies": { @@ -2812,7 +2748,6 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fullyQualifiedPrefixPath", "geoPointEquals", @@ -2820,7 +2755,6 @@ "getEncodedDatabaseId", "getLocalWriteTime", "hardAssert", - "invalidClassError", "invokeCommitRpc", "isEmpty", "isMapValue", @@ -2834,6 +2768,7 @@ "logError", "logWarn", "looksLikeJsonObject", + "makeDatabaseInfo", "mapCodeFromRpcCode", "newConnection", "newDatastore", @@ -2846,7 +2781,6 @@ "numberEquals", "objectEquals", "objectSize", - "ordinal", "parseArray", "parseData", "parseObject", @@ -2875,11 +2809,8 @@ "typeOrder", "uint8ArrayFromBinaryString", "updateDoc", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validatePlainObject", - "validateType", "valueDescription", "valueEquals" ], @@ -2905,6 +2836,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GeoPoint", "GrpcConnection", "JsonProtoSerializer", @@ -2932,7 +2864,7 @@ ], "variables": [] }, - "sizeInBytes": 52813 + "sizeInBytes": 53042 }, "where": { "dependencies": { @@ -2961,7 +2893,6 @@ "findFilterOperator", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fullyQualifiedPrefixPath", "geoPointEquals", @@ -2969,13 +2900,10 @@ "getInequalityFilterField", "getLocalWriteTime", "hardAssert", - "invalidClassError", "isArray", "isCollectionGroupQuery", "isEmpty", - "isNanValue", "isNegativeZero", - "isNullValue", "isPlainObject", "isSafeInteger", "isServerTimestamp", @@ -2992,7 +2920,6 @@ "numberEquals", "objectEquals", "objectSize", - "ordinal", "parseArray", "parseData", "parseDocumentIdValue", @@ -3015,14 +2942,11 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", "validateDisjunctiveFilterElements", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validateNewFilter", "validateOrderByAndInequalityMatch", "validatePlainObject", - "validateType", "valueCompare", "valueDescription", "valueEquals", @@ -3045,6 +2969,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GeoPoint", "InFilter", "JsonProtoSerializer", @@ -3067,7 +2992,7 @@ ], "variables": [] }, - "sizeInBytes": 48879 + "sizeInBytes": 47911 }, "writeBatch": { "dependencies": { @@ -3089,7 +3014,6 @@ "fieldPathFromDotSeparatedString", "forEach", "formatJSON", - "formatPlural", "fromDotSeparatedString", "fullyQualifiedPrefixPath", "geoPointEquals", @@ -3097,7 +3021,6 @@ "getEncodedDatabaseId", "getLocalWriteTime", "hardAssert", - "invalidClassError", "invokeCommitRpc", "isEmpty", "isMapValue", @@ -3111,6 +3034,7 @@ "logError", "logWarn", "looksLikeJsonObject", + "makeDatabaseInfo", "mapCodeFromRpcCode", "newConnection", "newDatastore", @@ -3123,7 +3047,6 @@ "numberEquals", "objectEquals", "objectSize", - "ordinal", "parseArray", "parseData", "parseObject", @@ -3152,12 +3075,9 @@ "tryGetCustomObjectType", "typeOrder", "uint8ArrayFromBinaryString", - "validateArgType", - "validateExactNumberOfArgs", - "validateNamedArrayAtLeastNumberOfElements", + "validateIsNotUsedTogether", "validatePlainObject", "validateReference", - "validateType", "valueDescription", "valueEquals", "writeBatch" @@ -3184,6 +3104,7 @@ "FirebaseCredentialsProvider", "FirebaseFirestore", "FirestoreError", + "FirestoreSettings", "GeoPoint", "GrpcConnection", "JsonProtoSerializer", @@ -3213,6 +3134,6 @@ ], "variables": [] }, - "sizeInBytes": 56451 + "sizeInBytes": 56682 } } \ No newline at end of file diff --git a/packages/firestore/lite/src/api/components.ts b/packages/firestore/lite/src/api/components.ts index 224dd2e32fe..43e4057a231 100644 --- a/packages/firestore/lite/src/api/components.ts +++ b/packages/firestore/lite/src/api/components.ts @@ -18,8 +18,7 @@ import { Datastore, newDatastore } from '../../../src/remote/datastore'; import { newConnection } from '../../../src/platform/connection'; import { newSerializer } from '../../../src/platform/serializer'; -import { FirebaseFirestore } from './database'; -import { DatabaseInfo } from '../../../src/core/database_info'; +import { FirebaseFirestore, makeDatabaseInfo } from './database'; import { logDebug } from '../../../src/util/log'; import { Code, FirestoreError } from '../../../src/util/error'; @@ -41,7 +40,7 @@ const datastoreInstances = new Map(); /** * Returns an initialized and started Datastore for the given Firestore - * instance. Callers must invoke removeDatastore() when the Firestore + * instance. Callers must invoke removeComponents() when the Firestore * instance is terminated. */ export function getDatastore(firestore: FirebaseFirestore): Datastore { @@ -53,18 +52,13 @@ export function getDatastore(firestore: FirebaseFirestore): Datastore { } if (!datastoreInstances.has(firestore)) { logDebug(LOG_TAG, 'Initializing Datastore'); - const settings = firestore._getSettings(); - const databaseInfo = new DatabaseInfo( + const databaseInfo = makeDatabaseInfo( firestore._databaseId, firestore._persistenceKey, - settings.host ?? DEFAULT_HOST, - settings.ssl ?? DEFAULT_SSL, - /* forceLongPolling= */ false, - /* forceAutoDetectLongPolling= */ true + firestore._getSettings() ); - const connection = newConnection(databaseInfo); - const serializer = newSerializer(databaseInfo.databaseId); + const serializer = newSerializer(firestore._databaseId); const datastore = newDatastore( firestore._credentials, connection, diff --git a/packages/firestore/lite/src/api/database.ts b/packages/firestore/lite/src/api/database.ts index 1eb3d6fdd07..c42ab38f774 100644 --- a/packages/firestore/lite/src/api/database.ts +++ b/packages/firestore/lite/src/api/database.ts @@ -20,13 +20,20 @@ import { _FirebaseService, FirebaseApp } from '@firebase/app-types-exp'; import { Provider } from '@firebase/component'; import { Code, FirestoreError } from '../../../src/util/error'; -import { DatabaseId } from '../../../src/core/database_info'; +import { DatabaseId, DatabaseInfo } from '../../../src/core/database_info'; import { FirebaseAuthInternalName } from '@firebase/auth-interop-types'; import { CredentialsProvider, + CredentialsSettings, FirebaseCredentialsProvider } from '../../../src/api/credentials'; import { removeComponents } from './components'; +import { + LRU_COLLECTION_DISABLED, + LRU_DEFAULT_CACHE_SIZE_BYTES, + LRU_MINIMUM_CACHE_SIZE_BYTES +} from '../../../src/local/lru_garbage_collector'; +import { validateIsNotUsedTogether } from '../../../src/util/input_validation'; declare module '@firebase/component' { interface NameServiceMapping { @@ -34,10 +41,107 @@ declare module '@firebase/component' { } } +// settings() defaults: +const DEFAULT_HOST = 'firestore.googleapis.com'; +const DEFAULT_SSL = true; + export interface Settings { host?: string; ssl?: boolean; ignoreUndefinedProperties?: boolean; + cacheSizeBytes?: number; + experimentalForceLongPolling?: boolean; + experimentalAutoDetectLongPolling?: boolean; +} + +/** Undocumented, private additional settings not exposed in our public API. */ +interface PrivateSettings extends Settings { + // Can be a google-auth-library or gapi client. + credentials?: CredentialsSettings; +} + +/** + * A concrete type describing all the values that can be applied via a + * user-supplied firestore.Settings object. This is a separate type so that + * defaults can be supplied and the value can be checked for equality. + */ +export class FirestoreSettings { + /** The hostname to connect to. */ + readonly host: string; + + /** Whether to use SSL when connecting. */ + readonly ssl: boolean; + + readonly cacheSizeBytes: number; + + readonly experimentalForceLongPolling: boolean; + + readonly experimentalAutoDetectLongPolling: boolean; + + readonly ignoreUndefinedProperties: boolean; + + // Can be a google-auth-library or gapi client. + // eslint-disable-next-line @typescript-eslint/no-explicit-any + credentials?: any; + + constructor(settings: PrivateSettings) { + if (settings.host === undefined) { + if (settings.ssl !== undefined) { + throw new FirestoreError( + Code.INVALID_ARGUMENT, + "Can't provide ssl option if host option is not set" + ); + } + this.host = DEFAULT_HOST; + this.ssl = DEFAULT_SSL; + } else { + this.host = settings.host; + this.ssl = settings.ssl ?? DEFAULT_SSL; + } + + this.credentials = settings.credentials; + this.ignoreUndefinedProperties = !!settings.ignoreUndefinedProperties; + + if (settings.cacheSizeBytes === undefined) { + this.cacheSizeBytes = LRU_DEFAULT_CACHE_SIZE_BYTES; + } else { + if ( + settings.cacheSizeBytes !== LRU_COLLECTION_DISABLED && + settings.cacheSizeBytes < LRU_MINIMUM_CACHE_SIZE_BYTES + ) { + throw new FirestoreError( + Code.INVALID_ARGUMENT, + `cacheSizeBytes must be at least ${LRU_MINIMUM_CACHE_SIZE_BYTES}` + ); + } else { + this.cacheSizeBytes = settings.cacheSizeBytes; + } + } + + this.experimentalForceLongPolling = !!settings.experimentalForceLongPolling; + this.experimentalAutoDetectLongPolling = !!settings.experimentalAutoDetectLongPolling; + + validateIsNotUsedTogether( + 'experimentalForceLongPolling', + settings.experimentalForceLongPolling, + 'experimentalAutoDetectLongPolling', + settings.experimentalAutoDetectLongPolling + ); + } + + isEqual(other: FirestoreSettings): boolean { + return ( + this.host === other.host && + this.ssl === other.ssl && + this.credentials === other.credentials && + this.cacheSizeBytes === other.cacheSizeBytes && + this.experimentalForceLongPolling === + other.experimentalForceLongPolling && + this.experimentalAutoDetectLongPolling === + other.experimentalAutoDetectLongPolling && + this.ignoreUndefinedProperties === other.ignoreUndefinedProperties + ); + } } /** @@ -50,7 +154,6 @@ export class FirebaseFirestore implements _FirebaseService { readonly _credentials: CredentialsProvider; readonly _persistenceKey: string = '(lite)'; - // Assigned via _configureClient() protected _settings?: Settings; private _settingsFrozen = false; @@ -81,7 +184,7 @@ export class FirebaseFirestore implements _FirebaseService { return this._terminateTask !== undefined; } - _configureClient(settings: Settings): void { + _setSettings(settings: Settings): void { if (this._settingsFrozen) { throw new FirestoreError( Code.FAILED_PRECONDITION, @@ -93,12 +196,12 @@ export class FirebaseFirestore implements _FirebaseService { this._settings = settings; } - _getSettings(): Settings { + _getSettings(): FirestoreSettings { if (!this._settings) { this._settings = {}; } this._settingsFrozen = true; - return this._settings; + return new FirestoreSettings(this._settings); } private static _databaseIdFromApp(app: FirebaseApp): DatabaseId { @@ -151,7 +254,7 @@ export function initializeFirestore( app, 'firestore/lite' ).getImmediate() as FirebaseFirestore; - firestore._configureClient(settings); + firestore._setSettings(settings); return firestore; } @@ -194,3 +297,18 @@ export function terminate(firestore: FirebaseFirestore): Promise { _removeServiceInstance(firestore.app, 'firestore/lite'); return firestore._delete(); } + +export function makeDatabaseInfo( + databaseId: DatabaseId, + persistenceKey: string, + settings: FirestoreSettings +): DatabaseInfo { + return new DatabaseInfo( + databaseId, + persistenceKey, + settings.host, + settings.ssl, + settings.experimentalForceLongPolling, + settings.experimentalAutoDetectLongPolling + ); +} diff --git a/packages/firestore/src/api/database.ts b/packages/firestore/src/api/database.ts index 0f3a94a4be8..7d9e8f799f5 100644 --- a/packages/firestore/src/api/database.ts +++ b/packages/firestore/src/api/database.ts @@ -46,15 +46,8 @@ import { import { FirebaseApp } from '@firebase/app-types'; import { _FirebaseApp, FirebaseService } from '@firebase/app-types/private'; import { Blob } from './blob'; -import { DatabaseId, DatabaseInfo } from '../core/database_info'; +import { DatabaseId } from '../core/database_info'; import { ListenOptions } from '../core/event_manager'; -import { - IndexedDbOfflineComponentProvider, - MemoryOfflineComponentProvider, - MultiTabOfflineComponentProvider, - OfflineComponentProvider, - OnlineComponentProvider -} from '../core/component_provider'; import { FirestoreClient, firestoreClientAddSnapshotsInSyncListener, @@ -96,7 +89,6 @@ import { } from '../core/query'; import { Transaction as InternalTransaction } from '../core/transaction'; import { ChangeType, ViewSnapshot } from '../core/view_snapshot'; -import { LruParams } from '../local/lru_garbage_collector'; import { Document, MaybeDocument, NoDocument } from '../model/document'; import { DocumentKey } from '../model/document_key'; import { DeleteMutation, Mutation, Precondition } from '../model/mutation'; @@ -116,11 +108,9 @@ import { } from '../util/input_validation'; import { logWarn, setLogLevel as setClientLogLevel } from '../util/log'; import { AutoId } from '../util/misc'; -import { Deferred } from '../util/promise'; import { FieldPath as ExternalFieldPath } from './field_path'; import { CredentialsProvider, - CredentialsSettings, EmptyCredentialsProvider, FirebaseCredentialsProvider, makeCredentialsProvider @@ -147,26 +137,23 @@ import { UserDataWriter } from './user_data_writer'; import { FirebaseAuthInternalName } from '@firebase/auth-interop-types'; import { Provider } from '@firebase/component'; import { - indexedDbClearPersistence, - indexedDbStoragePrefix -} from '../local/indexeddb_persistence'; - -// settings() defaults: -const DEFAULT_HOST = 'firestore.googleapis.com'; -const DEFAULT_SSL = true; + clearIndexedDbPersistence, + enableIndexedDbPersistence, + enableMultiTabIndexedDbPersistence +} from '../../exp/src/api/database'; +import { LRU_COLLECTION_DISABLED } from '../local/lru_garbage_collector'; +import { + FirestoreSettings, + makeDatabaseInfo +} from '../../lite/src/api/database'; +import { DEFAULT_HOST } from '../../lite/src/api/components'; /** * Constant used to indicate the LRU garbage collection should be disabled. * Set this value as the `cacheSizeBytes` on the settings passed to the * `Firestore` instance. */ -export const CACHE_SIZE_UNLIMITED = LruParams.COLLECTION_DISABLED; - -/** Undocumented, private additional settings not exposed in our public API. */ -interface PrivateSettings extends PublicSettings { - // Can be a google-auth-library or gapi client. - credentials?: CredentialsSettings; -} +export const CACHE_SIZE_UNLIMITED = LRU_COLLECTION_DISABLED; /** * Options that can be provided in the Firestore constructor when not using @@ -177,88 +164,18 @@ export interface FirestoreDatabase { database?: string; } -/** - * A concrete type describing all the values that can be applied via a - * user-supplied firestore.Settings object. This is a separate type so that - * defaults can be supplied and the value can be checked for equality. - */ -class FirestoreSettings { - /** The hostname to connect to. */ - readonly host: string; - - /** Whether to use SSL when connecting. */ - readonly ssl: boolean; - - readonly cacheSizeBytes: number; - - readonly experimentalForceLongPolling: boolean; - - readonly experimentalAutoDetectLongPolling: boolean; - - readonly ignoreUndefinedProperties: boolean; - - // Can be a google-auth-library or gapi client. - // eslint-disable-next-line @typescript-eslint/no-explicit-any - credentials?: any; - - constructor(settings: PrivateSettings) { - if (settings.host === undefined) { - if (settings.ssl !== undefined) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - "Can't provide ssl option if host option is not set" - ); - } - this.host = DEFAULT_HOST; - this.ssl = DEFAULT_SSL; - } else { - this.host = settings.host; - this.ssl = settings.ssl ?? DEFAULT_SSL; - } - - this.credentials = settings.credentials; - this.ignoreUndefinedProperties = !!settings.ignoreUndefinedProperties; - - if (settings.cacheSizeBytes === undefined) { - this.cacheSizeBytes = LruParams.DEFAULT_CACHE_SIZE_BYTES; - } else { - if ( - settings.cacheSizeBytes !== CACHE_SIZE_UNLIMITED && - settings.cacheSizeBytes < LruParams.MINIMUM_CACHE_SIZE_BYTES - ) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - `cacheSizeBytes must be at least ${LruParams.MINIMUM_CACHE_SIZE_BYTES}` - ); - } else { - this.cacheSizeBytes = settings.cacheSizeBytes; - } - } - - this.experimentalForceLongPolling = !!settings.experimentalForceLongPolling; - this.experimentalAutoDetectLongPolling = !!settings.experimentalAutoDetectLongPolling; - - validateIsNotUsedTogether( - 'experimentalForceLongPolling', - settings.experimentalForceLongPolling, - 'experimentalAutoDetectLongPolling', - settings.experimentalAutoDetectLongPolling - ); - } - - isEqual(other: FirestoreSettings): boolean { - return ( - this.host === other.host && - this.ssl === other.ssl && - this.credentials === other.credentials && - this.cacheSizeBytes === other.cacheSizeBytes && - this.experimentalForceLongPolling === - other.experimentalForceLongPolling && - this.experimentalAutoDetectLongPolling === - other.experimentalAutoDetectLongPolling && - this.ignoreUndefinedProperties === other.ignoreUndefinedProperties - ); - } +// TODO(firestore-compat): This interface exposes internal APIs that the Compat +// layer implements to interact with the firestore-exp SDK. We can remove this +// class once we have an actual compat class for FirebaseFirestore. +export interface FirestoreCompat { + readonly _initialized: boolean; + readonly _terminated: boolean; + readonly _databaseId: DatabaseId; + readonly _persistenceKey: string; + readonly _queue: AsyncQueue; + readonly _credentials: CredentialsProvider; + _firestoreClient?: FirestoreClient; + _getSettings(): FirestoreSettings; } /** @@ -267,11 +184,11 @@ class FirestoreSettings { */ export interface PersistenceProvider { enableIndexedDbPersistence( - firestore: Firestore, + firestore: FirestoreCompat, forceOwnership: boolean ): Promise; - enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise; - clearIndexedDbPersistence(firestore: Firestore): Promise; + enableMultiTabIndexedDbPersistence(firestore: FirestoreCompat): Promise; + clearIndexedDbPersistence(firestore: FirestoreCompat): Promise; } const MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE = @@ -285,7 +202,7 @@ const MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE = */ export class MemoryPersistenceProvider implements PersistenceProvider { enableIndexedDbPersistence( - firestore: Firestore, + firestore: FirestoreCompat, forceOwnership: boolean ): Promise { throw new FirestoreError( @@ -294,14 +211,16 @@ export class MemoryPersistenceProvider implements PersistenceProvider { ); } - enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise { + enableMultiTabIndexedDbPersistence( + firestore: FirestoreCompat + ): Promise { throw new FirestoreError( Code.FAILED_PRECONDITION, MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE ); } - clearIndexedDbPersistence(firestore: Firestore): Promise { + clearIndexedDbPersistence(firestore: FirestoreCompat): Promise { throw new FirestoreError( Code.FAILED_PRECONDITION, MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE @@ -314,71 +233,34 @@ export class MemoryPersistenceProvider implements PersistenceProvider { */ export class IndexedDbPersistenceProvider implements PersistenceProvider { enableIndexedDbPersistence( - firestore: Firestore, + firestore: FirestoreCompat, forceOwnership: boolean ): Promise { - const onlineComponentProvider = new OnlineComponentProvider(); - const offlineComponentProvider = new IndexedDbOfflineComponentProvider( - onlineComponentProvider, - firestore._getSettings().cacheSizeBytes, - forceOwnership - ); - return firestore._configureClient( - offlineComponentProvider, - onlineComponentProvider - ); - } - - enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise { - const onlineComponentProvider = new OnlineComponentProvider(); - const offlineComponentProvider = new MultiTabOfflineComponentProvider( - onlineComponentProvider, - firestore._getSettings().cacheSizeBytes - ); - return firestore._configureClient( - offlineComponentProvider, - onlineComponentProvider - ); - } - - clearIndexedDbPersistence(firestore: Firestore): Promise { - const deferred = new Deferred(); - firestore._queue.enqueueAndForgetEvenWhileRestricted(async () => { - try { - await indexedDbClearPersistence( - indexedDbStoragePrefix( - firestore._databaseId, - firestore._persistenceKey - ) - ); - deferred.resolve(); - } catch (e) { - deferred.reject(e); - } - }); - return deferred.promise; + return enableIndexedDbPersistence(firestore, { forceOwnership }); } + enableMultiTabIndexedDbPersistence = enableMultiTabIndexedDbPersistence.bind( + null + ); + clearIndexedDbPersistence = clearIndexedDbPersistence.bind(null); } /** * The root reference to the database. */ -export class Firestore implements PublicFirestore, FirebaseService { +export class Firestore + implements PublicFirestore, FirebaseService, FirestoreCompat { // The objects that are a part of this API are exposed to third-parties as // compiled javascript so we want to flag our private members with a leading // underscore to discourage their use. readonly _databaseId: DatabaseId; readonly _persistenceKey: string; - private _credentials: CredentialsProvider; + _credentials: CredentialsProvider; private readonly _firebaseApp: FirebaseApp | null = null; private _settings: FirestoreSettings; // The firestore client instance. This will be available as soon as - // configureClient is called, but any calls against it will block until + // `configureFirestore()` is called, but any calls against it will block until // setup has completed. - // - // Operations on the _firestoreClient don't block on _firestoreReady. Those - // are already set to synchronize on the async queue. - private _firestoreClient: FirestoreClient | undefined; + _firestoreClient?: FirestoreClient; // Public for use in tests. // TODO(mikelehen): Use modularized initialization instead. @@ -420,6 +302,14 @@ export class Firestore implements PublicFirestore, FirebaseService { this._settings = new FirestoreSettings({}); } + get _initialized(): boolean { + return !!this._firestoreClient; + } + + get _terminated(): boolean { + return this._queue.isShuttingDown; + } + get _dataReader(): UserDataReader { debugAssert( !!this._firestoreClient, @@ -473,12 +363,12 @@ export class Firestore implements PublicFirestore, FirebaseService { } enableNetwork(): Promise { - this.ensureClientConfigured(); + ensureFirestoreConfigured(this); return firestoreClientEnableNetwork(this._firestoreClient!); } disableNetwork(): Promise { - this.ensureClientConfigured(); + ensureFirestoreConfigured(this); return firestoreClientDisableNetwork(this._firestoreClient!); } @@ -516,16 +406,6 @@ export class Firestore implements PublicFirestore, FirebaseService { } async clearPersistence(): Promise { - if ( - this._firestoreClient !== undefined && - !this._firestoreClient.clientTerminated - ) { - throw new FirestoreError( - Code.FAILED_PRECONDITION, - 'Persistence can only be cleared before a Firestore instance is ' + - 'initialized or after it is terminated.' - ); - } return this._persistenceProvider.clearIndexedDbPersistence(this); } @@ -534,20 +414,15 @@ export class Firestore implements PublicFirestore, FirebaseService { return this.INTERNAL.delete(); } - get _isTerminated(): boolean { - this.ensureClientConfigured(); - return this._firestoreClient!.clientTerminated; - } - waitForPendingWrites(): Promise { - this.ensureClientConfigured(); + ensureFirestoreConfigured(this); return firestoreClientWaitForPendingWrites(this._firestoreClient!); } onSnapshotsInSync(observer: PartialObserver): Unsubscribe; onSnapshotsInSync(onSync: () => void): Unsubscribe; onSnapshotsInSync(arg: unknown): Unsubscribe { - this.ensureClientConfigured(); + ensureFirestoreConfigured(this); if (isPartialObserver(arg)) { return firestoreClientAddSnapshotsInSyncListener( @@ -565,52 +440,6 @@ export class Firestore implements PublicFirestore, FirebaseService { } } - ensureClientConfigured(): FirestoreClient { - if (!this._firestoreClient) { - // Kick off starting the client but don't actually wait for it. - // eslint-disable-next-line @typescript-eslint/no-floating-promises - this._configureClient( - new MemoryOfflineComponentProvider(), - new OnlineComponentProvider() - ); - } - return this._firestoreClient as FirestoreClient; - } - - private makeDatabaseInfo(): DatabaseInfo { - return new DatabaseInfo( - this._databaseId, - this._persistenceKey, - this._settings.host, - this._settings.ssl, - this._settings.experimentalForceLongPolling, - this._settings.experimentalAutoDetectLongPolling - ); - } - - // TODO(schmidt-sebastian): Make this private again in - // https://github.com/firebase/firebase-js-sdk/pull/3901. - _configureClient( - offlineComponentProvider: OfflineComponentProvider, - onlineComponentProvider: OnlineComponentProvider - ): Promise { - debugAssert(!!this._settings.host, 'FirestoreSettings.host is not set'); - debugAssert( - !this._firestoreClient, - 'configureClient() called multiple times' - ); - - const databaseInfo = this.makeDatabaseInfo(); - - this._firestoreClient = new FirestoreClient(this._credentials, this._queue); - - return this._firestoreClient.start( - databaseInfo, - offlineComponentProvider, - onlineComponentProvider - ); - } - private static databaseIdFromApp(app: FirebaseApp): DatabaseId { if (!contains(app.options, 'projectId')) { throw new FirestoreError( @@ -642,16 +471,18 @@ export class Firestore implements PublicFirestore, FirebaseService { INTERNAL = { delete: async (): Promise => { - // The client must be initalized to ensure that all subsequent API usage - // throws an exception. - this.ensureClientConfigured(); + if (!this._firestoreClient) { + // The client must be initialized to ensure that all subsequent API + // usage throws an exception. + configureFirestore(this); + } await this._firestoreClient!.terminate(); } }; collection(pathString: string): PublicCollectionReference { validateNonEmptyArgument('Firestore.collection', 'path', pathString); - this.ensureClientConfigured(); + ensureFirestoreConfigured(this); return new CollectionReference( ResourcePath.fromString(pathString), this, @@ -661,7 +492,7 @@ export class Firestore implements PublicFirestore, FirebaseService { doc(pathString: string): PublicDocumentReference { validateNonEmptyArgument('Firestore.doc', 'path', pathString); - this.ensureClientConfigured(); + ensureFirestoreConfigured(this); return DocumentReference.forPath( ResourcePath.fromString(pathString), this, @@ -682,7 +513,7 @@ export class Firestore implements PublicFirestore, FirebaseService { `Firestore.collectionGroup(). Collection IDs must not contain '/'.` ); } - this.ensureClientConfigured(); + ensureFirestoreConfigured(this); return new Query( newQueryForCollectionGroup(collectionId), this, @@ -693,9 +524,9 @@ export class Firestore implements PublicFirestore, FirebaseService { runTransaction( updateFunction: (transaction: PublicTransaction) => Promise ): Promise { - const firestoreClient = this.ensureClientConfigured(); + const client = ensureFirestoreConfigured(this); return firestoreClientTransaction( - firestoreClient, + client, (transaction: InternalTransaction) => { return updateFunction(new Transaction(this, transaction)); } @@ -703,16 +534,45 @@ export class Firestore implements PublicFirestore, FirebaseService { } batch(): PublicWriteBatch { - this.ensureClientConfigured(); + ensureFirestoreConfigured(this); return new WriteBatch(this); } - // Visible for testing. - _getSettings(): PublicSettings { + _getSettings(): FirestoreSettings { return this._settings; } } +export function ensureFirestoreConfigured( + firestore: FirestoreCompat +): FirestoreClient { + if (!firestore._firestoreClient) { + configureFirestore(firestore); + } + firestore._firestoreClient!.verifyNotTerminated(); + return firestore._firestoreClient as FirestoreClient; +} + +export function configureFirestore(firestore: FirestoreCompat): void { + const settings = firestore._getSettings(); + debugAssert(!!settings.host, 'FirestoreSettings.host is not set'); + debugAssert( + !firestore._firestoreClient, + 'configureFirestore() called multiple times' + ); + + const databaseInfo = makeDatabaseInfo( + firestore._databaseId, + firestore._persistenceKey, + settings + ); + firestore._firestoreClient = new FirestoreClient( + firestore._credentials, + firestore._queue, + databaseInfo + ); +} + export function setLogLevel(level: PublicLogLevel): void { setClientLogLevel(level); } @@ -984,8 +844,8 @@ export class WriteBatch implements PublicWriteBatch { this.verifyNotCommitted(); this._committed = true; if (this._mutations.length > 0) { - const firestoreClient = this._firestore.ensureClientConfigured(); - return firestoreClientWrite(firestoreClient, this._mutations); + const client = ensureFirestoreConfigured(this._firestore); + return firestoreClientWrite(client, this._mutations); } return Promise.resolve(); @@ -1016,7 +876,7 @@ export class DocumentReference readonly _converter: FirestoreDataConverter | null ) { super(firestore._databaseId, _key, _converter); - this._firestoreClient = this.firestore.ensureClientConfigured(); + this._firestoreClient = ensureFirestoreConfigured(firestore); } static forPath( @@ -1215,10 +1075,9 @@ export class DocumentReference } get(options?: GetOptions): Promise> { - const firestoreClient = this.firestore.ensureClientConfigured(); if (options && options.source === 'cache') { return firestoreClientGetDocumentFromLocalCache( - firestoreClient, + this._firestoreClient, this._key ).then( doc => @@ -1233,7 +1092,7 @@ export class DocumentReference ); } else { return firestoreClientGetDocumentViaSnapshotListener( - firestoreClient, + this._firestoreClient, this._key, options ).then(snapshot => this._convertToDocSnapshot(snapshot)); @@ -2060,24 +1919,18 @@ export class Query implements PublicQuery { }; validateHasExplicitOrderByForLimitToLast(this._query); - const firestoreClient = this.firestore.ensureClientConfigured(); - return firestoreClientListen( - firestoreClient, - this._query, - options, - observer - ); + const client = ensureFirestoreConfigured(this.firestore); + return firestoreClientListen(client, this._query, options, observer); } get(options?: GetOptions): Promise> { - validateGetOptions('Query.get', options); validateHasExplicitOrderByForLimitToLast(this._query); - const firestoreClient = this.firestore.ensureClientConfigured(); + const client = ensureFirestoreConfigured(this.firestore); return (options && options.source === 'cache' - ? firestoreClientGetDocumentsFromLocalCache(firestoreClient, this._query) + ? firestoreClientGetDocumentsFromLocalCache(client, this._query) : firestoreClientGetDocumentsViaSnapshotListener( - firestoreClient, + client, this._query, options ) @@ -2279,14 +2132,6 @@ export class CollectionReference } } -function validateGetOptions( - methodName: string, - options: GetOptions | undefined -): void { - if (options) { - } -} - function validateReference( methodName: string, documentRef: PublicDocumentReference, diff --git a/packages/firestore/src/core/firestore_client.ts b/packages/firestore/src/core/firestore_client.ts index 869c382f0d1..eda44a6d622 100644 --- a/packages/firestore/src/core/firestore_client.ts +++ b/packages/firestore/src/core/firestore_client.ts @@ -17,27 +17,28 @@ import { GetOptions } from '@firebase/firestore-types'; -import { CredentialsProvider } from '../api/credentials'; +import { + CredentialChangeListener, + CredentialsProvider +} from '../api/credentials'; import { User } from '../auth/user'; import { executeQuery, + handleUserChange, LocalStore, readLocalDocument } from '../local/local_store'; -import { GarbageCollectionScheduler, Persistence } from '../local/persistence'; import { Document, NoDocument } from '../model/document'; import { DocumentKey } from '../model/document_key'; import { Mutation } from '../model/mutation'; import { - remoteStoreHandleCredentialChange, RemoteStore, - remoteStoreEnableNetwork, remoteStoreDisableNetwork, - remoteStoreShutdown + remoteStoreEnableNetwork, + remoteStoreHandleCredentialChange } from '../remote/remote_store'; import { AsyncQueue, wrapInUserErrorIfRecoverable } from '../util/async_queue'; import { Code, FirestoreError } from '../util/error'; -import { logDebug } from '../util/log'; import { Deferred } from '../util/promise'; import { addSnapshotsInSyncListener, @@ -57,13 +58,12 @@ import { syncEngineWrite } from './sync_engine'; import { View } from './view'; -import { SharedClientState } from '../local/shared_client_state'; -import { AutoId } from '../util/misc'; -import { DatabaseId, DatabaseInfo } from './database_info'; +import { DatabaseInfo } from './database_info'; import { newQueryForPath, Query } from './query'; import { Transaction } from './transaction'; import { ViewSnapshot } from './view_snapshot'; import { + ComponentConfiguration, MemoryOfflineComponentProvider, OfflineComponentProvider, OnlineComponentProvider @@ -71,8 +71,10 @@ import { import { AsyncObserver } from '../util/async_observer'; import { debugAssert } from '../util/assert'; import { TransactionRunner } from './transaction_runner'; +import { logDebug } from '../util/log'; +import { AutoId } from '../util/misc'; +import { Persistence } from '../local/persistence'; import { Datastore } from '../remote/datastore'; -import { canFallbackFromIndexedDbError } from '../../exp/src/api/database'; const LOG_TAG = 'FirestoreClient'; export const MAX_CONCURRENT_LIMBO_RESOLUTIONS = 100; @@ -83,34 +85,13 @@ export const MAX_CONCURRENT_LIMBO_RESOLUTIONS = 100; * async queue that is shared by all of the other components in the system. */ export class FirestoreClient { - // NOTE: These should technically have '|undefined' in the types, since - // they're initialized asynchronously rather than in the constructor, but - // given that all work is done on the async queue and we assert that - // initialization completes before any other work is queued, we're cheating - // with the types rather than littering the code with '!' or unnecessary - // undefined checks. - private databaseInfo!: DatabaseInfo; - eventMgr!: EventManager; - persistence!: Persistence; - localStore!: LocalStore; - datastore!: Datastore; - remoteStore!: RemoteStore; - syncEngine!: SyncEngine; - private gcScheduler!: GarbageCollectionScheduler | null; - - // PORTING NOTE: SharedClientState is only used for multi-tab web. - private sharedClientState!: SharedClientState; - + private user = User.UNAUTHENTICATED; private readonly clientId = AutoId.newId(); + private credentialListener: CredentialChangeListener = () => {}; + private readonly receivedInitialUser = new Deferred(); - // We defer our initialization until we get the current user from - // setChangeListener(). We block the async queue until we got the initial - // user and the initialization is completed. This will prevent any scheduled - // work from happening before initialization is completed. - // - // If initializationDone resolved then the FirestoreClient is in a usable - // state. - readonly initializationDone = new Deferred(); + offlineComponents?: OfflineComponentProvider; + onlineComponents?: OnlineComponentProvider; constructor( private credentials: CredentialsProvider, @@ -122,176 +103,38 @@ export class FirestoreClient { * start processing a new operation while the previous one is waiting for * an async I/O to complete). */ - public asyncQueue: AsyncQueue - ) {} - - /** - * Starts up the FirestoreClient, returning only whether or not enabling - * persistence succeeded. - * - * The intent here is to "do the right thing" as far as users are concerned. - * Namely, in cases where offline persistence is requested and possible, - * enable it, but otherwise fall back to persistence disabled. For the most - * part we expect this to succeed one way or the other so we don't expect our - * users to actually wait on the firestore.enablePersistence Promise since - * they generally won't care. - * - * Of course some users actually do care about whether or not persistence - * was successfully enabled, so the Promise returned from this method - * indicates this outcome. - * - * This presents a problem though: even before enablePersistence resolves or - * rejects, users may have made calls to e.g. firestore.collection() which - * means that the FirestoreClient in there will be available and will be - * enqueuing actions on the async queue. - * - * Meanwhile any failure of an operation on the async queue causes it to - * panic and reject any further work, on the premise that unhandled errors - * are fatal. - * - * Consequently the fallback is handled internally here in start, and if the - * fallback succeeds we signal success to the async queue even though the - * start() itself signals failure. - * - * @param databaseInfo The connection information for the current instance. - * @param offlineComponentProvider Provider that returns all components - * required for memory-only or IndexedDB persistence. - * @param onlineComponentProvider Provider that returns all components - * required for online support. - * @returns A deferred result indicating the user-visible result of enabling - * offline persistence. This method will reject this if IndexedDB fails to - * start for any reason. If usePersistence is false this is - * unconditionally resolved. - */ - start( - databaseInfo: DatabaseInfo, - offlineComponentProvider: OfflineComponentProvider, - onlineComponentProvider: OnlineComponentProvider - ): Promise { - this.verifyNotTerminated(); - - this.databaseInfo = databaseInfo; - - // If usePersistence is true, certain classes of errors while starting are - // recoverable but only by falling back to persistence disabled. - // - // If there's an error in the first case but not in recovery we cannot - // reject the promise blocking the async queue because this will cause the - // async queue to panic. - const persistenceResult = new Deferred(); - - let initialized = false; + public asyncQueue: AsyncQueue, + private databaseInfo: DatabaseInfo + ) { this.credentials.setChangeListener(user => { - if (!initialized) { - initialized = true; - - logDebug(LOG_TAG, 'Initializing. user=', user.uid); - - return this.initializeComponents( - offlineComponentProvider, - onlineComponentProvider, - user, - persistenceResult - ).then(this.initializationDone.resolve, this.initializationDone.reject); - } else { - this.asyncQueue.enqueueRetryable(() => - remoteStoreHandleCredentialChange(this.remoteStore, user) - ); + logDebug(LOG_TAG, 'Received user=', user.uid); + if (!this.user.isEqual(user)) { + this.user = user; + this.credentialListener(user); } + this.receivedInitialUser.resolve(); }); - - // Block the async queue until initialization is done - this.asyncQueue.enqueueAndForget(() => this.initializationDone.promise); - - // Return only the result of enabling persistence. Note that this does not - // need to await the completion of initializationDone because the result of - // this method should not reflect any other kind of failure to start. - return persistenceResult.promise; } - /** - * Initializes persistent storage, attempting to use IndexedDB if - * usePersistence is true or memory-only if false. - * - * If IndexedDB fails because it's already open in another tab or because the - * platform can't possibly support our implementation then this method rejects - * the persistenceResult and falls back on memory-only persistence. - * - * @param offlineComponentProvider Provider that returns all components - * required for memory-only or IndexedDB persistence. - * @param onlineComponentProvider Provider that returns all components - * required for online support. - * @param user The initial user - * @param persistenceResult A deferred result indicating the user-visible - * result of enabling offline persistence. This method will reject this if - * IndexedDB fails to start for any reason. If usePersistence is false - * this is unconditionally resolved. - * @returns a Promise indicating whether or not initialization should - * continue, i.e. that one of the persistence implementations actually - * succeeded. - */ - private async initializeComponents( - offlineComponentProvider: OfflineComponentProvider, - onlineComponentProvider: OnlineComponentProvider, - user: User, - persistenceResult: Deferred - ): Promise { - try { - const componentConfiguration = { - asyncQueue: this.asyncQueue, - databaseInfo: this.databaseInfo, - clientId: this.clientId, - credentials: this.credentials, - initialUser: user, - maxConcurrentLimboResolutions: MAX_CONCURRENT_LIMBO_RESOLUTIONS - }; - - await offlineComponentProvider.initialize(componentConfiguration); - await onlineComponentProvider.initialize( - offlineComponentProvider, - componentConfiguration - ); + async getConfiguration(): Promise { + await this.receivedInitialUser.promise; + + return { + asyncQueue: this.asyncQueue, + databaseInfo: this.databaseInfo, + clientId: this.clientId, + credentials: this.credentials, + initialUser: this.user, + maxConcurrentLimboResolutions: MAX_CONCURRENT_LIMBO_RESOLUTIONS + }; + } - this.persistence = offlineComponentProvider.persistence; - this.sharedClientState = offlineComponentProvider.sharedClientState; - this.localStore = offlineComponentProvider.localStore; - this.gcScheduler = offlineComponentProvider.gcScheduler; - this.datastore = onlineComponentProvider.datastore; - this.remoteStore = onlineComponentProvider.remoteStore; - this.syncEngine = onlineComponentProvider.syncEngine; - this.eventMgr = onlineComponentProvider.eventManager; - - this.eventMgr.onListen = syncEngineListen.bind(null, this.syncEngine); - this.eventMgr.onUnlisten = syncEngineUnlisten.bind(null, this.syncEngine); - - // When a user calls clearPersistence() in one client, all other clients - // need to be terminated to allow the delete to succeed. - this.persistence.setDatabaseDeletedListener(async () => { - await this.terminate(); - }); - - persistenceResult.resolve(); - } catch (error) { - // Regardless of whether or not the retry succeeds, from an user - // perspective, offline persistence has failed. - persistenceResult.reject(error); - - // An unknown failure on the first stage shuts everything down. - if (!canFallbackFromIndexedDbError(error)) { - throw error; - } - console.warn( - 'Error enabling offline persistence. Falling back to' + - ' persistence disabled: ' + - error - ); - return this.initializeComponents( - new MemoryOfflineComponentProvider(), - new OnlineComponentProvider(), - user, - persistenceResult - ); - } + setCredentialChangeListener(listener: (user: User) => void): void { + this.credentialListener = listener; + // eslint-disable-next-line @typescript-eslint/no-floating-promises + this.receivedInitialUser.promise.then(() => + this.credentialListener(this.user) + ); } /** @@ -312,14 +155,12 @@ export class FirestoreClient { const deferred = new Deferred(); this.asyncQueue.enqueueAndForgetEvenWhileRestricted(async () => { try { - // PORTING NOTE: LocalStore does not need an explicit shutdown on web. - if (this.gcScheduler) { - this.gcScheduler.stop(); + if (this.onlineComponents) { + await this.onlineComponents.terminate(); + } + if (this.offlineComponents) { + await this.offlineComponents.terminate(); } - - await remoteStoreShutdown(this.remoteStore); - await this.sharedClientState.shutdown(); - await this.persistence.shutdown(); // `removeChangeListener` must be called after shutting down the // RemoteStore as it will prevent the RemoteStore from retrieving @@ -336,170 +177,271 @@ export class FirestoreClient { }); return deferred.promise; } +} + +export async function setOfflineComponentProvider( + client: FirestoreClient, + offlineComponentProvider: OfflineComponentProvider +): Promise { + client.asyncQueue.verifyOperationInProgress(); + + logDebug(LOG_TAG, 'Initializing OfflineComponentProvider'); + const configuration = await client.getConfiguration(); + await offlineComponentProvider.initialize(configuration); + + client.setCredentialChangeListener(user => + client.asyncQueue.enqueueRetryable(async () => { + await handleUserChange(offlineComponentProvider.localStore, user); + }) + ); - databaseId(): DatabaseId { - return this.databaseInfo.databaseId; + // When a user calls clearPersistence() in one client, all other clients + // need to be terminated to allow the delete to succeed. + offlineComponentProvider.persistence.setDatabaseDeletedListener(() => + client.terminate() + ); + + client.offlineComponents = offlineComponentProvider; +} + +export async function setOnlineComponentProvider( + client: FirestoreClient, + onlineComponentProvider: OnlineComponentProvider +): Promise { + client.asyncQueue.verifyOperationInProgress(); + + const offlineComponentProvider = await ensureOfflineComponents(client); + + logDebug(LOG_TAG, 'Initializing OnlineComponentProvider'); + const configuration = await client.getConfiguration(); + await onlineComponentProvider.initialize( + offlineComponentProvider, + configuration + ); + // The CredentialChangeListener of the online component provider takes + // precedence over the offline component provider. + client.setCredentialChangeListener(user => + client.asyncQueue.enqueueRetryable(() => + remoteStoreHandleCredentialChange( + onlineComponentProvider.remoteStore, + user + ) + ) + ); + client.onlineComponents = onlineComponentProvider; +} + +async function ensureOfflineComponents( + client: FirestoreClient +): Promise { + if (!client.offlineComponents) { + logDebug(LOG_TAG, 'Using default OfflineComponentProvider'); + await setOfflineComponentProvider( + client, + new MemoryOfflineComponentProvider() + ); } - get clientTerminated(): boolean { - // Technically, the asyncQueue is still running, but only accepting operations - // related to termination or supposed to be run after termination. It is effectively - // terminated to the eyes of users. - return this.asyncQueue.isShuttingDown; + return client.offlineComponents!; +} + +async function ensureOnlineComponents( + client: FirestoreClient +): Promise { + if (!client.onlineComponents) { + logDebug(LOG_TAG, 'Using default OnlineComponentProvider'); + await setOnlineComponentProvider(client, new OnlineComponentProvider()); } + + return client.onlineComponents!; +} + +function getPersistence(client: FirestoreClient): Promise { + return ensureOfflineComponents(client).then(c => c.persistence); +} + +export function getLocalStore(client: FirestoreClient): Promise { + return ensureOfflineComponents(client).then(c => c.localStore); +} + +function getRemoteStore(client: FirestoreClient): Promise { + return ensureOnlineComponents(client).then(c => c.remoteStore); } -/** Enables the network connection and requeues all pending operations. */ +function getSyncEngine(client: FirestoreClient): Promise { + return ensureOnlineComponents(client).then(c => c.syncEngine); +} + +function getDatastore(client: FirestoreClient): Promise { + return ensureOnlineComponents(client).then(c => c.datastore); +} + +export async function getEventManager( + client: FirestoreClient +): Promise { + const onlineComponentProvider = await ensureOnlineComponents(client); + const eventManager = onlineComponentProvider.eventManager; + eventManager.onListen = syncEngineListen.bind( + null, + onlineComponentProvider.syncEngine + ); + eventManager.onUnlisten = syncEngineUnlisten.bind( + null, + onlineComponentProvider.syncEngine + ); + return eventManager; +} + +/** Enables the network connection and re-enqueues all pending operations. */ export function firestoreClientEnableNetwork( - firestoreClient: FirestoreClient + client: FirestoreClient ): Promise { - firestoreClient.verifyNotTerminated(); - return firestoreClient.asyncQueue.enqueue(() => { - firestoreClient.persistence.setNetworkEnabled(true); - return remoteStoreEnableNetwork(firestoreClient.remoteStore); + return client.asyncQueue.enqueue(async () => { + const persistence = await getPersistence(client); + const remoteStore = await getRemoteStore(client); + persistence.setNetworkEnabled(true); + return remoteStoreEnableNetwork(remoteStore); }); } /** Disables the network connection. Pending operations will not complete. */ export function firestoreClientDisableNetwork( - firestoreClient: FirestoreClient + client: FirestoreClient ): Promise { - firestoreClient.verifyNotTerminated(); - return firestoreClient.asyncQueue.enqueue(() => { - firestoreClient.persistence.setNetworkEnabled(false); - return remoteStoreDisableNetwork(firestoreClient.remoteStore); + return client.asyncQueue.enqueue(async () => { + const persistence = await getPersistence(client); + const remoteStore = await getRemoteStore(client); + persistence.setNetworkEnabled(false); + return remoteStoreDisableNetwork(remoteStore); }); } /** - * Returns a Promise that resolves when all writes that were pending at the time this - * method was called received server acknowledgement. An acknowledgement can be either acceptance - * or rejection. + * Returns a Promise that resolves when all writes that were pending at the time + * this method was called received server acknowledgement. An acknowledgement + * can be either acceptance or rejection. */ export function firestoreClientWaitForPendingWrites( - firestoreClient: FirestoreClient + client: FirestoreClient ): Promise { - firestoreClient.verifyNotTerminated(); - const deferred = new Deferred(); - firestoreClient.asyncQueue.enqueueAndForget(() => - registerPendingWritesCallback(firestoreClient.syncEngine, deferred) - ); + client.asyncQueue.enqueueAndForget(async () => { + const syncEngine = await getSyncEngine(client); + return registerPendingWritesCallback(syncEngine, deferred); + }); return deferred.promise; } export function firestoreClientListen( - firestoreClient: FirestoreClient, + client: FirestoreClient, query: Query, options: ListenOptions, observer: Partial> ): () => void { - firestoreClient.verifyNotTerminated(); const wrappedObserver = new AsyncObserver(observer); const listener = new QueryListener(query, wrappedObserver, options); - firestoreClient.asyncQueue.enqueueAndForget(() => - eventManagerListen(firestoreClient.eventMgr, listener) - ); + client.asyncQueue.enqueueAndForget(async () => { + const eventManager = await getEventManager(client); + return eventManagerListen(eventManager, listener); + }); return () => { wrappedObserver.mute(); - firestoreClient.asyncQueue.enqueueAndForget(() => - eventManagerUnlisten(firestoreClient.eventMgr, listener) - ); + client.asyncQueue.enqueueAndForget(async () => { + const eventManager = await getEventManager(client); + return eventManagerUnlisten(eventManager, listener); + }); }; } -export async function firestoreClientGetDocumentFromLocalCache( - firestoreClient: FirestoreClient, +export function firestoreClientGetDocumentFromLocalCache( + client: FirestoreClient, docKey: DocumentKey ): Promise { - firestoreClient.verifyNotTerminated(); - await firestoreClient.initializationDone.promise; const deferred = new Deferred(); - firestoreClient.asyncQueue.enqueueAndForget(() => - readDocumentFromCache(firestoreClient.localStore, docKey, deferred) - ); + client.asyncQueue.enqueueAndForget(async () => { + const localStore = await getLocalStore(client); + return readDocumentFromCache(localStore, docKey, deferred); + }); return deferred.promise; } -export async function firestoreClientGetDocumentViaSnapshotListener( - firestoreClient: FirestoreClient, +export function firestoreClientGetDocumentViaSnapshotListener( + client: FirestoreClient, key: DocumentKey, options: GetOptions = {} ): Promise { - firestoreClient.verifyNotTerminated(); - await firestoreClient.initializationDone.promise; const deferred = new Deferred(); - firestoreClient.asyncQueue.enqueueAndForget(() => - readDocumentViaSnapshotListener( - firestoreClient.eventMgr, - firestoreClient.asyncQueue, + client.asyncQueue.enqueueAndForget(async () => { + const eventManager = await getEventManager(client); + return readDocumentViaSnapshotListener( + eventManager, + client.asyncQueue, key, options, deferred - ) - ); + ); + }); return deferred.promise; } -export async function firestoreClientGetDocumentsFromLocalCache( - firestoreClient: FirestoreClient, +export function firestoreClientGetDocumentsFromLocalCache( + client: FirestoreClient, query: Query ): Promise { - firestoreClient.verifyNotTerminated(); - await firestoreClient.initializationDone.promise; const deferred = new Deferred(); - firestoreClient.asyncQueue.enqueueAndForget(() => - executeQueryFromCache(firestoreClient.localStore, query, deferred) - ); + client.asyncQueue.enqueueAndForget(async () => { + const localStore = await getLocalStore(client); + return executeQueryFromCache(localStore, query, deferred); + }); return deferred.promise; } -export async function firestoreClientGetDocumentsViaSnapshotListener( - firestoreClient: FirestoreClient, +export function firestoreClientGetDocumentsViaSnapshotListener( + client: FirestoreClient, query: Query, options: GetOptions = {} ): Promise { - firestoreClient.verifyNotTerminated(); - await firestoreClient.initializationDone.promise; const deferred = new Deferred(); - firestoreClient.asyncQueue.enqueueAndForget(() => - executeQueryViaSnapshotListener( - firestoreClient.eventMgr, - firestoreClient.asyncQueue, + client.asyncQueue.enqueueAndForget(async () => { + const eventManager = await getEventManager(client); + return executeQueryViaSnapshotListener( + eventManager, + client.asyncQueue, query, options, deferred - ) - ); + ); + }); return deferred.promise; } export function firestoreClientWrite( - firestoreClient: FirestoreClient, + client: FirestoreClient, mutations: Mutation[] ): Promise { - firestoreClient.verifyNotTerminated(); const deferred = new Deferred(); - firestoreClient.asyncQueue.enqueueAndForget(() => - syncEngineWrite(firestoreClient.syncEngine, mutations, deferred) - ); + client.asyncQueue.enqueueAndForget(async () => { + const syncEngine = await getSyncEngine(client); + return syncEngineWrite(syncEngine, mutations, deferred); + }); return deferred.promise; } export function firestoreClientAddSnapshotsInSyncListener( - firestoreClient: FirestoreClient, + client: FirestoreClient, observer: Partial> ): () => void { - firestoreClient.verifyNotTerminated(); const wrappedObserver = new AsyncObserver(observer); - firestoreClient.asyncQueue.enqueueAndForget(async () => - addSnapshotsInSyncListener(firestoreClient.eventMgr, wrappedObserver) - ); + client.asyncQueue.enqueueAndForget(async () => { + const eventManager = await getEventManager(client); + return addSnapshotsInSyncListener(eventManager, wrappedObserver); + }); return () => { wrappedObserver.mute(); - firestoreClient.asyncQueue.enqueueAndForget(async () => - removeSnapshotsInSyncListener(firestoreClient.eventMgr, wrappedObserver) - ); + client.asyncQueue.enqueueAndForget(async () => { + const eventManager = await getEventManager(client); + return removeSnapshotsInSyncListener(eventManager, wrappedObserver); + }); }; } @@ -519,19 +461,18 @@ export function firestoreClientAddSnapshotsInSyncListener( * performed before any writes. Transactions must be performed while online. */ export function firestoreClientTransaction( - firestoreClient: FirestoreClient, + client: FirestoreClient, updateFunction: (transaction: Transaction) => Promise ): Promise { - firestoreClient.verifyNotTerminated(); const deferred = new Deferred(); - firestoreClient.asyncQueue.enqueueAndForget(() => { + client.asyncQueue.enqueueAndForget(async () => { + const datastore = await getDatastore(client); new TransactionRunner( - firestoreClient.asyncQueue, - firestoreClient.datastore, + client.asyncQueue, + datastore, updateFunction, deferred ).run(); - return Promise.resolve(); }); return deferred.promise; } diff --git a/packages/firestore/src/local/lru_garbage_collector.ts b/packages/firestore/src/local/lru_garbage_collector.ts index 2f83baca449..332bd110cb6 100644 --- a/packages/firestore/src/local/lru_garbage_collector.ts +++ b/packages/firestore/src/local/lru_garbage_collector.ts @@ -171,10 +171,11 @@ const GC_DID_NOT_RUN: LruResults = { documentsRemoved: 0 }; +export const LRU_COLLECTION_DISABLED = -1; +export const LRU_MINIMUM_CACHE_SIZE_BYTES = 1 * 1024 * 1024; +export const LRU_DEFAULT_CACHE_SIZE_BYTES = 40 * 1024 * 1024; + export class LruParams { - static readonly COLLECTION_DISABLED = -1; - static readonly MINIMUM_CACHE_SIZE_BYTES = 1 * 1024 * 1024; - static readonly DEFAULT_CACHE_SIZE_BYTES = 40 * 1024 * 1024; private static readonly DEFAULT_COLLECTION_PERCENTILE = 10; private static readonly DEFAULT_MAX_SEQUENCE_NUMBERS_TO_COLLECT = 1000; @@ -187,13 +188,13 @@ export class LruParams { } static readonly DEFAULT: LruParams = new LruParams( - LruParams.DEFAULT_CACHE_SIZE_BYTES, + LRU_DEFAULT_CACHE_SIZE_BYTES, LruParams.DEFAULT_COLLECTION_PERCENTILE, LruParams.DEFAULT_MAX_SEQUENCE_NUMBERS_TO_COLLECT ); static readonly DISABLED: LruParams = new LruParams( - LruParams.COLLECTION_DISABLED, + LRU_COLLECTION_DISABLED, 0, 0 ); @@ -237,7 +238,7 @@ export class LruScheduler implements GarbageCollectionScheduler { ); if ( this.garbageCollector.params.cacheSizeCollectionThreshold !== - LruParams.COLLECTION_DISABLED + LRU_COLLECTION_DISABLED ) { this.scheduleGC(localStore); } @@ -354,9 +355,7 @@ export class LruGarbageCollector { txn: PersistenceTransaction, activeTargetIds: ActiveTargets ): PersistencePromise { - if ( - this.params.cacheSizeCollectionThreshold === LruParams.COLLECTION_DISABLED - ) { + if (this.params.cacheSizeCollectionThreshold === LRU_COLLECTION_DISABLED) { logDebug('LruGarbageCollector', 'Garbage collection skipped; disabled'); return PersistencePromise.resolve(GC_DID_NOT_RUN); } diff --git a/packages/firestore/src/util/async_queue.ts b/packages/firestore/src/util/async_queue.ts index 1b5bd4e4896..c4e1fd03a67 100644 --- a/packages/firestore/src/util/async_queue.ts +++ b/packages/firestore/src/util/async_queue.ts @@ -240,8 +240,7 @@ export class AsyncQueue { if (document) { logDebug( LOG_TAG, - 'Visibility state changed to ', - document.visibilityState + 'Visibility state changed to ' + document.visibilityState ); } this.backoff.skipBackoff(); diff --git a/packages/firestore/test/integration/api_internal/database.test.ts b/packages/firestore/test/integration/api_internal/database.test.ts index 5eb2128a5d7..41ea6caad86 100644 --- a/packages/firestore/test/integration/api_internal/database.test.ts +++ b/packages/firestore/test/integration/api_internal/database.test.ts @@ -75,7 +75,7 @@ apiDescribe('Database (with internal API)', (persistence: boolean) => { await app.delete(); // eslint-disable-next-line @typescript-eslint/no-explicit-any - expect((docRef.firestore as any)._isTerminated).to.be.true; + expect((docRef.firestore as any)._terminated).to.be.true; }); }); }); diff --git a/packages/firestore/test/integration/util/helpers.ts b/packages/firestore/test/integration/util/helpers.ts index 16e44ff8a87..2ad8d005605 100644 --- a/packages/firestore/test/integration/util/helpers.ts +++ b/packages/firestore/test/integration/util/helpers.ts @@ -170,15 +170,11 @@ export async function withTestDbsSettings( const dbs: firestore.FirebaseFirestore[] = []; for (let i = 0; i < numDbs; i++) { - const firestoreClient = newTestFirestore( - projectId, - /* name =*/ undefined, - settings - ); + const db = newTestFirestore(projectId, /* name =*/ undefined, settings); if (persistence) { - await firestoreClient.enablePersistence(); + await db.enablePersistence(); } - dbs.push(firestoreClient); + dbs.push(db); } try { diff --git a/packages/firestore/test/unit/api/database.test.ts b/packages/firestore/test/unit/api/database.test.ts index 725ecb51b22..f8bc606c6ec 100644 --- a/packages/firestore/test/unit/api/database.test.ts +++ b/packages/firestore/test/unit/api/database.test.ts @@ -159,22 +159,20 @@ describe('SnapshotMetadata', () => { describe('Settings', () => { it('replaces settings by default', () => { // Use a new instance of Firestore in order to configure settings. - const firestoreClient = newTestFirestore(); - firestoreClient.settings({ host: 'other.host' }); - firestoreClient.settings({ ignoreUndefinedProperties: true }); + const db = newTestFirestore(); + db.settings({ host: 'other.host' }); + db.settings({ ignoreUndefinedProperties: true }); - expect(firestoreClient._getSettings().ignoreUndefinedProperties).to.be.true; + expect(db._getSettings().ignoreUndefinedProperties).to.be.true; // Expect host to be replaced with default host. - expect(firestoreClient._getSettings().host).to.equal( - 'firestore.googleapis.com' - ); + expect(db._getSettings().host).to.equal('firestore.googleapis.com'); }); it('can not use mutually exclusive settings together', () => { // Use a new instance of Firestore in order to configure settings. - const firestoreClient = newTestFirestore(); + const db = newTestFirestore(); expect( - firestoreClient.settings.bind(firestoreClient.settings, { + db.settings.bind(db.settings, { experimentalForceLongPolling: true, experimentalAutoDetectLongPolling: true }) @@ -185,33 +183,33 @@ describe('Settings', () => { it('can merge settings', () => { // Use a new instance of Firestore in order to configure settings. - const firestoreClient = newTestFirestore(); - firestoreClient.settings({ host: 'other.host' }); - firestoreClient.settings({ + const db = newTestFirestore(); + db.settings({ host: 'other.host' }); + db.settings({ ignoreUndefinedProperties: true, merge: true }); - expect(firestoreClient._getSettings().ignoreUndefinedProperties).to.be.true; - expect(firestoreClient._getSettings().host).to.equal('other.host'); + expect(db._getSettings().ignoreUndefinedProperties).to.be.true; + expect(db._getSettings().host).to.equal('other.host'); }); it('gets settings from useEmulator', () => { // Use a new instance of Firestore in order to configure settings. - const firestoreClient = newTestFirestore(); - firestoreClient.useEmulator('localhost', 9000); + const db = newTestFirestore(); + db.useEmulator('localhost', 9000); - expect(firestoreClient._getSettings().host).to.equal('localhost:9000'); - expect(firestoreClient._getSettings().ssl).to.be.false; + expect(db._getSettings().host).to.equal('localhost:9000'); + expect(db._getSettings().ssl).to.be.false; }); it('prefers host from useEmulator to host from settings', () => { // Use a new instance of Firestore in order to configure settings. - const firestoreClient = newTestFirestore(); - firestoreClient.settings({ host: 'other.host' }); - firestoreClient.useEmulator('localhost', 9000); + const db = newTestFirestore(); + db.settings({ host: 'other.host' }); + db.useEmulator('localhost', 9000); - expect(firestoreClient._getSettings().host).to.equal('localhost:9000'); - expect(firestoreClient._getSettings().ssl).to.be.false; + expect(db._getSettings().host).to.equal('localhost:9000'); + expect(db._getSettings().ssl).to.be.false; }); }); diff --git a/packages/firestore/test/util/api_helpers.ts b/packages/firestore/test/util/api_helpers.ts index 6832e3780ae..150337062f5 100644 --- a/packages/firestore/test/util/api_helpers.ts +++ b/packages/firestore/test/util/api_helpers.ts @@ -22,6 +22,7 @@ import { CollectionReference, DocumentReference, DocumentSnapshot, + ensureFirestoreConfigured, Firestore, IndexedDbPersistenceProvider, Query, @@ -69,25 +70,15 @@ export function newTestFirestore(): Firestore { } export function collectionReference(path: string): CollectionReference { - const firestoreClient = firestore(); - // eslint-disable-next-line @typescript-eslint/no-floating-promises - firestoreClient.ensureClientConfigured(); - return new CollectionReference( - pathFrom(path), - firestoreClient, - /* converter= */ null - ); + const db = firestore(); + ensureFirestoreConfigured(db); + return new CollectionReference(pathFrom(path), db, /* converter= */ null); } export function documentReference(path: string): DocumentReference { - const firestoreClient = firestore(); - // eslint-disable-next-line @typescript-eslint/no-floating-promises - firestoreClient.ensureClientConfigured(); - return new DocumentReference( - key(path), - firestoreClient, - /* converter= */ null - ); + const db = firestore(); + ensureFirestoreConfigured(db); + return new DocumentReference(key(path), db, /* converter= */ null); } export function documentSnapshot( From 8f3bb80389c3c6a094dca3c80e107fe20f457f7c Mon Sep 17 00:00:00 2001 From: Alex Volkovitsky Date: Wed, 28 Oct 2020 09:41:13 -0700 Subject: [PATCH 044/624] Make sure sendSignInLinkToEmail requires handleCodeInApp (auth/next) (#3964) --- .../src/core/strategies/email_link.test.ts | 23 ++++++++++++++++--- .../src/core/strategies/email_link.ts | 3 +++ 2 files changed, 23 insertions(+), 3 deletions(-) diff --git a/packages-exp/auth-exp/src/core/strategies/email_link.test.ts b/packages-exp/auth-exp/src/core/strategies/email_link.test.ts index 0f8907456fc..aea80699f28 100644 --- a/packages-exp/auth-exp/src/core/strategies/email_link.test.ts +++ b/packages-exp/auth-exp/src/core/strategies/email_link.test.ts @@ -55,13 +55,25 @@ describe('core/strategies/sendSignInLinkToEmail', () => { const mock = mockEndpoint(Endpoint.SEND_OOB_CODE, { email }); - await sendSignInLinkToEmail(auth, email); + await sendSignInLinkToEmail(auth, email, { + handleCodeInApp: true, + url: 'continue-url' + }); expect(mock.calls[0].request).to.eql({ requestType: externs.Operation.EMAIL_SIGNIN, - email + email, + canHandleCodeInApp: true, + continueUrl: 'continue-url' }); }); + it('should require handleCodeInApp to be true', async () => { + await expect(sendSignInLinkToEmail(auth, email)).to.be.rejectedWith( + FirebaseError, + 'auth/argument-error).' + ); + }); + it('should surface errors', async () => { const mock = mockEndpoint( Endpoint.SEND_OOB_CODE, @@ -73,7 +85,12 @@ describe('core/strategies/sendSignInLinkToEmail', () => { }, 400 ); - await expect(sendSignInLinkToEmail(auth, email)).to.be.rejectedWith( + await expect( + sendSignInLinkToEmail(auth, email, { + handleCodeInApp: true, + url: 'continue-url' + }) + ).to.be.rejectedWith( FirebaseError, 'Firebase: The email address is badly formatted. (auth/invalid-email).' ); diff --git a/packages-exp/auth-exp/src/core/strategies/email_link.ts b/packages-exp/auth-exp/src/core/strategies/email_link.ts index 2023249c8be..dfe5125e0dd 100644 --- a/packages-exp/auth-exp/src/core/strategies/email_link.ts +++ b/packages-exp/auth-exp/src/core/strategies/email_link.ts @@ -73,6 +73,9 @@ export async function sendSignInLinkToEmail( requestType: externs.Operation.EMAIL_SIGNIN, email }; + assert(actionCodeSettings?.handleCodeInApp, AuthErrorCode.ARGUMENT_ERROR, { + appName: auth.name + }); if (actionCodeSettings) { _setActionCodeSettingsOnRequest(auth, request, actionCodeSettings); } From a8df6698388bf455e6cda0dde5565dab18cbbc4e Mon Sep 17 00:00:00 2001 From: Alex Volkovitsky Date: Wed, 28 Oct 2020 09:41:30 -0700 Subject: [PATCH 045/624] Add auth-exp to firebase-exp (#3991) --- packages-exp/firebase-exp/auth/index.ts | 17 +++++++++++++++++ packages-exp/firebase-exp/auth/package.json | 7 +++++++ packages-exp/firebase-exp/package.json | 2 ++ 3 files changed, 26 insertions(+) create mode 100644 packages-exp/firebase-exp/auth/index.ts create mode 100644 packages-exp/firebase-exp/auth/package.json diff --git a/packages-exp/firebase-exp/auth/index.ts b/packages-exp/firebase-exp/auth/index.ts new file mode 100644 index 00000000000..2505d8e8794 --- /dev/null +++ b/packages-exp/firebase-exp/auth/index.ts @@ -0,0 +1,17 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +export * from '@firebase/auth-exp'; diff --git a/packages-exp/firebase-exp/auth/package.json b/packages-exp/firebase-exp/auth/package.json new file mode 100644 index 00000000000..a3874cfe19b --- /dev/null +++ b/packages-exp/firebase-exp/auth/package.json @@ -0,0 +1,7 @@ +{ + "name": "firebase-exp/auth", + "main": "dist/index.cjs.js", + "browser": "dist/index.esm.js", + "module": "dist/index.esm.js", + "typings": "dist/auth/index.d.ts" +} diff --git a/packages-exp/firebase-exp/package.json b/packages-exp/firebase-exp/package.json index 4445689e506..5f74e1c80fe 100644 --- a/packages-exp/firebase-exp/package.json +++ b/packages-exp/firebase-exp/package.json @@ -39,6 +39,7 @@ "dependencies": { "@firebase/app-exp": "0.0.800", "@firebase/app-compat": "0.0.800", + "@firebase/auth-exp": "0.0.800", "@firebase/functions-exp": "0.0.800", "@firebase/firestore": "2.0.0", "@firebase/performance-exp": "0.0.800" @@ -59,6 +60,7 @@ }, "components": [ "app", + "auth", "functions", "firestore", "firestore/lite", From b5e9d6ae8e6406b9a31ec9e4d60216527b256a4a Mon Sep 17 00:00:00 2001 From: Alex Volkovitsky Date: Wed, 28 Oct 2020 09:56:40 -0700 Subject: [PATCH 046/624] Implement service worker message passing for auth-exp (#3959) * Implement service worker message passing for auth-exp * More tests & cleanup * Use const enum * Add a null check * Make timeout duration a const enum * PR feedback * PR Feedback --- packages-exp/auth-exp/demo/.firebaserc | 6 - .../demo/src/worker/service-worker.ts | 124 ++++++------ .../src/core/auth/auth_event_manager.test.ts | 2 +- .../src/core/auth/firebase_internal.test.ts | 2 +- .../auth-exp/src/core/auth/initialize.test.ts | 2 +- .../src/core/credentials/oauth.test.ts | 2 +- .../persistence/persistence_user_manager.ts | 12 +- .../src/core/providers/facebook.test.ts | 2 +- .../src/core/providers/github.test.ts | 2 +- .../src/core/providers/google.test.ts | 2 +- .../src/core/providers/twitter.test.ts | 2 +- .../auth-exp/src/core/strategies/idp.test.ts | 2 +- .../src/core/user/id_token_result.test.ts | 2 +- .../src/core/user/invalidation.test.ts | 2 +- .../src/core/user/proactive_refresh.test.ts | 2 +- .../src/core/user/reauthenticate.test.ts | 2 +- .../src/core/util/instantiator.test.ts | 2 +- .../src/platform_browser/iframe/gapi.test.ts | 2 +- .../platform_browser/iframe/iframe.test.ts | 2 +- .../platform_browser/messagechannel/index.ts | 109 +++++++++++ .../messagechannel/promise.test.ts | 60 ++++++ .../messagechannel/promise.ts | 58 ++++++ .../messagechannel/receiver.test.ts | 178 +++++++++++++++++ .../messagechannel/receiver.ts | 161 ++++++++++++++++ .../messagechannel/sender.test.ts | 163 ++++++++++++++++ .../platform_browser/messagechannel/sender.ts | 144 ++++++++++++++ .../mfa/assertions/phone.test.ts | 7 +- .../persistence/indexed_db.test.ts | 180 +++++++++++++++++- .../persistence/indexed_db.ts | 136 ++++++++++++- .../persistence/local_storage.test.ts | 2 +- .../persistence/local_storage.ts | 9 +- .../persistence/session_storage.test.ts | 2 +- .../platform_browser/popup_redirect.test.ts | 2 +- .../platform_browser/providers/phone.test.ts | 2 +- .../recaptcha/recaptcha_loader.test.ts | 2 +- .../recaptcha/recaptcha_mock.test.ts | 2 +- .../recaptcha/recaptcha_verifier.test.ts | 2 +- .../recaptcha/recaptcha_verifier.ts | 10 +- .../abstract_popup_redirect_operation.test.ts | 2 +- .../platform_browser/strategies/phone.test.ts | 2 +- .../platform_browser/strategies/popup.test.ts | 2 +- .../strategies/redirect.test.ts | 2 +- .../src/platform_browser/util/popup.test.ts | 2 +- .../src/platform_browser/util/worker.ts | 45 +++++ .../test/helpers/fake_service_worker.ts | 59 ++++++ 45 files changed, 1391 insertions(+), 126 deletions(-) delete mode 100644 packages-exp/auth-exp/demo/.firebaserc create mode 100644 packages-exp/auth-exp/src/platform_browser/messagechannel/index.ts create mode 100644 packages-exp/auth-exp/src/platform_browser/messagechannel/promise.test.ts create mode 100644 packages-exp/auth-exp/src/platform_browser/messagechannel/promise.ts create mode 100644 packages-exp/auth-exp/src/platform_browser/messagechannel/receiver.test.ts create mode 100644 packages-exp/auth-exp/src/platform_browser/messagechannel/receiver.ts create mode 100644 packages-exp/auth-exp/src/platform_browser/messagechannel/sender.test.ts create mode 100644 packages-exp/auth-exp/src/platform_browser/messagechannel/sender.ts create mode 100644 packages-exp/auth-exp/src/platform_browser/util/worker.ts create mode 100644 packages-exp/auth-exp/test/helpers/fake_service_worker.ts diff --git a/packages-exp/auth-exp/demo/.firebaserc b/packages-exp/auth-exp/demo/.firebaserc deleted file mode 100644 index 7f7f6d262c3..00000000000 --- a/packages-exp/auth-exp/demo/.firebaserc +++ /dev/null @@ -1,6 +0,0 @@ -{ - "projects": { - "default": "fir-auth-next-demo", - "demo": "fir-auth-next-demo" - } -} \ No newline at end of file diff --git a/packages-exp/auth-exp/demo/src/worker/service-worker.ts b/packages-exp/auth-exp/demo/src/worker/service-worker.ts index bff551fee60..564e46517d4 100644 --- a/packages-exp/auth-exp/demo/src/worker/service-worker.ts +++ b/packages-exp/auth-exp/demo/src/worker/service-worker.ts @@ -92,66 +92,70 @@ self.addEventListener('install', (event: ExtendableEvent) => { }); // As this is a test app, let's only return cached data when offline. -self.addEventListener('fetch', async (event: FetchEvent) => { - // Try to fetch the resource first after checking for the ID token. - const idToken = await getIdToken(); - let req = event.request; - // For same origin https requests, append idToken to header. - if ( - self.location.origin === getOriginFromUrl(event.request.url) && - (self.location.protocol === 'https:' || - self.location.hostname === 'localhost') && - idToken - ) { - // Clone headers as request headers are immutable. - const headers = new Headers(); - req.headers.forEach((value, key) => { - headers.append(key, value); - }); - // Add ID token to header. We can't add to Authentication header as it - // will break HTTP basic authentication. - headers.append('x-id-token', idToken); - try { - req = new Request(req.url, { - method: req.method, - headers, - mode: 'same-origin', - credentials: req.credentials, - cache: req.cache, - redirect: req.redirect, - referrer: req.referrer, - body: req.body - }); - } catch (e) { - // This will fail for CORS requests. We just continue with the - // fetch caching logic below and do not pass the ID token. - } - } - let response: Response; - try { - response = await fetch(req); - } catch (e) { - // For fetch errors, attempt to retrieve the resource from cache. - try { - response = (await caches.match(event.request.clone()))!; - } catch (error) { - // If error getting resource from cache, do nothing. - console.log(error); - return; - } - } - // Check if we received a valid response. - // If not, just funnel the error response. - if (!response || response.status !== 200 || response.type !== 'basic') { - return response; - } - // If response is valid, clone it and save it to the cache. - const responseToCache = response.clone(); - // Save response to cache. - const cache = await caches.open(CACHE_NAME); - await cache.put(event.request, responseToCache); - // After caching, return response. - return response; +self.addEventListener('fetch', (event: FetchEvent) => { + event.respondWith( + (async function () { + const idToken = await getIdToken(); + // Try to fetch the resource first after checking for the ID token. + let req = event.request; + // For same origin https requests, append idToken to header. + if ( + self.location.origin === getOriginFromUrl(event.request.url) && + (self.location.protocol === 'https:' || + self.location.hostname === 'localhost') && + idToken + ) { + // Clone headers as request headers are immutable. + const headers = new Headers(); + req.headers.forEach((value, key) => { + headers.append(key, value); + }); + // Add ID token to header. We can't add to Authentication header as it + // will break HTTP basic authentication. + headers.append('x-id-token', idToken); + try { + req = new Request(req.url, { + method: req.method, + headers, + mode: 'same-origin', + credentials: req.credentials, + cache: req.cache, + redirect: req.redirect, + referrer: req.referrer, + body: req.body + }); + } catch (e) { + // This will fail for CORS requests. We just continue with the + // fetch caching logic below and do not pass the ID token. + } + } + return fetch(req) + .then(response => { + // Check if we received a valid response. + // If not, just funnel the error response. + if (response.status !== 200 || response.type !== 'basic') { + return response; + } + // If response is valid, clone it and save it to the cache. + var responseToCache = response.clone(); + // Save response to cache. + caches.open(CACHE_NAME).then(function (cache) { + cache.put(event.request, responseToCache); + }); + // After caching, return response. + return response; + }) + .catch(() => { + // For fetch errors, attempt to retrieve the resource from cache. + return caches.match(event.request.clone()) as Promise; + }) + .catch(error => { + // If error getting resource from cache, do nothing. + console.log(error); + throw error; + }); + })() + ); }); self.addEventListener('activate', (event: ExtendableEvent) => { diff --git a/packages-exp/auth-exp/src/core/auth/auth_event_manager.test.ts b/packages-exp/auth-exp/src/core/auth/auth_event_manager.test.ts index 08757c006b6..f513ae707dc 100644 --- a/packages-exp/auth-exp/src/core/auth/auth_event_manager.test.ts +++ b/packages-exp/auth-exp/src/core/auth/auth_event_manager.test.ts @@ -30,7 +30,7 @@ import { AuthEventManager } from './auth_event_manager'; use(sinonChai); -describe('src/core/auth/auth_event_manager', () => { +describe('core/auth/auth_event_manager', () => { let manager: AuthEventManager; function makeConsumer( diff --git a/packages-exp/auth-exp/src/core/auth/firebase_internal.test.ts b/packages-exp/auth-exp/src/core/auth/firebase_internal.test.ts index a8ba62e3b01..299159650e8 100644 --- a/packages-exp/auth-exp/src/core/auth/firebase_internal.test.ts +++ b/packages-exp/auth-exp/src/core/auth/firebase_internal.test.ts @@ -23,7 +23,7 @@ import { Auth } from '../../model/auth'; import { User } from '../../model/user'; import { AuthInternal } from './firebase_internal'; -describe('src/core/auth/firebase_internal', () => { +describe('core/auth/firebase_internal', () => { let auth: Auth; let authInternal: AuthInternal; beforeEach(async () => { diff --git a/packages-exp/auth-exp/src/core/auth/initialize.test.ts b/packages-exp/auth-exp/src/core/auth/initialize.test.ts index cb258b7305b..001b9538f3f 100644 --- a/packages-exp/auth-exp/src/core/auth/initialize.test.ts +++ b/packages-exp/auth-exp/src/core/auth/initialize.test.ts @@ -41,7 +41,7 @@ import { ClientPlatform, _getClientVersion } from '../util/version'; import { initializeAuth } from './initialize'; import { registerAuth } from './register'; -describe('src/core/auth/initialize', () => { +describe('core/auth/initialize', () => { let fakeApp: FirebaseApp; class FakeSessionPersistence implements Persistence { diff --git a/packages-exp/auth-exp/src/core/credentials/oauth.test.ts b/packages-exp/auth-exp/src/core/credentials/oauth.test.ts index 3b2602c2336..93413685567 100644 --- a/packages-exp/auth-exp/src/core/credentials/oauth.test.ts +++ b/packages-exp/auth-exp/src/core/credentials/oauth.test.ts @@ -32,7 +32,7 @@ const BASE_PARAMS: OAuthCredentialParams = { signInMethod: SignInMethod.GOOGLE }; -describe('src/core/credentials/oauth', () => { +describe('core/credentials/oauth', () => { let auth: TestAuth; let signInWithIdp: fetch.Route; diff --git a/packages-exp/auth-exp/src/core/persistence/persistence_user_manager.ts b/packages-exp/auth-exp/src/core/persistence/persistence_user_manager.ts index b10a7336a61..7a2bf49f710 100644 --- a/packages-exp/auth-exp/src/core/persistence/persistence_user_manager.ts +++ b/packages-exp/auth-exp/src/core/persistence/persistence_user_manager.ts @@ -38,6 +38,7 @@ export function _persistenceKeyName( export class PersistenceUserManager { private readonly fullUserKey: string; private readonly fullPersistenceKey: string; + private readonly boundEventHandler: () => void; private constructor( public persistence: Persistence, @@ -51,10 +52,8 @@ export class PersistenceUserManager { config.apiKey, name ); - this.persistence._addListener( - this.fullUserKey, - auth._onStorageEvent.bind(auth) - ); + this.boundEventHandler = auth._onStorageEvent.bind(auth); + this.persistence._addListener(this.fullUserKey, this.boundEventHandler); } setCurrentUser(user: User): Promise { @@ -93,10 +92,7 @@ export class PersistenceUserManager { } delete(): void { - this.persistence._removeListener( - this.fullUserKey, - this.auth._onStorageEvent - ); + this.persistence._removeListener(this.fullUserKey, this.boundEventHandler); } static async create( diff --git a/packages-exp/auth-exp/src/core/providers/facebook.test.ts b/packages-exp/auth-exp/src/core/providers/facebook.test.ts index ed2d5dc9f99..31adc8de71d 100644 --- a/packages-exp/auth-exp/src/core/providers/facebook.test.ts +++ b/packages-exp/auth-exp/src/core/providers/facebook.test.ts @@ -30,7 +30,7 @@ import { AUTH_ERROR_FACTORY, AuthErrorCode } from '../errors'; import { UserCredentialImpl } from '../user/user_credential_impl'; import { FacebookAuthProvider } from './facebook'; -describe('src/core/providers/facebook', () => { +describe('core/providers/facebook', () => { it('generates the correct type of oauth credential', () => { const cred = FacebookAuthProvider.credential('access-token'); expect(cred.accessToken).to.eq('access-token'); diff --git a/packages-exp/auth-exp/src/core/providers/github.test.ts b/packages-exp/auth-exp/src/core/providers/github.test.ts index 1ab22f23567..3ec9ccd6b9b 100644 --- a/packages-exp/auth-exp/src/core/providers/github.test.ts +++ b/packages-exp/auth-exp/src/core/providers/github.test.ts @@ -30,7 +30,7 @@ import { AUTH_ERROR_FACTORY, AuthErrorCode } from '../errors'; import { UserCredentialImpl } from '../user/user_credential_impl'; import { GithubAuthProvider } from './github'; -describe('src/core/providers/github', () => { +describe('core/providers/github', () => { it('generates the correct type of oauth credential', () => { const cred = GithubAuthProvider.credential('access-token'); expect(cred.accessToken).to.eq('access-token'); diff --git a/packages-exp/auth-exp/src/core/providers/google.test.ts b/packages-exp/auth-exp/src/core/providers/google.test.ts index 1a5a982f5fa..9b250c9296e 100644 --- a/packages-exp/auth-exp/src/core/providers/google.test.ts +++ b/packages-exp/auth-exp/src/core/providers/google.test.ts @@ -30,7 +30,7 @@ import { AUTH_ERROR_FACTORY, AuthErrorCode } from '../errors'; import { UserCredentialImpl } from '../user/user_credential_impl'; import { GoogleAuthProvider } from './google'; -describe('src/core/providers/google', () => { +describe('core/providers/google', () => { it('generates the correct type of oauth credential', () => { const cred = GoogleAuthProvider.credential('id-token', 'access-token'); expect(cred.accessToken).to.eq('access-token'); diff --git a/packages-exp/auth-exp/src/core/providers/twitter.test.ts b/packages-exp/auth-exp/src/core/providers/twitter.test.ts index 51ef349f1e7..22bd01fa90d 100644 --- a/packages-exp/auth-exp/src/core/providers/twitter.test.ts +++ b/packages-exp/auth-exp/src/core/providers/twitter.test.ts @@ -47,7 +47,7 @@ import { AUTH_ERROR_FACTORY, AuthErrorCode } from '../errors'; import { UserCredentialImpl } from '../user/user_credential_impl'; import { TwitterAuthProvider } from './twitter'; -describe('src/core/providers/twitter', () => { +describe('core/providers/twitter', () => { it('generates the correct type of oauth credential', () => { const cred = TwitterAuthProvider.credential('token', 'secret'); expect(cred.accessToken).to.eq('token'); diff --git a/packages-exp/auth-exp/src/core/strategies/idp.test.ts b/packages-exp/auth-exp/src/core/strategies/idp.test.ts index 3a44fbf9f66..3f781b55bac 100644 --- a/packages-exp/auth-exp/src/core/strategies/idp.test.ts +++ b/packages-exp/auth-exp/src/core/strategies/idp.test.ts @@ -31,7 +31,7 @@ import * as idpTasks from './idp'; use(chaiAsPromised); -describe('src/core/strategies/idb', () => { +describe('core/strategies/idb', () => { let auth: TestAuth; let user: User; let signInEndpoint: fetch.Route; diff --git a/packages-exp/auth-exp/src/core/user/id_token_result.test.ts b/packages-exp/auth-exp/src/core/user/id_token_result.test.ts index 240e0a4e364..572ed08e465 100644 --- a/packages-exp/auth-exp/src/core/user/id_token_result.test.ts +++ b/packages-exp/auth-exp/src/core/user/id_token_result.test.ts @@ -33,7 +33,7 @@ const MAY_1 = new Date('May 1, 2020'); const MAY_2 = new Date('May 2, 2020'); const MAY_3 = new Date('May 3, 2020'); -describe('/core/user/id_token_result', () => { +describe('core/user/id_token_result', () => { let user: User; beforeEach(async () => { diff --git a/packages-exp/auth-exp/src/core/user/invalidation.test.ts b/packages-exp/auth-exp/src/core/user/invalidation.test.ts index 36e1f8d0561..3629f0887ec 100644 --- a/packages-exp/auth-exp/src/core/user/invalidation.test.ts +++ b/packages-exp/auth-exp/src/core/user/invalidation.test.ts @@ -28,7 +28,7 @@ import { _logoutIfInvalidated } from './invalidation'; use(chaiAsPromised); -describe('src/core/user/invalidation', () => { +describe('core/user/invalidation', () => { let user: User; let auth: Auth; diff --git a/packages-exp/auth-exp/src/core/user/proactive_refresh.test.ts b/packages-exp/auth-exp/src/core/user/proactive_refresh.test.ts index 474cfa195f1..1f1b9417fce 100644 --- a/packages-exp/auth-exp/src/core/user/proactive_refresh.test.ts +++ b/packages-exp/auth-exp/src/core/user/proactive_refresh.test.ts @@ -32,7 +32,7 @@ import { use(chaiAsPromised); use(sinonChai); -describe('src/core/user/proactive_refresh', () => { +describe('core/user/proactive_refresh', () => { let user: User; let proactiveRefresh: ProactiveRefresh; let getTokenStub: sinon.SinonStub; diff --git a/packages-exp/auth-exp/src/core/user/reauthenticate.test.ts b/packages-exp/auth-exp/src/core/user/reauthenticate.test.ts index 89494090cf0..84765c4d504 100644 --- a/packages-exp/auth-exp/src/core/user/reauthenticate.test.ts +++ b/packages-exp/auth-exp/src/core/user/reauthenticate.test.ts @@ -43,7 +43,7 @@ import { _reauthenticate } from './reauthenticate'; use(chaiAsPromised); -describe('src/core/user/reauthenticate', () => { +describe('core/user/reauthenticate', () => { let credential: AuthCredential; let user: User; diff --git a/packages-exp/auth-exp/src/core/util/instantiator.test.ts b/packages-exp/auth-exp/src/core/util/instantiator.test.ts index f1c1ba603ad..b93e02d72b7 100644 --- a/packages-exp/auth-exp/src/core/util/instantiator.test.ts +++ b/packages-exp/auth-exp/src/core/util/instantiator.test.ts @@ -19,7 +19,7 @@ import { expect } from 'chai'; import { _getInstance } from './instantiator'; -describe('src/core/util/instantiator', () => { +describe('core/util/instantiator', () => { context('_getInstance', () => { // All tests define their own classes since the Class object is used in the // global map. diff --git a/packages-exp/auth-exp/src/platform_browser/iframe/gapi.test.ts b/packages-exp/auth-exp/src/platform_browser/iframe/gapi.test.ts index 785a9f0e7a8..af7dc30210d 100644 --- a/packages-exp/auth-exp/src/platform_browser/iframe/gapi.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/iframe/gapi.test.ts @@ -30,7 +30,7 @@ import { _loadGapi, _resetLoader } from './gapi'; use(sinonChai); use(chaiAsPromised); -describe('src/platform_browser/iframe/gapi', () => { +describe('platform_browser/iframe/gapi', () => { let library: typeof gapi; let auth: TestAuth; function onJsLoad(globalLoadFnName: string): void { diff --git a/packages-exp/auth-exp/src/platform_browser/iframe/iframe.test.ts b/packages-exp/auth-exp/src/platform_browser/iframe/iframe.test.ts index 96ef34f3247..3bf897d3cd4 100644 --- a/packages-exp/auth-exp/src/platform_browser/iframe/iframe.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/iframe/iframe.test.ts @@ -39,7 +39,7 @@ use(chaiAsPromised); type IframesCallback = (iframesLib: unknown) => Promise; -describe('src/platform_browser/iframe/iframe', () => { +describe('platform_browser/iframe/iframe', () => { let auth: TestAuth; let iframeSettings: Record; let libraryLoadedCallback: IframesCallback; diff --git a/packages-exp/auth-exp/src/platform_browser/messagechannel/index.ts b/packages-exp/auth-exp/src/platform_browser/messagechannel/index.ts new file mode 100644 index 00000000000..8417c9ead5b --- /dev/null +++ b/packages-exp/auth-exp/src/platform_browser/messagechannel/index.ts @@ -0,0 +1,109 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { PromiseSettledResult } from './promise'; + +export const enum _TimeoutDuration { + ACK = 50, + COMPLETION = 3000, + // Used when a handler is confirmed to be available on the other side. + LONG_ACK = 800 +} + +/** + * Enumeration of possible response types from the Receiver. + */ +export const enum _Status { + ACK = 'ack', + DONE = 'done' +} + +export const enum _MessageError { + CONNECTION_CLOSED = 'connection_closed', + CONNECTION_UNAVAILABLE = 'connection_unavailable', + INVALID_RESPONSE = 'invalid_response', + TIMEOUT = 'timeout', + UNKNOWN = 'unknown_error', + UNSUPPORTED_EVENT = 'unsupported_event' +} + +/** + * Enumeration of possible events sent by the Sender. + */ +export const enum _EventType { + KEY_CHANGED = 'keyChanged', + PING = 'ping' +} + +/** + * Response to a {@link EventType.KEY_CHANGED} event. + */ +export interface KeyChangedResponse { + keyProcessed: boolean; +} + +/** + * Response to a {@link EventType.PING} event. + */ +export type _PingResponse = _EventType[]; + +export type _ReceiverResponse = KeyChangedResponse | _PingResponse; + +interface MessageEvent { + eventType: _EventType; + eventId: string; +} + +/** + * Request for a {@link EventType.KEY_CHANGED} event. + */ +export interface KeyChangedRequest { + key: string; +} + +/** + * Request for a {@link EventType.PING} event. + */ +export interface PingRequest {} + +/** Data sent by Sender */ +export type _SenderRequest = KeyChangedRequest | PingRequest; + +/** Receiver handler to process events sent by the Sender */ +export interface ReceiverHandler< + T extends _ReceiverResponse, + S extends _SenderRequest +> { + (origin: string, data: S): T | Promise; +} + +/** Full message sent by Sender */ +export interface SenderMessageEvent + extends MessageEvent { + data: T; +} + +export type _ReceiverMessageResponse = Array< + PromiseSettledResult +> | null; + +/** Full message sent by Receiver */ +export interface ReceiverMessageEvent + extends MessageEvent { + status: _Status; + response: _ReceiverMessageResponse; +} diff --git a/packages-exp/auth-exp/src/platform_browser/messagechannel/promise.test.ts b/packages-exp/auth-exp/src/platform_browser/messagechannel/promise.test.ts new file mode 100644 index 00000000000..0bf17f50772 --- /dev/null +++ b/packages-exp/auth-exp/src/platform_browser/messagechannel/promise.test.ts @@ -0,0 +1,60 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { expect } from 'chai'; +import { _allSettled } from './promise'; + +describe('platform_browser/messagechannel/promise', () => { + describe('_allSettled', () => { + it('should work with a single successfull promise', async () => { + const result = await _allSettled([Promise.resolve('foo')]); + expect(result).to.have.deep.members([ + { + fulfilled: true, + value: 'foo' + } + ]); + }); + + it('should work with a failed promise', async () => { + const result = await _allSettled([Promise.reject('bar')]); + expect(result).to.have.deep.members([ + { + fulfilled: false, + reason: 'bar' + } + ]); + }); + + it('should work with mixed promises', async () => { + const result = await _allSettled([ + Promise.resolve('foo'), + Promise.reject('bar') + ]); + expect(result).to.have.deep.members([ + { + fulfilled: true, + value: 'foo' + }, + { + fulfilled: false, + reason: 'bar' + } + ]); + }); + }); +}); diff --git a/packages-exp/auth-exp/src/platform_browser/messagechannel/promise.ts b/packages-exp/auth-exp/src/platform_browser/messagechannel/promise.ts new file mode 100644 index 00000000000..2469a3d9c99 --- /dev/null +++ b/packages-exp/auth-exp/src/platform_browser/messagechannel/promise.ts @@ -0,0 +1,58 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** TODO: remove this once tslib has a polyfill for Promise.allSettled */ +interface PromiseFulfilledResult { + fulfilled: true; + value: T; +} + +interface PromiseRejectedResult { + fulfilled: false; + // eslint-disable-next-line @typescript-eslint/no-explicit-any + reason: any; +} + +export type PromiseSettledResult = + | PromiseFulfilledResult + | PromiseRejectedResult; + +/** + * Shim for Promise.allSettled, note the slightly different format of `fulfilled` vs `status`. + * + * @param promises - Array of promises to wait on. + */ +export function _allSettled( + promises: Array> +): Promise>> { + return Promise.all( + promises.map(async promise => { + try { + const value = await promise; + return { + fulfilled: true, + value + } as PromiseFulfilledResult; + } catch (reason) { + return { + fulfilled: false, + reason + } as PromiseRejectedResult; + } + }) + ); +} diff --git a/packages-exp/auth-exp/src/platform_browser/messagechannel/receiver.test.ts b/packages-exp/auth-exp/src/platform_browser/messagechannel/receiver.test.ts new file mode 100644 index 00000000000..820b9223e26 --- /dev/null +++ b/packages-exp/auth-exp/src/platform_browser/messagechannel/receiver.test.ts @@ -0,0 +1,178 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { expect, use } from 'chai'; +import * as sinon from 'sinon'; +import * as sinonChai from 'sinon-chai'; +import { + _EventType, + PingRequest, + _PingResponse, + ReceiverMessageEvent, + SenderMessageEvent, + _Status +} from '.'; +import { FakeServiceWorker } from '../../../test/helpers/fake_service_worker'; +import { Receiver } from './receiver'; + +use(sinonChai); + +describe('platform_browser/messagechannel/receiver', () => { + let receiver: Receiver; + let serviceWorker: ServiceWorker; + let messageChannel: MessageChannel; + + beforeEach(() => { + serviceWorker = (new FakeServiceWorker() as unknown) as ServiceWorker; + receiver = Receiver._getInstance(serviceWorker); + messageChannel = new MessageChannel(); + }); + + describe('_getInstance', () => { + it('should memoize the instances', () => { + expect(Receiver._getInstance(serviceWorker)).to.eq(receiver); + }); + }); + + describe('_subscribe', () => { + it('should not respond to events that arent subscribed to', () => { + messageChannel.port1.onmessage = sinon.spy(); + serviceWorker.postMessage( + { + eventType: _EventType.PING, + eventId: '12345', + data: {} + } as SenderMessageEvent, + [messageChannel.port2] + ); + expect(messageChannel.port1.onmessage).to.not.have.been.called; + }); + + it('should return the handlers response to the caller', done => { + const response = [_EventType.KEY_CHANGED]; + let ackReceived = false; + receiver._subscribe<_PingResponse, PingRequest>( + _EventType.PING, + (_origin: string, data: PingRequest) => { + expect(data).to.eql({}); + return response; + } + ); + messageChannel.port1.onmessage = (event: Event) => { + const messageEvent = event as MessageEvent< + ReceiverMessageEvent<_PingResponse> + >; + if (!ackReceived) { + expect(messageEvent.data.eventId).to.eq('12345'); + expect(messageEvent.data.eventType).to.eq(_EventType.PING); + expect(messageEvent.data.status).to.eq(_Status.ACK); + ackReceived = true; + } else { + expect(messageEvent.data.eventId).to.eq('12345'); + expect(messageEvent.data.eventType).to.eq(_EventType.PING); + expect(messageEvent.data.status).to.eq(_Status.DONE); + expect(messageEvent.data.response).to.have.deep.members([ + { + fulfilled: true, + value: response + } + ]); + expect(ackReceived).to.be.true; + done(); + } + }; + serviceWorker.postMessage( + { + eventType: _EventType.PING, + eventId: '12345', + data: {} + } as SenderMessageEvent, + [messageChannel.port2] + ); + }); + + it('should handle multiple subscribers, even if one fails', done => { + const response = [_EventType.KEY_CHANGED]; + let ackReceived = false; + receiver._subscribe( + _EventType.PING, + (_origin: string, data: PingRequest) => { + expect(data).to.eql({}); + return response; + } + ); + receiver._subscribe( + _EventType.PING, + (_origin: string, _data: PingRequest) => Promise.reject('fail') + ); + messageChannel.port1.onmessage = (event: Event) => { + const messageEvent = event as MessageEvent< + ReceiverMessageEvent<_PingResponse> + >; + if (!ackReceived) { + expect(messageEvent.data.eventId).to.eq('12345'); + expect(messageEvent.data.eventType).to.eq(_EventType.PING); + expect(messageEvent.data.status).to.eq(_Status.ACK); + ackReceived = true; + } else { + expect(messageEvent.data.eventId).to.eq('12345'); + expect(messageEvent.data.eventType).to.eq(_EventType.PING); + expect(messageEvent.data.status).to.eq(_Status.DONE); + expect(messageEvent.data.response).to.have.deep.members([ + { + fulfilled: true, + value: response + }, + { + fulfilled: false, + reason: 'fail' + } + ]); + done(); + } + }; + serviceWorker.postMessage( + { + eventType: _EventType.PING, + eventId: '12345', + data: {} + } as SenderMessageEvent, + [messageChannel.port2] + ); + }); + }); + + describe('_unsubscribe', () => { + it('should remove the handlers', () => { + messageChannel.port1.onmessage = sinon.spy(); + const handler = (_origin: string, _data: PingRequest): _EventType[] => { + return [_EventType.KEY_CHANGED]; + }; + receiver._subscribe(_EventType.PING, handler); + receiver._unsubscribe(_EventType.PING, handler); + serviceWorker.postMessage( + { + eventType: _EventType.PING, + eventId: '12345', + data: {} + } as SenderMessageEvent, + [messageChannel.port2] + ); + expect(messageChannel.port1.onmessage).to.not.have.been.called; + }); + }); +}); diff --git a/packages-exp/auth-exp/src/platform_browser/messagechannel/receiver.ts b/packages-exp/auth-exp/src/platform_browser/messagechannel/receiver.ts new file mode 100644 index 00000000000..f004b6e919a --- /dev/null +++ b/packages-exp/auth-exp/src/platform_browser/messagechannel/receiver.ts @@ -0,0 +1,161 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { + ReceiverHandler, + _EventType, + _ReceiverResponse, + SenderMessageEvent, + _Status, + _SenderRequest +} from './index'; +import { _allSettled } from './promise'; + +/** + * Interface class for receiving messages. + * + * @internal + */ +export class Receiver { + private static readonly receivers: Receiver[] = []; + private readonly boundEventHandler: EventListener; + + private readonly handlersMap: { + // Typescript doesn't have existential types :( + // eslint-disable-next-line @typescript-eslint/no-explicit-any + [eventType: string]: Set>; + } = {}; + + constructor(private readonly eventTarget: EventTarget) { + this.boundEventHandler = this.handleEvent.bind(this); + } + + /** + * Obtain an instance of a Receiver for a given event target, if none exists it will be created. + * + * @param eventTarget - An event target (such as window or self) through which the underlying + * messages will be received. + */ + static _getInstance(eventTarget: EventTarget): Receiver { + // The results are stored in an array since objects can't be keys for other + // objects. In addition, setting a unique property on an event target as a + // hash map key may not be allowed due to CORS restrictions. + const existingInstance = this.receivers.find(receiver => + receiver.isListeningto(eventTarget) + ); + if (existingInstance) { + return existingInstance; + } + const newInstance = new Receiver(eventTarget); + this.receivers.push(newInstance); + return newInstance; + } + + private isListeningto(eventTarget: EventTarget): boolean { + return this.eventTarget === eventTarget; + } + + /** + * Fans out a MessageEvent to the appropriate listeners. + * + * @remarks + * Sends an {@link Status.ACK} upon receipt and a {@link Status.DONE} once all handlers have + * finished processing. + * + * @param event - The MessageEvent. + * + * @internal + */ + private async handleEvent< + T extends _ReceiverResponse, + S extends _SenderRequest + >(event: Event): Promise { + const messageEvent = event as MessageEvent>; + const { eventId, eventType, data } = messageEvent.data; + + const handlers: Set> | undefined = this.handlersMap[ + eventType + ]; + if (!handlers?.size) { + return; + } + + messageEvent.ports[0].postMessage({ + status: _Status.ACK, + eventId, + eventType + }); + + const promises = Array.from(handlers).map(async handler => + handler(messageEvent.origin, data) + ); + const response = await _allSettled(promises); + messageEvent.ports[0].postMessage({ + status: _Status.DONE, + eventId, + eventType, + response + }); + } + + /** + * Subscribe an event handler for a particular event. + * + * @param eventType - Event name to subscribe to. + * @param eventHandler - The event handler which should receive the events. + * + * @internal + */ + _subscribe( + eventType: _EventType, + eventHandler: ReceiverHandler + ): void { + if (Object.keys(this.handlersMap).length === 0) { + this.eventTarget.addEventListener('message', this.boundEventHandler); + } + + if (!this.handlersMap[eventType]) { + this.handlersMap[eventType] = new Set(); + } + + this.handlersMap[eventType].add(eventHandler); + } + + /** + * Unsubscribe an event handler from a particular event. + * + * @param eventType - Event name to unsubscribe from. + * @param eventHandler - Optinoal event handler, if none provided, unsubscribe all handlers on this event. + * + * @internal + */ + _unsubscribe( + eventType: _EventType, + eventHandler?: ReceiverHandler + ): void { + if (this.handlersMap[eventType] && eventHandler) { + this.handlersMap[eventType].delete(eventHandler); + } + if (!eventHandler || this.handlersMap[eventType].size === 0) { + delete this.handlersMap[eventType]; + } + + if (Object.keys(this.handlersMap).length === 0) { + this.eventTarget.removeEventListener('message', this.boundEventHandler); + } + } +} diff --git a/packages-exp/auth-exp/src/platform_browser/messagechannel/sender.test.ts b/packages-exp/auth-exp/src/platform_browser/messagechannel/sender.test.ts new file mode 100644 index 00000000000..427b1dfc4b4 --- /dev/null +++ b/packages-exp/auth-exp/src/platform_browser/messagechannel/sender.test.ts @@ -0,0 +1,163 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { expect, use } from 'chai'; +import * as chaiAsPromised from 'chai-as-promised'; +import * as sinon from 'sinon'; +import * as sinonChai from 'sinon-chai'; +import { + _EventType, + _MessageError, + PingRequest, + _PingResponse, + ReceiverMessageEvent, + SenderMessageEvent, + _Status, + _TimeoutDuration +} from '.'; +import { delay } from '../../../test/helpers/delay'; +import { FakeServiceWorker } from '../../../test/helpers/fake_service_worker'; +import { stubTimeouts, TimerMap } from '../../../test/helpers/timeout_stub'; +import { Sender } from './sender'; + +use(sinonChai); +use(chaiAsPromised); + +describe('platform_browser/messagechannel/sender', () => { + describe('_send', () => { + let sender: Sender; + let serviceWorker: ServiceWorker; + let pendingTimeouts: TimerMap; + + beforeEach(() => { + serviceWorker = (new FakeServiceWorker() as unknown) as ServiceWorker; + sender = new Sender(serviceWorker); + pendingTimeouts = stubTimeouts(); + sinon.stub(window, 'clearTimeout'); + }); + + afterEach(() => { + sinon.restore(); + }); + + it('should send an event and wait for a response', async () => { + const response = [ + { + fulfilled: true, + value: [_EventType.KEY_CHANGED] + } + ]; + serviceWorker.addEventListener('message', (event: Event) => { + const messageEvent = event as MessageEvent< + SenderMessageEvent + >; + messageEvent.ports[0].postMessage({ + status: _Status.ACK, + eventId: messageEvent.data.eventId, + eventType: messageEvent.data.eventType, + response: null + } as ReceiverMessageEvent<_PingResponse>); + messageEvent.ports[0].postMessage({ + status: _Status.DONE, + eventId: messageEvent.data.eventId, + eventType: messageEvent.data.eventType, + response + } as ReceiverMessageEvent<_PingResponse>); + }); + const result = await sender._send<_PingResponse, PingRequest>( + _EventType.PING, + {}, + _TimeoutDuration.ACK + ); + expect(result).to.have.deep.members(response); + }); + + it('should timeout if it doesnt see an ACK', async () => { + serviceWorker.addEventListener('message', (_event: Event) => { + delay(() => { + pendingTimeouts[_TimeoutDuration.ACK](); + }); + }); + await expect( + sender._send<_PingResponse, PingRequest>( + _EventType.PING, + {}, + _TimeoutDuration.ACK + ) + ).to.be.rejectedWith(Error, _MessageError.UNSUPPORTED_EVENT); + }); + + it('should work with a long ACK', async () => { + const response = [ + { + fulfilled: true, + value: [_EventType.KEY_CHANGED] + } + ]; + serviceWorker.addEventListener('message', (event: Event) => { + delay(() => { + pendingTimeouts[_TimeoutDuration.ACK](); + }); + const messageEvent = event as MessageEvent< + SenderMessageEvent + >; + messageEvent.ports[0].postMessage({ + status: _Status.ACK, + eventId: messageEvent.data.eventId, + eventType: messageEvent.data.eventType, + response: null + } as ReceiverMessageEvent<_PingResponse>); + messageEvent.ports[0].postMessage({ + status: _Status.DONE, + eventId: messageEvent.data.eventId, + eventType: messageEvent.data.eventType, + response + } as ReceiverMessageEvent<_PingResponse>); + }); + const result = await sender._send<_PingResponse, PingRequest>( + _EventType.PING, + {}, + _TimeoutDuration.LONG_ACK + ); + expect(result).to.have.deep.members(response); + }); + + it('it should timeout if it gets an ACK but not a DONE', async () => { + serviceWorker.addEventListener('message', (event: Event) => { + const messageEvent = event as MessageEvent< + SenderMessageEvent + >; + messageEvent.ports[0].postMessage({ + status: _Status.ACK, + eventId: messageEvent.data.eventId, + eventType: messageEvent.data.eventType, + response: null + } as ReceiverMessageEvent<_PingResponse>); + delay(() => { + pendingTimeouts[_TimeoutDuration.COMPLETION](); + }); + }); + await expect( + sender._send<_PingResponse, PingRequest>( + _EventType.PING, + {}, + _TimeoutDuration.ACK + ) + ).to.be.rejectedWith(Error, _MessageError.TIMEOUT); + }); + }); +}); diff --git a/packages-exp/auth-exp/src/platform_browser/messagechannel/sender.ts b/packages-exp/auth-exp/src/platform_browser/messagechannel/sender.ts new file mode 100644 index 00000000000..9042b63bf40 --- /dev/null +++ b/packages-exp/auth-exp/src/platform_browser/messagechannel/sender.ts @@ -0,0 +1,144 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { + _SenderRequest, + _EventType, + ReceiverMessageEvent, + _MessageError, + SenderMessageEvent, + _Status, + _ReceiverMessageResponse, + _ReceiverResponse, + _TimeoutDuration +} from './index'; + +interface MessageHandler { + messageChannel: MessageChannel; + onMessage: EventListenerOrEventListenerObject; +} + +function generateEventId(prefix = '', digits = 20): string { + return `${prefix}${Math.floor(Math.random() * Math.pow(10, digits))}`; +} + +/** + * Interface for sending messages and waiting for a completion response. + * + * @internal + */ +export class Sender { + private readonly handlers = new Set(); + + constructor(private readonly target: ServiceWorker) {} + + /** + * Unsubscribe the handler and remove it from our tracking Set. + * + * @param handler - The handler to unsubscribe. + */ + private removeMessageHandler(handler: MessageHandler): void { + if (handler.messageChannel) { + handler.messageChannel.port1.removeEventListener( + 'message', + handler.onMessage + ); + handler.messageChannel.port1.close(); + } + this.handlers.delete(handler); + } + + /** + * Send a message to the Receiver located at {@link target}. + * + * @remarks + * We'll first wait a bit for an ACK , if we get one we will wait significantly longer until the + * receiver has had a chance to fully process the event. + * + * @param eventType - Type of event to send. + * @param data - The payload of the event. + * @param timeout - Timeout for waiting on an ACK from the receiver. + * + * @returns An array of settled promises from all the handlers that were listening on the receiver. + */ + async _send( + eventType: _EventType, + data: S, + timeout = _TimeoutDuration.ACK + ): Promise<_ReceiverMessageResponse> { + const messageChannel = + typeof MessageChannel !== 'undefined' ? new MessageChannel() : null; + if (!messageChannel) { + throw new Error(_MessageError.CONNECTION_UNAVAILABLE); + } + // Node timers and browser timers return fundamentally different types. + // We don't actually care what the value is but TS won't accept unknown and + // we can't cast properly in both environments. + // eslint-disable-next-line @typescript-eslint/no-explicit-any + let completionTimer: any; + let handler: MessageHandler; + return new Promise<_ReceiverMessageResponse>((resolve, reject) => { + const eventId = generateEventId(); + messageChannel.port1.start(); + const ackTimer = setTimeout(() => { + reject(new Error(_MessageError.UNSUPPORTED_EVENT)); + }, timeout); + handler = { + messageChannel, + onMessage(event: Event): void { + const messageEvent = event as MessageEvent>; + if (messageEvent.data.eventId !== eventId) { + return; + } + switch (messageEvent.data.status) { + case _Status.ACK: + // The receiver should ACK first. + clearTimeout(ackTimer); + completionTimer = setTimeout(() => { + reject(new Error(_MessageError.TIMEOUT)); + }, _TimeoutDuration.COMPLETION); + break; + case _Status.DONE: + // Once the receiver's handlers are finished we will get the results. + clearTimeout(completionTimer); + resolve(messageEvent.data.response); + break; + default: + clearTimeout(ackTimer); + clearTimeout(completionTimer); + reject(new Error(_MessageError.INVALID_RESPONSE)); + break; + } + } + }; + this.handlers.add(handler); + messageChannel.port1.addEventListener('message', handler.onMessage); + this.target.postMessage( + { + eventType, + eventId, + data + } as SenderMessageEvent, + [messageChannel.port2] + ); + }).finally(() => { + if (handler) { + this.removeMessageHandler(handler); + } + }); + } +} diff --git a/packages-exp/auth-exp/src/platform_browser/mfa/assertions/phone.test.ts b/packages-exp/auth-exp/src/platform_browser/mfa/assertions/phone.test.ts index aafa2aec130..cf72fa883e4 100644 --- a/packages-exp/auth-exp/src/platform_browser/mfa/assertions/phone.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/mfa/assertions/phone.test.ts @@ -15,24 +15,23 @@ * limitations under the License. */ +import { ProviderId } from '@firebase/auth-types-exp'; import { expect, use } from 'chai'; import * as chaiAsPromised from 'chai-as-promised'; -import { ProviderId } from '@firebase/auth-types-exp'; - import { mockEndpoint } from '../../../../test/helpers/api/helper'; import { testAuth, TestAuth } from '../../../../test/helpers/mock_auth'; import * as mockFetch from '../../../../test/helpers/mock_fetch'; import { Endpoint } from '../../../api'; import { FinalizeMfaResponse } from '../../../api/authentication/mfa'; import { PhoneAuthCredential } from '../../../core/credentials/phone'; -import { PhoneAuthProvider } from '../../providers/phone'; import { MultiFactorSession } from '../../../mfa/mfa_session'; +import { PhoneAuthProvider } from '../../providers/phone'; import { PhoneMultiFactorAssertion, PhoneMultiFactorGenerator } from './phone'; use(chaiAsPromised); -describe('core/mfa/phone/PhoneMultiFactorAssertion', () => { +describe('platform_browser/mfa/phone', () => { let auth: TestAuth; let credential: PhoneAuthCredential; let assertion: PhoneMultiFactorAssertion; diff --git a/packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.test.ts b/packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.test.ts index 461dc6d0dca..0decef78da5 100644 --- a/packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.test.ts @@ -18,21 +18,36 @@ import { expect, use } from 'chai'; import * as sinon from 'sinon'; import * as sinonChai from 'sinon-chai'; - -import { testUser, testAuth } from '../../../test/helpers/mock_auth'; -import { _getInstance } from '../../core/util/instantiator'; +import { FakeServiceWorker } from '../../../test/helpers/fake_service_worker'; +import { testAuth, testUser } from '../../../test/helpers/mock_auth'; import { Persistence, PersistenceType } from '../../core/persistence'; +import { + SingletonInstantiator, + _getInstance +} from '../../core/util/instantiator'; +import { + _EventType, + KeyChangedRequest, + _TimeoutDuration +} from '../messagechannel/index'; +import { Receiver } from '../messagechannel/receiver'; +import { Sender } from '../messagechannel/sender'; +import * as workerUtil from '../util/worker'; import { indexedDBLocalPersistence, - _POLLING_INTERVAL_MS, - _putObject, + _clearDatabase, _openDatabase, - _clearDatabase + _POLLING_INTERVAL_MS, + _putObject } from './indexed_db'; use(sinonChai); -describe('core/persistence/indexed_db', () => { +interface TestPersistence extends Persistence { + _workerInitializationPromise: Promise; +} + +describe('platform_browser/persistence/indexed_db', () => { const persistence: Persistence = _getInstance(indexedDBLocalPersistence); afterEach(sinon.restore); @@ -158,4 +173,155 @@ describe('core/persistence/indexed_db', () => { }); }); }); + + context('service worker integration', () => { + let serviceWorker: ServiceWorker; + let persistence: TestPersistence; + + beforeEach(() => { + serviceWorker = (new FakeServiceWorker() as unknown) as ServiceWorker; + }); + + afterEach(() => { + sinon.restore(); + }); + + context('as a service worker', () => { + let sender: Sender; + let db: IDBDatabase; + + beforeEach(async () => { + sender = new Sender(serviceWorker); + sinon.stub(workerUtil, '_isWorker').returns(true); + sinon.stub(workerUtil, '_getWorkerGlobalScope').returns(serviceWorker); + persistence = new ((indexedDBLocalPersistence as unknown) as SingletonInstantiator< + TestPersistence + >)(); + db = await _openDatabase(); + }); + + it('should respond to pings', async () => { + await persistence._workerInitializationPromise; + const response = await sender._send( + _EventType.PING, + {}, + _TimeoutDuration.ACK + ); + + expect(response).to.have.deep.members([ + { + fulfilled: true, + value: [_EventType.KEY_CHANGED] + } + ]); + }); + + it('should let us know if the key didnt actually change on a key changed event', async () => { + await persistence._workerInitializationPromise; + const response = await sender._send( + _EventType.KEY_CHANGED, + { + key: 'foo' + }, + _TimeoutDuration.LONG_ACK + ); + + expect(response).to.have.deep.members([ + { + fulfilled: true, + value: { + keyProcessed: false + } + } + ]); + }); + + it('should refresh on key changed events when a key has changed', async () => { + await persistence._workerInitializationPromise; + await _putObject(db, 'foo', 'bar'); + const response = await sender._send( + _EventType.KEY_CHANGED, + { + key: 'foo' + }, + _TimeoutDuration.LONG_ACK + ); + + expect(response).to.have.deep.members([ + { + fulfilled: true, + value: { + keyProcessed: true + } + } + ]); + }); + }); + + context('as a service worker controller', () => { + let receiver: Receiver; + + beforeEach(() => { + receiver = Receiver._getInstance(serviceWorker); + sinon.stub(workerUtil, '_isWorker').returns(false); + sinon + .stub(workerUtil, '_getActiveServiceWorker') + .returns(Promise.resolve(serviceWorker)); + sinon + .stub(workerUtil, '_getServiceWorkerController') + .returns(serviceWorker); + persistence = new ((indexedDBLocalPersistence as unknown) as SingletonInstantiator< + TestPersistence + >)(); + }); + + it('should send a ping on init', async () => { + return new Promise(resolve => { + receiver._subscribe(_EventType.PING, () => { + resolve(); + return [_EventType.KEY_CHANGED]; + }); + return persistence._workerInitializationPromise; + }); + }); + + it('should send a key changed event when a key is set', async () => { + return new Promise(async resolve => { + await persistence._workerInitializationPromise; + receiver._subscribe( + _EventType.KEY_CHANGED, + (_origin: string, data: KeyChangedRequest) => { + expect(data.key).to.eq('foo'); + resolve(); + return { + keyProcessed: true + }; + } + ); + return persistence._set('foo', 'bar'); + }); + }); + + it('should send a key changed event when a key is removed', async () => { + return new Promise(async resolve => { + receiver._subscribe( + _EventType.KEY_CHANGED, + async (_origin: string, data: KeyChangedRequest) => { + expect(data.key).to.eq('foo'); + const persistedValue = await persistence._get('foo'); + if (!persistedValue) { + resolve(); + } + return { + keyProcessed: true + }; + } + ); + await persistence._workerInitializationPromise; + await persistence._set('foo', 'bar'); + return persistence._remove('foo'); + }); + }); + }); + }); }); diff --git a/packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.ts b/packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.ts index 9fae0a0abb0..dee7448a602 100644 --- a/packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.ts +++ b/packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.ts @@ -24,6 +24,22 @@ import { StorageEventListener, STORAGE_AVAILABLE_KEY } from '../../core/persistence/'; +import { + _EventType, + _PingResponse, + KeyChangedResponse, + KeyChangedRequest, + PingRequest, + _TimeoutDuration +} from '../messagechannel/index'; +import { Receiver } from '../messagechannel/receiver'; +import { Sender } from '../messagechannel/sender'; +import { + _isWorker, + _getActiveServiceWorker, + _getServiceWorkerController, + _getWorkerGlobalScope +} from '../util/worker'; export const DB_NAME = 'firebaseLocalStorageDb'; const DB_VERSION = 1; @@ -162,6 +178,21 @@ class IndexedDBLocalPersistence implements Persistence { private pollTimer: any | null = null; private pendingWrites = 0; + private receiver: Receiver | null = null; + private sender: Sender | null = null; + private serviceWorkerReceiverAvailable = false; + private activeServiceWorker: ServiceWorker | null = null; + // Visible for testing only + readonly _workerInitializationPromise: Promise; + + constructor() { + // Fire & forget the service worker registration as it may never resolve + this._workerInitializationPromise = this.initializeServiceWorkerMessaging().then( + () => {}, + () => {} + ); + } + private async initialize(): Promise { if (this.db) { return this.db; @@ -170,6 +201,100 @@ class IndexedDBLocalPersistence implements Persistence { return this.db; } + /** + * IndexedDB events do not propagate from the main window to the worker context. We rely on a + * postMessage interface to send these events to the worker ourselves. + */ + private async initializeServiceWorkerMessaging(): Promise { + return _isWorker() ? this.initializeReceiver() : this.initializeSender(); + } + + /** + * As the worker we should listen to events from the main window. + */ + private async initializeReceiver(): Promise { + this.receiver = Receiver._getInstance(_getWorkerGlobalScope()!); + // Refresh from persistence if we receive a KeyChanged message. + this.receiver._subscribe( + _EventType.KEY_CHANGED, + async (_origin: string, data: KeyChangedRequest) => { + const keys = await this._poll(); + return { + keyProcessed: keys.includes(data.key) + }; + } + ); + // Let the sender know that we are listening so they give us more timeout. + this.receiver._subscribe( + _EventType.PING, + async (_origin: string, _data: PingRequest) => { + return [_EventType.KEY_CHANGED]; + } + ); + } + + /** + * As the main window, we should let the worker know when keys change (set and remove). + * + * @remarks + * {@link https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerContainer/ready | ServiceWorkerContainer.ready} + * may not resolve. + */ + private async initializeSender(): Promise { + // Check to see if there's an active service worker. + this.activeServiceWorker = await _getActiveServiceWorker(); + if (!this.activeServiceWorker) { + return; + } + this.sender = new Sender(this.activeServiceWorker); + // Ping the service worker to check what events they can handle. + const results = await this.sender._send<_PingResponse, PingRequest>( + _EventType.PING, + {}, + _TimeoutDuration.LONG_ACK + ); + if (!results) { + return; + } + if ( + results[0]?.fulfilled && + results[0]?.value.includes(_EventType.KEY_CHANGED) + ) { + this.serviceWorkerReceiverAvailable = true; + } + } + + /** + * Let the worker know about a changed key, the exact key doesn't technically matter since the + * worker will just trigger a full sync anyway. + * + * @remarks + * For now, we only support one service worker per page. + * + * @param key - Storage key which changed. + */ + private async notifyServiceWorker(key: string): Promise { + if ( + !this.sender || + !this.activeServiceWorker || + _getServiceWorkerController() !== this.activeServiceWorker + ) { + return; + } + try { + await this.sender._send( + _EventType.KEY_CHANGED, + { key }, + // Use long timeout if receiver has previously responded to a ping from us. + this.serviceWorkerReceiverAvailable + ? _TimeoutDuration.LONG_ACK + : _TimeoutDuration.ACK + ); + } catch { + // This is a best effort approach. Ignore errors. + } + } + async _isAvailable(): Promise { try { if (!indexedDB) { @@ -197,6 +322,7 @@ class IndexedDBLocalPersistence implements Persistence { return this._withPendingWrite(async () => { await _putObject(db, key, value); this.localCache[key] = value; + return this.notifyServiceWorker(key); }); } @@ -212,10 +338,11 @@ class IndexedDBLocalPersistence implements Persistence { return this._withPendingWrite(async () => { await deleteObject(db, key); delete this.localCache[key]; + return this.notifyServiceWorker(key); }); } - private async _poll(): Promise { + private async _poll(): Promise { const db = await _openDatabase(); // TODO: check if we need to fallback if getAll is not supported @@ -225,19 +352,22 @@ class IndexedDBLocalPersistence implements Persistence { ).toPromise(); if (!result) { - return; + return []; } // If we have pending writes in progress abort, we'll get picked up on the next poll if (this.pendingWrites !== 0) { - return; + return []; } + const keys = []; for (const { fbase_key: key, value } of result) { if (JSON.stringify(this.localCache[key]) !== JSON.stringify(value)) { this.notifyListeners(key, value as PersistenceValue); + keys.push(key); } } + return keys; } private notifyListeners( diff --git a/packages-exp/auth-exp/src/platform_browser/persistence/local_storage.test.ts b/packages-exp/auth-exp/src/platform_browser/persistence/local_storage.test.ts index 8e138ce2e3f..4bcc2ca9be0 100644 --- a/packages-exp/auth-exp/src/platform_browser/persistence/local_storage.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/persistence/local_storage.test.ts @@ -29,7 +29,7 @@ import { browserLocalPersistence, _POLLING_INTERVAL_MS } from './local_storage'; use(sinonChai); -describe('browserLocalPersistence', () => { +describe('platform_browser/persistence/local_storage', () => { const persistence: Persistence = _getInstance(browserLocalPersistence); beforeEach(() => { diff --git a/packages-exp/auth-exp/src/platform_browser/persistence/local_storage.ts b/packages-exp/auth-exp/src/platform_browser/persistence/local_storage.ts index e75725643bf..c3b911315f5 100644 --- a/packages-exp/auth-exp/src/platform_browser/persistence/local_storage.ts +++ b/packages-exp/auth-exp/src/platform_browser/persistence/local_storage.ts @@ -50,8 +50,13 @@ class BrowserLocalPersistence constructor() { super(localStorage, PersistenceType.LOCAL); + this.boundEventHandler = this.onStorageEvent.bind(this); } + private readonly boundEventHandler: ( + event: StorageEvent, + poll?: boolean + ) => void; private readonly listeners: Record> = {}; private readonly localCache: Record = {}; // setTimeout return value is platform specific @@ -195,11 +200,11 @@ class BrowserLocalPersistence } private attachListener(): void { - window.addEventListener('storage', this.onStorageEvent.bind(this)); + window.addEventListener('storage', this.boundEventHandler); } private detachListener(): void { - window.removeEventListener('storage', this.onStorageEvent); + window.removeEventListener('storage', this.boundEventHandler); } _addListener(key: string, listener: StorageEventListener): void { diff --git a/packages-exp/auth-exp/src/platform_browser/persistence/session_storage.test.ts b/packages-exp/auth-exp/src/platform_browser/persistence/session_storage.test.ts index 7eae761311b..9f7e63049a3 100644 --- a/packages-exp/auth-exp/src/platform_browser/persistence/session_storage.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/persistence/session_storage.test.ts @@ -26,7 +26,7 @@ import { import { _getInstance } from '../../core/util/instantiator'; import { browserSessionPersistence } from './session_storage'; -describe('core/persistence/browser', () => { +describe('platform_browser/persistence/session_storage', () => { beforeEach(() => { localStorage.clear(); sessionStorage.clear(); diff --git a/packages-exp/auth-exp/src/platform_browser/popup_redirect.test.ts b/packages-exp/auth-exp/src/platform_browser/popup_redirect.test.ts index ae8db8590f1..fa314cf8597 100644 --- a/packages-exp/auth-exp/src/platform_browser/popup_redirect.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/popup_redirect.test.ts @@ -47,7 +47,7 @@ import { browserPopupRedirectResolver } from './popup_redirect'; use(chaiAsPromised); use(sinonChai); -describe('src/platform_browser/popup_redirect', () => { +describe('platform_browser/popup_redirect', () => { let resolver: PopupRedirectResolver; let auth: TestAuth; let onIframeMessage: (event: GapiAuthEvent) => Promise; diff --git a/packages-exp/auth-exp/src/platform_browser/providers/phone.test.ts b/packages-exp/auth-exp/src/platform_browser/providers/phone.test.ts index 884d284308b..25383a0deb4 100644 --- a/packages-exp/auth-exp/src/platform_browser/providers/phone.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/providers/phone.test.ts @@ -25,7 +25,7 @@ import { Endpoint } from '../../api'; import { RecaptchaVerifier } from '../../platform_browser/recaptcha/recaptcha_verifier'; import { PhoneAuthProvider } from './phone'; -describe('core/providers/phone', () => { +describe('platform_browser/providers/phone', () => { let auth: TestAuth; beforeEach(async () => { diff --git a/packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha_loader.test.ts b/packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha_loader.test.ts index 94bbe0c6e1a..4683bf1125e 100644 --- a/packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha_loader.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha_loader.test.ts @@ -37,7 +37,7 @@ import { MockReCaptcha } from './recaptcha_mock'; use(chaiAsPromised); use(sinonChai); -describe('platform-browser/recaptcha/recaptcha_loader', () => { +describe('platform_browser/recaptcha/recaptcha_loader', () => { let auth: TestAuth; beforeEach(async () => { diff --git a/packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha_mock.test.ts b/packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha_mock.test.ts index e39040aca49..0dff03cac04 100644 --- a/packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha_mock.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha_mock.test.ts @@ -36,7 +36,7 @@ import { use(sinonChai); use(chaiAsPromised); -describe('platform-browser/recaptcha/recaptcha_mock', () => { +describe('platform_browser/recaptcha/recaptcha_mock', () => { let container: HTMLElement; let auth: TestAuth; diff --git a/packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha_verifier.test.ts b/packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha_verifier.test.ts index 89e8a9aa238..a5b23db09e9 100644 --- a/packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha_verifier.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha_verifier.test.ts @@ -35,7 +35,7 @@ import { RecaptchaVerifier } from './recaptcha_verifier'; use(chaiAsPromised); use(sinonChai); -describe('platform_browser/recaptcha/recaptcha_verifier.ts', () => { +describe('platform_browser/recaptcha/recaptcha_verifier', () => { let auth: TestAuth; let container: HTMLElement; let verifier: RecaptchaVerifier; diff --git a/packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha_verifier.ts b/packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha_verifier.ts index 3c0129dcf11..ab8bc3ee7a4 100644 --- a/packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha_verifier.ts +++ b/packages-exp/auth-exp/src/platform_browser/recaptcha/recaptcha_verifier.ts @@ -24,6 +24,7 @@ import { _isHttpOrHttps } from '../../core/util/location'; import { ApplicationVerifier } from '../../model/application_verifier'; import { Auth } from '../../model/auth'; import { _window } from '../auth_window'; +import { _isWorker } from '../util/worker'; import { Parameters, Recaptcha } from './recaptcha'; import { MockReCaptchaLoaderImpl, @@ -215,7 +216,7 @@ export class RecaptchaVerifier } private async init(): Promise { - assert(_isHttpOrHttps() && !isWorker(), AuthErrorCode.INTERNAL_ERROR, { + assert(_isHttpOrHttps() && !_isWorker(), AuthErrorCode.INTERNAL_ERROR, { appName: this.appName }); @@ -238,13 +239,6 @@ export class RecaptchaVerifier } } -function isWorker(): boolean { - return ( - typeof _window()['WorkerGlobalScope'] !== 'undefined' && - typeof _window()['importScripts'] === 'function' - ); -} - function domReady(): Promise { let resolver: (() => void) | null = null; return new Promise(resolve => { diff --git a/packages-exp/auth-exp/src/platform_browser/strategies/abstract_popup_redirect_operation.test.ts b/packages-exp/auth-exp/src/platform_browser/strategies/abstract_popup_redirect_operation.test.ts index fb0e1f854dd..4b3efec3e13 100644 --- a/packages-exp/auth-exp/src/platform_browser/strategies/abstract_popup_redirect_operation.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/strategies/abstract_popup_redirect_operation.test.ts @@ -57,7 +57,7 @@ class WrapperOperation extends AbstractPopupRedirectOperation { cleanUp = sinon.stub(); } -describe('src/core/strategies/abstract_popup_redirect_operation', () => { +describe('platform_browser/strategies/abstract_popup_redirect_operation', () => { let auth: TestAuth; let resolver: PopupRedirectResolver; let eventManager: EventManager; diff --git a/packages-exp/auth-exp/src/platform_browser/strategies/phone.test.ts b/packages-exp/auth-exp/src/platform_browser/strategies/phone.test.ts index edfbda8ec81..cd4e6a2ac95 100644 --- a/packages-exp/auth-exp/src/platform_browser/strategies/phone.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/strategies/phone.test.ts @@ -47,7 +47,7 @@ import { use(chaiAsPromised); use(sinonChai); -describe('core/strategies/phone', () => { +describe('platform_browser/strategies/phone', () => { let auth: TestAuth; let verifier: ApplicationVerifier; let sendCodeEndpoint: fetch.Route; diff --git a/packages-exp/auth-exp/src/platform_browser/strategies/popup.test.ts b/packages-exp/auth-exp/src/platform_browser/strategies/popup.test.ts index 0dd0020bfc2..b8707c394ed 100644 --- a/packages-exp/auth-exp/src/platform_browser/strategies/popup.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/strategies/popup.test.ts @@ -56,7 +56,7 @@ use(chaiAsPromised); const MATCHING_EVENT_ID = 'matching-event-id'; const OTHER_EVENT_ID = 'wrong-id'; -describe('src/core/strategies/popup', () => { +describe('platform_browser/strategies/popup', () => { let resolver: PopupRedirectResolver; let provider: OAuthProvider; let eventManager: AuthEventManager; diff --git a/packages-exp/auth-exp/src/platform_browser/strategies/redirect.test.ts b/packages-exp/auth-exp/src/platform_browser/strategies/redirect.test.ts index f6018a6b88e..39573e9e69e 100644 --- a/packages-exp/auth-exp/src/platform_browser/strategies/redirect.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/strategies/redirect.test.ts @@ -63,7 +63,7 @@ const OTHER_EVENT_ID = 'wrong-id'; class RedirectPersistence extends InMemoryPersistence {} -describe('src/core/strategies/redirect', () => { +describe('platform_browser/strategies/redirect', () => { let auth: TestAuth; let eventManager: AuthEventManager; let provider: OAuthProvider; diff --git a/packages-exp/auth-exp/src/platform_browser/util/popup.test.ts b/packages-exp/auth-exp/src/platform_browser/util/popup.test.ts index d097e8088d4..f328ebb2019 100644 --- a/packages-exp/auth-exp/src/platform_browser/util/popup.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/util/popup.test.ts @@ -26,7 +26,7 @@ import { _open, AuthPopup } from './popup'; use(sinonChai); -describe('src/core/util/popup', () => { +describe('platform_browser/util/popup', () => { let windowOpenStub: sinon.SinonStub; let popupStub: sinon.SinonStubbedInstance; diff --git a/packages-exp/auth-exp/src/platform_browser/util/worker.ts b/packages-exp/auth-exp/src/platform_browser/util/worker.ts new file mode 100644 index 00000000000..ae82ecb6343 --- /dev/null +++ b/packages-exp/auth-exp/src/platform_browser/util/worker.ts @@ -0,0 +1,45 @@ +/** + * @license + * Copyright 2020 Google LLC. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { _window } from '../auth_window'; + +export function _isWorker(): boolean { + return ( + typeof _window()['WorkerGlobalScope'] !== 'undefined' && + typeof _window()['importScripts'] === 'function' + ); +} + +export async function _getActiveServiceWorker(): Promise { + if (!navigator?.serviceWorker) { + return null; + } + try { + const registration = await navigator.serviceWorker.ready; + return registration.active; + } catch { + return null; + } +} + +export function _getServiceWorkerController(): ServiceWorker | null { + return navigator?.serviceWorker?.controller || null; +} + +export function _getWorkerGlobalScope(): ServiceWorker | null { + return _isWorker() ? ((self as unknown) as ServiceWorker) : null; +} diff --git a/packages-exp/auth-exp/test/helpers/fake_service_worker.ts b/packages-exp/auth-exp/test/helpers/fake_service_worker.ts new file mode 100644 index 00000000000..9515bfb50ba --- /dev/null +++ b/packages-exp/auth-exp/test/helpers/fake_service_worker.ts @@ -0,0 +1,59 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +export class FakeServiceWorker { + private readonly listeners: { + [type: string]: Set; + } = {}; + + postMessage(message: any, transfer: MessagePort[]): void { + if (!this.listeners['message']) { + return; + } + this.listeners['message'].forEach(listener => { + const event = new MessageEvent('message', { + data: message, + ports: transfer + }); + if (typeof listener === 'object') { + listener.handleEvent(event); + } else { + listener(event); + } + }); + } + addEventListener( + type: string, + listener: EventListenerOrEventListenerObject, + _options?: boolean | AddEventListenerOptions + ): void { + if (!this.listeners[type]) { + this.listeners[type] = new Set(); + } + this.listeners[type].add(listener); + } + removeEventListener( + type: string, + listener: EventListenerOrEventListenerObject, + _options?: boolean | EventListenerOptions + ): void { + this.listeners[type].delete(listener); + if (this.listeners[type].size === 0) { + delete this.listeners[type]; + } + } +} From 9c0a47f437873ceec52f861b6a973d52e8e737ce Mon Sep 17 00:00:00 2001 From: Alex Volkovitsky Date: Wed, 28 Oct 2020 10:39:52 -0700 Subject: [PATCH 047/624] Inline constants in auth-exp (#3986) * Inline constants in auth-exp * Only use server error map for non 1:1 errors --- packages-exp/auth-exp/index.webworker.ts | 7 +-- packages-exp/auth-exp/internal/index.ts | 7 +-- .../src/api/authentication/token.test.ts | 4 +- .../auth-exp/src/api/authentication/token.ts | 14 +++-- packages-exp/auth-exp/src/api/errors.ts | 55 +------------------ packages-exp/auth-exp/src/api/index.ts | 12 ++-- .../auth-exp/src/core/action_code_url.ts | 33 +++++------ .../auth-exp/src/core/auth/auth_impl.test.ts | 20 +++---- .../auth-exp/src/core/auth/auth_impl.ts | 12 ++-- .../auth-exp/src/core/auth/register.ts | 28 ++++------ packages-exp/auth-exp/src/core/errors.ts | 2 +- .../persistence_user_manager.test.ts | 8 ++- .../persistence/persistence_user_manager.ts | 18 +++--- .../src/core/user/proactive_refresh.test.ts | 46 +++++++--------- .../src/core/user/proactive_refresh.ts | 20 ++++--- .../src/core/user/token_manager.test.ts | 10 ++-- .../auth-exp/src/core/user/token_manager.ts | 6 +- .../auth-exp/src/core/util/delay.test.ts | 4 +- packages-exp/auth-exp/src/core/util/delay.ts | 6 +- .../auth-exp/src/core/util/version.ts | 8 ++- .../src/platform_browser/auth.test.ts | 26 ++++----- .../src/platform_browser/iframe/gapi.ts | 3 +- .../platform_browser/strategies/popup.test.ts | 8 +-- .../src/platform_browser/strategies/popup.ts | 9 +-- 24 files changed, 159 insertions(+), 207 deletions(-) diff --git a/packages-exp/auth-exp/index.webworker.ts b/packages-exp/auth-exp/index.webworker.ts index 4c68fada1dd..886105720b8 100644 --- a/packages-exp/auth-exp/index.webworker.ts +++ b/packages-exp/auth-exp/index.webworker.ts @@ -20,7 +20,7 @@ import { Auth } from '@firebase/auth-types-exp'; import { AuthImpl } from './src/core/auth/auth_impl'; import { _initializeAuthInstance } from './src/core/auth/initialize'; -import { _AUTH_COMPONENT_NAME, registerAuth } from './src/core/auth/register'; +import { _ComponentName, registerAuth } from './src/core/auth/register'; import { Persistence } from './src/core/persistence'; import { _getInstance } from './src/core/util/instantiator'; import { ClientPlatform } from './src/core/util/version'; @@ -37,10 +37,7 @@ registerAuth(ClientPlatform.WORKER); export function getAuth(app = getApp()): Auth { // Unlike the other environments, we need to explicitly check if indexedDb is // available. That means doing the whole rigamarole - const auth = _getProvider( - app, - _AUTH_COMPONENT_NAME - ).getImmediate() as AuthImpl; + const auth = _getProvider(app, _ComponentName.AUTH).getImmediate() as AuthImpl; // This promise is intended to float; auth initialization happens in the // background, meanwhile the auth object may be used by the app. diff --git a/packages-exp/auth-exp/internal/index.ts b/packages-exp/auth-exp/internal/index.ts index d04a3452406..5195810f0fb 100644 --- a/packages-exp/auth-exp/internal/index.ts +++ b/packages-exp/auth-exp/internal/index.ts @@ -30,12 +30,7 @@ export { UserImpl } from '../src/core/user/user_impl'; export { _getInstance } from '../src/core/util/instantiator'; export { UserCredential, UserParameters } from '../src/model/user'; export { registerAuth } from '../src/core/auth/register'; -export { - DEFAULT_API_HOST, - DEFAULT_API_SCHEME, - DEFAULT_TOKEN_API_HOST, - AuthImpl -} from '../src/core/auth/auth_impl'; +export { DefaultConfig, AuthImpl } from '../src/core/auth/auth_impl'; export { ClientPlatform, _getClientVersion } from '../src/core/util/version'; diff --git a/packages-exp/auth-exp/src/api/authentication/token.test.ts b/packages-exp/auth-exp/src/api/authentication/token.test.ts index a33e6323953..fa0373868e9 100644 --- a/packages-exp/auth-exp/src/api/authentication/token.test.ts +++ b/packages-exp/auth-exp/src/api/authentication/token.test.ts @@ -24,7 +24,7 @@ import { HttpHeader } from '../'; import { testAuth, TestAuth } from '../../../test/helpers/mock_auth'; import * as fetch from '../../../test/helpers/mock_fetch'; import { ServerError } from '../errors'; -import { _ENDPOINT, requestStsToken } from './token'; +import { Endpoint, requestStsToken } from './token'; use(chaiAsPromised); @@ -35,7 +35,7 @@ describe('requestStsToken', () => { beforeEach(async () => { auth = await testAuth(); const { apiKey, tokenApiHost, apiScheme } = auth.config; - endpoint = `${apiScheme}://${tokenApiHost}${_ENDPOINT}?key=${apiKey}`; + endpoint = `${apiScheme}://${tokenApiHost}${Endpoint.TOKEN}?key=${apiKey}`; fetch.setUp(); }); diff --git a/packages-exp/auth-exp/src/api/authentication/token.ts b/packages-exp/auth-exp/src/api/authentication/token.ts index a464841761f..3f486b53e32 100644 --- a/packages-exp/auth-exp/src/api/authentication/token.ts +++ b/packages-exp/auth-exp/src/api/authentication/token.ts @@ -27,8 +27,9 @@ import { import { FetchProvider } from '../../core/util/fetch_provider'; import { Auth } from '@firebase/auth-types-exp'; -export const _ENDPOINT = '/v1/token'; -const GRANT_TYPE = 'refresh_token'; +export const enum Endpoint { + TOKEN = '/v1/token' +} /** The server responses with snake_case; we convert to camelCase */ interface RequestStsTokenServerResponse { @@ -51,11 +52,16 @@ export async function requestStsToken( RequestStsTokenServerResponse >(auth, {}, () => { const body = querystring({ - 'grant_type': GRANT_TYPE, + 'grant_type': 'refresh_token', 'refresh_token': refreshToken }).slice(1); const { tokenApiHost, apiKey, sdkClientVersion } = auth.config; - const url = _getFinalTarget(auth, tokenApiHost, _ENDPOINT, `key=${apiKey}`); + const url = _getFinalTarget( + auth, + tokenApiHost, + Endpoint.TOKEN, + `key=${apiKey}` + ); return FetchProvider.fetch()(url, { method: HttpMethod.POST, diff --git a/packages-exp/auth-exp/src/api/errors.ts b/packages-exp/auth-exp/src/api/errors.ts index 342e4c7fc57..e70f8523011 100644 --- a/packages-exp/auth-exp/src/api/errors.ts +++ b/packages-exp/auth-exp/src/api/errors.ts @@ -119,9 +119,8 @@ export declare type ServerErrorMap = { /** * Map from errors returned by the server to errors to developer visible errors */ -export const SERVER_ERROR_MAP: ServerErrorMap = { +export const SERVER_ERROR_MAP: Partial> = { // Custom token errors. - [ServerError.INVALID_CUSTOM_TOKEN]: AuthErrorCode.INVALID_CUSTOM_TOKEN, [ServerError.CREDENTIAL_MISMATCH]: AuthErrorCode.CREDENTIAL_MISMATCH, // This can only happen if the SDK sends a bad request. [ServerError.MISSING_CUSTOM_TOKEN]: AuthErrorCode.INTERNAL_ERROR, @@ -132,9 +131,7 @@ export const SERVER_ERROR_MAP: ServerErrorMap = { [ServerError.MISSING_CONTINUE_URI]: AuthErrorCode.INTERNAL_ERROR, // Sign in with email and password errors (some apply to sign up too). - [ServerError.INVALID_EMAIL]: AuthErrorCode.INVALID_EMAIL, [ServerError.INVALID_PASSWORD]: AuthErrorCode.INVALID_PASSWORD, - [ServerError.USER_DISABLED]: AuthErrorCode.USER_DISABLED, // This can only happen if the SDK sends a bad request. [ServerError.MISSING_PASSWORD]: AuthErrorCode.INTERNAL_ERROR, @@ -147,13 +144,7 @@ export const SERVER_ERROR_MAP: ServerErrorMap = { [ServerError.INVALID_PENDING_TOKEN]: AuthErrorCode.INVALID_IDP_RESPONSE, [ServerError.FEDERATED_USER_ID_ALREADY_LINKED]: AuthErrorCode.CREDENTIAL_ALREADY_IN_USE, - [ServerError.MISSING_OR_INVALID_NONCE]: - AuthErrorCode.MISSING_OR_INVALID_NONCE, - // Email template errors while sending emails: - [ServerError.INVALID_MESSAGE_PAYLOAD]: AuthErrorCode.INVALID_MESSAGE_PAYLOAD, - [ServerError.INVALID_RECIPIENT_EMAIL]: AuthErrorCode.INVALID_RECIPIENT_EMAIL, - [ServerError.INVALID_SENDER]: AuthErrorCode.INVALID_SENDER, // This can only happen if the SDK sends a bad request. [ServerError.MISSING_REQ_TYPE]: AuthErrorCode.INTERNAL_ERROR, @@ -162,15 +153,11 @@ export const SERVER_ERROR_MAP: ServerErrorMap = { [ServerError.RESET_PASSWORD_EXCEED_LIMIT]: AuthErrorCode.TOO_MANY_ATTEMPTS_TRY_LATER, - // Reset password errors: [ServerError.EXPIRED_OOB_CODE]: AuthErrorCode.EXPIRED_OOB_CODE, [ServerError.INVALID_OOB_CODE]: AuthErrorCode.INVALID_OOB_CODE, // This can only happen if the SDK sends a bad request. [ServerError.MISSING_OOB_CODE]: AuthErrorCode.INTERNAL_ERROR, - // Get Auth URI errors: - [ServerError.INVALID_PROVIDER_ID]: AuthErrorCode.INVALID_PROVIDER_ID, - // Operations that require ID token in request: [ServerError.CREDENTIAL_TOO_OLD_LOGIN_AGAIN]: AuthErrorCode.CREDENTIAL_TOO_OLD_LOGIN_AGAIN, @@ -178,66 +165,31 @@ export const SERVER_ERROR_MAP: ServerErrorMap = { [ServerError.TOKEN_EXPIRED]: AuthErrorCode.TOKEN_EXPIRED, [ServerError.USER_NOT_FOUND]: AuthErrorCode.TOKEN_EXPIRED, - // CORS issues. - [ServerError.CORS_UNSUPPORTED]: AuthErrorCode.CORS_UNSUPPORTED, - - // Dynamic link not activated. - [ServerError.DYNAMIC_LINK_NOT_ACTIVATED]: - AuthErrorCode.DYNAMIC_LINK_NOT_ACTIVATED, - - // iosBundleId or androidPackageName not valid error. - [ServerError.INVALID_APP_ID]: AuthErrorCode.INVALID_APP_ID, - // Other errors. [ServerError.TOO_MANY_ATTEMPTS_TRY_LATER]: AuthErrorCode.TOO_MANY_ATTEMPTS_TRY_LATER, - [ServerError.WEAK_PASSWORD]: AuthErrorCode.WEAK_PASSWORD, - [ServerError.OPERATION_NOT_ALLOWED]: AuthErrorCode.OPERATION_NOT_ALLOWED, - [ServerError.USER_CANCELLED]: AuthErrorCode.USER_CANCELLED, // Phone Auth related errors. - [ServerError.CAPTCHA_CHECK_FAILED]: AuthErrorCode.CAPTCHA_CHECK_FAILED, - [ServerError.INVALID_APP_CREDENTIAL]: AuthErrorCode.INVALID_APP_CREDENTIAL, [ServerError.INVALID_CODE]: AuthErrorCode.INVALID_CODE, - [ServerError.INVALID_PHONE_NUMBER]: AuthErrorCode.INVALID_PHONE_NUMBER, [ServerError.INVALID_SESSION_INFO]: AuthErrorCode.INVALID_SESSION_INFO, [ServerError.INVALID_TEMPORARY_PROOF]: AuthErrorCode.INVALID_IDP_RESPONSE, - [ServerError.MISSING_APP_CREDENTIAL]: AuthErrorCode.MISSING_APP_CREDENTIAL, - [ServerError.MISSING_CODE]: AuthErrorCode.MISSING_CODE, - [ServerError.MISSING_PHONE_NUMBER]: AuthErrorCode.MISSING_PHONE_NUMBER, [ServerError.MISSING_SESSION_INFO]: AuthErrorCode.MISSING_SESSION_INFO, - [ServerError.QUOTA_EXCEEDED]: AuthErrorCode.QUOTA_EXCEEDED, [ServerError.SESSION_EXPIRED]: AuthErrorCode.CODE_EXPIRED, - [ServerError.REJECTED_CREDENTIAL]: AuthErrorCode.REJECTED_CREDENTIAL, // Other action code errors when additional settings passed. - [ServerError.INVALID_CONTINUE_URI]: AuthErrorCode.INVALID_CONTINUE_URI, // MISSING_CONTINUE_URI is getting mapped to INTERNAL_ERROR above. // This is OK as this error will be caught by client side validation. [ServerError.MISSING_ANDROID_PACKAGE_NAME]: AuthErrorCode.MISSING_ANDROID_PACKAGE_NAME, - [ServerError.MISSING_IOS_BUNDLE_ID]: AuthErrorCode.MISSING_IOS_BUNDLE_ID, [ServerError.UNAUTHORIZED_DOMAIN]: AuthErrorCode.UNAUTHORIZED_DOMAIN, - [ServerError.INVALID_DYNAMIC_LINK_DOMAIN]: - AuthErrorCode.INVALID_DYNAMIC_LINK_DOMAIN, // getProjectConfig errors when clientId is passed. [ServerError.INVALID_OAUTH_CLIENT_ID]: AuthErrorCode.INVALID_OAUTH_CLIENT_ID, - // getProjectConfig errors when sha1Cert is passed. - [ServerError.INVALID_CERT_HASH]: AuthErrorCode.INVALID_CERT_HASH, - - // Multi-tenant related errors. - [ServerError.UNSUPPORTED_TENANT_OPERATION]: - AuthErrorCode.UNSUPPORTED_TENANT_OPERATION, - [ServerError.INVALID_TENANT_ID]: AuthErrorCode.INVALID_TENANT_ID, - [ServerError.TENANT_ID_MISMATCH]: AuthErrorCode.TENANT_ID_MISMATCH, // User actions (sign-up or deletion) disabled errors. [ServerError.ADMIN_ONLY_OPERATION]: AuthErrorCode.ADMIN_ONLY_OPERATION, // Multi factor related errors. - [ServerError.EMAIL_CHANGE_NEEDS_VERIFICATION]: - AuthErrorCode.EMAIL_CHANGE_NEEDS_VERIFICATION, [ServerError.INVALID_MFA_PENDING_CREDENTIAL]: AuthErrorCode.INVALID_MFA_SESSION, [ServerError.MFA_ENROLLMENT_NOT_FOUND]: AuthErrorCode.MFA_INFO_NOT_FOUND, @@ -247,8 +199,5 @@ export const SERVER_ERROR_MAP: ServerErrorMap = { [ServerError.SECOND_FACTOR_EXISTS]: AuthErrorCode.SECOND_FACTOR_ALREADY_ENROLLED, [ServerError.SECOND_FACTOR_LIMIT_EXCEEDED]: - AuthErrorCode.SECOND_FACTOR_LIMIT_EXCEEDED, - [ServerError.UNSUPPORTED_FIRST_FACTOR]: - AuthErrorCode.UNSUPPORTED_FIRST_FACTOR, - [ServerError.UNVERIFIED_EMAIL]: AuthErrorCode.UNVERIFIED_EMAIL + AuthErrorCode.SECOND_FACTOR_LIMIT_EXCEEDED }; diff --git a/packages-exp/auth-exp/src/api/index.ts b/packages-exp/auth-exp/src/api/index.ts index 06cba677f10..c44fe546da2 100644 --- a/packages-exp/auth-exp/src/api/index.ts +++ b/packages-exp/auth-exp/src/api/index.ts @@ -20,7 +20,8 @@ import { FirebaseError, querystring } from '@firebase/util'; import { AUTH_ERROR_FACTORY, AuthErrorCode, - NamedErrorParams + NamedErrorParams, + ERRORS } from '../core/errors'; import { fail } from '../core/util/assert'; import { Delay } from '../core/util/delay'; @@ -149,9 +150,12 @@ export async function _performFetchWithErrorHandling( } else if (serverErrorCode === ServerError.EMAIL_EXISTS) { throw makeTaggedError(auth, AuthErrorCode.EMAIL_EXISTS, json); } - - const authError = errorMap[serverErrorCode]; - if (authError) { + const authError = + errorMap[serverErrorCode] || + ((serverErrorCode + .toLowerCase() + .replace(/_/g, '-') as unknown) as AuthErrorCode); + if (authError && Object.keys(ERRORS).includes(authError)) { fail(authError, { appName: auth.name }); } else { // TODO probably should handle improperly formatted errors as well diff --git a/packages-exp/auth-exp/src/core/action_code_url.ts b/packages-exp/auth-exp/src/core/action_code_url.ts index 85e5776b0ad..51cc5a03238 100644 --- a/packages-exp/auth-exp/src/core/action_code_url.ts +++ b/packages-exp/auth-exp/src/core/action_code_url.ts @@ -24,7 +24,7 @@ import { AuthErrorCode, AUTH_ERROR_FACTORY } from './errors'; * @enum {string} * @internal */ -enum QueryField { +const enum QueryField { API_KEY = 'apiKey', CODE = 'oobCode', CONTINUE_URL = 'continueUrl', @@ -33,20 +33,6 @@ enum QueryField { TENANT_ID = 'tenantId' } -/** - * Map from mode string in action code URL to Action Code Info operation. - * - * @internal - */ -const MODE_TO_OPERATION_MAP: { [key: string]: externs.Operation } = { - 'recoverEmail': externs.Operation.RECOVER_EMAIL, - 'resetPassword': externs.Operation.PASSWORD_RESET, - 'signIn': externs.Operation.EMAIL_SIGNIN, - 'verifyEmail': externs.Operation.VERIFY_EMAIL, - 'verifyAndChangeEmail': externs.Operation.VERIFY_AND_CHANGE_EMAIL, - 'revertSecondFactorAddition': externs.Operation.REVERT_SECOND_FACTOR_ADDITION -}; - /** * Maps the mode string in action code URL to Action Code Info operation. * @@ -54,7 +40,22 @@ const MODE_TO_OPERATION_MAP: { [key: string]: externs.Operation } = { * @internal */ function parseMode(mode: string | null): externs.Operation | null { - return mode ? MODE_TO_OPERATION_MAP[mode] || null : null; + switch (mode) { + case 'recoverEmail': + return externs.Operation.RECOVER_EMAIL; + case 'resetPassword': + return externs.Operation.PASSWORD_RESET; + case 'signIn': + return externs.Operation.EMAIL_SIGNIN; + case 'verifyEmail': + return externs.Operation.VERIFY_EMAIL; + case 'verifyAndChangeEmail': + return externs.Operation.VERIFY_AND_CHANGE_EMAIL; + case 'revertSecondFactorAddition': + return externs.Operation.REVERT_SECOND_FACTOR_ADDITION; + default: + return null; + } } /** diff --git a/packages-exp/auth-exp/src/core/auth/auth_impl.test.ts b/packages-exp/auth-exp/src/core/auth/auth_impl.test.ts index 99cbab07435..1fc34d6785b 100644 --- a/packages-exp/auth-exp/src/core/auth/auth_impl.test.ts +++ b/packages-exp/auth-exp/src/core/auth/auth_impl.test.ts @@ -34,13 +34,7 @@ import { inMemoryPersistence } from '../persistence/in_memory'; import { _getInstance } from '../util/instantiator'; import * as navigator from '../util/navigator'; import * as reload from '../user/reload'; -import { - _castAuth, - AuthImpl, - DEFAULT_API_HOST, - DEFAULT_API_SCHEME, - DEFAULT_TOKEN_API_HOST -} from './auth_impl'; +import { _castAuth, AuthImpl, DefaultConfig } from './auth_impl'; import { _initializeAuthInstance } from './initialize'; use(sinonChai); @@ -63,9 +57,9 @@ describe('core/auth/auth_impl', () => { persistenceStub = sinon.stub(_getInstance(inMemoryPersistence)); const authImpl = new AuthImpl(FAKE_APP, { apiKey: FAKE_APP.options.apiKey!, - apiHost: DEFAULT_API_HOST, - apiScheme: DEFAULT_API_SCHEME, - tokenApiHost: DEFAULT_TOKEN_API_HOST, + apiHost: DefaultConfig.API_HOST, + apiScheme: DefaultConfig.API_SCHEME, + tokenApiHost: DefaultConfig.TOKEN_API_HOST, sdkClientVersion: 'v' }); @@ -440,9 +434,9 @@ describe('core/auth/auth_impl', () => { it('prevents initialization from completing', async () => { const authImpl = new AuthImpl(FAKE_APP, { apiKey: FAKE_APP.options.apiKey!, - apiHost: DEFAULT_API_HOST, - apiScheme: DEFAULT_API_SCHEME, - tokenApiHost: DEFAULT_TOKEN_API_HOST, + apiHost: DefaultConfig.API_HOST, + apiScheme: DefaultConfig.API_SCHEME, + tokenApiHost: DefaultConfig.TOKEN_API_HOST, sdkClientVersion: 'v' }); diff --git a/packages-exp/auth-exp/src/core/auth/auth_impl.ts b/packages-exp/auth-exp/src/core/auth/auth_impl.ts index 9af266b09f7..e7b4afecba5 100644 --- a/packages-exp/auth-exp/src/core/auth/auth_impl.ts +++ b/packages-exp/auth-exp/src/core/auth/auth_impl.ts @@ -33,7 +33,7 @@ import { User } from '../../model/user'; import { AuthErrorCode } from '../errors'; import { Persistence } from '../persistence'; import { - _REDIRECT_USER_KEY_NAME, + KeyName, PersistenceUserManager } from '../persistence/persistence_user_manager'; import { _reloadWithoutSaving } from '../user/reload'; @@ -45,9 +45,11 @@ interface AsyncAction { (): Promise; } -export const DEFAULT_TOKEN_API_HOST = 'securetoken.googleapis.com'; -export const DEFAULT_API_HOST = 'identitytoolkit.googleapis.com'; -export const DEFAULT_API_SCHEME = 'https'; +export const enum DefaultConfig { + TOKEN_API_HOST = 'securetoken.googleapis.com', + API_HOST = 'identitytoolkit.googleapis.com', + API_SCHEME = 'https' +} export class AuthImpl implements Auth, _FirebaseService { currentUser: externs.User | null = null; @@ -324,7 +326,7 @@ export class AuthImpl implements Auth, _FirebaseService { this.redirectPersistenceManager = await PersistenceUserManager.create( this, [_getInstance(resolver._redirectPersistence)], - _REDIRECT_USER_KEY_NAME + KeyName.REDIRECT_USER ); this.redirectUser = await this.redirectPersistenceManager.getCurrentUser(); } diff --git a/packages-exp/auth-exp/src/core/auth/register.ts b/packages-exp/auth-exp/src/core/auth/register.ts index 684599a7f15..3b8980200ea 100644 --- a/packages-exp/auth-exp/src/core/auth/register.ts +++ b/packages-exp/auth-exp/src/core/auth/register.ts @@ -23,17 +23,13 @@ import { version } from '../../../package.json'; import { AuthErrorCode } from '../errors'; import { assert } from '../util/assert'; import { _getClientVersion, ClientPlatform } from '../util/version'; -import { - _castAuth, - AuthImpl, - DEFAULT_API_HOST, - DEFAULT_API_SCHEME, - DEFAULT_TOKEN_API_HOST -} from './auth_impl'; +import { _castAuth, AuthImpl, DefaultConfig } from './auth_impl'; import { AuthInternal } from './firebase_internal'; -export const _AUTH_COMPONENT_NAME = 'auth-exp'; -export const _AUTH_INTERNAL_COMPONENT_NAME = 'auth-internal'; +export const enum _ComponentName { + AUTH = 'auth-exp', + AUTH_INTERNAL = 'auth-internal' +} function getVersionForPlatform( clientPlatform: ClientPlatform @@ -54,7 +50,7 @@ function getVersionForPlatform( export function registerAuth(clientPlatform: ClientPlatform): void { _registerComponent( new Component( - _AUTH_COMPONENT_NAME, + _ComponentName.AUTH, container => { const app = container.getProvider('app-exp').getImmediate()!; const { apiKey, authDomain } = app.options; @@ -63,9 +59,9 @@ export function registerAuth(clientPlatform: ClientPlatform): void { const config: externs.Config = { apiKey, authDomain, - apiHost: DEFAULT_API_HOST, - tokenApiHost: DEFAULT_TOKEN_API_HOST, - apiScheme: DEFAULT_API_SCHEME, + apiHost: DefaultConfig.API_HOST, + tokenApiHost: DefaultConfig.TOKEN_API_HOST, + apiScheme: DefaultConfig.API_SCHEME, sdkClientVersion: _getClientVersion(clientPlatform) }; return new AuthImpl(app, config); @@ -77,10 +73,10 @@ export function registerAuth(clientPlatform: ClientPlatform): void { _registerComponent( new Component( - _AUTH_INTERNAL_COMPONENT_NAME, + _ComponentName.AUTH_INTERNAL, container => { const auth = _castAuth( - container.getProvider(_AUTH_COMPONENT_NAME).getImmediate()! + container.getProvider(_ComponentName.AUTH).getImmediate()! ); return (auth => new AuthInternal(auth))(auth); }, @@ -89,7 +85,7 @@ export function registerAuth(clientPlatform: ClientPlatform): void { ); registerVersion( - _AUTH_COMPONENT_NAME, + _ComponentName.AUTH, version, getVersionForPlatform(clientPlatform) ); diff --git a/packages-exp/auth-exp/src/core/errors.ts b/packages-exp/auth-exp/src/core/errors.ts index 6bdbce44339..879620354f7 100644 --- a/packages-exp/auth-exp/src/core/errors.ts +++ b/packages-exp/auth-exp/src/core/errors.ts @@ -123,7 +123,7 @@ export const enum AuthErrorCode { WEB_STORAGE_UNSUPPORTED = 'web-storage-unsupported' } -const ERRORS: ErrorMap = { +export const ERRORS: ErrorMap = { [AuthErrorCode.ADMIN_ONLY_OPERATION]: 'This operation is restricted to administrators only.', [AuthErrorCode.ARGUMENT_ERROR]: '', diff --git a/packages-exp/auth-exp/src/core/persistence/persistence_user_manager.test.ts b/packages-exp/auth-exp/src/core/persistence/persistence_user_manager.test.ts index 69ac510d172..1cce6c683cf 100644 --- a/packages-exp/auth-exp/src/core/persistence/persistence_user_manager.test.ts +++ b/packages-exp/auth-exp/src/core/persistence/persistence_user_manager.test.ts @@ -25,7 +25,7 @@ import { UserImpl } from '../user/user_impl'; import { _getInstance } from '../util/instantiator'; import { Persistence, PersistenceType, StorageEventListener } from './'; import { inMemoryPersistence } from './in_memory'; -import { PersistenceUserManager } from './persistence_user_manager'; +import { KeyName, PersistenceUserManager } from './persistence_user_manager'; chai.use(sinonChai); @@ -89,7 +89,11 @@ describe('core/persistence/persistence_user_manager', () => { it('uses user key if provided', async () => { const { stub, persistence } = makePersistence(); - await PersistenceUserManager.create(auth, [persistence], 'redirectUser'); + await PersistenceUserManager.create( + auth, + [persistence], + KeyName.REDIRECT_USER + ); expect(stub._get).to.have.been.calledWith( 'firebase:redirectUser:test-api-key:test-app' ); diff --git a/packages-exp/auth-exp/src/core/persistence/persistence_user_manager.ts b/packages-exp/auth-exp/src/core/persistence/persistence_user_manager.ts index 7a2bf49f710..80bf2b91abc 100644 --- a/packages-exp/auth-exp/src/core/persistence/persistence_user_manager.ts +++ b/packages-exp/auth-exp/src/core/persistence/persistence_user_manager.ts @@ -22,17 +22,21 @@ import { UserImpl } from '../user/user_impl'; import { _getInstance } from '../util/instantiator'; import { inMemoryPersistence } from './in_memory'; -export const _AUTH_USER_KEY_NAME = 'authUser'; -export const _REDIRECT_USER_KEY_NAME = 'redirectUser'; -export const _PERSISTENCE_KEY_NAME = 'persistence'; -const PERSISTENCE_NAMESPACE = 'firebase'; +export const enum KeyName { + AUTH_USER = 'authUser', + REDIRECT_USER = 'redirectUser', + PERSISTENCE_USER = 'persistence' +} +export const enum Namespace { + PERSISTENCE = 'firebase' +} export function _persistenceKeyName( key: string, apiKey: ApiKey, appName: AppName ): string { - return `${PERSISTENCE_NAMESPACE}:${key}:${apiKey}:${appName}`; + return `${Namespace.PERSISTENCE}:${key}:${apiKey}:${appName}`; } export class PersistenceUserManager { @@ -48,7 +52,7 @@ export class PersistenceUserManager { const { config, name } = this.auth; this.fullUserKey = _persistenceKeyName(this.userKey, config.apiKey, name); this.fullPersistenceKey = _persistenceKeyName( - _PERSISTENCE_KEY_NAME, + KeyName.PERSISTENCE_USER, config.apiKey, name ); @@ -98,7 +102,7 @@ export class PersistenceUserManager { static async create( auth: Auth, persistenceHierarchy: Persistence[], - userKey = _AUTH_USER_KEY_NAME + userKey = KeyName.AUTH_USER ): Promise { if (!persistenceHierarchy.length) { return new PersistenceUserManager( diff --git a/packages-exp/auth-exp/src/core/user/proactive_refresh.test.ts b/packages-exp/auth-exp/src/core/user/proactive_refresh.test.ts index 1f1b9417fce..ae64eaef3d0 100644 --- a/packages-exp/auth-exp/src/core/user/proactive_refresh.test.ts +++ b/packages-exp/auth-exp/src/core/user/proactive_refresh.test.ts @@ -23,11 +23,7 @@ import * as sinonChai from 'sinon-chai'; import { testAuth, testUser } from '../../../test/helpers/mock_auth'; import { User } from '../../model/user'; import { AUTH_ERROR_FACTORY, AuthErrorCode } from '../errors'; -import { - _OFFSET_DURATION, - _RETRY_BACKOFF_MIN, - ProactiveRefresh -} from './proactive_refresh'; +import { Duration, ProactiveRefresh } from './proactive_refresh'; use(chaiAsPromised); use(sinonChai); @@ -41,7 +37,7 @@ describe('core/user/proactive_refresh', () => { // Sets the expiration time in accordance with the offset in proactive refresh // This translates to the interval between updates function setExpirationTime(offset: number): void { - user.stsTokenManager.expirationTime = _OFFSET_DURATION + offset; + user.stsTokenManager.expirationTime = Duration.OFFSET + offset; } // clock.nextAsync() returns the number of milliseconds since the unix epoch. @@ -116,41 +112,41 @@ describe('core/user/proactive_refresh', () => { setExpirationTime(1000); proactiveRefresh._start(); expect(await nextAsync()).to.eq(1000); - expect(await nextAsync()).to.eq(_RETRY_BACKOFF_MIN); + expect(await nextAsync()).to.eq(Duration.RETRY_BACKOFF_MIN); }); it('backoff continues to increase until the max', async () => { setExpirationTime(1000); proactiveRefresh._start(); expect(await nextAsync()).to.eq(1000); - expect(await nextAsync()).to.eq(_RETRY_BACKOFF_MIN); - expect(await nextAsync()).to.eq(_RETRY_BACKOFF_MIN * 2); - expect(await nextAsync()).to.eq(_RETRY_BACKOFF_MIN * 4); - expect(await nextAsync()).to.eq(_RETRY_BACKOFF_MIN * 8); - expect(await nextAsync()).to.eq(_RETRY_BACKOFF_MIN * 16); - expect(await nextAsync()).to.eq(_RETRY_BACKOFF_MIN * 32); - expect(await nextAsync()).to.eq(_RETRY_BACKOFF_MIN * 32); - expect(await nextAsync()).to.eq(_RETRY_BACKOFF_MIN * 32); + expect(await nextAsync()).to.eq(Duration.RETRY_BACKOFF_MIN); + expect(await nextAsync()).to.eq(Duration.RETRY_BACKOFF_MIN * 2); + expect(await nextAsync()).to.eq(Duration.RETRY_BACKOFF_MIN * 4); + expect(await nextAsync()).to.eq(Duration.RETRY_BACKOFF_MIN * 8); + expect(await nextAsync()).to.eq(Duration.RETRY_BACKOFF_MIN * 16); + expect(await nextAsync()).to.eq(Duration.RETRY_BACKOFF_MIN * 32); + expect(await nextAsync()).to.eq(Duration.RETRY_BACKOFF_MIN * 32); + expect(await nextAsync()).to.eq(Duration.RETRY_BACKOFF_MIN * 32); }); it('backoff resets after one success', async () => { setExpirationTime(1000); proactiveRefresh._start(); expect(await nextAsync()).to.eq(1000); - expect(await nextAsync()).to.eq(_RETRY_BACKOFF_MIN); - expect(await nextAsync()).to.eq(_RETRY_BACKOFF_MIN * 2); - expect(await nextAsync()).to.eq(_RETRY_BACKOFF_MIN * 4); - expect(await nextAsync()).to.eq(_RETRY_BACKOFF_MIN * 8); - expect(await nextAsync()).to.eq(_RETRY_BACKOFF_MIN * 16); - setExpirationTime(1000 + Date.now() + _RETRY_BACKOFF_MIN * 32); + expect(await nextAsync()).to.eq(Duration.RETRY_BACKOFF_MIN); + expect(await nextAsync()).to.eq(Duration.RETRY_BACKOFF_MIN * 2); + expect(await nextAsync()).to.eq(Duration.RETRY_BACKOFF_MIN * 4); + expect(await nextAsync()).to.eq(Duration.RETRY_BACKOFF_MIN * 8); + expect(await nextAsync()).to.eq(Duration.RETRY_BACKOFF_MIN * 16); + setExpirationTime(1000 + Date.now() + Duration.RETRY_BACKOFF_MIN * 32); getTokenStub.callsFake(() => Promise.resolve()); - expect(await nextAsync()).to.eq(_RETRY_BACKOFF_MIN * 32); + expect(await nextAsync()).to.eq(Duration.RETRY_BACKOFF_MIN * 32); expect(await nextAsync()).to.eq(1000); getTokenStub.callsFake(() => Promise.reject(error)); await nextAsync(); - expect(await nextAsync()).to.eq(_RETRY_BACKOFF_MIN); - expect(await nextAsync()).to.eq(_RETRY_BACKOFF_MIN * 2); - expect(await nextAsync()).to.eq(_RETRY_BACKOFF_MIN * 4); + expect(await nextAsync()).to.eq(Duration.RETRY_BACKOFF_MIN); + expect(await nextAsync()).to.eq(Duration.RETRY_BACKOFF_MIN * 2); + expect(await nextAsync()).to.eq(Duration.RETRY_BACKOFF_MIN * 4); }); }); }); diff --git a/packages-exp/auth-exp/src/core/user/proactive_refresh.ts b/packages-exp/auth-exp/src/core/user/proactive_refresh.ts index a94d3d8b8a4..e26d7fa6695 100644 --- a/packages-exp/auth-exp/src/core/user/proactive_refresh.ts +++ b/packages-exp/auth-exp/src/core/user/proactive_refresh.ts @@ -19,10 +19,11 @@ import { User } from '../../model/user'; import { AuthErrorCode } from '../errors'; // Refresh the token five minutes before expiration -export const _OFFSET_DURATION = 5 * 1000 * 60; - -export const _RETRY_BACKOFF_MIN = 30 * 1000; -export const _RETRY_BACKOFF_MAX = 16 * 60 * 1000; +export const enum Duration { + OFFSET = 5 * 1000 * 60, + RETRY_BACKOFF_MIN = 30 * 1000, + RETRY_BACKOFF_MAX = 16 * 60 * 1000 +} export class ProactiveRefresh { private isRunning = false; @@ -32,7 +33,7 @@ export class ProactiveRefresh { // we can't cast properly in both environments. // eslint-disable-next-line @typescript-eslint/no-explicit-any private timerId: any | null = null; - private errorBackoff = _RETRY_BACKOFF_MIN; + private errorBackoff = Duration.RETRY_BACKOFF_MIN; constructor(private readonly user: User) {} @@ -59,13 +60,16 @@ export class ProactiveRefresh { private getInterval(wasError: boolean): number { if (wasError) { const interval = this.errorBackoff; - this.errorBackoff = Math.min(this.errorBackoff * 2, _RETRY_BACKOFF_MAX); + this.errorBackoff = Math.min( + this.errorBackoff * 2, + Duration.RETRY_BACKOFF_MAX + ); return interval; } else { // Reset the error backoff - this.errorBackoff = _RETRY_BACKOFF_MIN; + this.errorBackoff = Duration.RETRY_BACKOFF_MIN; const expTime = this.user.stsTokenManager.expirationTime ?? 0; - const interval = expTime - Date.now() - _OFFSET_DURATION; + const interval = expTime - Date.now() - Duration.OFFSET; return Math.max(0, interval); } diff --git a/packages-exp/auth-exp/src/core/user/token_manager.test.ts b/packages-exp/auth-exp/src/core/user/token_manager.test.ts index bba09a1d29a..a3a4e06ee31 100644 --- a/packages-exp/auth-exp/src/core/user/token_manager.test.ts +++ b/packages-exp/auth-exp/src/core/user/token_manager.test.ts @@ -23,9 +23,9 @@ import { FirebaseError } from '@firebase/util'; import { testAuth, TestAuth } from '../../../test/helpers/mock_auth'; import * as fetch from '../../../test/helpers/mock_fetch'; -import { _ENDPOINT } from '../../api/authentication/token'; +import { Endpoint } from '../../api/authentication/token'; import { IdTokenResponse } from '../../model/id_token'; -import { StsTokenManager, TOKEN_REFRESH_BUFFER_MS } from './token_manager'; +import { StsTokenManager, Buffer } from './token_manager'; use(chaiAsPromised); @@ -52,12 +52,12 @@ describe('core/user/token_manager', () => { }); it('is true if exp is in future but within buffer', () => { - stsTokenManager.expirationTime = now + (TOKEN_REFRESH_BUFFER_MS - 10); + stsTokenManager.expirationTime = now + (Buffer.TOKEN_REFRESH - 10); expect(stsTokenManager.isExpired).to.eq(true); }); it('is fals if exp is far enough in future', () => { - stsTokenManager.expirationTime = now + (TOKEN_REFRESH_BUFFER_MS + 10); + stsTokenManager.expirationTime = now + (Buffer.TOKEN_REFRESH + 10); expect(stsTokenManager.isExpired).to.eq(false); }); }); @@ -89,7 +89,7 @@ describe('core/user/token_manager', () => { let mock: fetch.Route; beforeEach(() => { const { apiKey, tokenApiHost, apiScheme } = auth.config; - const endpoint = `${apiScheme}://${tokenApiHost}${_ENDPOINT}?key=${apiKey}`; + const endpoint = `${apiScheme}://${tokenApiHost}${Endpoint.TOKEN}?key=${apiKey}`; mock = fetch.mock(endpoint, { 'access_token': 'new-access-token', 'refresh_token': 'new-refresh-token', diff --git a/packages-exp/auth-exp/src/core/user/token_manager.ts b/packages-exp/auth-exp/src/core/user/token_manager.ts index d728d7ac1da..289889e6029 100644 --- a/packages-exp/auth-exp/src/core/user/token_manager.ts +++ b/packages-exp/auth-exp/src/core/user/token_manager.ts @@ -29,7 +29,9 @@ import { assert, debugFail } from '../util/assert'; * * @internal */ -export const TOKEN_REFRESH_BUFFER_MS = 30_000; +export const enum Buffer { + TOKEN_REFRESH = 30_000 +} export class StsTokenManager { refreshToken: string | null = null; @@ -39,7 +41,7 @@ export class StsTokenManager { get isExpired(): boolean { return ( !this.expirationTime || - Date.now() > this.expirationTime - TOKEN_REFRESH_BUFFER_MS + Date.now() > this.expirationTime - Buffer.TOKEN_REFRESH ); } diff --git a/packages-exp/auth-exp/src/core/util/delay.test.ts b/packages-exp/auth-exp/src/core/util/delay.test.ts index 939ac98c588..54ce00ab9b1 100644 --- a/packages-exp/auth-exp/src/core/util/delay.test.ts +++ b/packages-exp/auth-exp/src/core/util/delay.test.ts @@ -18,7 +18,7 @@ import * as util from '@firebase/util'; import { expect } from 'chai'; import { restore, stub } from 'sinon'; -import { Delay, _OFFLINE_DELAY_MS } from './delay'; +import { Delay, DelayMin } from './delay'; import * as navigator from './navigator'; describe('core/util/delay', () => { @@ -50,6 +50,6 @@ describe('core/util/delay', () => { const mock = stub(navigator, '_isOnline'); mock.callsFake(() => false); const delay = new Delay(SHORT_DELAY, LONG_DELAY); - expect(delay.get()).to.eq(_OFFLINE_DELAY_MS); + expect(delay.get()).to.eq(DelayMin.OFFLINE); }); }); diff --git a/packages-exp/auth-exp/src/core/util/delay.ts b/packages-exp/auth-exp/src/core/util/delay.ts index dae81f2d8c7..d5d189d64b4 100644 --- a/packages-exp/auth-exp/src/core/util/delay.ts +++ b/packages-exp/auth-exp/src/core/util/delay.ts @@ -19,7 +19,9 @@ import { isMobileCordova, isReactNative } from '@firebase/util'; import { _isOnline } from './navigator'; import { debugAssert } from './assert'; -export const _OFFLINE_DELAY_MS = 5000; +export const enum DelayMin { + OFFLINE = 5000 +} /** * A structure to help pick between a range of long and short delay durations @@ -45,7 +47,7 @@ export class Delay { get(): number { if (!_isOnline()) { // Pick the shorter timeout. - return Math.min(_OFFLINE_DELAY_MS, this.shortDelay); + return Math.min(DelayMin.OFFLINE, this.shortDelay); } // If running in a mobile environment, return the long delay, otherwise // return the short delay. diff --git a/packages-exp/auth-exp/src/core/util/version.ts b/packages-exp/auth-exp/src/core/util/version.ts index 2cb9eeab9da..c50f01d9f3f 100644 --- a/packages-exp/auth-exp/src/core/util/version.ts +++ b/packages-exp/auth-exp/src/core/util/version.ts @@ -19,7 +19,9 @@ import { SDK_VERSION } from '@firebase/app-exp'; import { _getBrowserName } from './browser'; import { getUA } from '@firebase/util'; -const CLIENT_IMPLEMENTATION = 'JsCore'; +export const enum ClientImplementation { + CORE = 'JsCore' +} export const enum ClientPlatform { BROWSER = 'Browser', @@ -28,7 +30,7 @@ export const enum ClientPlatform { WORKER = 'Worker' } -enum ClientFramework { +const enum ClientFramework { // No other framework used. DEFAULT = 'FirebaseCore-web', // Firebase Auth used with FirebaseUI-web. @@ -57,5 +59,5 @@ export function _getClientVersion(clientPlatform: ClientPlatform): string { default: reportedPlatform = clientPlatform; } - return `${reportedPlatform}/${CLIENT_IMPLEMENTATION}/${SDK_VERSION}/${ClientFramework.DEFAULT}`; + return `${reportedPlatform}/${ClientImplementation.CORE}/${SDK_VERSION}/${ClientFramework.DEFAULT}`; } diff --git a/packages-exp/auth-exp/src/platform_browser/auth.test.ts b/packages-exp/auth-exp/src/platform_browser/auth.test.ts index 6e836a30da6..d6cd470d6d4 100644 --- a/packages-exp/auth-exp/src/platform_browser/auth.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/auth.test.ts @@ -24,13 +24,7 @@ import { FirebaseApp } from '@firebase/app-types-exp'; import * as externs from '@firebase/auth-types-exp'; import { testAuth, testUser } from '../../test/helpers/mock_auth'; -import { - _castAuth, - AuthImpl, - DEFAULT_API_HOST, - DEFAULT_API_SCHEME, - DEFAULT_TOKEN_API_HOST -} from '../core/auth/auth_impl'; +import { _castAuth, AuthImpl, DefaultConfig } from '../core/auth/auth_impl'; import { _initializeAuthInstance } from '../core/auth/initialize'; import { AUTH_ERROR_FACTORY, AuthErrorCode } from '../core/errors'; import { Persistence } from '../core/persistence'; @@ -64,9 +58,9 @@ describe('core/auth/auth_impl', () => { persistenceStub = sinon.stub(_getInstance(inMemoryPersistence)); const authImpl = new AuthImpl(FAKE_APP, { apiKey: FAKE_APP.options.apiKey!, - apiHost: DEFAULT_API_HOST, - apiScheme: DEFAULT_API_SCHEME, - tokenApiHost: DEFAULT_TOKEN_API_HOST, + apiHost: DefaultConfig.API_HOST, + apiScheme: DefaultConfig.API_SCHEME, + tokenApiHost: DefaultConfig.TOKEN_API_HOST, sdkClientVersion: 'v' }); @@ -117,9 +111,9 @@ describe('core/auth/initializeAuth', () => { ): Promise { const auth = new AuthImpl(FAKE_APP, { apiKey: FAKE_APP.options.apiKey!, - apiHost: DEFAULT_API_HOST, - apiScheme: DEFAULT_API_SCHEME, - tokenApiHost: DEFAULT_TOKEN_API_HOST, + apiHost: DefaultConfig.API_HOST, + apiScheme: DefaultConfig.API_SCHEME, + tokenApiHost: DefaultConfig.TOKEN_API_HOST, authDomain: FAKE_APP.options.authDomain, sdkClientVersion: _getClientVersion(ClientPlatform.BROWSER) }); @@ -255,9 +249,9 @@ describe('core/auth/initializeAuth', () => { expect(auth.config).to.eql({ apiKey: FAKE_APP.options.apiKey, authDomain: FAKE_APP.options.authDomain, - apiHost: DEFAULT_API_HOST, - apiScheme: DEFAULT_API_SCHEME, - tokenApiHost: DEFAULT_TOKEN_API_HOST, + apiHost: DefaultConfig.API_HOST, + apiScheme: DefaultConfig.API_SCHEME, + tokenApiHost: DefaultConfig.TOKEN_API_HOST, sdkClientVersion: _getClientVersion(ClientPlatform.BROWSER) }); }); diff --git a/packages-exp/auth-exp/src/platform_browser/iframe/gapi.ts b/packages-exp/auth-exp/src/platform_browser/iframe/gapi.ts index 40a558110e3..caba0c7ff70 100644 --- a/packages-exp/auth-exp/src/platform_browser/iframe/gapi.ts +++ b/packages-exp/auth-exp/src/platform_browser/iframe/gapi.ts @@ -22,7 +22,6 @@ import { _window } from '../auth_window'; import * as js from '../load_js'; const NETWORK_TIMEOUT = new Delay(30000, 60000); -const LOADJS_CALLBACK_PREFIX = 'iframefcb'; /** * Reset unlaoded GApi modules. If gapi.load fails due to a network error, @@ -95,7 +94,7 @@ function loadGapi(auth: Auth): Promise { // multiple times in parallel and could result in the later callback // overwriting the previous one. This would end up with a iframe // timeout. - const cbName = js._generateCallbackName(LOADJS_CALLBACK_PREFIX); + const cbName = js._generateCallbackName('iframefcb'); // GApi loader not available, dynamically load platform.js. _window()[cbName] = () => { // GApi loader should be ready. diff --git a/packages-exp/auth-exp/src/platform_browser/strategies/popup.test.ts b/packages-exp/auth-exp/src/platform_browser/strategies/popup.test.ts index b8707c394ed..874506a4b2f 100644 --- a/packages-exp/auth-exp/src/platform_browser/strategies/popup.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/strategies/popup.test.ts @@ -42,7 +42,7 @@ import * as eid from '../../core/util/event_id'; import { AuthPopup } from '../util/popup'; import * as idpTasks from '../../core/strategies/idp'; import { - _AUTH_EVENT_TIMEOUT, + _Timeout, _POLL_WINDOW_CLOSE_TIMEOUT, linkWithPopup, reauthenticateWithPopup, @@ -215,7 +215,7 @@ describe('platform_browser/strategies/popup', () => { delay(() => { underlyingWindow.closed = true; pendingTimeouts[_POLL_WINDOW_CLOSE_TIMEOUT.get()](); - pendingTimeouts[_AUTH_EVENT_TIMEOUT](); + pendingTimeouts[_Timeout.AUTH_EVENT](); }); iframeEvent({ type: AuthEventType.SIGN_IN_VIA_POPUP @@ -399,7 +399,7 @@ describe('platform_browser/strategies/popup', () => { delay(() => { underlyingWindow.closed = true; pendingTimeouts[_POLL_WINDOW_CLOSE_TIMEOUT.get()](); - pendingTimeouts[_AUTH_EVENT_TIMEOUT](); + pendingTimeouts[_Timeout.AUTH_EVENT](); }); iframeEvent({ type: AuthEventType.LINK_VIA_POPUP @@ -591,7 +591,7 @@ describe('platform_browser/strategies/popup', () => { delay(() => { underlyingWindow.closed = true; pendingTimeouts[_POLL_WINDOW_CLOSE_TIMEOUT.get()](); - pendingTimeouts[_AUTH_EVENT_TIMEOUT](); + pendingTimeouts[_Timeout.AUTH_EVENT](); }); iframeEvent({ type: AuthEventType.REAUTH_VIA_POPUP diff --git a/packages-exp/auth-exp/src/platform_browser/strategies/popup.ts b/packages-exp/auth-exp/src/platform_browser/strategies/popup.ts index cfed5f744a6..27b21078ea4 100644 --- a/packages-exp/auth-exp/src/platform_browser/strategies/popup.ts +++ b/packages-exp/auth-exp/src/platform_browser/strategies/popup.ts @@ -34,12 +34,13 @@ import { _withDefaultResolver } from '../popup_redirect'; import { AuthPopup } from '../util/popup'; import { AbstractPopupRedirectOperation } from './abstract_popup_redirect_operation'; -/** +/* * The event timeout is the same on mobile and desktop, no need for Delay. * @internal */ -export const _AUTH_EVENT_TIMEOUT = 2020; -/** @internal */ +export const enum _Timeout { + AUTH_EVENT = 2000 +} export const _POLL_WINDOW_CLOSE_TIMEOUT = new Delay(2000, 10000); /** @@ -291,7 +292,7 @@ class PopupOperation extends AbstractPopupRedirectOperation { appName }) ); - }, _AUTH_EVENT_TIMEOUT); + }, _Timeout.AUTH_EVENT); return; } From 878a1bff04bf32e51cab6817edf1e3c6a3a16fc5 Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Wed, 28 Oct 2020 11:19:05 -0700 Subject: [PATCH 048/624] Add changeset formatting check (#3980) --- .github/workflows/check-changeset.yml | 27 ++++++------- scripts/check_changeset.ts | 57 +++++++++++++++++++++------ 2 files changed, 59 insertions(+), 25 deletions(-) diff --git a/.github/workflows/check-changeset.yml b/.github/workflows/check-changeset.yml index 286f4234bcd..d8082f09804 100644 --- a/.github/workflows/check-changeset.yml +++ b/.github/workflows/check-changeset.yml @@ -22,8 +22,8 @@ jobs: - name: Run changeset script run: yarn ts-node-script scripts/check_changeset.ts id: check-changeset - - name: Read output - run: echo "${{steps.check-changeset.outputs.MISSING_PACKAGES}}" + - name: Print changeset checker output + run: echo "${{steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}}" - name: Find Comment uses: peter-evans/find-comment@v1 id: fc @@ -31,34 +31,33 @@ jobs: issue-number: ${{github.event.number}} body-includes: Changeset File Check - name: Create comment (missing packages) - if: ${{!steps.fc.outputs.comment-id && steps.check-changeset.outputs.MISSING_PACKAGES}} + if: ${{!steps.fc.outputs.comment-id && steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}} uses: peter-evans/create-or-update-comment@v1 with: issue-number: ${{github.event.number}} body: | ### Changeset File Check :warning: - Warning: This PR modifies files in the following packages but they have not been included in the changeset file: - ${{steps.check-changeset.outputs.MISSING_PACKAGES}} - - Make sure this was intentional. + ${{steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}} - name: Update comment (missing packages) if: ${{steps.fc.outputs.comment-id}} uses: peter-evans/create-or-update-comment@v1 with: - comment-id: ${{steps.fc.outputs.comment-id}} && steps.check-changeset.outputs.MISSING_PACKAGES}} + comment-id: ${{steps.fc.outputs.comment-id}} && steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}} edit-mode: replace body: | ### Changeset File Check :warning: - Warning: This PR modifies files in the following packages but they have not been included in the changeset file: - ${{steps.check-changeset.outputs.MISSING_PACKAGES}} - - Make sure this was intentional. + ${{steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}} - name: Update comment (no missing packages) - if: ${{steps.fc.outputs.comment-id && !steps.check-changeset.outputs.MISSING_PACKAGES}} + if: ${{steps.fc.outputs.comment-id && !steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}} uses: peter-evans/create-or-update-comment@v1 with: comment-id: ${{steps.fc.outputs.comment-id}} edit-mode: replace body: | ### Changeset File Check :white_check_mark: - No modified packages are missing from the changeset file. \ No newline at end of file + - No modified packages are missing from the changeset file. + - No changeset formatting errors detected. + # Don't want it to throw before editing the comment. + - name: Fail if checker script logged a blocking failure + if: ${{steps.check-changeset.outputs.BLOCKING_FAILURE}} + run: exit 1 \ No newline at end of file diff --git a/scripts/check_changeset.ts b/scripts/check_changeset.ts index 1ab8bf8b475..41532423f03 100644 --- a/scripts/check_changeset.ts +++ b/scripts/check_changeset.ts @@ -17,6 +17,7 @@ import { resolve } from 'path'; import { existsSync } from 'fs'; +import { exec } from 'child-process-promise'; import chalk from 'chalk'; import simpleGit from 'simple-git/promise'; import fs from 'mz/fs'; @@ -83,6 +84,31 @@ async function parseChangesetFile(changesetFile: string) { } async function main() { + const errors = []; + try { + await exec('yarn changeset status'); + } catch (e) { + const messageLines = e.message.replace(/🦋 error /g, '').split('\n'); + let formattedStatusError = + '- Changeset formatting error in following file:%0A'; + formattedStatusError += ' ```%0A'; + formattedStatusError += messageLines + .filter( + (line: string) => !line.match(/^ at [\w\.]+ \(.+:[0-9]+:[0-9]+\)/) + ) + .filter((line: string) => !line.includes('Command failed')) + .filter((line: string) => !line.includes('exited with error code 1')) + .map((line: string) => ` ${line}`) + .join('%0A'); + formattedStatusError += '%0A ```%0A'; + errors.push(formattedStatusError); + /** + * Sets Github Actions output for a step. Pass changeset error message to next + * step. See: + * https://github.com/actions/toolkit/blob/master/docs/commands.md#set-outputs + */ + console.log(`::set-output name=BLOCKING_FAILURE::true`); + } try { const diffData = await getDiffData(); if (diffData == null) { @@ -94,23 +120,32 @@ async function main() { changedPkg => !changesetPackages.includes(changedPkg) ); if (missingPackages.length > 0) { - /** - * Sets Github Actions output for a step. Pass missing package list to next - * step. See: - * https://github.com/actions/toolkit/blob/master/docs/commands.md#set-outputs - */ - console.log( - `::set-output name=MISSING_PACKAGES::${missingPackages - .map(pkg => `- ${pkg}`) - .join('%0A')}` - ); + const missingPackagesLines = [ + '- Warning: This PR modifies files in the following packages but they have not been included in the changeset file:' + ]; + for (const missingPackage of missingPackages) { + missingPackagesLines.push(` - ${missingPackage}`); + } + missingPackagesLines.push(''); + missingPackagesLines.push(' Make sure this was intentional.'); + errors.push(missingPackagesLines.join('%0A')); } - process.exit(); } } catch (e) { console.error(chalk`{red ${e}}`); process.exit(1); } + + /** + * Sets Github Actions output for a step. Pass changeset error message to next + * step. See: + * https://github.com/actions/toolkit/blob/master/docs/commands.md#set-outputs + */ + if (errors.length > 0) + console.log( + `::set-output name=CHANGESET_ERROR_MESSAGE::${errors.join('%0A')}` + ); + process.exit(); } main(); From 6f06d840e68f21a4276b51243886dfaa74ea4776 Mon Sep 17 00:00:00 2001 From: Sebastian Schmidt Date: Wed, 28 Oct 2020 16:56:26 -0700 Subject: [PATCH 049/624] Use Chrome for karma debugging (#4007) --- packages/firestore/package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/firestore/package.json b/packages/firestore/package.json index ba8398a0208..8f668410eaf 100644 --- a/packages/firestore/package.json +++ b/packages/firestore/package.json @@ -28,13 +28,13 @@ "test:lite": "node ./scripts/run-tests.js --emulator --platform node_lite --main=lite/index.ts 'lite/test/**/*.test.ts'", "test:lite:prod": "node ./scripts/run-tests.js --platform node_lite --main=lite/index.ts 'lite/test/**/*.test.ts'", "test:lite:browser": "karma start --single-run --lite", - "test:lite:browser:debug": "karma start --single-run --lite --auto-watch", + "test:lite:browser:debug": "karma start --browsers=Chrome --lite --auto-watch", "test:exp": "node ./scripts/run-tests.js --emulator --main=exp/index.ts test/integration/api/*.test.ts", "test:exp:prod": "node ./scripts/run-tests.js --main=exp/index.ts test/integration/api/*.test.ts", "test:exp:persistence": "node ./scripts/run-tests.js --emulator --persistence --main=exp/index.ts test/integration/api/*.test.ts", "test:exp:persistence:prod": "node ./scripts/run-tests.js --persistence --main=exp/index.ts test/integration/api/*.test.ts", "test:exp:browser": "karma start --single-run --exp", - "test:exp:browser:debug": "karma start --single-run --exp --auto-watch", + "test:exp:browser:debug": "karma start --browsers=Chrome --exp --auto-watch", "test": "run-s lint test:all", "test:ci": "node ../../scripts/run_tests_in_ci.js -s test:all", "test:all": "run-p test:browser test:lite:browser test:exp:browser test:travis test:minified", From 973cdfa7fa67f02b39455d1c4002b0c5a15c4a1f Mon Sep 17 00:00:00 2001 From: Sam Stern Date: Thu, 29 Oct 2020 06:15:11 -0400 Subject: [PATCH 050/624] Cache emulator between runs (#3956) --- .../emulators/database-emulator.ts | 2 +- .../emulator-testing/emulators/emulator.ts | 38 ++++++++++++++++++- .../emulators/firestore-emulator.ts | 2 +- 3 files changed, 39 insertions(+), 3 deletions(-) diff --git a/scripts/emulator-testing/emulators/database-emulator.ts b/scripts/emulator-testing/emulators/database-emulator.ts index ddd126e7698..d252f87c727 100644 --- a/scripts/emulator-testing/emulators/database-emulator.ts +++ b/scripts/emulator-testing/emulators/database-emulator.ts @@ -24,7 +24,7 @@ export class DatabaseEmulator extends Emulator { constructor(port = 8088, namespace = 'test-emulator') { super( - 'database-emulator.jar', + 'firebase-database-emulator-v4.4.1.jar', // Use locked version of emulator for test to be deterministic. // The latest version can be found from database emulator doc: // https://firebase.google.com/docs/database/security/test-rules-emulator diff --git a/scripts/emulator-testing/emulators/emulator.ts b/scripts/emulator-testing/emulators/emulator.ts index e5d49433c2b..bea75d39dc4 100644 --- a/scripts/emulator-testing/emulators/emulator.ts +++ b/scripts/emulator-testing/emulators/emulator.ts @@ -19,6 +19,7 @@ import { spawn } from 'child-process-promise'; import { ChildProcess } from 'child_process'; import * as fs from 'fs'; +import * as os from 'os'; import * as path from 'path'; import * as request from 'request'; // @ts-ignore @@ -28,13 +29,25 @@ export abstract class Emulator { binaryPath: string | null = null; emulator: ChildProcess | null = null; + cacheDirectory: string; + cacheBinaryPath: string; + constructor( private binaryName: string, private binaryUrl: string, public port: number - ) {} + ) { + this.cacheDirectory = path.join(os.homedir(), `.cache/firebase-js-sdk`); + this.cacheBinaryPath = path.join(this.cacheDirectory, binaryName); + } download(): Promise { + if (fs.existsSync(this.cacheBinaryPath)) { + console.log(`Emulator found in cache: ${this.cacheBinaryPath}`); + this.binaryPath = this.cacheBinaryPath; + return Promise.resolve(); + } + return new Promise((resolve, reject) => { tmp.dir((err: Error | null, dir: string) => { if (err) reject(err); @@ -55,6 +68,10 @@ export abstract class Emulator { if (err) reject(err); console.log(`Changed emulator file permissions to 'rwxr-xr-x'.`); this.binaryPath = filepath; + + if (this.copyToCache()) { + console.log(`Cached emulator at ${this.cacheBinaryPath}`); + } resolve(); }); }) @@ -129,4 +146,23 @@ export abstract class Emulator { fs.unlinkSync(this.binaryPath); } } + + private copyToCache(): boolean { + if (!this.binaryPath) { + return false; + } + + try { + if (!fs.existsSync(this.cacheDirectory)) { + fs.mkdirSync(this.cacheDirectory, { recursive: true }); + } + fs.copyFileSync(this.binaryPath, this.cacheBinaryPath); + + return true; + } catch (e) { + console.warn(`Unable to cache ${this.binaryName}`, e); + } + + return false; + } } diff --git a/scripts/emulator-testing/emulators/firestore-emulator.ts b/scripts/emulator-testing/emulators/firestore-emulator.ts index 84cd23d2eeb..3752a61c203 100644 --- a/scripts/emulator-testing/emulators/firestore-emulator.ts +++ b/scripts/emulator-testing/emulators/firestore-emulator.ts @@ -22,7 +22,7 @@ export class FirestoreEmulator extends Emulator { constructor(port: number, projectId = 'test-emulator') { super( - 'firestore-emulator.jar', + 'cloud-firestore-emulator-v1.11.7.jar', // Use locked version of emulator for test to be deterministic. // The latest version can be found from firestore emulator doc: // https://firebase.google.com/docs/firestore/security/test-rules-emulator From 0c602aa0a6ecd11c63f9efd49e82d2226dfcaf54 Mon Sep 17 00:00:00 2001 From: Feiyang Date: Thu, 29 Oct 2020 09:53:29 -0700 Subject: [PATCH 051/624] Remote Config Modularization (#3975) * rc exp init * Add apis * register rc exp * implement funcitonal APIs * fix tests * build rc exp * add api-extractor to rc types * cast directly witout function * delete changelog for rc exp * add code owners to rc exp * update dep version --- .github/CODEOWNERS | 6 +- common/api-review/remote-config-exp.api.md | 48 ++ config/webpack.test.js | 6 +- packages-exp/remote-config-exp/.eslintrc.js | 26 + packages-exp/remote-config-exp/.npmignore | 1 + packages-exp/remote-config-exp/README.md | 27 + .../remote-config-exp/api-extractor.json | 8 + packages-exp/remote-config-exp/karma.conf.js | 36 ++ packages-exp/remote-config-exp/package.json | 64 +++ .../remote-config-exp/rollup.config.js | 58 ++ .../rollup.config.release.js | 73 +++ .../remote-config-exp/rollup.shared.js | 53 ++ packages-exp/remote-config-exp/src/api.ts | 172 ++++++ packages-exp/remote-config-exp/src/api2.ts | 28 + .../src/client/caching_client.ts | 123 +++++ .../src/client/remote_config_fetch_client.ts | 139 +++++ .../src/client/rest_client.ts | 176 ++++++ .../src/client/retrying_client.ts | 144 +++++ .../remote-config-exp/src/constants.ts | 18 + packages-exp/remote-config-exp/src/errors.ts | 97 ++++ packages-exp/remote-config-exp/src/index.ts | 35 ++ .../remote-config-exp/src/language.ts | 38 ++ .../remote-config-exp/src/register.ts | 121 ++++ .../remote-config-exp/src/remote_config.ts | 88 +++ .../remote-config-exp/src/storage/storage.ts | 260 +++++++++ .../src/storage/storage_cache.ts | 99 ++++ packages-exp/remote-config-exp/src/value.ts | 57 ++ .../test/client/caching_client.test.ts | 160 ++++++ .../test/client/rest_client.test.ts | 270 +++++++++ .../test/client/retrying_client.test.ts | 218 ++++++++ .../remote-config-exp/test/errors.test.ts | 31 ++ .../remote-config-exp/test/language.test.ts | 44 ++ .../test/remote_config.test.ts | 522 ++++++++++++++++++ packages-exp/remote-config-exp/test/setup.ts | 26 + .../test/storage/storage.test.ts | 119 ++++ .../test/storage/storage_cache.test.ts | 84 +++ .../remote-config-exp/test/value.test.ts | 78 +++ .../remote-config-exp/test_app/index.html | 154 ++++++ .../remote-config-exp/test_app/index.js | 224 ++++++++ packages-exp/remote-config-exp/tsconfig.json | 10 + .../remote-config-types-exp/README.md | 3 + .../api-extractor.json | 5 + .../remote-config-types-exp/index.d.ts | 120 ++++ .../remote-config-types-exp/package.json | 29 + .../remote-config-types-exp/tsconfig.json | 9 + 45 files changed, 4103 insertions(+), 4 deletions(-) create mode 100644 common/api-review/remote-config-exp.api.md create mode 100644 packages-exp/remote-config-exp/.eslintrc.js create mode 100644 packages-exp/remote-config-exp/.npmignore create mode 100644 packages-exp/remote-config-exp/README.md create mode 100644 packages-exp/remote-config-exp/api-extractor.json create mode 100644 packages-exp/remote-config-exp/karma.conf.js create mode 100644 packages-exp/remote-config-exp/package.json create mode 100644 packages-exp/remote-config-exp/rollup.config.js create mode 100644 packages-exp/remote-config-exp/rollup.config.release.js create mode 100644 packages-exp/remote-config-exp/rollup.shared.js create mode 100644 packages-exp/remote-config-exp/src/api.ts create mode 100644 packages-exp/remote-config-exp/src/api2.ts create mode 100644 packages-exp/remote-config-exp/src/client/caching_client.ts create mode 100644 packages-exp/remote-config-exp/src/client/remote_config_fetch_client.ts create mode 100644 packages-exp/remote-config-exp/src/client/rest_client.ts create mode 100644 packages-exp/remote-config-exp/src/client/retrying_client.ts create mode 100644 packages-exp/remote-config-exp/src/constants.ts create mode 100644 packages-exp/remote-config-exp/src/errors.ts create mode 100644 packages-exp/remote-config-exp/src/index.ts create mode 100644 packages-exp/remote-config-exp/src/language.ts create mode 100644 packages-exp/remote-config-exp/src/register.ts create mode 100644 packages-exp/remote-config-exp/src/remote_config.ts create mode 100644 packages-exp/remote-config-exp/src/storage/storage.ts create mode 100644 packages-exp/remote-config-exp/src/storage/storage_cache.ts create mode 100644 packages-exp/remote-config-exp/src/value.ts create mode 100644 packages-exp/remote-config-exp/test/client/caching_client.test.ts create mode 100644 packages-exp/remote-config-exp/test/client/rest_client.test.ts create mode 100644 packages-exp/remote-config-exp/test/client/retrying_client.test.ts create mode 100644 packages-exp/remote-config-exp/test/errors.test.ts create mode 100644 packages-exp/remote-config-exp/test/language.test.ts create mode 100644 packages-exp/remote-config-exp/test/remote_config.test.ts create mode 100644 packages-exp/remote-config-exp/test/setup.ts create mode 100644 packages-exp/remote-config-exp/test/storage/storage.test.ts create mode 100644 packages-exp/remote-config-exp/test/storage/storage_cache.test.ts create mode 100644 packages-exp/remote-config-exp/test/value.test.ts create mode 100644 packages-exp/remote-config-exp/test_app/index.html create mode 100644 packages-exp/remote-config-exp/test_app/index.js create mode 100644 packages-exp/remote-config-exp/tsconfig.json create mode 100644 packages-exp/remote-config-types-exp/README.md create mode 100644 packages-exp/remote-config-types-exp/api-extractor.json create mode 100644 packages-exp/remote-config-types-exp/index.d.ts create mode 100644 packages-exp/remote-config-types-exp/package.json create mode 100644 packages-exp/remote-config-types-exp/tsconfig.json diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 5462c0ea9e5..af19815e422 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -99,4 +99,8 @@ packages/installations-types-exp @andirayo @ChaoqunCHEN @firebase/jssdk-global-a # Perf-Exp Code packages/performance-exp @alikn @zijianjoy @firebase/jssdk-global-approvers -packages/performance-types-exp @alikn @zijianjoy @firebase/jssdk-global-approvers \ No newline at end of file +packages/performance-types-exp @alikn @zijianjoy @firebase/jssdk-global-approvers + +# RC-Exp Code +packages/remote-config-exp @erikeldridge @firebase/jssdk-global-approvers +packages/remote-config-types-exp @erikeldridge @firebase/jssdk-global-approvers \ No newline at end of file diff --git a/common/api-review/remote-config-exp.api.md b/common/api-review/remote-config-exp.api.md new file mode 100644 index 00000000000..a51619116ca --- /dev/null +++ b/common/api-review/remote-config-exp.api.md @@ -0,0 +1,48 @@ +## API Report File for "@firebase/remote-config-exp" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { FirebaseApp } from '@firebase/app-types-exp'; +import { LogLevel } from '@firebase/remote-config-types-exp'; +import { RemoteConfig } from '@firebase/remote-config-types-exp'; +import { Value } from '@firebase/remote-config-types-exp'; + +// @public (undocumented) +export function activate(remoteConfig: RemoteConfig): Promise; + +// @public (undocumented) +export function ensureInitialized(remoteConfig: RemoteConfig): Promise; + +// @public (undocumented) +export function fetchAndActivate(remoteConfig: RemoteConfig): Promise; + +// @public (undocumented) +export function fetchConfig(remoteConfig: RemoteConfig): Promise; + +// @public (undocumented) +export function getAll(remoteConfig: RemoteConfig): Record; + +// @public (undocumented) +export function getBoolean(remoteConfig: RemoteConfig, key: string): boolean; + +// @public (undocumented) +export function getNumber(remoteConfig: RemoteConfig, key: string): number; + +// @public (undocumented) +export function getRemoteConfig(app: FirebaseApp): RemoteConfig; + +// @public (undocumented) +export function getString(remoteConfig: RemoteConfig, key: string): string; + +// @public (undocumented) +export function getValue(remoteConfig: RemoteConfig, key: string): Value; + +// @public (undocumented) +export function setLogLevel(remoteConfig: RemoteConfig, logLevel: LogLevel): void; + + +// (No @packageDocumentation comment for this package) + +``` diff --git a/config/webpack.test.js b/config/webpack.test.js index c437b49365e..887efd2ebec 100644 --- a/config/webpack.test.js +++ b/config/webpack.test.js @@ -75,13 +75,13 @@ module.exports = { } } }, + /** + * Transform firebase packages to cjs, so they can be stubbed in tests + */ { test: /\.js$/, include: function (modulePath) { const match = /node_modules\/@firebase.*/.test(modulePath); - if (match) { - console.log('modulePath', modulePath, match); - } return match; }, use: { diff --git a/packages-exp/remote-config-exp/.eslintrc.js b/packages-exp/remote-config-exp/.eslintrc.js new file mode 100644 index 00000000000..5a8c4b909c2 --- /dev/null +++ b/packages-exp/remote-config-exp/.eslintrc.js @@ -0,0 +1,26 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +module.exports = { + 'extends': '../../config/.eslintrc.js', + 'parserOptions': { + project: 'tsconfig.json', + // to make vscode-eslint work with monorepo + // https://github.com/typescript-eslint/typescript-eslint/issues/251#issuecomment-463943250 + tsconfigRootDir: __dirname + } +}; diff --git a/packages-exp/remote-config-exp/.npmignore b/packages-exp/remote-config-exp/.npmignore new file mode 100644 index 00000000000..6de0b6d2896 --- /dev/null +++ b/packages-exp/remote-config-exp/.npmignore @@ -0,0 +1 @@ +# This file is left intentionally blank \ No newline at end of file diff --git a/packages-exp/remote-config-exp/README.md b/packages-exp/remote-config-exp/README.md new file mode 100644 index 00000000000..1b21bbecc51 --- /dev/null +++ b/packages-exp/remote-config-exp/README.md @@ -0,0 +1,27 @@ +# @firebase/remote-config + +This is the [Remote Config](https://firebase.google.com/docs/remote-config/) component of the +[Firebase JS SDK](https://www.npmjs.com/package/firebase). + +**This package is not intended for direct usage, and should only be used via the officially +supported [firebase](https://www.npmjs.com/package/firebase) package.** + +## Contributing + +Setup: + +1. Run `yarn` in repo root + +Format: + +1. Run `yarn prettier` in RC package + +Unit test: + +1. Run `yarn test` in RC package + +End-to-end test: + +1. Run `yarn build` in RC package +1. Run `yarn build` in Firebase package +1. Open test_app/index.html in a browser diff --git a/packages-exp/remote-config-exp/api-extractor.json b/packages-exp/remote-config-exp/api-extractor.json new file mode 100644 index 00000000000..f291311f711 --- /dev/null +++ b/packages-exp/remote-config-exp/api-extractor.json @@ -0,0 +1,8 @@ +{ + "extends": "../../config/api-extractor.json", + // Point it to your entry point d.ts file. + "mainEntryPointFilePath": "/dist/src/index.d.ts", + "dtsRollup": { + "enabled": true + } +} \ No newline at end of file diff --git a/packages-exp/remote-config-exp/karma.conf.js b/packages-exp/remote-config-exp/karma.conf.js new file mode 100644 index 00000000000..5006cd5a4ea --- /dev/null +++ b/packages-exp/remote-config-exp/karma.conf.js @@ -0,0 +1,36 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +const karma = require('karma'); +const path = require('path'); +const karmaBase = require('../../config/karma.base'); + +const files = [`test/**/*`]; + +module.exports = function (config) { + const karmaConfig = Object.assign({}, karmaBase, { + // files to load into karma + files: files, + // frameworks to use + // available frameworks: https://npmjs.org/browse/keyword/karma-adapter + frameworks: ['mocha'] + }); + + config.set(karmaConfig); +}; + +module.exports.files = files; diff --git a/packages-exp/remote-config-exp/package.json b/packages-exp/remote-config-exp/package.json new file mode 100644 index 00000000000..5f191b1db0d --- /dev/null +++ b/packages-exp/remote-config-exp/package.json @@ -0,0 +1,64 @@ +{ + "name": "@firebase/remote-config-exp", + "version": "0.0.800", + "description": "The Remote Config package of the Firebase JS SDK", + "author": "Firebase (https://firebase.google.com/)", + "private": true, + "main": "dist/index.cjs.js", + "browser": "dist/index.esm.js", + "module": "dist/index.esm.js", + "esm2017": "dist/index.esm2017.js", + "files": ["dist"], + "scripts": { + "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'", + "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'", + "build": "rollup -c && yarn api-report", + "build:deps": "lerna run --scope @firebase/remote-config-exp --include-dependencies build", + "build:release": "rollup -c rollup.config.release.js && yarn api-report", + "dev": "rollup -c -w", + "test": "run-p lint test:browser", + "test:ci": "node ../../scripts/run_tests_in_ci.js -s test:browser", + "test:browser": "karma start --single-run", + "test:debug": "karma start --browsers=Chrome --auto-watch", + "prettier": "prettier --write '{src,test}/**/*.{js,ts}'", + "prepare": "yarn build", + "api-report": "api-extractor run --local --verbose", + "predoc": "node ../../scripts/exp/remove-exp.js temp", + "doc": "api-documenter markdown --input temp --output docs", + "build:doc": "yarn build && yarn doc" + }, + "peerDependencies": { + "@firebase/app-exp": "0.x", + "@firebase/app-types-exp": "0.x" + }, + "dependencies": { + "@firebase/installations-exp": "0.0.800", + "@firebase/logger": "0.2.6", + "@firebase/remote-config-types-exp": "0.0.800", + "@firebase/util": "0.3.3", + "@firebase/component": "0.1.20", + "tslib": "^1.11.1" + }, + "license": "Apache-2.0", + "devDependencies": { + "@firebase/app-exp": "0.0.800", + "rollup": "2.29.0", + "rollup-plugin-typescript2": "0.27.3", + "typescript": "4.0.2" + }, + "repository": { + "directory": "packages/remote-config", + "type": "git", + "url": "https://github.com/firebase/firebase-js-sdk.git" + }, + "bugs": { + "url": "https://github.com/firebase/firebase-js-sdk/issues" + }, + "typings": "dist/remote-config-exp.d.ts", + "nyc": { + "extension": [ + ".ts" + ], + "reportDir": "./coverage/node" + } +} diff --git a/packages-exp/remote-config-exp/rollup.config.js b/packages-exp/remote-config-exp/rollup.config.js new file mode 100644 index 00000000000..b57e5ad73ee --- /dev/null +++ b/packages-exp/remote-config-exp/rollup.config.js @@ -0,0 +1,58 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import json from '@rollup/plugin-json'; // Enables package.json import in TypeScript. +import typescriptPlugin from 'rollup-plugin-typescript2'; +import typescript from 'typescript'; +import { es2017BuildsNoPlugin, es5BuildsNoPlugin } from './rollup.shared'; + +/** + * ES5 Builds + */ +const es5BuildPlugins = [ + typescriptPlugin({ + typescript + }), + json() +]; + +const es5Builds = es5BuildsNoPlugin.map(build => ({ + ...build, + plugins: es5BuildPlugins +})); + +/** + * ES2017 Builds + */ +const es2017BuildPlugins = [ + typescriptPlugin({ + typescript, + tsconfigOverride: { + compilerOptions: { + target: 'es2017' + } + } + }), + json({ preferConst: true }) +]; + +const es2017Builds = es2017BuildsNoPlugin.map(build => ({ + ...build, + plugins: es2017BuildPlugins +})); + +export default [...es5Builds, ...es2017Builds]; diff --git a/packages-exp/remote-config-exp/rollup.config.release.js b/packages-exp/remote-config-exp/rollup.config.release.js new file mode 100644 index 00000000000..1e3b338e4b5 --- /dev/null +++ b/packages-exp/remote-config-exp/rollup.config.release.js @@ -0,0 +1,73 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import typescriptPlugin from 'rollup-plugin-typescript2'; +import typescript from 'typescript'; +import json from '@rollup/plugin-json'; +import { importPathTransformer } from '../../scripts/exp/ts-transform-import-path'; +import { es2017BuildsNoPlugin, es5BuildsNoPlugin } from './rollup.shared'; + +/** + * ES5 Builds + */ +const es5BuildPlugins = [ + typescriptPlugin({ + typescript, + clean: true, + abortOnError: false, + transformers: [importPathTransformer] + }), + json() +]; + +const es5Builds = es5BuildsNoPlugin.map(build => ({ + ...build, + plugins: es5BuildPlugins, + treeshake: { + moduleSideEffects: false + } +})); + +/** + * ES2017 Builds + */ +const es2017BuildPlugins = [ + typescriptPlugin({ + typescript, + tsconfigOverride: { + compilerOptions: { + target: 'es2017' + } + }, + abortOnError: false, + clean: true, + transformers: [importPathTransformer] + }), + json({ + preferConst: true + }) +]; + +const es2017Builds = es2017BuildsNoPlugin.map(build => ({ + ...build, + plugins: es2017BuildPlugins, + treeshake: { + moduleSideEffects: false + } +})); + +export default [...es5Builds, ...es2017Builds]; diff --git a/packages-exp/remote-config-exp/rollup.shared.js b/packages-exp/remote-config-exp/rollup.shared.js new file mode 100644 index 00000000000..c35a655a498 --- /dev/null +++ b/packages-exp/remote-config-exp/rollup.shared.js @@ -0,0 +1,53 @@ +/** + * @license + * Copyright 2018 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +import pkg from './package.json'; + +const deps = Object.keys( + Object.assign({}, pkg.peerDependencies, pkg.dependencies) +); + +export const es5BuildsNoPlugin = [ + /** + * Browser Builds + */ + { + input: 'src/index.ts', + output: [ + { file: pkg.main, format: 'cjs', sourcemap: true }, + { file: pkg.module, format: 'es', sourcemap: true } + ], + external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)) + } +]; + +/** + * ES2017 Builds + */ +export const es2017BuildsNoPlugin = [ + { + /** + * Browser Build + */ + input: 'src/index.ts', + output: { + file: pkg.esm2017, + format: 'es', + sourcemap: true + }, + external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)) + } +]; diff --git a/packages-exp/remote-config-exp/src/api.ts b/packages-exp/remote-config-exp/src/api.ts new file mode 100644 index 00000000000..0b48299c2f4 --- /dev/null +++ b/packages-exp/remote-config-exp/src/api.ts @@ -0,0 +1,172 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { _getProvider } from '@firebase/app-exp'; +import { FirebaseApp } from '@firebase/app-types-exp'; +import { + LogLevel as RemoteConfigLogLevel, + RemoteConfig, + Value as ValueType +} from '@firebase/remote-config-types-exp'; +import { RemoteConfigAbortSignal } from './client/remote_config_fetch_client'; +import { RC_COMPONENT_NAME } from './constants'; +import { ErrorCode, hasErrorCode } from './errors'; +import { RemoteConfig as RemoteConfigImpl } from './remote_config'; +import { Value } from './value'; +import { LogLevel as FirebaseLogLevel } from '@firebase/logger'; + +export function getRemoteConfig(app: FirebaseApp): RemoteConfig { + const rcProvider = _getProvider(app, RC_COMPONENT_NAME); + return rcProvider.getImmediate(); +} + +export async function activate(remoteConfig: RemoteConfig): Promise { + const rc = remoteConfig as RemoteConfigImpl; + const [lastSuccessfulFetchResponse, activeConfigEtag] = await Promise.all([ + rc._storage.getLastSuccessfulFetchResponse(), + rc._storage.getActiveConfigEtag() + ]); + if ( + !lastSuccessfulFetchResponse || + !lastSuccessfulFetchResponse.config || + !lastSuccessfulFetchResponse.eTag || + lastSuccessfulFetchResponse.eTag === activeConfigEtag + ) { + // Either there is no successful fetched config, or is the same as current active + // config. + return false; + } + await Promise.all([ + rc._storageCache.setActiveConfig(lastSuccessfulFetchResponse.config), + rc._storage.setActiveConfigEtag(lastSuccessfulFetchResponse.eTag) + ]); + return true; +} + +export function ensureInitialized(remoteConfig: RemoteConfig): Promise { + const rc = remoteConfig as RemoteConfigImpl; + if (!rc._initializePromise) { + rc._initializePromise = rc._storageCache.loadFromStorage().then(() => { + rc._isInitializationComplete = true; + }); + } + return rc._initializePromise; +} + +export async function fetchConfig(remoteConfig: RemoteConfig): Promise { + const rc = remoteConfig as RemoteConfigImpl; + // Aborts the request after the given timeout, causing the fetch call to + // reject with an AbortError. + // + //

Aborting after the request completes is a no-op, so we don't need a + // corresponding clearTimeout. + // + // Locating abort logic here because: + // * it uses a developer setting (timeout) + // * it applies to all retries (like curl's max-time arg) + // * it is consistent with the Fetch API's signal input + const abortSignal = new RemoteConfigAbortSignal(); + + setTimeout(async () => { + // Note a very low delay, eg < 10ms, can elapse before listeners are initialized. + abortSignal.abort(); + }, rc.settings.fetchTimeoutMillis); + + // Catches *all* errors thrown by client so status can be set consistently. + try { + await rc._client.fetch({ + cacheMaxAgeMillis: rc.settings.minimumFetchIntervalMillis, + signal: abortSignal + }); + + await rc._storageCache.setLastFetchStatus('success'); + } catch (e) { + const lastFetchStatus = hasErrorCode(e, ErrorCode.FETCH_THROTTLE) + ? 'throttle' + : 'failure'; + await rc._storageCache.setLastFetchStatus(lastFetchStatus); + throw e; + } +} + +export function getAll(remoteConfig: RemoteConfig): Record { + const rc = remoteConfig as RemoteConfigImpl; + return getAllKeys( + rc._storageCache.getActiveConfig(), + rc.defaultConfig + ).reduce((allConfigs, key) => { + allConfigs[key] = getValue(remoteConfig, key); + return allConfigs; + }, {} as Record); +} + +export function getBoolean(remoteConfig: RemoteConfig, key: string): boolean { + return getValue(remoteConfig, key).asBoolean(); +} + +export function getNumber(remoteConfig: RemoteConfig, key: string): number { + return getValue(remoteConfig, key).asNumber(); +} + +export function getString(remoteConfig: RemoteConfig, key: string): string { + return getValue(remoteConfig, key).asString(); +} + +export function getValue(remoteConfig: RemoteConfig, key: string): ValueType { + const rc = remoteConfig as RemoteConfigImpl; + if (!rc._isInitializationComplete) { + rc._logger.debug( + `A value was requested for key "${key}" before SDK initialization completed.` + + ' Await on ensureInitialized if the intent was to get a previously activated value.' + ); + } + const activeConfig = rc._storageCache.getActiveConfig(); + if (activeConfig && activeConfig[key] !== undefined) { + return new Value('remote', activeConfig[key]); + } else if (rc.defaultConfig && rc.defaultConfig[key] !== undefined) { + return new Value('default', String(rc.defaultConfig[key])); + } + rc._logger.debug( + `Returning static value for key "${key}".` + + ' Define a default or remote value if this is unintentional.' + ); + return new Value('static'); +} + +export function setLogLevel( + remoteConfig: RemoteConfig, + logLevel: RemoteConfigLogLevel +): void { + const rc = remoteConfig as RemoteConfigImpl; + switch (logLevel) { + case 'debug': + rc._logger.logLevel = FirebaseLogLevel.DEBUG; + break; + case 'silent': + rc._logger.logLevel = FirebaseLogLevel.SILENT; + break; + default: + rc._logger.logLevel = FirebaseLogLevel.ERROR; + } +} + +/** + * Dedupes and returns an array of all the keys of the received objects. + */ +function getAllKeys(obj1: {} = {}, obj2: {} = {}): string[] { + return Object.keys({ ...obj1, ...obj2 }); +} diff --git a/packages-exp/remote-config-exp/src/api2.ts b/packages-exp/remote-config-exp/src/api2.ts new file mode 100644 index 00000000000..ee1df4b1c06 --- /dev/null +++ b/packages-exp/remote-config-exp/src/api2.ts @@ -0,0 +1,28 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { RemoteConfig } from '@firebase/remote-config-types-exp'; +import { activate, fetchConfig } from './api'; + +// This API is put in a separate file, so we can stub fetchConfig and activate in tests. +// It's not possible to stub standalone functions from the same module. +export async function fetchAndActivate( + remoteConfig: RemoteConfig +): Promise { + await fetchConfig(remoteConfig); + return activate(remoteConfig); +} diff --git a/packages-exp/remote-config-exp/src/client/caching_client.ts b/packages-exp/remote-config-exp/src/client/caching_client.ts new file mode 100644 index 00000000000..aea61acfd1f --- /dev/null +++ b/packages-exp/remote-config-exp/src/client/caching_client.ts @@ -0,0 +1,123 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { StorageCache } from '../storage/storage_cache'; +import { + FetchResponse, + RemoteConfigFetchClient, + FetchRequest +} from './remote_config_fetch_client'; +import { Storage } from '../storage/storage'; +import { Logger } from '@firebase/logger'; + +/** + * Implements the {@link RemoteConfigClient} abstraction with success response caching. + * + *

Comparable to the browser's Cache API for responses, but the Cache API requires a Service + * Worker, which requires HTTPS, which would significantly complicate SDK installation. Also, the + * Cache API doesn't support matching entries by time. + */ +export class CachingClient implements RemoteConfigFetchClient { + constructor( + private readonly client: RemoteConfigFetchClient, + private readonly storage: Storage, + private readonly storageCache: StorageCache, + private readonly logger: Logger + ) {} + + /** + * Returns true if the age of the cached fetched configs is less than or equal to + * {@link Settings#minimumFetchIntervalInSeconds}. + * + *

This is comparable to passing `headers = { 'Cache-Control': max-age }` to the + * native Fetch API. + * + *

Visible for testing. + */ + isCachedDataFresh( + cacheMaxAgeMillis: number, + lastSuccessfulFetchTimestampMillis: number | undefined + ): boolean { + // Cache can only be fresh if it's populated. + if (!lastSuccessfulFetchTimestampMillis) { + this.logger.debug('Config fetch cache check. Cache unpopulated.'); + return false; + } + + // Calculates age of cache entry. + const cacheAgeMillis = Date.now() - lastSuccessfulFetchTimestampMillis; + + const isCachedDataFresh = cacheAgeMillis <= cacheMaxAgeMillis; + + this.logger.debug( + 'Config fetch cache check.' + + ` Cache age millis: ${cacheAgeMillis}.` + + ` Cache max age millis (minimumFetchIntervalMillis setting): ${cacheMaxAgeMillis}.` + + ` Is cache hit: ${isCachedDataFresh}.` + ); + + return isCachedDataFresh; + } + + async fetch(request: FetchRequest): Promise { + // Reads from persisted storage to avoid cache miss if callers don't wait on initialization. + const [ + lastSuccessfulFetchTimestampMillis, + lastSuccessfulFetchResponse + ] = await Promise.all([ + this.storage.getLastSuccessfulFetchTimestampMillis(), + this.storage.getLastSuccessfulFetchResponse() + ]); + + // Exits early on cache hit. + if ( + lastSuccessfulFetchResponse && + this.isCachedDataFresh( + request.cacheMaxAgeMillis, + lastSuccessfulFetchTimestampMillis + ) + ) { + return lastSuccessfulFetchResponse; + } + + // Deviates from pure decorator by not honoring a passed ETag since we don't have a public API + // that allows the caller to pass an ETag. + request.eTag = + lastSuccessfulFetchResponse && lastSuccessfulFetchResponse.eTag; + + // Falls back to service on cache miss. + const response = await this.client.fetch(request); + + // Fetch throws for non-success responses, so success is guaranteed here. + + const storageOperations = [ + // Uses write-through cache for consistency with synchronous public API. + this.storageCache.setLastSuccessfulFetchTimestampMillis(Date.now()) + ]; + + if (response.status === 200) { + // Caches response only if it has changed, ie non-304 responses. + storageOperations.push( + this.storage.setLastSuccessfulFetchResponse(response) + ); + } + + await Promise.all(storageOperations); + + return response; + } +} diff --git a/packages-exp/remote-config-exp/src/client/remote_config_fetch_client.ts b/packages-exp/remote-config-exp/src/client/remote_config_fetch_client.ts new file mode 100644 index 00000000000..25e00299855 --- /dev/null +++ b/packages-exp/remote-config-exp/src/client/remote_config_fetch_client.ts @@ -0,0 +1,139 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Defines a client, as in https://en.wikipedia.org/wiki/Client%E2%80%93server_model, for the + * Remote Config server (https://firebase.google.com/docs/reference/remote-config/rest). + * + *

Abstracts throttle, response cache and network implementation details. + * + *

Modeled after the native {@link GlobalFetch} interface, which is relatively modern and + * convenient, but simplified for Remote Config's use case. + * + * Disambiguation: {@link GlobalFetch} interface and the Remote Config service define "fetch" + * methods. The RestClient uses the former to make HTTP calls. This interface abstracts the latter. + */ +export interface RemoteConfigFetchClient { + /** + * @throws if response status is not 200 or 304. + */ + fetch(request: FetchRequest): Promise; +} + +/** + * Defines a self-descriptive reference for config key-value pairs. + */ +export interface FirebaseRemoteConfigObject { + [key: string]: string; +} + +/** + * Shims a minimal AbortSignal. + * + *

AbortController's AbortSignal conveniently decouples fetch timeout logic from other aspects + * of networking, such as retries. Firebase doesn't use AbortController enough to justify a + * polyfill recommendation, like we do with the Fetch API, but this minimal shim can easily be + * swapped out if/when we do. + */ +export class RemoteConfigAbortSignal { + listeners: Array<() => void> = []; + addEventListener(listener: () => void): void { + this.listeners.push(listener); + } + abort(): void { + this.listeners.forEach(listener => listener()); + } +} + +/** + * Defines per-request inputs for the Remote Config fetch request. + * + *

Modeled after the native {@link Request} interface, but simplified for Remote Config's + * use case. + */ +export interface FetchRequest { + /** + * Uses cached config if it is younger than this age. + * + *

Required because it's defined by settings, which always have a value. + * + *

Comparable to passing `headers = { 'Cache-Control': max-age }` to the native + * Fetch API. + */ + cacheMaxAgeMillis: number; + + /** + * An event bus for the signal to abort a request. + * + *

Required because all requests should be abortable. + * + *

Comparable to the native + * Fetch API's "signal" field on its request configuration object + * https://fetch.spec.whatwg.org/#dom-requestinit-signal. + * + *

Disambiguation: Remote Config commonly refers to API inputs as + * "signals". See the private ConfigFetchRequestBody interface for those: + * http://google3/firebase/remote_config/web/src/core/rest_client.ts?l=14&rcl=255515243. + */ + signal: RemoteConfigAbortSignal; + + /** + * The ETag header value from the last response. + * + *

Optional in case this is the first request. + * + *

Comparable to passing `headers = { 'If-None-Match': }` to the native Fetch API. + */ + eTag?: string; +} + +/** + * Defines a successful response (200 or 304). + * + *

Modeled after the native {@link Response} interface, but simplified for Remote Config's + * use case. + */ +export interface FetchResponse { + /** + * The HTTP status, which is useful for differentiating success responses with data from + * those without. + * + *

{@link RemoteConfigClient} is modeled after the native {@link GlobalFetch} interface, so + * HTTP status is first-class. + * + *

Disambiguation: the fetch response returns a legacy "state" value that is redundant with the + * HTTP status code. The former is normalized into the latter. + */ + status: number; + + /** + * Defines the ETag response header value. + * + *

Only defined for 200 and 304 responses. + */ + eTag?: string; + + /** + * Defines the map of parameters returned as "entries" in the fetch response body. + * + *

Only defined for 200 responses. + */ + config?: FirebaseRemoteConfigObject; + + // Note: we're not extracting experiment metadata until + // ABT and Analytics have Web SDKs. +} diff --git a/packages-exp/remote-config-exp/src/client/rest_client.ts b/packages-exp/remote-config-exp/src/client/rest_client.ts new file mode 100644 index 00000000000..a5b521a421e --- /dev/null +++ b/packages-exp/remote-config-exp/src/client/rest_client.ts @@ -0,0 +1,176 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { + FetchResponse, + RemoteConfigFetchClient, + FirebaseRemoteConfigObject, + FetchRequest +} from './remote_config_fetch_client'; +import { ERROR_FACTORY, ErrorCode } from '../errors'; +import { getUserLanguage } from '../language'; +import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp'; + +/** + * Defines request body parameters required to call the fetch API: + * https://firebase.google.com/docs/reference/remote-config/rest + * + *

Not exported because this file encapsulates REST API specifics. + * + *

Not passing User Properties because Analytics' source of truth on Web is server-side. + */ +interface FetchRequestBody { + // Disables camelcase linting for request body params. + /* eslint-disable camelcase*/ + sdk_version: string; + app_instance_id: string; + app_instance_id_token: string; + app_id: string; + language_code: string; + /* eslint-enable camelcase */ +} + +/** + * Implements the Client abstraction for the Remote Config REST API. + */ +export class RestClient implements RemoteConfigFetchClient { + constructor( + private readonly firebaseInstallations: _FirebaseInstallationsInternal, + private readonly sdkVersion: string, + private readonly namespace: string, + private readonly projectId: string, + private readonly apiKey: string, + private readonly appId: string + ) {} + + /** + * Fetches from the Remote Config REST API. + * + * @throws a {@link ErrorCode.FETCH_NETWORK} error if {@link GlobalFetch#fetch} can't + * connect to the network. + * @throws a {@link ErrorCode.FETCH_PARSE} error if {@link Response#json} can't parse the + * fetch response. + * @throws a {@link ErrorCode.FETCH_STATUS} error if the service returns an HTTP error status. + */ + async fetch(request: FetchRequest): Promise { + const [installationId, installationToken] = await Promise.all([ + this.firebaseInstallations.getId(), + this.firebaseInstallations.getToken() + ]); + + const urlBase = + window.FIREBASE_REMOTE_CONFIG_URL_BASE || + 'https://firebaseremoteconfig.googleapis.com'; + + const url = `${urlBase}/v1/projects/${this.projectId}/namespaces/${this.namespace}:fetch?key=${this.apiKey}`; + + const headers = { + 'Content-Type': 'application/json', + 'Content-Encoding': 'gzip', + // Deviates from pure decorator by not passing max-age header since we don't currently have + // service behavior using that header. + 'If-None-Match': request.eTag || '*' + }; + + const requestBody: FetchRequestBody = { + /* eslint-disable camelcase */ + sdk_version: this.sdkVersion, + app_instance_id: installationId, + app_instance_id_token: installationToken, + app_id: this.appId, + language_code: getUserLanguage() + /* eslint-enable camelcase */ + }; + + const options = { + method: 'POST', + headers, + body: JSON.stringify(requestBody) + }; + + // This logic isn't REST-specific, but shimming abort logic isn't worth another decorator. + const fetchPromise = fetch(url, options); + const timeoutPromise = new Promise((_resolve, reject) => { + // Maps async event listener to Promise API. + request.signal.addEventListener(() => { + // Emulates https://heycam.github.io/webidl/#aborterror + const error = new Error('The operation was aborted.'); + error.name = 'AbortError'; + reject(error); + }); + }); + + let response; + try { + await Promise.race([fetchPromise, timeoutPromise]); + response = await fetchPromise; + } catch (originalError) { + let errorCode = ErrorCode.FETCH_NETWORK; + if (originalError.name === 'AbortError') { + errorCode = ErrorCode.FETCH_TIMEOUT; + } + throw ERROR_FACTORY.create(errorCode, { + originalErrorMessage: originalError.message + }); + } + + let status = response.status; + + // Normalizes nullable header to optional. + const responseEtag = response.headers.get('ETag') || undefined; + + let config: FirebaseRemoteConfigObject | undefined; + let state: string | undefined; + + // JSON parsing throws SyntaxError if the response body isn't a JSON string. + // Requesting application/json and checking for a 200 ensures there's JSON data. + if (response.status === 200) { + let responseBody; + try { + responseBody = await response.json(); + } catch (originalError) { + throw ERROR_FACTORY.create(ErrorCode.FETCH_PARSE, { + originalErrorMessage: originalError.message + }); + } + config = responseBody['entries']; + state = responseBody['state']; + } + + // Normalizes based on legacy state. + if (state === 'INSTANCE_STATE_UNSPECIFIED') { + status = 500; + } else if (state === 'NO_CHANGE') { + status = 304; + } else if (state === 'NO_TEMPLATE' || state === 'EMPTY_CONFIG') { + // These cases can be fixed remotely, so normalize to safe value. + config = {}; + } + + // Normalize to exception-based control flow for non-success cases. + // Encapsulates HTTP specifics in this class as much as possible. Status is still the best for + // differentiating success states (200 from 304; the state body param is undefined in a + // standard 304). + if (status !== 304 && status !== 200) { + throw ERROR_FACTORY.create(ErrorCode.FETCH_STATUS, { + httpStatus: status + }); + } + + return { status, eTag: responseEtag, config }; + } +} diff --git a/packages-exp/remote-config-exp/src/client/retrying_client.ts b/packages-exp/remote-config-exp/src/client/retrying_client.ts new file mode 100644 index 00000000000..fe1737023df --- /dev/null +++ b/packages-exp/remote-config-exp/src/client/retrying_client.ts @@ -0,0 +1,144 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { + RemoteConfigAbortSignal, + RemoteConfigFetchClient, + FetchResponse, + FetchRequest +} from './remote_config_fetch_client'; +import { ThrottleMetadata, Storage } from '../storage/storage'; +import { ErrorCode, ERROR_FACTORY } from '../errors'; +import { FirebaseError, calculateBackoffMillis } from '@firebase/util'; + +/** + * Supports waiting on a backoff by: + * + *

    + *
  • Promisifying setTimeout, so we can set a timeout in our Promise chain
    • + *
  • Listening on a signal bus for abort events, just like the Fetch API
    • + *
  • Failing in the same way the Fetch API fails, so timing out a live request and a throttled + * request appear the same.
    • + *
+ * + *

Visible for testing. + */ +export function setAbortableTimeout( + signal: RemoteConfigAbortSignal, + throttleEndTimeMillis: number +): Promise { + return new Promise((resolve, reject) => { + // Derives backoff from given end time, normalizing negative numbers to zero. + const backoffMillis = Math.max(throttleEndTimeMillis - Date.now(), 0); + + const timeout = setTimeout(resolve, backoffMillis); + + // Adds listener, rather than sets onabort, because signal is a shared object. + signal.addEventListener(() => { + clearTimeout(timeout); + + // If the request completes before this timeout, the rejection has no effect. + reject( + ERROR_FACTORY.create(ErrorCode.FETCH_THROTTLE, { + throttleEndTimeMillis + }) + ); + }); + }); +} + +type RetriableError = FirebaseError & { customData: { httpStatus: string } }; +/** + * Returns true if the {@link Error} indicates a fetch request may succeed later. + */ +function isRetriableError(e: Error): e is RetriableError { + if (!(e instanceof FirebaseError) || !e.customData) { + return false; + } + + // Uses string index defined by ErrorData, which FirebaseError implements. + const httpStatus = Number(e.customData['httpStatus']); + + return ( + httpStatus === 429 || + httpStatus === 500 || + httpStatus === 503 || + httpStatus === 504 + ); +} + +/** + * Decorates a Client with retry logic. + * + *

Comparable to CachingClient, but uses backoff logic instead of cache max age and doesn't cache + * responses (because the SDK has no use for error responses). + */ +export class RetryingClient implements RemoteConfigFetchClient { + constructor( + private readonly client: RemoteConfigFetchClient, + private readonly storage: Storage + ) {} + + async fetch(request: FetchRequest): Promise { + const throttleMetadata = (await this.storage.getThrottleMetadata()) || { + backoffCount: 0, + throttleEndTimeMillis: Date.now() + }; + + return this.attemptFetch(request, throttleMetadata); + } + + /** + * A recursive helper for attempting a fetch request repeatedly. + * + * @throws any non-retriable errors. + */ + async attemptFetch( + request: FetchRequest, + { throttleEndTimeMillis, backoffCount }: ThrottleMetadata + ): Promise { + // Starts with a (potentially zero) timeout to support resumption from stored state. + // Ensures the throttle end time is honored if the last attempt timed out. + // Note the SDK will never make a request if the fetch timeout expires at this point. + await setAbortableTimeout(request.signal, throttleEndTimeMillis); + + try { + const response = await this.client.fetch(request); + + // Note the SDK only clears throttle state if response is success or non-retriable. + await this.storage.deleteThrottleMetadata(); + + return response; + } catch (e) { + if (!isRetriableError(e)) { + throw e; + } + + // Increments backoff state. + const throttleMetadata = { + throttleEndTimeMillis: + Date.now() + calculateBackoffMillis(backoffCount), + backoffCount: backoffCount + 1 + }; + + // Persists state. + await this.storage.setThrottleMetadata(throttleMetadata); + + return this.attemptFetch(request, throttleMetadata); + } + } +} diff --git a/packages-exp/remote-config-exp/src/constants.ts b/packages-exp/remote-config-exp/src/constants.ts new file mode 100644 index 00000000000..6bc7d1d5547 --- /dev/null +++ b/packages-exp/remote-config-exp/src/constants.ts @@ -0,0 +1,18 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +export const RC_COMPONENT_NAME = 'remote-config-exp'; diff --git a/packages-exp/remote-config-exp/src/errors.ts b/packages-exp/remote-config-exp/src/errors.ts new file mode 100644 index 00000000000..d4be9a09f76 --- /dev/null +++ b/packages-exp/remote-config-exp/src/errors.ts @@ -0,0 +1,97 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { ErrorFactory, FirebaseError } from '@firebase/util'; + +export const enum ErrorCode { + REGISTRATION_WINDOW = 'registration-window', + REGISTRATION_PROJECT_ID = 'registration-project-id', + REGISTRATION_API_KEY = 'registration-api-key', + REGISTRATION_APP_ID = 'registration-app-id', + STORAGE_OPEN = 'storage-open', + STORAGE_GET = 'storage-get', + STORAGE_SET = 'storage-set', + STORAGE_DELETE = 'storage-delete', + FETCH_NETWORK = 'fetch-client-network', + FETCH_TIMEOUT = 'fetch-timeout', + FETCH_THROTTLE = 'fetch-throttle', + FETCH_PARSE = 'fetch-client-parse', + FETCH_STATUS = 'fetch-status' +} + +const ERROR_DESCRIPTION_MAP: { readonly [key in ErrorCode]: string } = { + [ErrorCode.REGISTRATION_WINDOW]: + 'Undefined window object. This SDK only supports usage in a browser environment.', + [ErrorCode.REGISTRATION_PROJECT_ID]: + 'Undefined project identifier. Check Firebase app initialization.', + [ErrorCode.REGISTRATION_API_KEY]: + 'Undefined API key. Check Firebase app initialization.', + [ErrorCode.REGISTRATION_APP_ID]: + 'Undefined app identifier. Check Firebase app initialization.', + [ErrorCode.STORAGE_OPEN]: + 'Error thrown when opening storage. Original error: {$originalErrorMessage}.', + [ErrorCode.STORAGE_GET]: + 'Error thrown when reading from storage. Original error: {$originalErrorMessage}.', + [ErrorCode.STORAGE_SET]: + 'Error thrown when writing to storage. Original error: {$originalErrorMessage}.', + [ErrorCode.STORAGE_DELETE]: + 'Error thrown when deleting from storage. Original error: {$originalErrorMessage}.', + [ErrorCode.FETCH_NETWORK]: + 'Fetch client failed to connect to a network. Check Internet connection.' + + ' Original error: {$originalErrorMessage}.', + [ErrorCode.FETCH_TIMEOUT]: + 'The config fetch request timed out. ' + + ' Configure timeout using "fetchTimeoutMillis" SDK setting.', + [ErrorCode.FETCH_THROTTLE]: + 'The config fetch request timed out while in an exponential backoff state.' + + ' Configure timeout using "fetchTimeoutMillis" SDK setting.' + + ' Unix timestamp in milliseconds when fetch request throttling ends: {$throttleEndTimeMillis}.', + [ErrorCode.FETCH_PARSE]: + 'Fetch client could not parse response.' + + ' Original error: {$originalErrorMessage}.', + [ErrorCode.FETCH_STATUS]: + 'Fetch server returned an HTTP error status. HTTP status: {$httpStatus}.' +}; + +// Note this is effectively a type system binding a code to params. This approach overlaps with the +// role of TS interfaces, but works well for a few reasons: +// 1) JS is unaware of TS interfaces, eg we can't test for interface implementation in JS +// 2) callers should have access to a human-readable summary of the error and this interpolates +// params into an error message; +// 3) callers should be able to programmatically access data associated with an error, which +// ErrorData provides. +interface ErrorParams { + [ErrorCode.STORAGE_OPEN]: { originalErrorMessage: string | undefined }; + [ErrorCode.STORAGE_GET]: { originalErrorMessage: string | undefined }; + [ErrorCode.STORAGE_SET]: { originalErrorMessage: string | undefined }; + [ErrorCode.STORAGE_DELETE]: { originalErrorMessage: string | undefined }; + [ErrorCode.FETCH_NETWORK]: { originalErrorMessage: string }; + [ErrorCode.FETCH_THROTTLE]: { throttleEndTimeMillis: number }; + [ErrorCode.FETCH_PARSE]: { originalErrorMessage: string }; + [ErrorCode.FETCH_STATUS]: { httpStatus: number }; +} + +export const ERROR_FACTORY = new ErrorFactory( + 'remoteconfig' /* service */, + 'Remote Config' /* service name */, + ERROR_DESCRIPTION_MAP +); + +// Note how this is like typeof/instanceof, but for ErrorCode. +export function hasErrorCode(e: Error, errorCode: ErrorCode): boolean { + return e instanceof FirebaseError && e.code.indexOf(errorCode) !== -1; +} diff --git a/packages-exp/remote-config-exp/src/index.ts b/packages-exp/remote-config-exp/src/index.ts new file mode 100644 index 00000000000..2b639bccfc7 --- /dev/null +++ b/packages-exp/remote-config-exp/src/index.ts @@ -0,0 +1,35 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import '@firebase/installations-exp'; +import { registerRemoteConfig } from './register'; + +// Facilitates debugging by enabling settings changes without rebuilding asset. +// Note these debug options are not part of a documented, supported API and can change at any time. +// Consolidates debug options for easier discovery. +// Uses transient variables on window to avoid lingering state causing panic. +declare global { + interface Window { + FIREBASE_REMOTE_CONFIG_URL_BASE: string; + } +} + +export * from './api'; +export * from './api2'; + +/** register component and version */ +registerRemoteConfig(); diff --git a/packages-exp/remote-config-exp/src/language.ts b/packages-exp/remote-config-exp/src/language.ts new file mode 100644 index 00000000000..9c44ee275bf --- /dev/null +++ b/packages-exp/remote-config-exp/src/language.ts @@ -0,0 +1,38 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * Attempts to get the most accurate browser language setting. + * + *

Adapted from getUserLanguage in packages/auth/src/utils.js for TypeScript. + * + *

Defers default language specification to server logic for consistency. + * + * @param navigatorLanguage Enables tests to override read-only {@link NavigatorLanguage}. + */ +export function getUserLanguage( + navigatorLanguage: NavigatorLanguage = navigator +): string { + return ( + // Most reliable, but only supported in Chrome/Firefox. + (navigatorLanguage.languages && navigatorLanguage.languages[0]) || + // Supported in most browsers, but returns the language of the browser + // UI, not the language set in browser settings. + navigatorLanguage.language + // Polyfill otherwise. + ); +} diff --git a/packages-exp/remote-config-exp/src/register.ts b/packages-exp/remote-config-exp/src/register.ts new file mode 100644 index 00000000000..6d6dde396ea --- /dev/null +++ b/packages-exp/remote-config-exp/src/register.ts @@ -0,0 +1,121 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +import { + _registerComponent, + registerVersion, + SDK_VERSION +} from '@firebase/app-exp'; +import { + Component, + ComponentType, + ComponentContainer +} from '@firebase/component'; +import { Logger, LogLevel as FirebaseLogLevel } from '@firebase/logger'; +import { RemoteConfig } from '@firebase/remote-config-types-exp'; +import { name as packageName, version } from '../package.json'; +import { ensureInitialized } from './api'; +import { CachingClient } from './client/caching_client'; +import { RestClient } from './client/rest_client'; +import { RetryingClient } from './client/retrying_client'; +import { RC_COMPONENT_NAME } from './constants'; +import { ErrorCode, ERROR_FACTORY } from './errors'; +import { RemoteConfig as RemoteConfigImpl } from './remote_config'; +import { Storage } from './storage/storage'; +import { StorageCache } from './storage/storage_cache'; + +export function registerRemoteConfig(): void { + _registerComponent( + new Component( + RC_COMPONENT_NAME, + remoteConfigFactory, + ComponentType.PUBLIC + ).setMultipleInstances(true) + ); + + registerVersion(packageName, version); + + function remoteConfigFactory( + container: ComponentContainer, + namespace?: string + ): RemoteConfig { + /* Dependencies */ + // getImmediate for FirebaseApp will always succeed + const app = container.getProvider('app-exp').getImmediate(); + // The following call will always succeed because rc has `import '@firebase/installations'` + const installations = container + .getProvider('installations-exp-internal') + .getImmediate(); + + // Guards against the SDK being used in non-browser environments. + if (typeof window === 'undefined') { + throw ERROR_FACTORY.create(ErrorCode.REGISTRATION_WINDOW); + } + + // Normalizes optional inputs. + const { projectId, apiKey, appId } = app.options; + if (!projectId) { + throw ERROR_FACTORY.create(ErrorCode.REGISTRATION_PROJECT_ID); + } + if (!apiKey) { + throw ERROR_FACTORY.create(ErrorCode.REGISTRATION_API_KEY); + } + if (!appId) { + throw ERROR_FACTORY.create(ErrorCode.REGISTRATION_APP_ID); + } + namespace = namespace || 'firebase'; + + const storage = new Storage(appId, app.name, namespace); + const storageCache = new StorageCache(storage); + + const logger = new Logger(packageName); + + // Sets ERROR as the default log level. + // See RemoteConfig#setLogLevel for corresponding normalization to ERROR log level. + logger.logLevel = FirebaseLogLevel.ERROR; + + const restClient = new RestClient( + installations, + // Uses the JS SDK version, by which the RC package version can be deduced, if necessary. + SDK_VERSION, + namespace, + projectId, + apiKey, + appId + ); + const retryingClient = new RetryingClient(restClient, storage); + const cachingClient = new CachingClient( + retryingClient, + storage, + storageCache, + logger + ); + + const remoteConfigInstance = new RemoteConfigImpl( + app, + cachingClient, + storageCache, + storage, + logger + ); + + // Starts warming cache. + // eslint-disable-next-line @typescript-eslint/no-floating-promises + ensureInitialized(remoteConfigInstance); + + return remoteConfigInstance; + } +} diff --git a/packages-exp/remote-config-exp/src/remote_config.ts b/packages-exp/remote-config-exp/src/remote_config.ts new file mode 100644 index 00000000000..de7825b348b --- /dev/null +++ b/packages-exp/remote-config-exp/src/remote_config.ts @@ -0,0 +1,88 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { FirebaseApp } from '@firebase/app-types-exp'; +import { + RemoteConfig as RemoteConfigType, + FetchStatus, + Settings +} from '@firebase/remote-config-types-exp'; +import { StorageCache } from './storage/storage_cache'; +import { RemoteConfigFetchClient } from './client/remote_config_fetch_client'; +import { Storage } from './storage/storage'; +import { Logger } from '@firebase/logger'; + +const DEFAULT_FETCH_TIMEOUT_MILLIS = 60 * 1000; // One minute +const DEFAULT_CACHE_MAX_AGE_MILLIS = 12 * 60 * 60 * 1000; // Twelve hours. + +/** + * Encapsulates business logic mapping network and storage dependencies to the public SDK API. + * + * See {@link https://github.com/FirebasePrivate/firebase-js-sdk/blob/master/packages/firebase/index.d.ts|interface documentation} for method descriptions. + */ +export class RemoteConfig implements RemoteConfigType { + /** + * Tracks completion of initialization promise. + * @internal + */ + _isInitializationComplete = false; + + /** + * De-duplicates initialization calls. + * @internal + */ + _initializePromise?: Promise; + + settings: Settings = { + fetchTimeoutMillis: DEFAULT_FETCH_TIMEOUT_MILLIS, + minimumFetchIntervalMillis: DEFAULT_CACHE_MAX_AGE_MILLIS + }; + + defaultConfig: { [key: string]: string | number | boolean } = {}; + + get fetchTimeMillis(): number { + return this._storageCache.getLastSuccessfulFetchTimestampMillis() || -1; + } + + get lastFetchStatus(): FetchStatus { + return this._storageCache.getLastFetchStatus() || 'no-fetch-yet'; + } + + constructor( + // Required by FirebaseServiceFactory interface. + readonly app: FirebaseApp, + // JS doesn't support private yet + // (https://github.com/tc39/proposal-class-fields#private-fields), so we hint using an + // underscore prefix. + /** + * @internal + */ + readonly _client: RemoteConfigFetchClient, + /** + * @internal + */ + readonly _storageCache: StorageCache, + /** + * @internal + */ + readonly _storage: Storage, + /** + * @internal + */ + readonly _logger: Logger + ) {} +} diff --git a/packages-exp/remote-config-exp/src/storage/storage.ts b/packages-exp/remote-config-exp/src/storage/storage.ts new file mode 100644 index 00000000000..f5f457161b1 --- /dev/null +++ b/packages-exp/remote-config-exp/src/storage/storage.ts @@ -0,0 +1,260 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { FetchStatus } from '@firebase/remote-config-types'; +import { + FetchResponse, + FirebaseRemoteConfigObject +} from '../client/remote_config_fetch_client'; +import { ERROR_FACTORY, ErrorCode } from '../errors'; +import { FirebaseError } from '@firebase/util'; + +/** + * Converts an error event associated with a {@link IDBRequest} to a {@link FirebaseError}. + */ +function toFirebaseError(event: Event, errorCode: ErrorCode): FirebaseError { + const originalError = (event.target as IDBRequest).error || undefined; + return ERROR_FACTORY.create(errorCode, { + originalErrorMessage: originalError && originalError.message + }); +} + +/** + * A general-purpose store keyed by app + namespace + {@link + * ProjectNamespaceKeyFieldValue}. + * + *

The Remote Config SDK can be used with multiple app installations, and each app can interact + * with multiple namespaces, so this store uses app (ID + name) and namespace as common parent keys + * for a set of key-value pairs. See {@link Storage#createCompositeKey}. + * + *

Visible for testing. + */ +export const APP_NAMESPACE_STORE = 'app_namespace_store'; + +const DB_NAME = 'firebase_remote_config'; +const DB_VERSION = 1; + +/** + * Encapsulates metadata concerning throttled fetch requests. + */ +export interface ThrottleMetadata { + // The number of times fetch has backed off. Used for resuming backoff after a timeout. + backoffCount: number; + // The Unix timestamp in milliseconds when callers can retry a request. + throttleEndTimeMillis: number; +} + +/** + * Provides type-safety for the "key" field used by {@link APP_NAMESPACE_STORE}. + * + *

This seems like a small price to avoid potentially subtle bugs caused by a typo. + */ +type ProjectNamespaceKeyFieldValue = + | 'active_config' + | 'active_config_etag' + | 'last_fetch_status' + | 'last_successful_fetch_timestamp_millis' + | 'last_successful_fetch_response' + | 'settings' + | 'throttle_metadata'; + +// Visible for testing. +export function openDatabase(): Promise { + return new Promise((resolve, reject) => { + const request = indexedDB.open(DB_NAME, DB_VERSION); + request.onerror = event => { + reject(toFirebaseError(event, ErrorCode.STORAGE_OPEN)); + }; + request.onsuccess = event => { + resolve((event.target as IDBOpenDBRequest).result); + }; + request.onupgradeneeded = event => { + const db = (event.target as IDBOpenDBRequest).result; + + // We don't use 'break' in this switch statement, the fall-through + // behavior is what we want, because if there are multiple versions between + // the old version and the current version, we want ALL the migrations + // that correspond to those versions to run, not only the last one. + // eslint-disable-next-line default-case + switch (event.oldVersion) { + case 0: + db.createObjectStore(APP_NAMESPACE_STORE, { + keyPath: 'compositeKey' + }); + } + }; + }); +} + +/** + * Abstracts data persistence. + */ +export class Storage { + /** + * @param appId enables storage segmentation by app (ID + name). + * @param appName enables storage segmentation by app (ID + name). + * @param namespace enables storage segmentation by namespace. + */ + constructor( + private readonly appId: string, + private readonly appName: string, + private readonly namespace: string, + private readonly openDbPromise = openDatabase() + ) {} + + getLastFetchStatus(): Promise { + return this.get('last_fetch_status'); + } + + setLastFetchStatus(status: FetchStatus): Promise { + return this.set('last_fetch_status', status); + } + + // This is comparable to a cache entry timestamp. If we need to expire other data, we could + // consider adding timestamp to all storage records and an optional max age arg to getters. + getLastSuccessfulFetchTimestampMillis(): Promise { + return this.get('last_successful_fetch_timestamp_millis'); + } + + setLastSuccessfulFetchTimestampMillis(timestamp: number): Promise { + return this.set( + 'last_successful_fetch_timestamp_millis', + timestamp + ); + } + + getLastSuccessfulFetchResponse(): Promise { + return this.get('last_successful_fetch_response'); + } + + setLastSuccessfulFetchResponse(response: FetchResponse): Promise { + return this.set('last_successful_fetch_response', response); + } + + getActiveConfig(): Promise { + return this.get('active_config'); + } + + setActiveConfig(config: FirebaseRemoteConfigObject): Promise { + return this.set('active_config', config); + } + + getActiveConfigEtag(): Promise { + return this.get('active_config_etag'); + } + + setActiveConfigEtag(etag: string): Promise { + return this.set('active_config_etag', etag); + } + + getThrottleMetadata(): Promise { + return this.get('throttle_metadata'); + } + + setThrottleMetadata(metadata: ThrottleMetadata): Promise { + return this.set('throttle_metadata', metadata); + } + + deleteThrottleMetadata(): Promise { + return this.delete('throttle_metadata'); + } + + async get(key: ProjectNamespaceKeyFieldValue): Promise { + const db = await this.openDbPromise; + return new Promise((resolve, reject) => { + const transaction = db.transaction([APP_NAMESPACE_STORE], 'readonly'); + const objectStore = transaction.objectStore(APP_NAMESPACE_STORE); + const compositeKey = this.createCompositeKey(key); + try { + const request = objectStore.get(compositeKey); + request.onerror = event => { + reject(toFirebaseError(event, ErrorCode.STORAGE_GET)); + }; + request.onsuccess = event => { + const result = (event.target as IDBRequest).result; + if (result) { + resolve(result.value); + } else { + resolve(undefined); + } + }; + } catch (e) { + reject( + ERROR_FACTORY.create(ErrorCode.STORAGE_GET, { + originalErrorMessage: e && e.message + }) + ); + } + }); + } + + async set(key: ProjectNamespaceKeyFieldValue, value: T): Promise { + const db = await this.openDbPromise; + return new Promise((resolve, reject) => { + const transaction = db.transaction([APP_NAMESPACE_STORE], 'readwrite'); + const objectStore = transaction.objectStore(APP_NAMESPACE_STORE); + const compositeKey = this.createCompositeKey(key); + try { + const request = objectStore.put({ + compositeKey, + value + }); + request.onerror = (event: Event) => { + reject(toFirebaseError(event, ErrorCode.STORAGE_SET)); + }; + request.onsuccess = () => { + resolve(); + }; + } catch (e) { + reject( + ERROR_FACTORY.create(ErrorCode.STORAGE_SET, { + originalErrorMessage: e && e.message + }) + ); + } + }); + } + + async delete(key: ProjectNamespaceKeyFieldValue): Promise { + const db = await this.openDbPromise; + return new Promise((resolve, reject) => { + const transaction = db.transaction([APP_NAMESPACE_STORE], 'readwrite'); + const objectStore = transaction.objectStore(APP_NAMESPACE_STORE); + const compositeKey = this.createCompositeKey(key); + try { + const request = objectStore.delete(compositeKey); + request.onerror = (event: Event) => { + reject(toFirebaseError(event, ErrorCode.STORAGE_DELETE)); + }; + request.onsuccess = () => { + resolve(); + }; + } catch (e) { + reject( + ERROR_FACTORY.create(ErrorCode.STORAGE_DELETE, { + originalErrorMessage: e && e.message + }) + ); + } + }); + } + + // Facilitates composite key functionality (which is unsupported in IE). + createCompositeKey(key: ProjectNamespaceKeyFieldValue): string { + return [this.appId, this.appName, this.namespace, key].join(); + } +} diff --git a/packages-exp/remote-config-exp/src/storage/storage_cache.ts b/packages-exp/remote-config-exp/src/storage/storage_cache.ts new file mode 100644 index 00000000000..5ffbdba20c0 --- /dev/null +++ b/packages-exp/remote-config-exp/src/storage/storage_cache.ts @@ -0,0 +1,99 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { FetchStatus } from '@firebase/remote-config-types'; +import { FirebaseRemoteConfigObject } from '../client/remote_config_fetch_client'; +import { Storage } from './storage'; + +/** + * A memory cache layer over storage to support the SDK's synchronous read requirements. + */ +export class StorageCache { + constructor(private readonly storage: Storage) {} + + /** + * Memory caches. + */ + private lastFetchStatus?: FetchStatus; + private lastSuccessfulFetchTimestampMillis?: number; + private activeConfig?: FirebaseRemoteConfigObject; + + /** + * Memory-only getters + */ + getLastFetchStatus(): FetchStatus | undefined { + return this.lastFetchStatus; + } + + getLastSuccessfulFetchTimestampMillis(): number | undefined { + return this.lastSuccessfulFetchTimestampMillis; + } + + getActiveConfig(): FirebaseRemoteConfigObject | undefined { + return this.activeConfig; + } + + /** + * Read-ahead getter + */ + async loadFromStorage(): Promise { + const lastFetchStatusPromise = this.storage.getLastFetchStatus(); + const lastSuccessfulFetchTimestampMillisPromise = this.storage.getLastSuccessfulFetchTimestampMillis(); + const activeConfigPromise = this.storage.getActiveConfig(); + + // Note: + // 1. we consistently check for undefined to avoid clobbering defined values + // in memory + // 2. we defer awaiting to improve readability, as opposed to destructuring + // a Promise.all result, for example + + const lastFetchStatus = await lastFetchStatusPromise; + if (lastFetchStatus) { + this.lastFetchStatus = lastFetchStatus; + } + + const lastSuccessfulFetchTimestampMillis = await lastSuccessfulFetchTimestampMillisPromise; + if (lastSuccessfulFetchTimestampMillis) { + this.lastSuccessfulFetchTimestampMillis = lastSuccessfulFetchTimestampMillis; + } + + const activeConfig = await activeConfigPromise; + if (activeConfig) { + this.activeConfig = activeConfig; + } + } + + /** + * Write-through setters + */ + setLastFetchStatus(status: FetchStatus): Promise { + this.lastFetchStatus = status; + return this.storage.setLastFetchStatus(status); + } + + setLastSuccessfulFetchTimestampMillis( + timestampMillis: number + ): Promise { + this.lastSuccessfulFetchTimestampMillis = timestampMillis; + return this.storage.setLastSuccessfulFetchTimestampMillis(timestampMillis); + } + + setActiveConfig(activeConfig: FirebaseRemoteConfigObject): Promise { + this.activeConfig = activeConfig; + return this.storage.setActiveConfig(activeConfig); + } +} diff --git a/packages-exp/remote-config-exp/src/value.ts b/packages-exp/remote-config-exp/src/value.ts new file mode 100644 index 00000000000..f3fb6ff9581 --- /dev/null +++ b/packages-exp/remote-config-exp/src/value.ts @@ -0,0 +1,57 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { Value as ValueType, ValueSource } from '@firebase/remote-config-types'; + +const DEFAULT_VALUE_FOR_BOOLEAN = false; +const DEFAULT_VALUE_FOR_STRING = ''; +const DEFAULT_VALUE_FOR_NUMBER = 0; + +const BOOLEAN_TRUTHY_VALUES = ['1', 'true', 't', 'yes', 'y', 'on']; + +export class Value implements ValueType { + constructor( + private readonly _source: ValueSource, + private readonly _value: string = DEFAULT_VALUE_FOR_STRING + ) {} + + asString(): string { + return this._value; + } + + asBoolean(): boolean { + if (this._source === 'static') { + return DEFAULT_VALUE_FOR_BOOLEAN; + } + return BOOLEAN_TRUTHY_VALUES.indexOf(this._value.toLowerCase()) >= 0; + } + + asNumber(): number { + if (this._source === 'static') { + return DEFAULT_VALUE_FOR_NUMBER; + } + let num = Number(this._value); + if (isNaN(num)) { + num = DEFAULT_VALUE_FOR_NUMBER; + } + return num; + } + + getSource(): ValueSource { + return this._source; + } +} diff --git a/packages-exp/remote-config-exp/test/client/caching_client.test.ts b/packages-exp/remote-config-exp/test/client/caching_client.test.ts new file mode 100644 index 00000000000..a808dffb605 --- /dev/null +++ b/packages-exp/remote-config-exp/test/client/caching_client.test.ts @@ -0,0 +1,160 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import '../setup'; +import { expect } from 'chai'; +import { + RemoteConfigFetchClient, + FetchResponse, + FetchRequest, + RemoteConfigAbortSignal +} from '../../src/client/remote_config_fetch_client'; +import * as sinon from 'sinon'; +import { CachingClient } from '../../src/client/caching_client'; +import { StorageCache } from '../../src/storage/storage_cache'; +import { Storage } from '../../src/storage/storage'; +import { Logger } from '@firebase/logger'; + +const DEFAULT_REQUEST: FetchRequest = { + // Invalidates cache by default. + cacheMaxAgeMillis: 0, + signal: new RemoteConfigAbortSignal() +}; + +describe('CachingClient', () => { + const backingClient = {} as RemoteConfigFetchClient; + const storageCache = {} as StorageCache; + const logger = {} as Logger; + const storage = {} as Storage; + let cachingClient: CachingClient; + let clock: sinon.SinonFakeTimers; + + beforeEach(() => { + logger.debug = sinon.stub(); + cachingClient = new CachingClient( + backingClient, + storage, + storageCache, + logger + ); + clock = sinon.useFakeTimers({ now: 3000 }); // Mocks Date.now as 3000. + }); + + afterEach(() => { + clock.restore(); + }); + + describe('isCacheDataFresh', () => { + it('returns false if cached response is older than max age', () => { + expect( + cachingClient.isCachedDataFresh( + // Mocks a cache set when Date.now was 1000, ie it's two seconds old. + 1000, + // Tolerates a cache one second old. + 1000 + ) + ).to.be.false; + }); + + it('returns true if cached response is equal to max age', () => { + expect(cachingClient.isCachedDataFresh(2000, 1000)).to.be.true; + }); + + it('returns true if cached response is younger than max age', () => { + expect(cachingClient.isCachedDataFresh(3000, 1000)).to.be.true; + }); + }); + + describe('fetch', () => { + beforeEach(() => { + storage.getLastSuccessfulFetchTimestampMillis = sinon + .stub() + .returns(1000); // Mocks a cache set when Date.now was 1000, ie it's two seconds old. + storageCache.setLastSuccessfulFetchTimestampMillis = sinon.stub(); + storage.getLastSuccessfulFetchResponse = sinon.stub(); + storage.setLastSuccessfulFetchResponse = sinon.stub(); + backingClient.fetch = sinon.stub().returns(Promise.resolve({})); + }); + + it('exits early on cache hit', async () => { + const expectedResponse = { config: { eTag: 'etag', color: 'taupe' } }; + storage.getLastSuccessfulFetchResponse = sinon + .stub() + .returns(expectedResponse); + + const actualResponse = await cachingClient.fetch({ + cacheMaxAgeMillis: 2000, + signal: new RemoteConfigAbortSignal() + }); + + expect(actualResponse).to.deep.eq(expectedResponse); + expect(backingClient.fetch).not.to.have.been.called; + }); + + it('fetches on cache miss', async () => { + await cachingClient.fetch(DEFAULT_REQUEST); + + expect(backingClient.fetch).to.have.been.called; + }); + + it('passes etag from last successful fetch', async () => { + const lastSuccessfulFetchResponse = { eTag: 'etag' } as FetchResponse; + storage.getLastSuccessfulFetchResponse = sinon + .stub() + .returns(lastSuccessfulFetchResponse); + + await cachingClient.fetch(DEFAULT_REQUEST); + + expect(backingClient.fetch).to.have.been.calledWith( + Object.assign({}, DEFAULT_REQUEST, { + eTag: lastSuccessfulFetchResponse.eTag + }) + ); + }); + + it('caches timestamp and response if status is 200', async () => { + const response = { + status: 200, + eTag: 'etag', + config: { color: 'clear' } + }; + backingClient.fetch = sinon.stub().returns(Promise.resolve(response)); + + await cachingClient.fetch(DEFAULT_REQUEST); + + expect( + storageCache.setLastSuccessfulFetchTimestampMillis + ).to.have.been.calledWith(3000); // Based on mock timer in beforeEach. + expect(storage.setLastSuccessfulFetchResponse).to.have.been.calledWith( + response + ); + }); + + it('sets timestamp, but not config, if 304', async () => { + backingClient.fetch = sinon + .stub() + .returns(Promise.resolve({ status: 304 })); + + await cachingClient.fetch(DEFAULT_REQUEST); + + expect( + storageCache.setLastSuccessfulFetchTimestampMillis + ).to.have.been.calledWith(3000); // Based on mock timer in beforeEach. + expect(storage.setLastSuccessfulFetchResponse).not.to.have.been.called; + }); + }); +}); diff --git a/packages-exp/remote-config-exp/test/client/rest_client.test.ts b/packages-exp/remote-config-exp/test/client/rest_client.test.ts new file mode 100644 index 00000000000..89b745dacca --- /dev/null +++ b/packages-exp/remote-config-exp/test/client/rest_client.test.ts @@ -0,0 +1,270 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import '../setup'; +import { expect } from 'chai'; +import { RestClient } from '../../src/client/rest_client'; +import { FirebaseInstallations } from '@firebase/installations-types'; +import * as sinon from 'sinon'; +import { ERROR_FACTORY, ErrorCode } from '../../src/errors'; +import { FirebaseError } from '@firebase/util'; +import { + FetchRequest, + RemoteConfigAbortSignal +} from '../../src/client/remote_config_fetch_client'; + +const DEFAULT_REQUEST: FetchRequest = { + cacheMaxAgeMillis: 1, + signal: new RemoteConfigAbortSignal() +}; + +describe('RestClient', () => { + const firebaseInstallations = {} as FirebaseInstallations; + let client: RestClient; + + beforeEach(() => { + client = new RestClient( + firebaseInstallations, + 'sdk-version', + 'namespace', + 'project-id', + 'api-key', + 'app-id' + ); + firebaseInstallations.getId = sinon + .stub() + .returns(Promise.resolve('fis-id')); + firebaseInstallations.getToken = sinon + .stub() + .returns(Promise.resolve('fis-token')); + }); + + describe('fetch', () => { + let fetchStub: sinon.SinonStub< + [RequestInfo, RequestInit?], + Promise + >; + + beforeEach(() => { + fetchStub = sinon + .stub(window, 'fetch') + .returns(Promise.resolve(new Response('{}'))); + }); + + afterEach(() => { + fetchStub.restore(); + }); + + it('handles 200/UPDATE responses', async () => { + const expectedResponse = { + status: 200, + eTag: 'etag', + state: 'UPDATE', + entries: { color: 'sparkling' } + }; + + fetchStub.returns( + Promise.resolve({ + ok: true, + status: expectedResponse.status, + headers: new Headers({ ETag: expectedResponse.eTag }), + json: () => + Promise.resolve({ + entries: expectedResponse.entries, + state: expectedResponse.state + }) + } as Response) + ); + + const response = await client.fetch(DEFAULT_REQUEST); + + expect(response).to.deep.eq({ + status: expectedResponse.status, + eTag: expectedResponse.eTag, + config: expectedResponse.entries + }); + }); + + it('calls the correct endpoint', async () => { + await client.fetch(DEFAULT_REQUEST); + + expect(fetchStub).to.be.calledWith( + 'https://firebaseremoteconfig.googleapis.com/v1/projects/project-id/namespaces/namespace:fetch?key=api-key', + sinon.match.object + ); + }); + + it('passes injected params', async () => { + await client.fetch(DEFAULT_REQUEST); + + expect(fetchStub).to.be.calledWith( + sinon.match.string, + sinon.match({ + body: + '{"sdk_version":"sdk-version","app_instance_id":"fis-id","app_instance_id_token":"fis-token","app_id":"app-id","language_code":"en-US"}' + }) + ); + }); + + it('throws on network failure', async () => { + // The Fetch API throws a TypeError on network falure: + // https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch#Exceptions + const originalError = new TypeError('Network request failed'); + fetchStub.returns(Promise.reject(originalError)); + + const fetchPromise = client.fetch(DEFAULT_REQUEST); + + const firebaseError = ERROR_FACTORY.create(ErrorCode.FETCH_NETWORK, { + originalErrorMessage: originalError.message + }); + + await expect(fetchPromise) + .to.eventually.be.rejectedWith(FirebaseError, firebaseError.message) + .with.nested.property( + 'customData.originalErrorMessage', + 'Network request failed' + ); + }); + + it('throws on JSON parse failure', async () => { + // JSON parsing throws a SyntaxError on failure: + // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Exceptions + const res = new Response(/* empty body */); + sinon + .stub(res, 'json') + .throws(new SyntaxError('Unexpected end of input')); + fetchStub.returns(Promise.resolve(res)); + + const fetchPromise = client.fetch(DEFAULT_REQUEST); + + const firebaseError = ERROR_FACTORY.create(ErrorCode.FETCH_PARSE, { + originalErrorMessage: 'Unexpected end of input' + }); + + await expect(fetchPromise) + .to.eventually.be.rejectedWith(FirebaseError, firebaseError.message) + .with.nested.property( + 'customData.originalErrorMessage', + 'Unexpected end of input' + ); + }); + + it('handles 304 status code and empty body', async () => { + fetchStub.returns( + Promise.resolve({ + status: 304, + headers: new Headers({ ETag: 'response-etag' }) + } as Response) + ); + + const response = await client.fetch( + Object.assign({}, DEFAULT_REQUEST, { + eTag: 'request-etag' + }) + ); + + expect(fetchStub).to.be.calledWith( + sinon.match.string, + sinon.match({ headers: { 'If-None-Match': 'request-etag' } }) + ); + + expect(response).to.deep.eq({ + status: 304, + eTag: 'response-etag', + config: undefined + }); + }); + + it('normalizes INSTANCE_STATE_UNSPECIFIED state to server error', async () => { + fetchStub.returns( + Promise.resolve({ + status: 200, + headers: new Headers({ ETag: 'etag' }), + json: async () => ({ state: 'INSTANCE_STATE_UNSPECIFIED' }) + } as Response) + ); + + const fetchPromise = client.fetch(DEFAULT_REQUEST); + + const error = ERROR_FACTORY.create(ErrorCode.FETCH_STATUS, { + httpStatus: 500 + }); + + await expect(fetchPromise) + .to.eventually.be.rejectedWith(FirebaseError, error.message) + .with.nested.property('customData.httpStatus', 500); + }); + + it('normalizes NO_CHANGE state to 304 status', async () => { + fetchStub.returns( + Promise.resolve({ + status: 200, + headers: new Headers({ ETag: 'etag' }), + json: async () => ({ state: 'NO_CHANGE' }) + } as Response) + ); + + const response = await client.fetch(DEFAULT_REQUEST); + + expect(response).to.deep.eq({ + status: 304, + eTag: 'etag', + config: undefined + }); + }); + + it('normalizes empty change states', async () => { + for (const state of ['NO_TEMPLATE', 'EMPTY_CONFIG']) { + fetchStub.returns( + Promise.resolve({ + status: 200, + headers: new Headers({ ETag: 'etag' }), + json: async () => ({ state }) + } as Response) + ); + + await expect(client.fetch(DEFAULT_REQUEST)).to.eventually.be.deep.eq({ + status: 200, + eTag: 'etag', + config: {} + }); + } + }); + + it('throws error on HTTP error status', async () => { + // Error codes from logs plus an arbitrary unexpected code (300) + for (const status of [300, 400, 403, 404, 415, 429, 500, 503, 504]) { + fetchStub.returns( + Promise.resolve({ + status, + headers: new Headers() + } as Response) + ); + + const fetchPromise = client.fetch(DEFAULT_REQUEST); + + const error = ERROR_FACTORY.create(ErrorCode.FETCH_STATUS, { + httpStatus: status + }); + + await expect(fetchPromise) + .to.eventually.be.rejectedWith(FirebaseError, error.message) + .with.nested.property('customData.httpStatus', status); + } + }); + }); +}); diff --git a/packages-exp/remote-config-exp/test/client/retrying_client.test.ts b/packages-exp/remote-config-exp/test/client/retrying_client.test.ts new file mode 100644 index 00000000000..65641b438bd --- /dev/null +++ b/packages-exp/remote-config-exp/test/client/retrying_client.test.ts @@ -0,0 +1,218 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import { Storage, ThrottleMetadata } from '../../src/storage/storage'; +import { + RemoteConfigFetchClient, + FetchRequest, + FetchResponse, + RemoteConfigAbortSignal +} from '../../src/client/remote_config_fetch_client'; +import { + setAbortableTimeout, + RetryingClient +} from '../../src/client/retrying_client'; +import { ErrorCode, ERROR_FACTORY } from '../../src/errors'; +import '../setup'; + +const DEFAULT_REQUEST: FetchRequest = { + cacheMaxAgeMillis: 1, + signal: new RemoteConfigAbortSignal() +}; + +describe('RetryingClient', () => { + let backingClient: RemoteConfigFetchClient; + let storage: Storage; + let retryingClient: RetryingClient; + let abortSignal: RemoteConfigAbortSignal; + + beforeEach(() => { + backingClient = {} as RemoteConfigFetchClient; + storage = {} as Storage; + retryingClient = new RetryingClient(backingClient, storage); + storage.getThrottleMetadata = sinon.stub().returns(Promise.resolve()); + storage.deleteThrottleMetadata = sinon.stub().returns(Promise.resolve()); + storage.setThrottleMetadata = sinon.stub().returns(Promise.resolve()); + backingClient.fetch = sinon + .stub() + .returns(Promise.resolve({ status: 200 })); + abortSignal = new RemoteConfigAbortSignal(); + }); + + describe('setAbortableTimeout', () => { + let clock: sinon.SinonFakeTimers; + + beforeEach(() => { + // Sets Date.now() to zero. + clock = sinon.useFakeTimers(); + }); + + afterEach(() => { + clock.restore(); + }); + + it('Derives backoff from end time', async () => { + const setTimeoutSpy = sinon.spy(window, 'setTimeout'); + + const timeoutPromise = setAbortableTimeout(abortSignal, Date.now() + 1); + + // Advances mocked clock so setTimeout logic runs. + clock.runAll(); + + await timeoutPromise; + + expect(setTimeoutSpy).to.have.been.calledWith(sinon.match.any, 1); + }); + + it('Normalizes end time in the past to zero backoff', async () => { + const setTimeoutSpy = sinon.spy(window, 'setTimeout'); + + const timeoutPromise = setAbortableTimeout(abortSignal, Date.now() - 1); + + // Advances mocked clock so setTimeout logic runs. + clock.runAll(); + + await timeoutPromise; + + expect(setTimeoutSpy).to.have.been.calledWith(sinon.match.any, 0); + + setTimeoutSpy.restore(); + }); + + it('listens for abort event and rejects promise', async () => { + const throttleEndTimeMillis = 1000; + + const timeoutPromise = setAbortableTimeout( + abortSignal, + throttleEndTimeMillis + ); + + abortSignal.abort(); + + const expectedError = ERROR_FACTORY.create(ErrorCode.FETCH_THROTTLE, { + throttleEndTimeMillis + }); + + await expect(timeoutPromise).to.eventually.be.rejectedWith( + expectedError.message + ); + }); + }); + + describe('fetch', () => { + it('returns success response', async () => { + const setTimeoutSpy = sinon.spy(window, 'setTimeout'); + + const expectedResponse: FetchResponse = { + status: 200, + eTag: 'etag', + config: {} + }; + backingClient.fetch = sinon + .stub() + .returns(Promise.resolve(expectedResponse)); + + const actualResponse = retryingClient.fetch(DEFAULT_REQUEST); + + await expect(actualResponse).to.eventually.deep.eq(expectedResponse); + + // Asserts setTimeout is passed a zero delay, since throttleEndTimeMillis is set to Date.now, + // which is faked to be a constant. + expect(setTimeoutSpy).to.have.been.calledWith(sinon.match.any, 0); + + expect(storage.deleteThrottleMetadata).to.have.been.called; + + setTimeoutSpy.restore(); + }); + + it('rethrows unretriable errors rather than retrying', async () => { + const expectedError = ERROR_FACTORY.create(ErrorCode.FETCH_STATUS, { + httpStatus: 400 + }); + backingClient.fetch = sinon.stub().returns(Promise.reject(expectedError)); + + const fetchPromise = retryingClient.fetch(DEFAULT_REQUEST); + + await expect(fetchPromise).to.eventually.be.rejectedWith(expectedError); + }); + + it('retries on retriable errors', async () => { + // Configures Date.now() to advance clock from zero in 20ms increments, enabling + // tests to assert a known throttle end time and allow setTimeout to work. + const clock = sinon.useFakeTimers({ shouldAdvanceTime: true }); + + // Ensures backoff is always zero, which simplifies reasoning about timer. + const powSpy = sinon.stub(Math, 'pow').returns(0); + const randomSpy = sinon.stub(Math, 'random').returns(0.5); + + // Simulates a service call that returns errors several times before returning success. + // Error codes from logs. + const errorResponseStatuses = [429, 500, 503, 504]; + const errorResponseCount = errorResponseStatuses.length; + + backingClient.fetch = sinon.stub().callsFake(() => { + const httpStatus = errorResponseStatuses.pop(); + + if (httpStatus) { + // Triggers retry by returning a retriable status code. + const expectedError = ERROR_FACTORY.create(ErrorCode.FETCH_STATUS, { + httpStatus + }); + return Promise.reject(expectedError); + } + + // Halts retrying by returning success. + // Note backoff never terminates if the server always errors. + return Promise.resolve({ status: 200 }); + }); + + await retryingClient.fetch(DEFAULT_REQUEST); + + // Asserts throttle metadata was persisted after each error response. + for (let i = 1; i <= errorResponseCount; i++) { + expect(storage.setThrottleMetadata).to.have.been.calledWith({ + backoffCount: i, + throttleEndTimeMillis: i * 20 + }); + } + + powSpy.restore(); + randomSpy.restore(); + clock.restore(); + }); + }); + + describe('attemptFetch', () => { + it('honors metadata when initializing', async () => { + const clock = sinon.useFakeTimers({ shouldAdvanceTime: true }); + const setTimeoutSpy = sinon.spy(window, 'setTimeout'); + + const throttleMetadata = { + throttleEndTimeMillis: 123 + } as ThrottleMetadata; + + await retryingClient.attemptFetch(DEFAULT_REQUEST, throttleMetadata); + + expect(setTimeoutSpy).to.have.been.calledWith(sinon.match.any, 123); + + clock.restore(); + setTimeoutSpy.restore(); + }); + }); +}); diff --git a/packages-exp/remote-config-exp/test/errors.test.ts b/packages-exp/remote-config-exp/test/errors.test.ts new file mode 100644 index 00000000000..67d41bfa505 --- /dev/null +++ b/packages-exp/remote-config-exp/test/errors.test.ts @@ -0,0 +1,31 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { expect } from 'chai'; +import { hasErrorCode, ERROR_FACTORY, ErrorCode } from '../src/errors'; +import './setup'; + +describe('hasErrorCode', () => { + it('defaults false', () => { + const error = new Error(); + expect(hasErrorCode(error, ErrorCode.REGISTRATION_PROJECT_ID)).to.be.false; + }); + it('returns true for FirebaseError with given code', () => { + const error = ERROR_FACTORY.create(ErrorCode.REGISTRATION_PROJECT_ID); + expect(hasErrorCode(error, ErrorCode.REGISTRATION_PROJECT_ID)).to.be.true; + }); +}); diff --git a/packages-exp/remote-config-exp/test/language.test.ts b/packages-exp/remote-config-exp/test/language.test.ts new file mode 100644 index 00000000000..a92630467d4 --- /dev/null +++ b/packages-exp/remote-config-exp/test/language.test.ts @@ -0,0 +1,44 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { expect } from 'chai'; +import { getUserLanguage } from '../src/language'; +import './setup'; + +// Adapts getUserLanguage tests from packages/auth/test/utils_test.js for TypeScript. +describe('getUserLanguage', () => { + it('prioritizes navigator.languages', () => { + expect( + getUserLanguage({ + languages: ['de', 'en'], + language: 'en' + }) + ).to.eq('de'); + }); + + it('falls back to navigator.language', () => { + expect( + getUserLanguage({ + language: 'en' + } as NavigatorLanguage) + ).to.eq('en'); + }); + + it('defaults undefined', () => { + expect(getUserLanguage({} as NavigatorLanguage)).to.be.undefined; + }); +}); diff --git a/packages-exp/remote-config-exp/test/remote_config.test.ts b/packages-exp/remote-config-exp/test/remote_config.test.ts new file mode 100644 index 00000000000..128bcfff145 --- /dev/null +++ b/packages-exp/remote-config-exp/test/remote_config.test.ts @@ -0,0 +1,522 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { FirebaseApp } from '@firebase/app-types-exp'; +import { + RemoteConfig as RemoteConfigType, + LogLevel as RemoteConfigLogLevel +} from '@firebase/remote-config-types-exp'; +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import { StorageCache } from '../src/storage/storage_cache'; +import { Storage } from '../src/storage/storage'; +import { RemoteConfig } from '../src/remote_config'; +import { + RemoteConfigFetchClient, + FetchResponse +} from '../src/client/remote_config_fetch_client'; +import { Value } from '../src/value'; +import './setup'; +import { ERROR_FACTORY, ErrorCode } from '../src/errors'; +import { Logger, LogLevel as FirebaseLogLevel } from '@firebase/logger'; +import { + activate, + ensureInitialized, + getAll, + getBoolean, + getNumber, + getString, + getValue, + setLogLevel, + fetchConfig +} from '../src/api'; +import * as api from '../src/api'; +import { fetchAndActivate } from '../src'; +import { restore } from 'sinon'; + +describe('RemoteConfig', () => { + const ACTIVE_CONFIG = { + key1: 'active_config_value_1', + key2: 'active_config_value_2', + key3: 'true', + key4: '123' + }; + const DEFAULT_CONFIG = { + key1: 'default_config_value_1', + key2: 'default_config_value_2', + key3: 'false', + key4: '345', + test: 'test' + }; + + let app: FirebaseApp; + let client: RemoteConfigFetchClient; + let storageCache: StorageCache; + let storage: Storage; + let logger: Logger; + let rc: RemoteConfigType; + + let getActiveConfigStub: sinon.SinonStub; + let loggerDebugSpy: sinon.SinonSpy; + let loggerLogLevelSpy: any; + + beforeEach(() => { + // Clears stubbed behavior between each test. + app = {} as FirebaseApp; + client = {} as RemoteConfigFetchClient; + storageCache = {} as StorageCache; + storage = {} as Storage; + logger = new Logger('package-name'); + getActiveConfigStub = sinon.stub().returns(undefined); + storageCache.getActiveConfig = getActiveConfigStub; + loggerDebugSpy = sinon.spy(logger, 'debug'); + loggerLogLevelSpy = sinon.spy(logger, 'logLevel', ['set']); + rc = new RemoteConfig(app, client, storageCache, storage, logger); + }); + + afterEach(() => { + loggerDebugSpy.restore(); + loggerLogLevelSpy.restore(); + }); + + // Adapts getUserLanguage tests from packages/auth/test/utils_test.js for TypeScript. + describe('setLogLevel', () => { + it('proxies to the FirebaseLogger instance', () => { + setLogLevel(rc, 'debug'); + + // Casts spy to any because property setters aren't defined on the SinonSpy type. + expect(loggerLogLevelSpy.set).to.have.been.calledWith( + FirebaseLogLevel.DEBUG + ); + }); + + it('normalizes levels other than DEBUG and SILENT to ERROR', () => { + for (const logLevel of ['info', 'verbose', 'error', 'severe']) { + setLogLevel(rc, logLevel as RemoteConfigLogLevel); + + // Casts spy to any because property setters aren't defined on the SinonSpy type. + expect(loggerLogLevelSpy.set).to.have.been.calledWith( + FirebaseLogLevel.ERROR + ); + } + }); + }); + + describe('ensureInitialized', () => { + it('warms cache', async () => { + storageCache.loadFromStorage = sinon.stub().returns(Promise.resolve()); + + await ensureInitialized(rc); + + expect(storageCache.loadFromStorage).to.have.been.calledOnce; + }); + + it('de-duplicates repeated calls', async () => { + storageCache.loadFromStorage = sinon.stub().returns(Promise.resolve()); + + await ensureInitialized(rc); + await ensureInitialized(rc); + + expect(storageCache.loadFromStorage).to.have.been.calledOnce; + }); + }); + + describe('fetchTimeMillis', () => { + it('normalizes undefined values', async () => { + storageCache.getLastSuccessfulFetchTimestampMillis = sinon + .stub() + .returns(undefined); + + expect(rc.fetchTimeMillis).to.eq(-1); + }); + + it('reads from cache', async () => { + const lastFetchTimeMillis = 123; + + storageCache.getLastSuccessfulFetchTimestampMillis = sinon + .stub() + .returns(lastFetchTimeMillis); + + expect(rc.fetchTimeMillis).to.eq(lastFetchTimeMillis); + }); + }); + + describe('lastFetchStatus', () => { + it('normalizes undefined values', async () => { + storageCache.getLastFetchStatus = sinon.stub().returns(undefined); + + expect(rc.lastFetchStatus).to.eq('no-fetch-yet'); + }); + + it('reads from cache', async () => { + const lastFetchStatus = 'success'; + + storageCache.getLastFetchStatus = sinon.stub().returns(lastFetchStatus); + + expect(rc.lastFetchStatus).to.eq(lastFetchStatus); + }); + }); + + describe('getValue', () => { + it('returns the active value if available', () => { + getActiveConfigStub.returns(ACTIVE_CONFIG); + rc.defaultConfig = DEFAULT_CONFIG; + + expect(getValue(rc, 'key1')).to.deep.eq( + new Value('remote', ACTIVE_CONFIG.key1) + ); + }); + + it('returns the default value if active is not available', () => { + rc.defaultConfig = DEFAULT_CONFIG; + + expect(getValue(rc, 'key1')).to.deep.eq( + new Value('default', DEFAULT_CONFIG.key1) + ); + }); + + it('returns the stringified default boolean values if active is not available', () => { + const DEFAULTS = { trueVal: true, falseVal: false }; + rc.defaultConfig = DEFAULTS; + + expect(getValue(rc, 'trueVal')).to.deep.eq( + new Value('default', String(DEFAULTS.trueVal)) + ); + expect(getValue(rc, 'falseVal')).to.deep.eq( + new Value('default', String(DEFAULTS.falseVal)) + ); + }); + + it('returns the stringified default numeric values if active is not available', () => { + const DEFAULTS = { negative: -1, zero: 0, positive: 11 }; + rc.defaultConfig = DEFAULTS; + + expect(getValue(rc, 'negative')).to.deep.eq( + new Value('default', String(DEFAULTS.negative)) + ); + expect(getValue(rc, 'zero')).to.deep.eq( + new Value('default', String(DEFAULTS.zero)) + ); + expect(getValue(rc, 'positive')).to.deep.eq( + new Value('default', String(DEFAULTS.positive)) + ); + }); + + it('returns the static value if active and default are not available', () => { + expect(getValue(rc, 'key1')).to.deep.eq(new Value('static')); + + // Asserts debug message logged if static value is returned, per EAP feedback. + expect(logger.debug).to.have.been.called; + }); + + it('logs if initialization is incomplete', async () => { + // Defines default value to isolate initialization logging from static value logging. + rc.defaultConfig = { key1: 'val' }; + + // Gets value before initialization. + getValue(rc, 'key1'); + + // Asserts getValue logs. + expect(logger.debug).to.have.been.called; + + // Enables initialization to complete. + storageCache.loadFromStorage = sinon.stub().returns(Promise.resolve()); + + // Ensures initialization completes. + await ensureInitialized(rc); + + // Gets value after initialization. + getValue(rc, 'key1'); + + // Asserts getValue doesn't log after initialization is complete. + expect(logger.debug).to.have.been.calledOnce; + }); + }); + + describe('getBoolean', () => { + it('returns the active value if available', () => { + getActiveConfigStub.returns(ACTIVE_CONFIG); + rc.defaultConfig = DEFAULT_CONFIG; + + expect(getBoolean(rc, 'key3')).to.be.true; + }); + + it('returns the default value if active is not available', () => { + rc.defaultConfig = DEFAULT_CONFIG; + + expect(getBoolean(rc, 'key3')).to.be.false; + }); + + it('returns the static value if active and default are not available', () => { + expect(getBoolean(rc, 'key3')).to.be.false; + }); + }); + + describe('getString', () => { + it('returns the active value if available', () => { + getActiveConfigStub.returns(ACTIVE_CONFIG); + rc.defaultConfig = DEFAULT_CONFIG; + + expect(getString(rc, 'key1')).to.eq(ACTIVE_CONFIG.key1); + }); + + it('returns the default value if active is not available', () => { + rc.defaultConfig = DEFAULT_CONFIG; + + expect(getString(rc, 'key2')).to.eq(DEFAULT_CONFIG.key2); + }); + + it('returns the static value if active and default are not available', () => { + expect(getString(rc, 'key1')).to.eq(''); + }); + }); + + describe('getNumber', () => { + it('returns the active value if available', () => { + getActiveConfigStub.returns(ACTIVE_CONFIG); + rc.defaultConfig = DEFAULT_CONFIG; + + expect(getNumber(rc, 'key4')).to.eq(Number(ACTIVE_CONFIG.key4)); + }); + + it('returns the default value if active is not available', () => { + rc.defaultConfig = DEFAULT_CONFIG; + + expect(getNumber(rc, 'key4')).to.eq(Number(DEFAULT_CONFIG.key4)); + }); + + it('returns the static value if active and default are not available', () => { + expect(getNumber(rc, 'key1')).to.eq(0); + }); + }); + + describe('getAll', () => { + it('returns values for all keys included in active and default configs', () => { + getActiveConfigStub.returns(ACTIVE_CONFIG); + rc.defaultConfig = DEFAULT_CONFIG; + + expect(getAll(rc)).to.deep.eq({ + key1: new Value('remote', ACTIVE_CONFIG.key1), + key2: new Value('remote', ACTIVE_CONFIG.key2), + key3: new Value('remote', ACTIVE_CONFIG.key3), + key4: new Value('remote', ACTIVE_CONFIG.key4), + test: new Value('default', DEFAULT_CONFIG.test) + }); + }); + + it('returns values in default if active is not available', () => { + rc.defaultConfig = DEFAULT_CONFIG; + + expect(getAll(rc)).to.deep.eq({ + key1: new Value('default', DEFAULT_CONFIG.key1), + key2: new Value('default', DEFAULT_CONFIG.key2), + key3: new Value('default', DEFAULT_CONFIG.key3), + key4: new Value('default', DEFAULT_CONFIG.key4), + test: new Value('default', DEFAULT_CONFIG.test) + }); + }); + + it('returns empty object if both active and default configs are not defined', () => { + expect(getAll(rc)).to.deep.eq({}); + }); + }); + + describe('activate', () => { + const ETAG = 'etag'; + const CONFIG = { key: 'val' }; + const NEW_ETAG = 'new_etag'; + + let getLastSuccessfulFetchResponseStub: sinon.SinonStub; + let getActiveConfigEtagStub: sinon.SinonStub; + let setActiveConfigEtagStub: sinon.SinonStub; + let setActiveConfigStub: sinon.SinonStub; + + beforeEach(() => { + getLastSuccessfulFetchResponseStub = sinon.stub(); + getActiveConfigEtagStub = sinon.stub(); + setActiveConfigEtagStub = sinon.stub(); + setActiveConfigStub = sinon.stub(); + + storage.getLastSuccessfulFetchResponse = getLastSuccessfulFetchResponseStub; + storage.getActiveConfigEtag = getActiveConfigEtagStub; + storage.setActiveConfigEtag = setActiveConfigEtagStub; + storageCache.setActiveConfig = setActiveConfigStub; + }); + + it('does not activate if last successful fetch response is undefined', async () => { + getLastSuccessfulFetchResponseStub.returns(Promise.resolve()); + getActiveConfigEtagStub.returns(Promise.resolve(ETAG)); + + const activateResponse = await activate(rc); + + expect(activateResponse).to.be.false; + expect(storage.setActiveConfigEtag).to.not.have.been.called; + expect(storageCache.setActiveConfig).to.not.have.been.called; + }); + + it('does not activate if fetched and active etags are the same', async () => { + getLastSuccessfulFetchResponseStub.returns( + Promise.resolve({ config: {}, etag: ETAG }) + ); + getActiveConfigEtagStub.returns(Promise.resolve(ETAG)); + + const activateResponse = await activate(rc); + + expect(activateResponse).to.be.false; + expect(storage.setActiveConfigEtag).to.not.have.been.called; + expect(storageCache.setActiveConfig).to.not.have.been.called; + }); + + it('activates if fetched and active etags are different', async () => { + getLastSuccessfulFetchResponseStub.returns( + Promise.resolve({ config: CONFIG, eTag: NEW_ETAG }) + ); + getActiveConfigEtagStub.returns(Promise.resolve(ETAG)); + + const activateResponse = await activate(rc); + + expect(activateResponse).to.be.true; + expect(storage.setActiveConfigEtag).to.have.been.calledWith(NEW_ETAG); + expect(storageCache.setActiveConfig).to.have.been.calledWith(CONFIG); + }); + + it('activates if fetched is defined but active config is not', async () => { + getLastSuccessfulFetchResponseStub.returns( + Promise.resolve({ config: CONFIG, eTag: NEW_ETAG }) + ); + getActiveConfigEtagStub.returns(Promise.resolve()); + + const activateResponse = await activate(rc); + + expect(activateResponse).to.be.true; + expect(storage.setActiveConfigEtag).to.have.been.calledWith(NEW_ETAG); + expect(storageCache.setActiveConfig).to.have.been.calledWith(CONFIG); + }); + }); + + describe('fetchAndActivate', () => { + let rcActivateStub: sinon.SinonStub<[RemoteConfigType], Promise>; + + beforeEach(() => { + sinon.stub(api, 'fetchConfig').returns(Promise.resolve()); + rcActivateStub = sinon.stub(api, 'activate'); + }); + + afterEach(() => restore()); + + it('calls fetch and activate and returns activation boolean if true', async () => { + rcActivateStub.returns(Promise.resolve(true)); + + const response = await fetchAndActivate(rc); + + expect(response).to.be.true; + expect(api.fetchConfig).to.have.been.calledWith(rc); + expect(api.activate).to.have.been.calledWith(rc); + }); + + it('calls fetch and activate and returns activation boolean if false', async () => { + rcActivateStub.returns(Promise.resolve(false)); + + const response = await fetchAndActivate(rc); + + expect(response).to.be.false; + expect(api.fetchConfig).to.have.been.calledWith(rc); + expect(api.activate).to.have.been.calledWith(rc); + }); + }); + + describe('fetch', () => { + let timeoutStub: sinon.SinonStub<[ + (...args: any[]) => void, + number, + ...any[] + ]>; + beforeEach(() => { + client.fetch = sinon + .stub() + .returns(Promise.resolve({ status: 200 } as FetchResponse)); + storageCache.setLastFetchStatus = sinon.stub(); + timeoutStub = sinon.stub(window, 'setTimeout'); + }); + + afterEach(() => { + timeoutStub.restore(); + }); + + it('defines a default timeout', async () => { + await fetchConfig(rc); + + expect(timeoutStub).to.have.been.calledWith(sinon.match.any, 60000); + }); + + it('honors a custom timeout', async () => { + rc.settings.fetchTimeoutMillis = 1000; + + await fetchConfig(rc); + + expect(timeoutStub).to.have.been.calledWith(sinon.match.any, 1000); + }); + + it('sets success status', async () => { + for (const status of [200, 304]) { + client.fetch = sinon + .stub() + .returns(Promise.resolve({ status } as FetchResponse)); + + await fetchConfig(rc); + + expect(storageCache.setLastFetchStatus).to.have.been.calledWith( + 'success' + ); + } + }); + + it('sets throttle status', async () => { + storage.getThrottleMetadata = sinon.stub().returns(Promise.resolve({})); + + const error = ERROR_FACTORY.create(ErrorCode.FETCH_THROTTLE, { + throttleEndTimeMillis: 123 + }); + + client.fetch = sinon.stub().returns(Promise.reject(error)); + + const fetchPromise = fetchConfig(rc); + + await expect(fetchPromise).to.eventually.be.rejectedWith(error); + expect(storageCache.setLastFetchStatus).to.have.been.calledWith( + 'throttle' + ); + }); + + it('defaults to failure status', async () => { + storage.getThrottleMetadata = sinon.stub().returns(Promise.resolve()); + + const error = ERROR_FACTORY.create(ErrorCode.FETCH_STATUS, { + httpStatus: 400 + }); + + client.fetch = sinon.stub().returns(Promise.reject(error)); + + const fetchPromise = fetchConfig(rc); + + await expect(fetchPromise).to.eventually.be.rejectedWith(error); + expect(storageCache.setLastFetchStatus).to.have.been.calledWith( + 'failure' + ); + }); + }); +}); diff --git a/packages-exp/remote-config-exp/test/setup.ts b/packages-exp/remote-config-exp/test/setup.ts new file mode 100644 index 00000000000..90d154f1400 --- /dev/null +++ b/packages-exp/remote-config-exp/test/setup.ts @@ -0,0 +1,26 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { use } from 'chai'; +import * as sinonChai from 'sinon-chai'; +import * as chaiAsPromised from 'chai-as-promised'; + +// Normalizes Sinon assertions to Chai syntax. +use(sinonChai); + +// Adds Promise-friendly syntax to Chai. +use(chaiAsPromised); diff --git a/packages-exp/remote-config-exp/test/storage/storage.test.ts b/packages-exp/remote-config-exp/test/storage/storage.test.ts new file mode 100644 index 00000000000..4543b574094 --- /dev/null +++ b/packages-exp/remote-config-exp/test/storage/storage.test.ts @@ -0,0 +1,119 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import '../setup'; +import { expect } from 'chai'; +import { + Storage, + ThrottleMetadata, + openDatabase, + APP_NAMESPACE_STORE +} from '../../src/storage/storage'; +import { FetchResponse } from '../../src/client/remote_config_fetch_client'; + +// Clears global IndexedDB state. +async function clearDatabase(): Promise { + const db = await openDatabase(); + db.transaction([APP_NAMESPACE_STORE], 'readwrite') + .objectStore(APP_NAMESPACE_STORE) + .clear(); +} + +describe('Storage', () => { + const storage = new Storage('appId', 'appName', 'namespace'); + + beforeEach(async () => { + await clearDatabase(); + }); + + it('constructs a composite key', async () => { + // This is defensive, but the cost of accidentally changing the key composition is high. + expect(storage.createCompositeKey('throttle_metadata')).to.eq( + 'appId,appName,namespace,throttle_metadata' + ); + }); + + it('sets and gets last fetch attempt status', async () => { + const expectedStatus = 'success'; + + await storage.setLastFetchStatus(expectedStatus); + + const actualStatus = await storage.getLastFetchStatus(); + + expect(actualStatus).to.deep.eq(expectedStatus); + }); + + it('sets and gets last fetch success timestamp', async () => { + const lastSuccessfulFetchTimestampMillis = 123; + + await storage.setLastSuccessfulFetchTimestampMillis( + lastSuccessfulFetchTimestampMillis + ); + + const actualMetadata = await storage.getLastSuccessfulFetchTimestampMillis(); + + expect(actualMetadata).to.deep.eq(lastSuccessfulFetchTimestampMillis); + }); + + it('sets and gets last successful fetch response', async () => { + const lastSuccessfulFetchResponse = { status: 200 } as FetchResponse; + + await storage.setLastSuccessfulFetchResponse(lastSuccessfulFetchResponse); + + const actualConfig = await storage.getLastSuccessfulFetchResponse(); + + expect(actualConfig).to.deep.eq(lastSuccessfulFetchResponse); + }); + + it('sets and gets active config', async () => { + const expectedConfig = { key: 'value' }; + + await storage.setActiveConfig(expectedConfig); + + const storedConfig = await storage.getActiveConfig(); + + expect(storedConfig).to.deep.eq(expectedConfig); + }); + + it('sets and gets active config etag', async () => { + const expectedEtag = 'etag'; + + await storage.setActiveConfigEtag(expectedEtag); + + const storedConfigEtag = await storage.getActiveConfigEtag(); + + expect(storedConfigEtag).to.deep.eq(expectedEtag); + }); + + it('sets, gets and deletes throttle metadata', async () => { + const expectedMetadata = { + throttleEndTimeMillis: 1 + } as ThrottleMetadata; + + await storage.setThrottleMetadata(expectedMetadata); + + let actualMetadata = await storage.getThrottleMetadata(); + + expect(actualMetadata).to.deep.eq(expectedMetadata); + + await storage.deleteThrottleMetadata(); + + actualMetadata = await storage.getThrottleMetadata(); + + expect(actualMetadata).to.be.undefined; + }); +}); diff --git a/packages-exp/remote-config-exp/test/storage/storage_cache.test.ts b/packages-exp/remote-config-exp/test/storage/storage_cache.test.ts new file mode 100644 index 00000000000..e7cfb0ef0da --- /dev/null +++ b/packages-exp/remote-config-exp/test/storage/storage_cache.test.ts @@ -0,0 +1,84 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import '../setup'; +import { expect } from 'chai'; +import * as sinon from 'sinon'; +import { Storage } from '../../src/storage/storage'; +import { StorageCache } from '../../src/storage/storage_cache'; + +describe('StorageCache', () => { + const storage = {} as Storage; + let storageCache: StorageCache; + + beforeEach(() => { + storageCache = new StorageCache(storage); + }); + + /** + * Read-ahead getter. + */ + describe('loadFromStorage', () => { + it('populates memory cache with persisted data', async () => { + const status = 'success'; + const lastSuccessfulFetchTimestampMillis = 123; + const activeConfig = { key: 'value' }; + + storage.getLastFetchStatus = sinon + .stub() + .returns(Promise.resolve(status)); + storage.getLastSuccessfulFetchTimestampMillis = sinon + .stub() + .returns(Promise.resolve(lastSuccessfulFetchTimestampMillis)); + storage.getActiveConfig = sinon + .stub() + .returns(Promise.resolve(activeConfig)); + + await storageCache.loadFromStorage(); + + expect(storage.getLastFetchStatus).to.have.been.called; + expect(storage.getLastSuccessfulFetchTimestampMillis).to.have.been.called; + expect(storage.getActiveConfig).to.have.been.called; + + expect(storageCache.getLastFetchStatus()).to.eq(status); + expect(storageCache.getLastSuccessfulFetchTimestampMillis()).to.deep.eq( + lastSuccessfulFetchTimestampMillis + ); + expect(storageCache.getActiveConfig()).to.deep.eq(activeConfig); + }); + }); + + describe('setActiveConfig', () => { + const activeConfig = { key: 'value2' }; + + beforeEach(() => { + storage.setActiveConfig = sinon.stub().returns(Promise.resolve()); + }); + + it('writes to memory cache', async () => { + await storageCache.setActiveConfig(activeConfig); + + expect(storageCache.getActiveConfig()).to.deep.eq(activeConfig); + }); + + it('writes to persistent storage', async () => { + await storageCache.setActiveConfig(activeConfig); + + expect(storage.setActiveConfig).to.have.been.calledWith(activeConfig); + }); + }); +}); diff --git a/packages-exp/remote-config-exp/test/value.test.ts b/packages-exp/remote-config-exp/test/value.test.ts new file mode 100644 index 00000000000..ead90ce25cf --- /dev/null +++ b/packages-exp/remote-config-exp/test/value.test.ts @@ -0,0 +1,78 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import './setup'; +import { expect } from 'chai'; +import { Value } from '../src/value'; + +describe('Value', () => { + describe('asString', () => { + it('returns static default string if source is static', () => { + expect(new Value('static').asString()).to.eq(''); + }); + + it('returns the value as a string', () => { + const VALUE = 'test'; + const value = new Value('remote', VALUE); + + expect(value.asString()).to.eq(VALUE); + }); + }); + + describe('asBoolean', () => { + it('returns static default boolean if source is static', () => { + expect(new Value('static').asBoolean()).to.be.false; + }); + + it('returns true for a truthy values', () => { + expect(new Value('remote', '1').asBoolean()).to.be.true; + expect(new Value('remote', 'true').asBoolean()).to.be.true; + expect(new Value('remote', 't').asBoolean()).to.be.true; + expect(new Value('remote', 'yes').asBoolean()).to.be.true; + expect(new Value('remote', 'y').asBoolean()).to.be.true; + expect(new Value('remote', 'on').asBoolean()).to.be.true; + }); + + it('returns false for non-truthy values', () => { + expect(new Value('remote', '').asBoolean()).to.be.false; + expect(new Value('remote', 'false').asBoolean()).to.be.false; + expect(new Value('remote', 'random string').asBoolean()).to.be.false; + }); + }); + + describe('asNumber', () => { + it('returns static default number if source is static', () => { + expect(new Value('static').asNumber()).to.eq(0); + }); + + it('returns value as a number', () => { + expect(new Value('default', '33').asNumber()).to.eq(33); + expect(new Value('default', 'not a number').asNumber()).to.eq(0); + expect(new Value('default', '-10').asNumber()).to.eq(-10); + expect(new Value('default', '0').asNumber()).to.eq(0); + expect(new Value('default', '5.3').asNumber()).to.eq(5.3); + }); + }); + + describe('getSource', () => { + it('returns the source of the value', () => { + expect(new Value('default', 'test').getSource()).to.eq('default'); + expect(new Value('remote', 'test').getSource()).to.eq('remote'); + expect(new Value('static').getSource()).to.eq('static'); + }); + }); +}); diff --git a/packages-exp/remote-config-exp/test_app/index.html b/packages-exp/remote-config-exp/test_app/index.html new file mode 100644 index 00000000000..8bf6a0c888c --- /dev/null +++ b/packages-exp/remote-config-exp/test_app/index.html @@ -0,0 +1,154 @@ + + + + + Test App + + + + + +

+

Remote Config Test App

+
+
+
+
Firebase config
+
+ +
+
+
RC defaults
+
+ +
+
+
RC settings
+
+ +
+
+
Log level
+
+ +
+
+
+
+
Controls
+
+ + + + +
+
+
+
Value getters
+
+
+ key: + +
+ + + + +
+
+
+
General getters
+
+ + + + +
+
+
+
+
Output
+
+
+
+
+
+
+ + + diff --git a/packages-exp/remote-config-exp/test_app/index.js b/packages-exp/remote-config-exp/test_app/index.js new file mode 100644 index 00000000000..d38847d9f37 --- /dev/null +++ b/packages-exp/remote-config-exp/test_app/index.js @@ -0,0 +1,224 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +const FB_CONFIG_PLACEHOLDER = `{ + apiKey: ..., + authDomain: ..., + databaseURL: ..., + projectId: ..., + storageBucket: ..., + messagingSenderId: ..., + appId: ... +}`; +const DEFAULTS_PLACEHOLDER = `{ + key1: 'value1', + key2: 'value2', + ... +}`; +const SETTINGS_PLACEHOLDER = `{ + minimumFetchIntervalMillis: 43200000, + fetchTimeoutMillis: 5000 +}`; +const SUCCESS_MESSAGE = 'Done ✔'; + +let remoteConfig; +const outputBox = document.getElementById('output-box'); + +window.onload = function () { + document.querySelector( + '#firebase-config' + ).placeholder = FB_CONFIG_PLACEHOLDER; + document.querySelector('#rc-defaults').placeholder = DEFAULTS_PLACEHOLDER; + document.querySelector('#rc-settings').placeholder = SETTINGS_PLACEHOLDER; +}; + +function initializeFirebase() { + const val = document.querySelector('#firebase-config').value; + firebase.initializeApp(parseObjFromStr(val)); + remoteConfig = firebase.remoteConfig(); + return Promise.resolve(); +} + +function setDefaults() { + remoteConfig.defaultConfig = parseObjFromStr( + document.querySelector('#rc-defaults').value + ); + return SUCCESS_MESSAGE; +} + +function setSettings() { + const newSettings = parseObjFromStr( + document.querySelector('#rc-settings').value, + true + ); + const currentSettings = remoteConfig.settings; + remoteConfig.settings = Object.assign({}, currentSettings, newSettings); + return SUCCESS_MESSAGE; +} + +function setLogLevel() { + const newLogLevel = document.querySelector('#log-level-input').value; + remoteConfig.setLogLevel(newLogLevel); + return SUCCESS_MESSAGE; +} + +function activate() { + return remoteConfig.activate(); +} + +function ensureInitialized() { + return remoteConfig.ensureInitialized(); +} + +// Prefixed to avoid clobbering the browser's fetch function. +function rcFetch() { + return remoteConfig.fetch(); +} + +function fetchAndActivate() { + return remoteConfig.fetchAndActivate(); +} + +function getString() { + return remoteConfig.getString(getKey()); +} + +function getBoolean() { + return remoteConfig.getBoolean(getKey()); +} + +function getNumber() { + return remoteConfig.getNumber(getKey()); +} + +function getValue() { + return remoteConfig.getValue(getKey()); +} + +function getAll() { + return remoteConfig.getAll(); +} + +function getFetchTimeMillis() { + return remoteConfig.fetchTimeMillis; +} + +function getLastFetchStatus() { + return remoteConfig.lastFetchStatus; +} + +function getSettings() { + return remoteConfig.settings; +} + +// Helper functions +function getKey() { + return document.querySelector('#key-input').value; +} + +function handlerWrapper(handler) { + try { + clearOutput(); + var returnValue = handler(); + if (returnValue instanceof Promise) { + handlePromise(returnValue); + } else if (returnValue instanceof Array) { + handleArray(returnValue); + } else if (returnValue instanceof Object) { + handleObject(returnValue); + } else { + displayOutput(returnValue); + } + } catch (error) { + displayOutputError(error); + } +} + +function clearOutput() { + outputBox.innerHTML = ''; +} + +function appendOutput(text) { + outputBox.innerHTML = outputBox.innerHTML + text; +} + +function displayOutput(text) { + outputBox.innerHTML = text; +} + +function displayOutputError(error) { + outputBox.innerHTML = `${error.message || error}`; +} + +function handlePromise(prom) { + const timerId = setInterval(() => appendOutput('.'), 400); + prom + .then(res => { + clearInterval(timerId); + appendOutput(SUCCESS_MESSAGE); + if (res != undefined) { + appendOutput('
'); + appendOutput('return value: ' + res); + } + }) + .catch(e => { + clearInterval(timerId); + appendOutput(`${e}`); + }); +} + +function handleArray(ar) { + displayOutput(ar.toString()); +} + +function handleObject(obj) { + appendOutput('{'); + for (const key in obj) { + if (obj[key] instanceof Function) { + appendOutput(`
${key}: ${obj[key]()},`); + } else if (obj[key] instanceof Object) { + appendOutput(key + ': '); + handleObject(obj[key]); + appendOutput(','); + } else { + appendOutput(`
${key}: ${obj[key]},`); + } + } + appendOutput('
}'); +} + +/** + * Parses string received from input elements into objects. These strings are not JSON + * compatible. + */ +function parseObjFromStr(str, valueIsNumber = false) { + const obj = {}; + str + .substring(str.indexOf('{') + 1, str.indexOf('}')) + .replace(/["']/g, '') // Get rid of curly braces and quotes + .trim() + .split(/[,]/g) // Results in a string of key value separated by a colon + .map(str => str.trim()) + .forEach(keyValue => { + const colIndex = keyValue.indexOf(':'); + const key = keyValue.substring(0, colIndex); + const val = keyValue.substring(colIndex + 1).trim(); + const value = valueIsNumber ? Number(val) : val; + obj[key] = value; + }); + return obj; +} diff --git a/packages-exp/remote-config-exp/tsconfig.json b/packages-exp/remote-config-exp/tsconfig.json new file mode 100644 index 00000000000..a4b8678284b --- /dev/null +++ b/packages-exp/remote-config-exp/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "../../config/tsconfig.base.json", + "compilerOptions": { + "outDir": "dist", + "resolveJsonModule": true, + }, + "exclude": [ + "dist/**/*" + ] +} \ No newline at end of file diff --git a/packages-exp/remote-config-types-exp/README.md b/packages-exp/remote-config-types-exp/README.md new file mode 100644 index 00000000000..8e988de0262 --- /dev/null +++ b/packages-exp/remote-config-types-exp/README.md @@ -0,0 +1,3 @@ +# @firebase/remoteconfig-types + +**This package is not intended for direct usage, and should only be used via the officially supported [firebase](https://www.npmjs.com/package/firebase) package.** diff --git a/packages-exp/remote-config-types-exp/api-extractor.json b/packages-exp/remote-config-types-exp/api-extractor.json new file mode 100644 index 00000000000..42f37a88c4b --- /dev/null +++ b/packages-exp/remote-config-types-exp/api-extractor.json @@ -0,0 +1,5 @@ +{ + "extends": "../../config/api-extractor.json", + // Point it to your entry point d.ts file. + "mainEntryPointFilePath": "/index.d.ts" +} \ No newline at end of file diff --git a/packages-exp/remote-config-types-exp/index.d.ts b/packages-exp/remote-config-types-exp/index.d.ts new file mode 100644 index 00000000000..d0271d3e781 --- /dev/null +++ b/packages-exp/remote-config-types-exp/index.d.ts @@ -0,0 +1,120 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +export interface RemoteConfig { + /** + * Defines configuration for the Remote Config SDK. + */ + settings: Settings; + + /** + * Object containing default values for conigs. + */ + defaultConfig: { [key: string]: string | number | boolean }; + + /** + * The Unix timestamp in milliseconds of the last successful fetch, or negative one if + * the {@link RemoteConfig} instance either hasn't fetched or initialization + * is incomplete. + */ + fetchTimeMillis: number; + + /** + * The status of the last fetch attempt. + */ + lastFetchStatus: FetchStatus; +} + +/** + * Indicates the source of a value. + * + *
    + *
  • "static" indicates the value was defined by a static constant.
    • + *
  • "default" indicates the value was defined by default config.
    • + *
  • "remote" indicates the value was defined by fetched config.
    • + *
+ */ +export type ValueSource = 'static' | 'default' | 'remote'; + +/** + * Wraps a value with metadata and type-safe getters. + */ +export interface Value { + /** + * Gets the value as a boolean. + * + * The following values (case insensitive) are interpreted as true: + * "1", "true", "t", "yes", "y", "on". Other values are interpreted as false. + */ + asBoolean(): boolean; + + /** + * Gets the value as a number. Comparable to calling Number(value) || 0. + */ + asNumber(): number; + + /** + * Gets the value as a string. + */ + asString(): string; + + /** + * Gets the {@link ValueSource} for the given key. + */ + getSource(): ValueSource; +} + +/** + * Defines configuration options for the Remote Config SDK. + */ +export interface Settings { + /** + * Defines the maximum age in milliseconds of an entry in the config cache before + * it is considered stale. Defaults to 43200000 (Twelve hours). + */ + minimumFetchIntervalMillis: number; + + /** + * Defines the maximum amount of milliseconds to wait for a response when fetching + * configuration from the Remote Config server. Defaults to 60000 (One minute). + */ + fetchTimeoutMillis: number; +} + +/** + * Summarizes the outcome of the last attempt to fetch config from the Firebase Remote Config server. + * + *
    + *
  • "no-fetch-yet" indicates the {@link RemoteConfig} instance has not yet attempted + * to fetch config, or that SDK initialization is incomplete.
    • + *
  • "success" indicates the last attempt succeeded.
    • + *
  • "failure" indicates the last attempt failed.
    • + *
  • "throttle" indicates the last attempt was rate-limited.
    • + *
+ */ +export type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle'; + +/** + * Defines levels of Remote Config logging. + */ +export type LogLevel = 'debug' | 'error' | 'silent'; + +declare module '@firebase/component' { + interface NameServiceMapping { + 'remote-config-exp': RemoteConfig; + } +} diff --git a/packages-exp/remote-config-types-exp/package.json b/packages-exp/remote-config-types-exp/package.json new file mode 100644 index 00000000000..62de11f27d3 --- /dev/null +++ b/packages-exp/remote-config-types-exp/package.json @@ -0,0 +1,29 @@ +{ + "name": "@firebase/remote-config-types-exp", + "version": "0.0.800", + "description": "@firebase/remote-config Types", + "author": "Firebase (https://firebase.google.com/)", + "license": "Apache-2.0", + "scripts": { + "test": "tsc", + "test:ci": "node ../../scripts/run_tests_in_ci.js", + "api-report": "api-extractor run --local --verbose", + "predoc": "node ../../scripts/exp/remove-exp.js temp", + "doc": "api-documenter markdown --input temp --output docs", + "build:doc": "yarn api-report && yarn doc" + }, + "files": [ + "index.d.ts" + ], + "repository": { + "directory": "packages/remote-config-types", + "type": "git", + "url": "https://github.com/firebase/firebase-js-sdk.git" + }, + "bugs": { + "url": "https://github.com/firebase/firebase-js-sdk/issues" + }, + "devDependencies": { + "typescript": "4.0.2" + } +} diff --git a/packages-exp/remote-config-types-exp/tsconfig.json b/packages-exp/remote-config-types-exp/tsconfig.json new file mode 100644 index 00000000000..9a785433d90 --- /dev/null +++ b/packages-exp/remote-config-types-exp/tsconfig.json @@ -0,0 +1,9 @@ +{ + "extends": "../../config/tsconfig.base.json", + "compilerOptions": { + "noEmit": true + }, + "exclude": [ + "dist/**/*" + ] +} From 7e3846b0f1286a5c17b164cf53d22b8cb14d0401 Mon Sep 17 00:00:00 2001 From: Sam Horlbeck Olsen Date: Thu, 29 Oct 2020 10:09:24 -0700 Subject: [PATCH 052/624] Remove AuthErrorCode from core export (#4013) * Remove AuthErrorCode from core export * Api --- common/api-review/auth-exp.api.md | 190 ------------------------ packages-exp/auth-exp/src/core/index.ts | 2 - 2 files changed, 192 deletions(-) diff --git a/common/api-review/auth-exp.api.md b/common/api-review/auth-exp.api.md index 23aa51decd1..c08f0b326c7 100644 --- a/common/api-review/auth-exp.api.md +++ b/common/api-review/auth-exp.api.md @@ -61,196 +61,6 @@ export class AuthCredential { toJSON(): object; } -// @public -export const enum AuthErrorCode { - // (undocumented) - ADMIN_ONLY_OPERATION = "admin-restricted-operation", - // (undocumented) - APP_NOT_AUTHORIZED = "app-not-authorized", - // (undocumented) - APP_NOT_INSTALLED = "app-not-installed", - // (undocumented) - ARGUMENT_ERROR = "argument-error", - // (undocumented) - CAPTCHA_CHECK_FAILED = "captcha-check-failed", - // (undocumented) - CODE_EXPIRED = "code-expired", - // (undocumented) - CORDOVA_NOT_READY = "cordova-not-ready", - // (undocumented) - CORS_UNSUPPORTED = "cors-unsupported", - // (undocumented) - CREDENTIAL_ALREADY_IN_USE = "credential-already-in-use", - // (undocumented) - CREDENTIAL_MISMATCH = "custom-token-mismatch", - // (undocumented) - CREDENTIAL_TOO_OLD_LOGIN_AGAIN = "requires-recent-login", - // (undocumented) - DYNAMIC_LINK_NOT_ACTIVATED = "dynamic-link-not-activated", - // (undocumented) - EMAIL_CHANGE_NEEDS_VERIFICATION = "email-change-needs-verification", - // (undocumented) - EMAIL_EXISTS = "email-already-in-use", - // (undocumented) - EMULATOR_CONFIG_FAILED = "emulator-config-failed", - // (undocumented) - EXPIRED_OOB_CODE = "expired-action-code", - // (undocumented) - EXPIRED_POPUP_REQUEST = "cancelled-popup-request", - // (undocumented) - INTERNAL_ERROR = "internal-error", - // (undocumented) - INVALID_API_KEY = "invalid-api-key", - // (undocumented) - INVALID_APP_CREDENTIAL = "invalid-app-credential", - // (undocumented) - INVALID_APP_ID = "invalid-app-id", - // (undocumented) - INVALID_AUTH = "invalid-user-token", - // (undocumented) - INVALID_AUTH_EVENT = "invalid-auth-event", - // (undocumented) - INVALID_CERT_HASH = "invalid-cert-hash", - // (undocumented) - INVALID_CODE = "invalid-verification-code", - // (undocumented) - INVALID_CONTINUE_URI = "invalid-continue-uri", - // (undocumented) - INVALID_CORDOVA_CONFIGURATION = "invalid-cordova-configuration", - // (undocumented) - INVALID_CUSTOM_TOKEN = "invalid-custom-token", - // (undocumented) - INVALID_DYNAMIC_LINK_DOMAIN = "invalid-dynamic-link-domain", - // (undocumented) - INVALID_EMAIL = "invalid-email", - // (undocumented) - INVALID_EMULATOR_SCHEME = "invalid-emulator-scheme", - // (undocumented) - INVALID_IDP_RESPONSE = "invalid-credential", - // (undocumented) - INVALID_MESSAGE_PAYLOAD = "invalid-message-payload", - // (undocumented) - INVALID_MFA_SESSION = "invalid-multi-factor-session", - // (undocumented) - INVALID_OAUTH_CLIENT_ID = "invalid-oauth-client-id", - // (undocumented) - INVALID_OAUTH_PROVIDER = "invalid-oauth-provider", - // (undocumented) - INVALID_OOB_CODE = "invalid-action-code", - // (undocumented) - INVALID_ORIGIN = "unauthorized-domain", - // (undocumented) - INVALID_PASSWORD = "wrong-password", - // (undocumented) - INVALID_PERSISTENCE = "invalid-persistence-type", - // (undocumented) - INVALID_PHONE_NUMBER = "invalid-phone-number", - // (undocumented) - INVALID_PROVIDER_ID = "invalid-provider-id", - // (undocumented) - INVALID_RECIPIENT_EMAIL = "invalid-recipient-email", - // (undocumented) - INVALID_SENDER = "invalid-sender", - // (undocumented) - INVALID_SESSION_INFO = "invalid-verification-id", - // (undocumented) - INVALID_TENANT_ID = "invalid-tenant-id", - // (undocumented) - MFA_INFO_NOT_FOUND = "multi-factor-info-not-found", - // (undocumented) - MFA_REQUIRED = "multi-factor-auth-required", - // (undocumented) - MISSING_ANDROID_PACKAGE_NAME = "missing-android-pkg-name", - // (undocumented) - MISSING_APP_CREDENTIAL = "missing-app-credential", - // (undocumented) - MISSING_AUTH_DOMAIN = "auth-domain-config-required", - // (undocumented) - MISSING_CODE = "missing-verification-code", - // (undocumented) - MISSING_CONTINUE_URI = "missing-continue-uri", - // (undocumented) - MISSING_IFRAME_START = "missing-iframe-start", - // (undocumented) - MISSING_IOS_BUNDLE_ID = "missing-ios-bundle-id", - // (undocumented) - MISSING_MFA_INFO = "missing-multi-factor-info", - // (undocumented) - MISSING_MFA_SESSION = "missing-multi-factor-session", - // (undocumented) - MISSING_OR_INVALID_NONCE = "missing-or-invalid-nonce", - // (undocumented) - MISSING_PHONE_NUMBER = "missing-phone-number", - // (undocumented) - MISSING_SESSION_INFO = "missing-verification-id", - // (undocumented) - MODULE_DESTROYED = "app-deleted", - // (undocumented) - NEED_CONFIRMATION = "account-exists-with-different-credential", - // (undocumented) - NETWORK_REQUEST_FAILED = "network-request-failed", - // (undocumented) - NO_AUTH_EVENT = "no-auth-event", - // (undocumented) - NO_SUCH_PROVIDER = "no-such-provider", - // (undocumented) - NULL_USER = "null-user", - // (undocumented) - OPERATION_NOT_ALLOWED = "operation-not-allowed", - // (undocumented) - OPERATION_NOT_SUPPORTED = "operation-not-supported-in-this-environment", - // (undocumented) - POPUP_BLOCKED = "popup-blocked", - // (undocumented) - POPUP_CLOSED_BY_USER = "popup-closed-by-user", - // (undocumented) - PROVIDER_ALREADY_LINKED = "provider-already-linked", - // (undocumented) - QUOTA_EXCEEDED = "quota-exceeded", - // (undocumented) - REDIRECT_CANCELLED_BY_USER = "redirect-cancelled-by-user", - // (undocumented) - REDIRECT_OPERATION_PENDING = "redirect-operation-pending", - // (undocumented) - REJECTED_CREDENTIAL = "rejected-credential", - // (undocumented) - SECOND_FACTOR_ALREADY_ENROLLED = "second-factor-already-in-use", - // (undocumented) - SECOND_FACTOR_LIMIT_EXCEEDED = "maximum-second-factor-count-exceeded", - // (undocumented) - TENANT_ID_MISMATCH = "tenant-id-mismatch", - // (undocumented) - TIMEOUT = "timeout", - // (undocumented) - TOKEN_EXPIRED = "user-token-expired", - // (undocumented) - TOO_MANY_ATTEMPTS_TRY_LATER = "too-many-requests", - // (undocumented) - UNAUTHORIZED_DOMAIN = "unauthorized-continue-uri", - // (undocumented) - UNSUPPORTED_FIRST_FACTOR = "unsupported-first-factor", - // (undocumented) - UNSUPPORTED_PERSISTENCE = "unsupported-persistence-type", - // (undocumented) - UNSUPPORTED_TENANT_OPERATION = "unsupported-tenant-operation", - // (undocumented) - UNVERIFIED_EMAIL = "unverified-email", - // (undocumented) - USER_CANCELLED = "user-cancelled", - // (undocumented) - USER_DELETED = "user-not-found", - // (undocumented) - USER_DISABLED = "user-disabled", - // (undocumented) - USER_MISMATCH = "user-mismatch", - // (undocumented) - USER_SIGNED_OUT = "user-signed-out", - // (undocumented) - WEAK_PASSWORD = "weak-password", - // (undocumented) - WEB_STORAGE_UNSUPPORTED = "web-storage-unsupported" -} - // @public export const browserLocalPersistence: externs.Persistence; diff --git a/packages-exp/auth-exp/src/core/index.ts b/packages-exp/auth-exp/src/core/index.ts index fdddd706ac1..f8ef50f4e94 100644 --- a/packages-exp/auth-exp/src/core/index.ts +++ b/packages-exp/auth-exp/src/core/index.ts @@ -18,8 +18,6 @@ import * as externs from '@firebase/auth-types-exp'; import { CompleteFn, ErrorFn, Unsubscribe } from '@firebase/util'; -export { AuthErrorCode } from './errors'; - // Non-optional auth methods. /** * Changes the type of persistence on the Auth instance for the currently saved From de5237f914f867286d181a349d99dbb496b52390 Mon Sep 17 00:00:00 2001 From: Dimitri Mitropoulos Date: Thu, 29 Oct 2020 13:36:10 -0400 Subject: [PATCH 053/624] adds a root changelog (#4009) * adds a root changelog * Update CHANGELOG.md Co-authored-by: Feiyang --- CHANGELOG.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000000..ec4d0166d7e --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Changelog + +You can view the changelog for the packages within this monorepo in `packages//CHANGELOG.md`. For example, you will find the changelog for the Firestore package at [`packages/firestore/CHANGELOG.md`](./packages/firestore/CHANGELOG.md). + +Additionally, you can view our official release notes for the entire monorepo at the [firebase support page](https://firebase.google.com/support/release-notes/js). From 1cdd3ab34fd5e8e3840b1754ad81f6c8305ee955 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 29 Oct 2020 11:02:57 -0700 Subject: [PATCH 054/624] Update dependency typescript to v4.0.5 (#3846) Co-authored-by: Renovate Bot --- integration/firebase/package.json | 2 +- integration/firestore/package.json | 2 +- package.json | 2 +- packages-exp/app-compat/package.json | 2 +- packages-exp/app-exp/package.json | 2 +- packages-exp/app-types-exp/package.json | 2 +- .../auth-compat-exp/demo/package.json | 2 +- packages-exp/auth-compat-exp/demo/yarn.lock | 114 +++++++++++------- packages-exp/auth-compat-exp/package.json | 2 +- packages-exp/auth-exp/package.json | 2 +- packages-exp/auth-types-exp/package.json | 2 +- packages-exp/firebase-exp/package.json | 2 +- packages-exp/functions-exp/package.json | 2 +- packages-exp/functions-types-exp/package.json | 2 +- packages-exp/installations-exp/package.json | 2 +- .../installations-types-exp/package.json | 2 +- packages-exp/performance-exp/package.json | 2 +- .../performance-types-exp/package.json | 2 +- packages-exp/remote-config-exp/package.json | 2 +- .../remote-config-types-exp/package.json | 2 +- packages/analytics-interop-types/package.json | 2 +- packages/analytics-types/package.json | 2 +- packages/analytics/package.json | 2 +- packages/app-types/package.json | 2 +- packages/app/package.json | 2 +- packages/auth-interop-types/package.json | 2 +- packages/auth-types/package.json | 2 +- packages/component/package.json | 2 +- packages/database-types/package.json | 2 +- packages/database/package.json | 2 +- packages/firebase/package.json | 2 +- packages/firestore-types/package.json | 2 +- packages/firestore/package.json | 2 +- packages/functions-types/package.json | 2 +- packages/functions/package.json | 2 +- packages/installations-types/package.json | 2 +- packages/installations/package.json | 2 +- packages/logger/package.json | 2 +- packages/messaging-types/package.json | 2 +- packages/messaging/package.json | 2 +- packages/performance-types/package.json | 2 +- packages/performance/package.json | 2 +- packages/remote-config-types/package.json | 2 +- packages/remote-config/package.json | 2 +- packages/rxfire/package.json | 2 +- packages/storage-types/package.json | 2 +- packages/storage/package.json | 2 +- packages/template-types/package.json | 2 +- packages/template/package.json | 2 +- packages/util/package.json | 2 +- packages/webchannel-wrapper/package.json | 2 +- repo-scripts/changelog-generator/package.json | 2 +- repo-scripts/size-analysis/package.json | 2 +- yarn.lock | 8 +- 54 files changed, 127 insertions(+), 99 deletions(-) diff --git a/integration/firebase/package.json b/integration/firebase/package.json index d80e095e9f7..c1ccc3fb326 100644 --- a/integration/firebase/package.json +++ b/integration/firebase/package.json @@ -21,6 +21,6 @@ "karma-typescript": "5.2.0", "mocha": "7.2.0", "npm-run-all": "4.1.5", - "typescript": "4.0.2" + "typescript": "4.0.5" } } diff --git a/integration/firestore/package.json b/integration/firestore/package.json index a9846bbe475..c1894b72c58 100644 --- a/integration/firestore/package.json +++ b/integration/firestore/package.json @@ -27,7 +27,7 @@ "karma-spec-reporter": "0.0.32", "mocha": "7.2.0", "ts-loader": "8.0.5", - "typescript": "4.0.2", + "typescript": "4.0.5", "webpack": "4.44.2", "webpack-stream": "6.1.0" } diff --git a/package.json b/package.json index 2a5043cb372..2f392684d1c 100644 --- a/package.json +++ b/package.json @@ -151,7 +151,7 @@ "ts-node": "9.0.0", "tslint": "6.1.3", "typedoc": "0.16.11", - "typescript": "4.0.2", + "typescript": "4.0.5", "watch": "1.0.2", "webpack": "4.44.2", "yargs": "16.0.3" diff --git a/packages-exp/app-compat/package.json b/packages-exp/app-compat/package.json index 3ca8c1df8e4..1fc5d2b1cc3 100644 --- a/packages-exp/app-compat/package.json +++ b/packages-exp/app-compat/package.json @@ -41,7 +41,7 @@ "@rollup/plugin-json": "4.1.0", "rollup-plugin-replace": "2.2.0", "rollup-plugin-typescript2": "0.27.3", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages-exp/app-compat", diff --git a/packages-exp/app-exp/package.json b/packages-exp/app-exp/package.json index 974913b95f6..99fd7a615d6 100644 --- a/packages-exp/app-exp/package.json +++ b/packages-exp/app-exp/package.json @@ -42,7 +42,7 @@ "@rollup/plugin-json": "4.1.0", "rollup-plugin-replace": "2.2.0", "rollup-plugin-typescript2": "0.27.3", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages-exp/app-exp", diff --git a/packages-exp/app-types-exp/package.json b/packages-exp/app-types-exp/package.json index 96eea841c5a..6486c2df78a 100644 --- a/packages-exp/app-types-exp/package.json +++ b/packages-exp/app-types-exp/package.json @@ -26,6 +26,6 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" } } diff --git a/packages-exp/auth-compat-exp/demo/package.json b/packages-exp/auth-compat-exp/demo/package.json index a7c941eebc8..8152c3b3947 100644 --- a/packages-exp/auth-compat-exp/demo/package.json +++ b/packages-exp/auth-compat-exp/demo/package.json @@ -35,7 +35,7 @@ "rollup-plugin-sourcemaps": "0.6.3", "rollup-plugin-typescript2": "0.27.3", "rollup-plugin-uglify": "6.0.4", - "typescript": "3.9.5" + "typescript": "4.0.5" }, "repository": { "directory": "packages-exp/auth-compat-exp/demo", diff --git a/packages-exp/auth-compat-exp/demo/yarn.lock b/packages-exp/auth-compat-exp/demo/yarn.lock index a81f23c4f21..6c6ab10ca95 100644 --- a/packages-exp/auth-compat-exp/demo/yarn.lock +++ b/packages-exp/auth-compat-exp/demo/yarn.lock @@ -916,7 +916,39 @@ dependencies: "@types/node" ">= 8" -"@rollup/pluginutils@^3.0.9", "@rollup/pluginutils@^3.1.0": +"@rollup/plugin-commonjs@15.1.0": + version "15.1.0" + resolved "https://registry.npmjs.org/@rollup/plugin-commonjs/-/plugin-commonjs-15.1.0.tgz#1e7d076c4f1b2abf7e65248570e555defc37c238" + integrity sha512-xCQqz4z/o0h2syQ7d9LskIMvBSH4PX5PjYdpSSvgS+pQik3WahkQVNWg3D8XJeYjZoVWnIUQYDghuEMRGrmQYQ== + dependencies: + "@rollup/pluginutils" "^3.1.0" + commondir "^1.0.1" + estree-walker "^2.0.1" + glob "^7.1.6" + is-reference "^1.2.1" + magic-string "^0.25.7" + resolve "^1.17.0" + +"@rollup/plugin-json@4.1.0": + version "4.1.0" + resolved "https://registry.npmjs.org/@rollup/plugin-json/-/plugin-json-4.1.0.tgz#54e09867ae6963c593844d8bd7a9c718294496f3" + integrity sha512-yfLbTdNS6amI/2OpmbiBoW12vngr5NW2jCJVZSBEz+H5KfUJZ2M7sDjk0U6GOOdCWFVScShte29o9NezJ53TPw== + dependencies: + "@rollup/pluginutils" "^3.0.8" + +"@rollup/plugin-node-resolve@9.0.0": + version "9.0.0" + resolved "https://registry.npmjs.org/@rollup/plugin-node-resolve/-/plugin-node-resolve-9.0.0.tgz#39bd0034ce9126b39c1699695f440b4b7d2b62e6" + integrity sha512-gPz+utFHLRrd41WMP13Jq5mqqzHL3OXrfj3/MkSyB6UBIcuNt9j60GCbarzMzdf1VHFpOxfQh/ez7wyadLMqkg== + dependencies: + "@rollup/pluginutils" "^3.1.0" + "@types/resolve" "1.17.1" + builtin-modules "^3.1.0" + deepmerge "^4.2.2" + is-module "^1.0.0" + resolve "^1.17.0" + +"@rollup/pluginutils@^3.0.8", "@rollup/pluginutils@^3.0.9", "@rollup/pluginutils@^3.1.0": version "3.1.0" resolved "https://registry.npmjs.org/@rollup/pluginutils/-/pluginutils-3.1.0.tgz#706b4524ee6dc8b103b3c995533e5ad680c02b9b" integrity sha512-GksZ6pr6TpIjHm8h9lSQ8pi8BE9VeubNT0OMJ3B5uZJ8pz73NPiqOtCog/x2/QzM1ENChPKxMDhiQuRHsqc+lg== @@ -963,10 +995,10 @@ resolved "https://registry.npmjs.org/@types/normalize-package-data/-/normalize-package-data-2.4.0.tgz#e486d0d97396d79beedd0a6e33f4534ff6b4973e" integrity sha512-f5j5b/Gf71L+dbqxIpQ4Z2WlmI/mPJ0fOkGGmFgtb6sAu97EPczzbS3/tJKxmcYDj55OX6ssqwDAWOHIYDRDGA== -"@types/resolve@0.0.8": - version "0.0.8" - resolved "https://registry.npmjs.org/@types/resolve/-/resolve-0.0.8.tgz#f26074d238e02659e323ce1a13d041eee280e194" - integrity sha512-auApPaJf3NPfe18hSoJkp8EbZzer2ISk7o8mCC3M9he/a04+gbMF97NkpD2S8riMGvm4BMRI59/SZQSaLTKpsQ== +"@types/resolve@1.17.1": + version "1.17.1" + resolved "https://registry.npmjs.org/@types/resolve/-/resolve-1.17.1.tgz#3afd6ad8967c77e4376c598a82ddd58f46ec45d6" + integrity sha512-yy7HuzQhj0dhGpD8RLXSZWEkLsV9ibvxvi6EiJ3bkqLAO1RGo0WbkWQiwpRlSFymTJRz0d3k5LM3kkx8ArDbLw== dependencies: "@types/node" "*" @@ -1755,6 +1787,11 @@ dedent@^0.7.0: resolved "https://registry.npmjs.org/dedent/-/dedent-0.7.0.tgz#2495ddbaf6eb874abb0e1be9df22d2e5a544326c" integrity sha1-JJXduvbrh0q7Dhvp3yLS5aVEMmw= +deepmerge@^4.2.2: + version "4.2.2" + resolved "https://registry.npmjs.org/deepmerge/-/deepmerge-4.2.2.tgz#44d2ea3679b8f4d4ffba33f03d865fc1e7bf4955" + integrity sha512-FJ3UgI4gIl+PHZm53knsuSFpE+nESMr7M4v9QcgB7S63Kj/6WqMiFQJpBBYz1Pt+66bZpP3Q7Lye0Oo9MPKEdg== + defaults@^1.0.3: version "1.0.3" resolved "https://registry.npmjs.org/defaults/-/defaults-1.0.3.tgz#c656051e9817d9ff08ed881477f3fe4019f3ef7d" @@ -1980,6 +2017,11 @@ estree-walker@^1.0.1: resolved "https://registry.npmjs.org/estree-walker/-/estree-walker-1.0.1.tgz#31bc5d612c96b704106b477e6dd5d8aa138cb700" integrity sha512-1fMXF3YP4pZZVozF8j/ZLfvnR8NSIljt56UhbZ5PeeDmmGHpgpdwQt7ITlGvYaQukCvuBRMLEiKiYC+oeIg4cg== +estree-walker@^2.0.1: + version "2.0.1" + resolved "https://registry.npmjs.org/estree-walker/-/estree-walker-2.0.1.tgz#f8e030fb21cefa183b44b7ad516b747434e7a3e0" + integrity sha512-tF0hv+Yi2Ot1cwj9eYHtxC0jB9bmjacjQs6ZBTj82H8JwUywFuc+7E83NWfNMwHXZc11mjfFcVXPe9gEP4B8dg== + eventemitter3@^3.1.0: version "3.1.2" resolved "https://registry.npmjs.org/eventemitter3/-/eventemitter3-3.1.2.tgz#2d3d48f9c346698fce83a85d7d664e98535df6e7" @@ -2358,7 +2400,7 @@ glob-to-regexp@^0.3.0: resolved "https://registry.npmjs.org/glob-to-regexp/-/glob-to-regexp-0.3.0.tgz#8c5a1494d2066c570cc3bfe4496175acc4d502ab" integrity sha1-jFoUlNIGbFcMw7/kSWF1rMTVAqs= -glob@7.1.6, glob@^7.1.1, glob@^7.1.3, glob@^7.1.4: +glob@7.1.6, glob@^7.1.1, glob@^7.1.3, glob@^7.1.4, glob@^7.1.6: version "7.1.6" resolved "https://registry.npmjs.org/glob/-/glob-7.1.6.tgz#141f33b81a7c2492e125594307480c46679278a6" integrity sha512-LwaxwyZ72Lk7vZINtNNrywX0ZuLyStrdDtabefZKAY5ZGJhVtgdznluResxNmPitE0SAO+O26sWTHeKSI2wMBA== @@ -2680,6 +2722,13 @@ is-ci@^2.0.0: dependencies: ci-info "^2.0.0" +is-core-module@^2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/is-core-module/-/is-core-module-2.0.0.tgz#58531b70aed1db7c0e8d4eb1a0a2d1ddd64bd12d" + integrity sha512-jq1AH6C8MuteOoBPwkxHafmByhL9j5q4OaPGdbuD+ZtQJVzH+i6E3BJDQcBA09k57i2Hh2yQbEG8yObZ0jdlWw== + dependencies: + has "^1.0.3" + is-data-descriptor@^0.1.4: version "0.1.4" resolved "https://registry.npmjs.org/is-data-descriptor/-/is-data-descriptor-0.1.4.tgz#0b5ee648388e2c860282e793f1856fec3f301b56" @@ -2814,7 +2863,7 @@ is-plain-object@^5.0.0: resolved "https://registry.npmjs.org/is-plain-object/-/is-plain-object-5.0.0.tgz#4427f50ab3429e9025ea7d52e9043a9ef4159344" integrity sha512-VRSzKkbMm5jMDoKLbltAkFQ5Qr7VDiTFGXxYFXXowVj387GeGNOCsOH6Msy00SGZ3Fp84b1Naa1psqgcCIEP5Q== -is-reference@^1.1.2: +is-reference@^1.2.1: version "1.2.1" resolved "https://registry.npmjs.org/is-reference/-/is-reference-1.2.1.tgz#8b2dac0b371f4bc994fdeaba9eb542d03002d0b7" integrity sha512-U82MsXXiFIrjCK4otLT+o2NA2Cd2g5MLoOVXUZjIOhLurrRxpEXzI8O0KZHr3IjLvlAH1kTPYSuqer5T9ZVBKQ== @@ -3157,7 +3206,7 @@ macos-release@^2.2.0: resolved "https://registry.npmjs.org/macos-release/-/macos-release-2.4.1.tgz#64033d0ec6a5e6375155a74b1a1eba8e509820ac" integrity sha512-H/QHeBIN1fIGJX517pvK8IEK53yQOW7YcEI55oYtgjDdoCQQz7eJS94qt5kNrscReEyuD/JcdFCm2XBEcGOITg== -magic-string@0.25.7, magic-string@^0.25.2: +magic-string@0.25.7, magic-string@^0.25.2, magic-string@^0.25.7: version "0.25.7" resolved "https://registry.npmjs.org/magic-string/-/magic-string-0.25.7.tgz#3f497d6fd34c669c6798dcb821f2ef31f5445051" integrity sha512-4CrMT5DOHTDk4HYDlzmwu4FVCcIYI8gauveasrdCu2IKIFOJ3f0v/8MDGJCDL9oD2ppz/Av1b0Nj345H9M+XIA== @@ -4331,13 +4380,21 @@ resolve-url@^0.2.1: resolved "https://registry.npmjs.org/resolve-url/-/resolve-url-0.2.1.tgz#2c637fe77c893afd2a663fe21aa9080068e2052a" integrity sha1-LGN/53yJOv0qZj/iGqkIAGjiBSo= -resolve@1.17.0, resolve@^1.10.0, resolve@^1.11.0, resolve@^1.11.1: +resolve@1.17.0, resolve@^1.10.0: version "1.17.0" resolved "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz#b25941b54968231cc2d1bb76a79cb7f2c0bf8444" integrity sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w== dependencies: path-parse "^1.0.6" +resolve@^1.17.0: + version "1.18.1" + resolved "https://registry.npmjs.org/resolve/-/resolve-1.18.1.tgz#018fcb2c5b207d2a6424aee361c5a266da8f4130" + integrity sha512-lDfCPaMKfOJXjy0dPayzPdF1phampNWr3qFCjAu+rw/qbQmr5jWH5xN2hwh9QKfw9E5v4hwV7A+jrCmL8yjjqA== + dependencies: + is-core-module "^2.0.0" + path-parse "^1.0.6" + restore-cursor@^2.0.0: version "2.0.0" resolved "https://registry.npmjs.org/restore-cursor/-/restore-cursor-2.0.0.tgz#9f7ee287f82fd326d4fd162923d62129eee0dfaf" @@ -4363,24 +4420,6 @@ rimraf@^2.5.4, rimraf@^2.6.2, rimraf@^2.6.3: dependencies: glob "^7.1.3" -rollup-plugin-commonjs@10.1.0: - version "10.1.0" - resolved "https://registry.npmjs.org/rollup-plugin-commonjs/-/rollup-plugin-commonjs-10.1.0.tgz#417af3b54503878e084d127adf4d1caf8beb86fb" - integrity sha512-jlXbjZSQg8EIeAAvepNwhJj++qJWNJw1Cl0YnOqKtP5Djx+fFGkp3WRh+W0ASCaFG5w1jhmzDxgu3SJuVxPF4Q== - dependencies: - estree-walker "^0.6.1" - is-reference "^1.1.2" - magic-string "^0.25.2" - resolve "^1.11.0" - rollup-pluginutils "^2.8.1" - -rollup-plugin-json@4.0.0: - version "4.0.0" - resolved "https://registry.npmjs.org/rollup-plugin-json/-/rollup-plugin-json-4.0.0.tgz#a18da0a4b30bf5ca1ee76ddb1422afbb84ae2b9e" - integrity sha512-hgb8N7Cgfw5SZAkb3jf0QXii6QX/FOkiIq2M7BAQIEydjHvTyxXHQiIzZaTFgx1GK0cRCHOCBHIyEkkLdWKxow== - dependencies: - rollup-pluginutils "^2.5.0" - rollup-plugin-license@0.14.0: version "0.14.0" resolved "https://registry.npmjs.org/rollup-plugin-license/-/rollup-plugin-license-0.14.0.tgz#623e5b6306b1521d7b89927d0a28d0f99ac52915" @@ -4395,17 +4434,6 @@ rollup-plugin-license@0.14.0: spdx-expression-validate "2.0.0" spdx-satisfies "5.0.0" -rollup-plugin-node-resolve@5.2.0: - version "5.2.0" - resolved "https://registry.npmjs.org/rollup-plugin-node-resolve/-/rollup-plugin-node-resolve-5.2.0.tgz#730f93d10ed202473b1fb54a5997a7db8c6d8523" - integrity sha512-jUlyaDXts7TW2CqQ4GaO5VJ4PwwaV8VUGA7+km3n6k6xtOEacf61u0VXwN80phY/evMcaS+9eIeJ9MOyDxt5Zw== - dependencies: - "@types/resolve" "0.0.8" - builtin-modules "^3.1.0" - is-module "^1.0.0" - resolve "^1.11.1" - rollup-pluginutils "^2.8.1" - rollup-plugin-replace@2.2.0: version "2.2.0" resolved "https://registry.npmjs.org/rollup-plugin-replace/-/rollup-plugin-replace-2.2.0.tgz#f41ae5372e11e7a217cde349c8b5d5fd115e70e3" @@ -4443,7 +4471,7 @@ rollup-plugin-uglify@6.0.4: serialize-javascript "^2.1.2" uglify-js "^3.4.9" -rollup-pluginutils@^2.5.0, rollup-pluginutils@^2.6.0, rollup-pluginutils@^2.8.1: +rollup-pluginutils@^2.6.0: version "2.8.2" resolved "https://registry.npmjs.org/rollup-pluginutils/-/rollup-pluginutils-2.8.2.tgz#72f2af0748b592364dbd3389e600e5a9444a351e" integrity sha512-EEp9NhnUkwY8aif6bxgovPHMoMoNr2FulJziTndpt5H9RdwC47GSGuII9XxpSdzVGM0GWrNPHV6ie1LTNJPaLQ== @@ -5111,10 +5139,10 @@ typedarray@^0.0.6: resolved "https://registry.npmjs.org/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777" integrity sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c= -typescript@3.9.5: - version "3.9.5" - resolved "https://registry.npmjs.org/typescript/-/typescript-3.9.5.tgz#586f0dba300cde8be52dd1ac4f7e1009c1b13f36" - integrity sha512-hSAifV3k+i6lEoCJ2k6R2Z/rp/H3+8sdmcn5NrS3/3kE7+RyZXm9aqvxWqjEXHAd8b0pShatpcdMTvEdvAJltQ== +typescript@4.0.5: + version "4.0.5" + resolved "https://registry.npmjs.org/typescript/-/typescript-4.0.5.tgz#ae9dddfd1069f1cb5beb3ef3b2170dd7c1332389" + integrity sha512-ywmr/VrTVCmNTJ6iV2LwIrfG1P+lv6luD8sUJs+2eI9NLGigaN+nUQc13iHqisq7bra9lnmUSYqbJvegraBOPQ== uglify-js@^3.1.4, uglify-js@^3.4.9: version "3.11.0" diff --git a/packages-exp/auth-compat-exp/package.json b/packages-exp/auth-compat-exp/package.json index 6578622b975..81b1357cd24 100644 --- a/packages-exp/auth-compat-exp/package.json +++ b/packages-exp/auth-compat-exp/package.json @@ -41,7 +41,7 @@ "@rollup/plugin-json": "4.1.0", "rollup-plugin-replace": "2.2.0", "rollup-plugin-typescript2": "0.27.3", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages-exp/auth-compat-exp", diff --git a/packages-exp/auth-exp/package.json b/packages-exp/auth-exp/package.json index 1f31949edc3..77c7052ad91 100644 --- a/packages-exp/auth-exp/package.json +++ b/packages-exp/auth-exp/package.json @@ -53,7 +53,7 @@ "rollup-plugin-sourcemaps": "0.6.3", "rollup-plugin-typescript2": "0.27.3", "@rollup/plugin-strip": "2.0.0", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages-exp/auth-exp", diff --git a/packages-exp/auth-types-exp/package.json b/packages-exp/auth-types-exp/package.json index e0a5b339fe7..3c702e85734 100644 --- a/packages-exp/auth-types-exp/package.json +++ b/packages-exp/auth-types-exp/package.json @@ -24,6 +24,6 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" } } diff --git a/packages-exp/firebase-exp/package.json b/packages-exp/firebase-exp/package.json index 5f74e1c80fe..22bd7538462 100644 --- a/packages-exp/firebase-exp/package.json +++ b/packages-exp/firebase-exp/package.json @@ -56,7 +56,7 @@ "gulp": "4.0.2", "gulp-sourcemaps": "2.6.5", "gulp-concat": "2.6.1", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "components": [ "app", diff --git a/packages-exp/functions-exp/package.json b/packages-exp/functions-exp/package.json index 9b3bcfc6a1a..aedc77d1d0a 100644 --- a/packages-exp/functions-exp/package.json +++ b/packages-exp/functions-exp/package.json @@ -38,7 +38,7 @@ "@firebase/app-exp": "0.0.800", "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages/functions", diff --git a/packages-exp/functions-types-exp/package.json b/packages-exp/functions-types-exp/package.json index 714acf335ea..c1db6edb570 100644 --- a/packages-exp/functions-types-exp/package.json +++ b/packages-exp/functions-types-exp/package.json @@ -26,6 +26,6 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" } } diff --git a/packages-exp/installations-exp/package.json b/packages-exp/installations-exp/package.json index 0e816aede9f..743924504f2 100644 --- a/packages-exp/installations-exp/package.json +++ b/packages-exp/installations-exp/package.json @@ -47,7 +47,7 @@ "@rollup/plugin-node-resolve": "9.0.0", "rollup-plugin-typescript2": "0.27.3", "rollup-plugin-uglify": "6.0.4", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "peerDependencies": { "@firebase/app-exp": "0.x", diff --git a/packages-exp/installations-types-exp/package.json b/packages-exp/installations-types-exp/package.json index 77628cffd78..50c9d11fdee 100644 --- a/packages-exp/installations-types-exp/package.json +++ b/packages-exp/installations-types-exp/package.json @@ -28,6 +28,6 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" } } diff --git a/packages-exp/performance-exp/package.json b/packages-exp/performance-exp/package.json index 6c053eb6cad..7522cb4a9bc 100644 --- a/packages-exp/performance-exp/package.json +++ b/packages-exp/performance-exp/package.json @@ -45,7 +45,7 @@ "rollup": "2.29.0", "@rollup/plugin-json": "4.1.0", "rollup-plugin-typescript2": "0.27.3", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages/performance-exp", diff --git a/packages-exp/performance-types-exp/package.json b/packages-exp/performance-types-exp/package.json index 17e2c820650..7df6fe16c8a 100644 --- a/packages-exp/performance-types-exp/package.json +++ b/packages-exp/performance-types-exp/package.json @@ -17,7 +17,7 @@ "index.d.ts" ], "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages/performance-types-exp", diff --git a/packages-exp/remote-config-exp/package.json b/packages-exp/remote-config-exp/package.json index 5f191b1db0d..407dc6ee6b9 100644 --- a/packages-exp/remote-config-exp/package.json +++ b/packages-exp/remote-config-exp/package.json @@ -44,7 +44,7 @@ "@firebase/app-exp": "0.0.800", "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages/remote-config", diff --git a/packages-exp/remote-config-types-exp/package.json b/packages-exp/remote-config-types-exp/package.json index 62de11f27d3..39e75defce7 100644 --- a/packages-exp/remote-config-types-exp/package.json +++ b/packages-exp/remote-config-types-exp/package.json @@ -24,6 +24,6 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" } } diff --git a/packages/analytics-interop-types/package.json b/packages/analytics-interop-types/package.json index 4c6f5c20e1a..51bcf67e7b3 100644 --- a/packages/analytics-interop-types/package.json +++ b/packages/analytics-interop-types/package.json @@ -20,6 +20,6 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" } } diff --git a/packages/analytics-types/package.json b/packages/analytics-types/package.json index 345be90ed88..977acdf4360 100644 --- a/packages/analytics-types/package.json +++ b/packages/analytics-types/package.json @@ -20,6 +20,6 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" } } diff --git a/packages/analytics/package.json b/packages/analytics/package.json index e494d99f496..27af462bdf0 100644 --- a/packages/analytics/package.json +++ b/packages/analytics/package.json @@ -40,7 +40,7 @@ "@rollup/plugin-json": "4.1.0", "@rollup/plugin-node-resolve": "9.0.0", "rollup-plugin-typescript2": "0.27.3", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages/analytics", diff --git a/packages/app-types/package.json b/packages/app-types/package.json index 295d5db99e3..d73d6f4fd2a 100644 --- a/packages/app-types/package.json +++ b/packages/app-types/package.json @@ -21,6 +21,6 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" } } diff --git a/packages/app/package.json b/packages/app/package.json index 5f79a9fd77e..a3e7d2a3829 100644 --- a/packages/app/package.json +++ b/packages/app/package.json @@ -40,7 +40,7 @@ "@rollup/plugin-json": "4.1.0", "rollup-plugin-replace": "2.2.0", "rollup-plugin-typescript2": "0.27.3", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages/app", diff --git a/packages/auth-interop-types/package.json b/packages/auth-interop-types/package.json index ee79c88cdd8..f4b713d7986 100644 --- a/packages/auth-interop-types/package.json +++ b/packages/auth-interop-types/package.json @@ -24,6 +24,6 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" } } diff --git a/packages/auth-types/package.json b/packages/auth-types/package.json index 6ddabd04c75..578f4eadc34 100644 --- a/packages/auth-types/package.json +++ b/packages/auth-types/package.json @@ -24,6 +24,6 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" } } diff --git a/packages/component/package.json b/packages/component/package.json index 890f19dc2b8..ce99acd8602 100644 --- a/packages/component/package.json +++ b/packages/component/package.json @@ -29,7 +29,7 @@ "devDependencies": { "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages/component", diff --git a/packages/database-types/package.json b/packages/database-types/package.json index 37db39c2a25..bace9abf2e5 100644 --- a/packages/database-types/package.json +++ b/packages/database-types/package.json @@ -23,6 +23,6 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" } } diff --git a/packages/database/package.json b/packages/database/package.json index 054a7c66abb..2139ecb319a 100644 --- a/packages/database/package.json +++ b/packages/database/package.json @@ -38,7 +38,7 @@ "@firebase/app-types": "0.6.1", "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages/database", diff --git a/packages/firebase/package.json b/packages/firebase/package.json index 381dc9aaec4..30e9cd7d507 100644 --- a/packages/firebase/package.json +++ b/packages/firebase/package.json @@ -69,7 +69,7 @@ "rollup-plugin-terser": "7.0.2", "rollup-plugin-typescript2": "0.27.3", "rollup-plugin-uglify": "6.0.4", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "typings": "index.d.ts", "components": [ diff --git a/packages/firestore-types/package.json b/packages/firestore-types/package.json index 3c0d23d34a3..847df8416a7 100644 --- a/packages/firestore-types/package.json +++ b/packages/firestore-types/package.json @@ -23,6 +23,6 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" } } diff --git a/packages/firestore/package.json b/packages/firestore/package.json index 8f668410eaf..0f3caec1929 100644 --- a/packages/firestore/package.json +++ b/packages/firestore/package.json @@ -92,7 +92,7 @@ "rollup-plugin-terser": "7.0.2", "rollup-plugin-typescript2": "0.27.3", "ts-node": "9.0.0", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages/firestore", diff --git a/packages/functions-types/package.json b/packages/functions-types/package.json index 43be179ce39..cd1ebb41956 100644 --- a/packages/functions-types/package.json +++ b/packages/functions-types/package.json @@ -20,6 +20,6 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" } } diff --git a/packages/functions/package.json b/packages/functions/package.json index 999274b9b3e..4ab59582328 100644 --- a/packages/functions/package.json +++ b/packages/functions/package.json @@ -33,7 +33,7 @@ "@firebase/messaging": "0.7.2", "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages/functions", diff --git a/packages/installations-types/package.json b/packages/installations-types/package.json index aa3bb15d818..691ddfad54e 100644 --- a/packages/installations-types/package.json +++ b/packages/installations-types/package.json @@ -23,6 +23,6 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" } } diff --git a/packages/installations/package.json b/packages/installations/package.json index ca68d7bd7bb..e8019eaedaa 100644 --- a/packages/installations/package.json +++ b/packages/installations/package.json @@ -37,7 +37,7 @@ "@rollup/plugin-node-resolve": "9.0.0", "rollup-plugin-typescript2": "0.27.3", "rollup-plugin-uglify": "6.0.4", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "peerDependencies": { "@firebase/app": "0.x", diff --git a/packages/logger/package.json b/packages/logger/package.json index 7f6a57d43a2..4d3cfb5f9cf 100644 --- a/packages/logger/package.json +++ b/packages/logger/package.json @@ -25,7 +25,7 @@ "devDependencies": { "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages/logger", diff --git a/packages/messaging-types/package.json b/packages/messaging-types/package.json index 2ac0f45fe8f..907b823dccd 100644 --- a/packages/messaging-types/package.json +++ b/packages/messaging-types/package.json @@ -23,6 +23,6 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" } } diff --git a/packages/messaging/package.json b/packages/messaging/package.json index 80b3b22bc05..4f890b6815a 100644 --- a/packages/messaging/package.json +++ b/packages/messaging/package.json @@ -38,7 +38,7 @@ "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", "ts-essentials": "7.0.0", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages/messaging", diff --git a/packages/performance-types/package.json b/packages/performance-types/package.json index e6c0d15aaa3..a10c9ed1974 100644 --- a/packages/performance-types/package.json +++ b/packages/performance-types/package.json @@ -12,7 +12,7 @@ "index.d.ts" ], "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages/performance-types", diff --git a/packages/performance/package.json b/packages/performance/package.json index 36c3efae7ac..9538fd0d6f3 100644 --- a/packages/performance/package.json +++ b/packages/performance/package.json @@ -39,7 +39,7 @@ "rollup": "2.29.0", "@rollup/plugin-json": "4.1.0", "rollup-plugin-typescript2": "0.27.3", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages/performance", diff --git a/packages/remote-config-types/package.json b/packages/remote-config-types/package.json index 48c9ac1ae2f..8b32f91d978 100644 --- a/packages/remote-config-types/package.json +++ b/packages/remote-config-types/package.json @@ -20,6 +20,6 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" } } diff --git a/packages/remote-config/package.json b/packages/remote-config/package.json index 97d9c95411b..7705a6cd462 100644 --- a/packages/remote-config/package.json +++ b/packages/remote-config/package.json @@ -38,7 +38,7 @@ "@firebase/app": "0.6.12", "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages/remote-config", diff --git a/packages/rxfire/package.json b/packages/rxfire/package.json index 40b1186beb0..05edbd306f1 100644 --- a/packages/rxfire/package.json +++ b/packages/rxfire/package.json @@ -46,7 +46,7 @@ "@rollup/plugin-node-resolve": "9.0.0", "rollup-plugin-typescript2": "0.27.3", "rollup-plugin-uglify": "6.0.4", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "files": [ "/auth/package.json", diff --git a/packages/storage-types/package.json b/packages/storage-types/package.json index 6d0ec0df8d5..7384efd6f79 100644 --- a/packages/storage-types/package.json +++ b/packages/storage-types/package.json @@ -24,6 +24,6 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" } } diff --git a/packages/storage/package.json b/packages/storage/package.json index ee80f61d509..86a5291aadf 100644 --- a/packages/storage/package.json +++ b/packages/storage/package.json @@ -37,7 +37,7 @@ "@firebase/auth": "0.15.1", "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages/storage", diff --git a/packages/template-types/package.json b/packages/template-types/package.json index 2daf4dc4171..2a15fb29f61 100644 --- a/packages/template-types/package.json +++ b/packages/template-types/package.json @@ -21,6 +21,6 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" } } diff --git a/packages/template/package.json b/packages/template/package.json index 1d014822114..85b5e666d94 100644 --- a/packages/template/package.json +++ b/packages/template/package.json @@ -35,7 +35,7 @@ "@firebase/app": "0.6.12", "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages/template", diff --git a/packages/util/package.json b/packages/util/package.json index 57d208709d3..632859ae8ee 100644 --- a/packages/util/package.json +++ b/packages/util/package.json @@ -28,7 +28,7 @@ "devDependencies": { "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages/util", diff --git a/packages/webchannel-wrapper/package.json b/packages/webchannel-wrapper/package.json index 72676c84956..73fbea8b0dc 100644 --- a/packages/webchannel-wrapper/package.json +++ b/packages/webchannel-wrapper/package.json @@ -24,7 +24,7 @@ "@rollup/plugin-commonjs": "15.1.0", "rollup-plugin-sourcemaps": "0.6.3", "rollup-plugin-typescript2": "0.27.3", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages/webchannel-wrapper", diff --git a/repo-scripts/changelog-generator/package.json b/repo-scripts/changelog-generator/package.json index caab43e5e59..3bbb73d11d2 100644 --- a/repo-scripts/changelog-generator/package.json +++ b/repo-scripts/changelog-generator/package.json @@ -24,7 +24,7 @@ }, "license": "Apache-2.0", "devDependencies": { - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "repo-scripts/changelog-generator", diff --git a/repo-scripts/size-analysis/package.json b/repo-scripts/size-analysis/package.json index 04151d152b2..f46e702bae0 100644 --- a/repo-scripts/size-analysis/package.json +++ b/repo-scripts/size-analysis/package.json @@ -29,7 +29,7 @@ "child-process-promise": "2.2.1", "memfs": "3.2.0", "tmp": "0.2.1", - "typescript": "4.0.2", + "typescript": "4.0.5", "terser": "5.3.5", "yargs": "16.0.3", "@firebase/util": "0.3.3", diff --git a/yarn.lock b/yarn.lock index f6cb6b44204..d664485a38a 100644 --- a/yarn.lock +++ b/yarn.lock @@ -15379,10 +15379,10 @@ typescript@3.7.x: resolved "https://registry.npmjs.org/typescript/-/typescript-3.7.5.tgz#0692e21f65fd4108b9330238aac11dd2e177a1ae" integrity sha512-/P5lkRXkWHNAbcJIiHPfRoKqyd7bsyCma1hZNUGfn20qm64T6ZBlrzprymeu918H+mB/0rIg2gGK/BXkhhYgBw== -typescript@4.0.2: - version "4.0.2" - resolved "https://registry.npmjs.org/typescript/-/typescript-4.0.2.tgz#7ea7c88777c723c681e33bf7988be5d008d05ac2" - integrity sha512-e4ERvRV2wb+rRZ/IQeb3jm2VxBsirQLpQhdxplZ2MEzGvDkkMmPglecnNDfSUBivMjP93vRbngYYDQqQ/78bcQ== +typescript@4.0.5: + version "4.0.5" + resolved "https://registry.npmjs.org/typescript/-/typescript-4.0.5.tgz#ae9dddfd1069f1cb5beb3ef3b2170dd7c1332389" + integrity sha512-ywmr/VrTVCmNTJ6iV2LwIrfG1P+lv6luD8sUJs+2eI9NLGigaN+nUQc13iHqisq7bra9lnmUSYqbJvegraBOPQ== typescript@~3.9.5: version "3.9.7" From a7991f42f81747e94582d4658f7f79f5c66715ea Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 29 Oct 2020 11:05:42 -0700 Subject: [PATCH 055/624] Update dependency karma-firefox-launcher to v2 (#3987) Co-authored-by: Renovate Bot --- integration/firebase/package.json | 2 +- integration/firestore/package.json | 2 +- package.json | 2 +- yarn.lock | 13 +++++++------ 4 files changed, 10 insertions(+), 9 deletions(-) diff --git a/integration/firebase/package.json b/integration/firebase/package.json index c1ccc3fb326..b4c4d643db1 100644 --- a/integration/firebase/package.json +++ b/integration/firebase/package.json @@ -14,7 +14,7 @@ "karma": "5.2.3", "karma-babel-preprocessor": "8.0.1", "karma-chrome-launcher": "3.1.0", - "karma-firefox-launcher": "1.3.0", + "karma-firefox-launcher": "2.0.0", "karma-mocha": "2.0.1", "karma-sauce-launcher": "1.2.0", "karma-spec-reporter": "0.0.32", diff --git a/integration/firestore/package.json b/integration/firestore/package.json index c1894b72c58..ad425809985 100644 --- a/integration/firestore/package.json +++ b/integration/firestore/package.json @@ -22,7 +22,7 @@ "gulp-replace": "1.0.0", "karma": "5.2.3", "karma-chrome-launcher": "3.1.0", - "karma-firefox-launcher": "1.3.0", + "karma-firefox-launcher": "2.0.0", "karma-mocha": "2.0.1", "karma-spec-reporter": "0.0.32", "mocha": "7.2.0", diff --git a/package.json b/package.json index 2f392684d1c..899a6e3f3fe 100644 --- a/package.json +++ b/package.json @@ -116,7 +116,7 @@ "karma-chrome-launcher": "3.1.0", "karma-cli": "2.0.0", "karma-coverage-istanbul-reporter": "2.1.1", - "karma-firefox-launcher": "1.3.0", + "karma-firefox-launcher": "2.0.0", "karma-mocha": "2.0.1", "karma-mocha-reporter": "2.2.5", "karma-safari-launcher": "1.0.0", diff --git a/yarn.lock b/yarn.lock index d664485a38a..a4dfb3ed5ad 100644 --- a/yarn.lock +++ b/yarn.lock @@ -9353,7 +9353,7 @@ is-wsl@^1.1.0: resolved "https://registry.npmjs.org/is-wsl/-/is-wsl-1.1.0.tgz#1f16e4aa22b04d1336b66188a66af3c600c3a66d" integrity sha1-HxbkqiKwTRM2tmGIpmrzxgDDpm0= -is-wsl@^2.1.0: +is-wsl@^2.2.0: version "2.2.0" resolved "https://registry.npmjs.org/is-wsl/-/is-wsl-2.2.0.tgz#74a4c76e77ca9fd3f932f290c17ea326cd157271" integrity sha512-fKzAra0rGJUUBwGBgNkHZuToZcn+TtXHpeCgmkMJMMYx1sQDYaCSyjJBSCa2nH1DGm7s3n1oBnohoVTBaN7Lww== @@ -9911,12 +9911,13 @@ karma-coverage-istanbul-reporter@2.1.1: istanbul-api "^2.1.6" minimatch "^3.0.4" -karma-firefox-launcher@1.3.0: - version "1.3.0" - resolved "https://registry.npmjs.org/karma-firefox-launcher/-/karma-firefox-launcher-1.3.0.tgz#ebcbb1d1ddfada6be900eb8fae25bcf2dcdc8171" - integrity sha512-Fi7xPhwrRgr+94BnHX0F5dCl1miIW4RHnzjIGxF8GaIEp7rNqX7LSi7ok63VXs3PS/5MQaQMhGxw+bvD+pibBQ== +karma-firefox-launcher@2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/karma-firefox-launcher/-/karma-firefox-launcher-2.0.0.tgz#01319c50e452222311cfd92c06483ced6b934af9" + integrity sha512-BVq24Qwa//531LXRwvqu14ba04wcHNAX/m3lFF5v90w1rzUgck1FPBwQqlAIgKfkN5uHjT0PcxUqUNUctbQGVA== dependencies: - is-wsl "^2.1.0" + is-wsl "^2.2.0" + which "^2.0.1" karma-mocha-reporter@2.2.5: version "2.2.5" From 3f6f5e4912a044664b8746a727ecd75429344dc9 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 29 Oct 2020 11:09:17 -0700 Subject: [PATCH 056/624] Update dependency google-closure-library to v20200830 (#3765) * Update dependency google-closure-library to v20200830 * Replace goog.isArray with Array.isArray https://github.com/google/closure-library/releases/tag/v20200628 Co-authored-by: Renovate Bot Co-authored-by: Alex Volkovitsky --- packages/auth/package.json | 2 +- packages/auth/src/rpchandler.js | 2 +- packages/webchannel-wrapper/package.json | 2 +- yarn.lock | 13 ++++--------- 4 files changed, 7 insertions(+), 12 deletions(-) diff --git a/packages/auth/package.json b/packages/auth/package.json index ad4fb224672..7bdaff80a48 100644 --- a/packages/auth/package.json +++ b/packages/auth/package.json @@ -27,7 +27,7 @@ "devDependencies": { "firebase-tools": "8.12.1", "google-closure-compiler": "20200112.0.0", - "google-closure-library": "20200224.0.0", + "google-closure-library": "20200830.0.0", "gulp": "4.0.2", "gulp-sourcemaps": "2.6.5" }, diff --git a/packages/auth/src/rpchandler.js b/packages/auth/src/rpchandler.js index 363648349a0..eefa65bad47 100644 --- a/packages/auth/src/rpchandler.js +++ b/packages/auth/src/rpchandler.js @@ -1989,7 +1989,7 @@ fireauth.RpcHandler.verifyPhoneNumberForExistingErrorMap_[ * @private */ fireauth.RpcHandler.validateDeleteLinkedAccountsRequest_ = function(request) { - if (!goog.isArray(request['deleteProvider'])) { + if (!Array.isArray(request['deleteProvider'])) { throw new fireauth.AuthError(fireauth.authenum.Error.INTERNAL_ERROR); } }; diff --git a/packages/webchannel-wrapper/package.json b/packages/webchannel-wrapper/package.json index 73fbea8b0dc..83bbf1666ca 100644 --- a/packages/webchannel-wrapper/package.json +++ b/packages/webchannel-wrapper/package.json @@ -17,7 +17,7 @@ "license": "Apache-2.0", "devDependencies": { "google-closure-compiler": "20200628.0.0", - "google-closure-library": "20200628.0.0", + "google-closure-library": "20200830.0.0", "gulp": "4.0.2", "gulp-sourcemaps": "2.6.5", "rollup": "2.29.0", diff --git a/yarn.lock b/yarn.lock index a4dfb3ed5ad..82cc1f120f2 100644 --- a/yarn.lock +++ b/yarn.lock @@ -8074,15 +8074,10 @@ google-closure-compiler@20200628.0.0: google-closure-compiler-osx "^20200628.0.0" google-closure-compiler-windows "^20200628.0.0" -google-closure-library@20200224.0.0: - version "20200224.0.0" - resolved "https://registry.npmjs.org/google-closure-library/-/google-closure-library-20200224.0.0.tgz#70c36576b21c81c514cfbfcc001780c2fdacd173" - integrity sha512-cF9LP7F5Klj4go5TB4cPpcCvC/qgSVNYgzVS+bzxPgLvIiVL8aWOwApj6rsCkPY9Yr675FouylqNE24F31LWeQ== - -google-closure-library@20200628.0.0: - version "20200628.0.0" - resolved "https://registry.npmjs.org/google-closure-library/-/google-closure-library-20200628.0.0.tgz#0a1b6f40a4b1dc408832d33bfe3494a2ef212f3f" - integrity sha512-G+PoGe8vtcjxszr1ie3GSrlxjO+gZDuOZClanGJMWHsefUynzPqJeIGh3zMpSsCAXZXtO6DpB59l99DVvRVcVQ== +google-closure-library@20200830.0.0: + version "20200830.0.0" + resolved "https://registry.npmjs.org/google-closure-library/-/google-closure-library-20200830.0.0.tgz#9f3807e5a4af55ebf2c8a22853d53b8da39a48e8" + integrity sha512-s4ma73K+FTeVywSMjVOxQ435t6kPfSlxEtIflq7Gabp2fxAnc9i8vUpvT8ZP/GH89LwSJReIaBGtrn72rfNC5Q== google-gax@^1.14.2: version "1.15.3" From f68ce24371981ba4d0d7997d29842c13e7b8839a Mon Sep 17 00:00:00 2001 From: Feiyang Date: Thu, 29 Oct 2020 13:54:13 -0700 Subject: [PATCH 057/624] exclude remote config exp packages in changeset (#4014) --- .changeset/config.json | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.changeset/config.json b/.changeset/config.json index 5d0be005d42..9a8a347920c 100644 --- a/.changeset/config.json +++ b/.changeset/config.json @@ -21,6 +21,8 @@ "@firebase/installations-types-exp", "@firebase/performance-exp", "@firebase/performance-types-exp", + "@firebase/remote-config-exp", + "@firebase/remote-config-types-exp", "firebase-exp", "@firebase/app-compat", "@firebase/changelog-generator", From 54a46f89c1c45435c76412fa2ed296e986c2f6ab Mon Sep 17 00:00:00 2001 From: Kai Wu Date: Thu, 29 Oct 2020 14:49:11 -0700 Subject: [PATCH 058/624] Set 1s timeout for onBackgroundMessage Hook (#3780) * await onBackgroundMessage hook * Create fluffy-panthers-hide.md * block in onPush to let onBackgroundMessage to execute * polish wording * Update changeset to be more specific * Update fluffy-panthers-hide.md * Clarify PR is about a bug fix * Update fluffy-panthers-hide.md --- .changeset/fluffy-panthers-hide.md | 6 ++++++ .../src/controllers/sw-controller.ts | 15 ++++++++++++--- packages/messaging/src/util/constants.ts | 19 ++++++++++++++----- 3 files changed, 32 insertions(+), 8 deletions(-) create mode 100644 .changeset/fluffy-panthers-hide.md diff --git a/.changeset/fluffy-panthers-hide.md b/.changeset/fluffy-panthers-hide.md new file mode 100644 index 00000000000..6a62355c638 --- /dev/null +++ b/.changeset/fluffy-panthers-hide.md @@ -0,0 +1,6 @@ +--- +'@firebase/messaging': patch +--- + +Adds a timeout for `onBackgroundMessage` hook so that silent-push warnings won't show if `showNotification` is called inside the hook within 1s. +This fixes the issue where the silent-push warning is displayed along with the message shown with [ServiceWorkerRegistration.showNotification](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/showNotification). diff --git a/packages/messaging/src/controllers/sw-controller.ts b/packages/messaging/src/controllers/sw-controller.ts index 86a4d05af54..c4b9b7a024e 100644 --- a/packages/messaging/src/controllers/sw-controller.ts +++ b/packages/messaging/src/controllers/sw-controller.ts @@ -15,7 +15,13 @@ * limitations under the License. */ -import { DEFAULT_VAPID_KEY, FCM_MSG, TAG } from '../util/constants'; +import { + BACKGROUND_HANDLE_EXECUTION_TIME_LIMIT_MS, + DEFAULT_VAPID_KEY, + FCM_MSG, + FOREGROUND_HANDLE_PREPARATION_TIME_MS, + TAG +} from '../util/constants'; import { ERROR_FACTORY, ErrorCode } from '../util/errors'; import { FirebaseMessaging, MessagePayload } from '@firebase/messaging-types'; import { @@ -47,8 +53,8 @@ export class SwController implements FirebaseMessaging, FirebaseService { private isOnBackgroundMessageUsed: boolean | null = null; private vapidKey: string | null = null; private bgMessageHandler: - | BgMessageHandler | null + | BgMessageHandler | NextFn | Observer = null; @@ -211,6 +217,9 @@ export class SwController implements FirebaseMessaging, FirebaseService { this.bgMessageHandler.next(payload); } } + + // wait briefly to allow onBackgroundMessage to complete + await sleep(BACKGROUND_HANDLE_EXECUTION_TIME_LIMIT_MS); } async onSubChange(event: PushSubscriptionChangeEvent): Promise { @@ -267,7 +276,7 @@ export class SwController implements FirebaseMessaging, FirebaseService { // Wait three seconds for the client to initialize and set up the message handler so that it // can receive the message. - await sleep(3000); + await sleep(FOREGROUND_HANDLE_PREPARATION_TIME_MS); } else { client = await client.focus(); } diff --git a/packages/messaging/src/util/constants.ts b/packages/messaging/src/util/constants.ts index 4bafce33b0a..3a10bab3361 100644 --- a/packages/messaging/src/util/constants.ts +++ b/packages/messaging/src/util/constants.ts @@ -23,12 +23,21 @@ export const DEFAULT_VAPID_KEY = export const ENDPOINT = 'https://fcmregistrations.googleapis.com/v1'; -/** Key of FCM Payload in Notification's data field. */ +// Key of FCM Payload in Notification's data field. export const FCM_MSG = 'FCM_MSG'; +export const TAG = 'FirebaseMessaging: '; +// Set to '1' if Analytics is enabled for the campaign +export const CONSOLE_CAMPAIGN_ANALYTICS_ENABLED = 'google.c.a.e'; export const CONSOLE_CAMPAIGN_ID = 'google.c.a.c_id'; -export const CONSOLE_CAMPAIGN_NAME = 'google.c.a.c_l'; export const CONSOLE_CAMPAIGN_TIME = 'google.c.a.ts'; -/** Set to '1' if Analytics is enabled for the campaign */ -export const CONSOLE_CAMPAIGN_ANALYTICS_ENABLED = 'google.c.a.e'; -export const TAG = 'FirebaseMessaging: '; +export const CONSOLE_CAMPAIGN_NAME = 'google.c.a.c_l'; + +// Due to the fact that onBackgroundMessage can't be awaited (to support rxjs), a silent push +// warning might be shown by the browser if the callback fails to completes by the end of onPush. +// Experiments were ran to determine the majority onBackground message clock time. This brief +// blocking time would allow majority of the onBackgroundMessage callback to finish. +export const BACKGROUND_HANDLE_EXECUTION_TIME_LIMIT_MS = 1000; + +// Preparation time for client to initialize and set up the message handler. +export const FOREGROUND_HANDLE_PREPARATION_TIME_MS = 3000; From 2ac31a1dbadbaf1d158b7c664567efd7a651bf81 Mon Sep 17 00:00:00 2001 From: Sam Horlbeck Olsen Date: Thu, 29 Oct 2020 15:39:12 -0700 Subject: [PATCH 059/624] A whole bunch of things to bring auth (compat) to parity (#3970) * Handle anonymous auth re-login edge case * Formatting * Initial fixes * Fix redirect * clean up additional user info * Formatting * PR feedback * Fix some tests * Fix tests & write some new ones * Fix broken build * Formatting * Formatting * PR feedback * Formatting * PR feedback Co-authored-by: avolkovi --- .../auth-compat-exp/src/user_credential.ts | 6 +- .../api/account_management/profile.test.ts | 3 +- .../src/api/account_management/profile.ts | 1 + .../api/authentication/custom_token.test.ts | 3 +- .../src/api/authentication/custom_token.ts | 1 + .../auth-exp/src/core/auth/auth_impl.ts | 87 ++++++++++++++++--- .../src/core/auth/firebase_internal.test.ts | 1 + .../auth-exp/src/core/auth/initialize.test.ts | 7 ++ .../src/core/providers/google.test.ts | 6 ++ .../auth-exp/src/core/providers/google.ts | 1 + .../src/core/strategies/credential.test.ts | 12 ++- .../src/core/strategies/credential.ts | 8 +- .../src/core/strategies/custom_token.test.ts | 14 ++- .../src/core/strategies/custom_token.ts | 3 +- .../auth-exp/src/core/strategies/idp.test.ts | 60 +++++++++++++ .../auth-exp/src/core/strategies/idp.ts | 12 ++- .../src/core/user/account_info.test.ts | 9 +- .../auth-exp/src/core/user/account_info.ts | 12 ++- .../core/user/additional_user_info.test.ts | 17 +++- .../src/core/user/additional_user_info.ts | 4 +- .../src/core/user/invalidation.test.ts | 8 ++ .../auth-exp/src/core/user/invalidation.ts | 6 +- .../auth-exp/src/core/user/link_unlink.ts | 6 +- .../auth-exp/src/core/user/reauthenticate.ts | 6 +- .../auth-exp/src/core/user/reload.test.ts | 52 +++++++++++ packages-exp/auth-exp/src/core/user/reload.ts | 18 +++- .../auth-exp/src/core/user/token_manager.ts | 19 ++-- .../auth-exp/src/model/popup_redirect.ts | 7 ++ .../src/platform_browser/auth.test.ts | 44 ++++++++++ .../src/platform_browser/popup_redirect.ts | 3 + .../abstract_popup_redirect_operation.test.ts | 22 ++++- .../abstract_popup_redirect_operation.ts | 6 +- .../platform_browser/strategies/phone.test.ts | 3 +- .../strategies/redirect.test.ts | 27 +++++- .../platform_browser/strategies/redirect.ts | 26 ++++-- .../helpers/mock_popup_redirect_resolver.ts | 2 + .../test/integration/flows/phone.test.ts | 3 +- 37 files changed, 465 insertions(+), 60 deletions(-) diff --git a/packages-exp/auth-compat-exp/src/user_credential.ts b/packages-exp/auth-compat-exp/src/user_credential.ts index bf7e4982878..628340ebb19 100644 --- a/packages-exp/auth-compat-exp/src/user_credential.ts +++ b/packages-exp/auth-compat-exp/src/user_credential.ts @@ -116,10 +116,10 @@ export async function convertConfirmationResult( auth: externs.Auth, confirmationResultPromise: Promise ): Promise { - const { verificationId, confirm } = await confirmationResultPromise; + const confirmationResultExp = await confirmationResultPromise; return { - verificationId, + verificationId: confirmationResultExp.verificationId, confirm: (verificationCode: string) => - convertCredential(auth, confirm(verificationCode)) + convertCredential(auth, confirmationResultExp.confirm(verificationCode)) }; } diff --git a/packages-exp/auth-exp/src/api/account_management/profile.test.ts b/packages-exp/auth-exp/src/api/account_management/profile.test.ts index dddeb07e9dd..085b5ac4d8a 100644 --- a/packages-exp/auth-exp/src/api/account_management/profile.test.ts +++ b/packages-exp/auth-exp/src/api/account_management/profile.test.ts @@ -33,7 +33,8 @@ describe('api/account_management/updateProfile', () => { const request = { idToken: 'my-token', email: 'test@foo.com', - password: 'my-password' + password: 'my-password', + returnSecureToken: true }; let auth: TestAuth; diff --git a/packages-exp/auth-exp/src/api/account_management/profile.ts b/packages-exp/auth-exp/src/api/account_management/profile.ts index 658223e1960..73c7cd2336b 100644 --- a/packages-exp/auth-exp/src/api/account_management/profile.ts +++ b/packages-exp/auth-exp/src/api/account_management/profile.ts @@ -23,6 +23,7 @@ export interface UpdateProfileRequest { idToken: string; displayName?: string | null; photoUrl?: string | null; + returnSecureToken: boolean; } export interface UpdateProfileResponse extends IdTokenResponse { diff --git a/packages-exp/auth-exp/src/api/authentication/custom_token.test.ts b/packages-exp/auth-exp/src/api/authentication/custom_token.test.ts index b1cd9d0b7fc..bc39e27c804 100644 --- a/packages-exp/auth-exp/src/api/authentication/custom_token.test.ts +++ b/packages-exp/auth-exp/src/api/authentication/custom_token.test.ts @@ -32,7 +32,8 @@ use(chaiAsPromised); describe('api/authentication/signInWithCustomToken', () => { const request = { - token: 'my-token' + token: 'my-token', + returnSecureToken: true }; let auth: TestAuth; diff --git a/packages-exp/auth-exp/src/api/authentication/custom_token.ts b/packages-exp/auth-exp/src/api/authentication/custom_token.ts index 42646197fde..40ea6192298 100644 --- a/packages-exp/auth-exp/src/api/authentication/custom_token.ts +++ b/packages-exp/auth-exp/src/api/authentication/custom_token.ts @@ -21,6 +21,7 @@ import { Auth } from '@firebase/auth-types-exp'; export interface SignInWithCustomTokenRequest { token: string; + returnSecureToken: boolean; } export interface SignInWithCustomTokenResponse extends IdTokenResponse {} diff --git a/packages-exp/auth-exp/src/core/auth/auth_impl.ts b/packages-exp/auth-exp/src/core/auth/auth_impl.ts index e7b4afecba5..4805e438c89 100644 --- a/packages-exp/auth-exp/src/core/auth/auth_impl.ts +++ b/packages-exp/auth-exp/src/core/auth/auth_impl.ts @@ -60,6 +60,7 @@ export class AuthImpl implements Auth, _FirebaseService { private idTokenSubscription = new Subscription(this); private redirectUser: User | null = null; private isProactiveRefreshEnabled = false; + private redirectInitializerError: Error | null = null; // Any network calls will set this to true and prevent subsequent emulator // initialization @@ -109,17 +110,21 @@ export class AuthImpl implements Auth, _FirebaseService { return; } - await this.initializeCurrentUser(); + await this.initializeCurrentUser(popupRedirectResolver); if (this._deleted) { return; } this._isInitialized = true; - this.notifyAuthListeners(); }); - return this._initializationPromise; + // After initialization completes, throw any error caused by redirect flow + return this._initializationPromise.then(() => { + if (this.redirectInitializerError) { + throw this.redirectInitializerError; + } + }); } /** @@ -149,18 +154,40 @@ export class AuthImpl implements Auth, _FirebaseService { // Update current Auth state. Either a new login or logout. await this._updateCurrentUser(user); - // Notify external Auth changes of Auth change event. - this.notifyAuthListeners(); } - private async initializeCurrentUser(): Promise { - const storedUser = (await this.assertedPersistence.getCurrentUser()) as User | null; + private async initializeCurrentUser( + popupRedirectResolver?: externs.PopupRedirectResolver + ): Promise { + // First check to see if we have a pending redirect event. + let storedUser = (await this.assertedPersistence.getCurrentUser()) as User | null; + if (popupRedirectResolver) { + await this.getOrInitRedirectPersistenceManager(); + const redirectUserEventId = this.redirectUser?._redirectEventId; + const storedUserEventId = storedUser?._redirectEventId; + const result = await this.tryRedirectSignIn(popupRedirectResolver); + + // If the stored user (i.e. the old "currentUser") has a redirectId that + // matches the redirect user, then we want to initially sign in with the + // new user object from result. + // TODO(samgho): More thoroughly test all of this + if ( + (!redirectUserEventId || redirectUserEventId === storedUserEventId) && + result?.user + ) { + storedUser = result.user as User; + } + } + + // If no user in persistence, there is no current user. Set to null. if (!storedUser) { - return this.directlySetCurrentUser(storedUser); + return this.directlySetCurrentUser(null); } if (!storedUser._redirectEventId) { // This isn't a redirect user, we can reload and bail + // This will also catch the redirected user, if available, as that method + // strips the _redirectEventId return this.reloadAndSetCurrentUserOrClear(storedUser); } @@ -182,6 +209,42 @@ export class AuthImpl implements Auth, _FirebaseService { return this.reloadAndSetCurrentUserOrClear(storedUser); } + private async tryRedirectSignIn( + redirectResolver: externs.PopupRedirectResolver + ): Promise { + // The redirect user needs to be checked (and signed in if available) + // during auth initialization. All of the normal sign in and link/reauth + // flows call back into auth and push things onto the promise queue. We + // need to await the result of the redirect sign in *inside the promise + // queue*. This presents a problem: we run into deadlock. See: + // ┌> [Initialization] ─────┐ + // ┌> [] │ + // └─ [getRedirectResult] <─┘ + // where [] are tasks on the queue and arrows denote awaits + // Initialization will never complete because it's waiting on something + // that's waiting for initialization to complete! + // + // Instead, this method calls getRedirectResult() (stored in + // _completeRedirectFn) with an optional parameter that instructs all of + // the underlying auth operations to skip anything that mutates auth state. + + let result: externs.UserCredential | null = null; + try { + // We know this._popupRedirectResolver is set since redirectResolver + // is passed in. The _completeRedirectFn expects the unwrapped extern. + result = await this._popupRedirectResolver!._completeRedirectFn( + this, + redirectResolver, + true + ); + } catch (e) { + this.redirectInitializerError = e; + await this._setRedirectUser(null); + } + + return result; + } + private async reloadAndSetCurrentUserOrClear(user: User): Promise { try { await _reloadWithoutSaving(user); @@ -243,6 +306,7 @@ export class AuthImpl implements Auth, _FirebaseService { { appName: this.name } ); } + return this.queue(async () => { await this.directlySetCurrentUser(user as User | null); this.notifyAuthListeners(); @@ -335,8 +399,11 @@ export class AuthImpl implements Auth, _FirebaseService { } async _redirectUserForId(id: string): Promise { - // Make sure we've cleared any pending ppersistence actions - await this.queue(async () => {}); + // Make sure we've cleared any pending persistence actions if we're not in + // the initializer + if (this._isInitialized) { + await this.queue(async () => {}); + } if (this._currentUser?._redirectEventId === id) { return this._currentUser; diff --git a/packages-exp/auth-exp/src/core/auth/firebase_internal.test.ts b/packages-exp/auth-exp/src/core/auth/firebase_internal.test.ts index 299159650e8..23545fcd5c3 100644 --- a/packages-exp/auth-exp/src/core/auth/firebase_internal.test.ts +++ b/packages-exp/auth-exp/src/core/auth/firebase_internal.test.ts @@ -56,6 +56,7 @@ describe('core/auth/firebase_internal', () => { const user = testUser(auth, 'uid'); await auth._updateCurrentUser(user); user.stsTokenManager.accessToken = 'access-token'; + user.stsTokenManager.refreshToken = 'refresh-token'; user.stsTokenManager.expirationTime = Date.now() + 1000 * 60 * 60 * 24; expect(await authInternal.getToken()).to.eql({ accessToken: 'access-token' diff --git a/packages-exp/auth-exp/src/core/auth/initialize.test.ts b/packages-exp/auth-exp/src/core/auth/initialize.test.ts index 001b9538f3f..65b2bcc4f9f 100644 --- a/packages-exp/auth-exp/src/core/auth/initialize.test.ts +++ b/packages-exp/auth-exp/src/core/auth/initialize.test.ts @@ -106,6 +106,13 @@ describe('core/auth/initialize', () => { ): void { cb(true); } + async _completeRedirectFn( + _auth: externs.Auth, + _resolver: externs.PopupRedirectResolver, + _bypassAuthState: boolean + ): Promise { + return null; + } } const fakePopupRedirectResolver: externs.PopupRedirectResolver = FakePopupRedirectResolver; diff --git a/packages-exp/auth-exp/src/core/providers/google.test.ts b/packages-exp/auth-exp/src/core/providers/google.test.ts index 9b250c9296e..2e4ce5f39f8 100644 --- a/packages-exp/auth-exp/src/core/providers/google.test.ts +++ b/packages-exp/auth-exp/src/core/providers/google.test.ts @@ -39,6 +39,12 @@ describe('core/providers/google', () => { expect(cred.signInMethod).to.eq(SignInMethod.GOOGLE); }); + it('adds the profile scope by default', () => { + const provider = new GoogleAuthProvider(); + expect(provider.providerId).to.eq(ProviderId.GOOGLE); + expect(provider.getScopes()).to.eql(['profile']); + }); + it('credentialFromResult creates the cred from a tagged result', async () => { const auth = await testAuth(); const userCred = new UserCredentialImpl({ diff --git a/packages-exp/auth-exp/src/core/providers/google.ts b/packages-exp/auth-exp/src/core/providers/google.ts index 00514db9098..0d25e2779a1 100644 --- a/packages-exp/auth-exp/src/core/providers/google.ts +++ b/packages-exp/auth-exp/src/core/providers/google.ts @@ -73,6 +73,7 @@ export class GoogleAuthProvider extends OAuthProvider { constructor() { super(externs.ProviderId.GOOGLE); + this.addScope('profile'); } /** diff --git a/packages-exp/auth-exp/src/core/strategies/credential.test.ts b/packages-exp/auth-exp/src/core/strategies/credential.test.ts index 3671680f5da..d3e8e892a68 100644 --- a/packages-exp/auth-exp/src/core/strategies/credential.test.ts +++ b/packages-exp/auth-exp/src/core/strategies/credential.test.ts @@ -42,7 +42,8 @@ import { AUTH_ERROR_FACTORY, AuthErrorCode } from '../errors'; import { linkWithCredential, reauthenticateWithCredential, - signInWithCredential + signInWithCredential, + _signInWithCredential } from './credential'; use(chaiAsPromised); @@ -111,6 +112,15 @@ describe('core/strategies/credential', () => { expect(auth.currentUser).to.eq(user); }); + it('does not update the current user if bypass is true', async () => { + stub(authCredential, '_getIdTokenResponse').returns( + Promise.resolve(idTokenResponse) + ); + const { user } = await _signInWithCredential(auth, authCredential, true); + expect(auth.currentUser).to.be.null; + expect(user).not.to.be.null; + }); + it('should handle MFA', async () => { const serverResponse: IdTokenMfaResponse = { localId: 'uid', diff --git a/packages-exp/auth-exp/src/core/strategies/credential.ts b/packages-exp/auth-exp/src/core/strategies/credential.ts index 012218eb382..e97f2880063 100644 --- a/packages-exp/auth-exp/src/core/strategies/credential.ts +++ b/packages-exp/auth-exp/src/core/strategies/credential.ts @@ -30,7 +30,8 @@ import { _castAuth } from '../auth/auth_impl'; /** @internal */ export async function _signInWithCredential( auth: Auth, - credential: AuthCredential + credential: AuthCredential, + bypassAuthState = false ): Promise { const operationType = OperationType.SIGN_IN; const response = await _processCredentialSavingMfaContextIfNecessary( @@ -43,7 +44,10 @@ export async function _signInWithCredential( operationType, response ); - await auth._updateCurrentUser(userCredential.user); + + if (!bypassAuthState) { + await auth._updateCurrentUser(userCredential.user); + } return userCredential; } diff --git a/packages-exp/auth-exp/src/core/strategies/custom_token.test.ts b/packages-exp/auth-exp/src/core/strategies/custom_token.test.ts index 0491b965ed8..39a789df543 100644 --- a/packages-exp/auth-exp/src/core/strategies/custom_token.test.ts +++ b/packages-exp/auth-exp/src/core/strategies/custom_token.test.ts @@ -52,11 +52,15 @@ describe('core/strategies/signInWithCustomToken', () => { }; let auth: TestAuth; + let signInRoute: mockFetch.Route; beforeEach(async () => { auth = await testAuth(); mockFetch.setUp(); - mockEndpoint(Endpoint.SIGN_IN_WITH_CUSTOM_TOKEN, idTokenResponse); + signInRoute = mockEndpoint( + Endpoint.SIGN_IN_WITH_CUSTOM_TOKEN, + idTokenResponse + ); mockEndpoint(Endpoint.GET_ACCOUNT_INFO, { users: [serverUser] }); @@ -78,6 +82,14 @@ describe('core/strategies/signInWithCustomToken', () => { expect(operationType).to.eq(OperationType.SIGN_IN); }); + it('should send with a valid request', async () => { + await signInWithCustomToken(auth, 'j.w.t'); + expect(signInRoute.calls[0].request).to.eql({ + token: 'j.w.t', + returnSecureToken: true + }); + }); + it('should update the current user', async () => { const { user } = await signInWithCustomToken(auth, 'oh.no'); expect(auth.currentUser).to.eq(user); diff --git a/packages-exp/auth-exp/src/core/strategies/custom_token.ts b/packages-exp/auth-exp/src/core/strategies/custom_token.ts index 919a638e8b6..8ba413f6479 100644 --- a/packages-exp/auth-exp/src/core/strategies/custom_token.ts +++ b/packages-exp/auth-exp/src/core/strategies/custom_token.ts @@ -43,7 +43,8 @@ export async function signInWithCustomToken( customToken: string ): Promise { const response: IdTokenResponse = await getIdTokenResponse(auth, { - token: customToken + token: customToken, + returnSecureToken: true }); const authInternal = _castAuth(auth); const cred = await UserCredentialImpl._fromIdTokenResponse( diff --git a/packages-exp/auth-exp/src/core/strategies/idp.test.ts b/packages-exp/auth-exp/src/core/strategies/idp.test.ts index 3f781b55bac..142233ed86e 100644 --- a/packages-exp/auth-exp/src/core/strategies/idp.test.ts +++ b/packages-exp/auth-exp/src/core/strategies/idp.test.ts @@ -15,6 +15,8 @@ * limitations under the License. */ +import * as sinon from 'sinon'; +import * as sinonChai from 'sinon-chai'; import { expect, use } from 'chai'; import * as chaiAsPromised from 'chai-as-promised'; @@ -27,9 +29,15 @@ import { testAuth, testUser, TestAuth } from '../../../test/helpers/mock_auth'; import * as fetch from '../../../test/helpers/mock_fetch'; import { Endpoint } from '../../api'; import { User } from '../../model/user'; +import * as reauthenticate from '../../core/user/reauthenticate'; +import * as linkUnlink from '../../core/user/link_unlink'; +import * as credential from '../../core/strategies/credential'; + import * as idpTasks from './idp'; +import { UserCredentialImpl } from '../user/user_credential_impl'; use(chaiAsPromised); +use(sinonChai); describe('core/strategies/idb', () => { let auth: TestAuth; @@ -54,6 +62,7 @@ describe('core/strategies/idb', () => { afterEach(() => { fetch.tearDown(); + sinon.restore(); }); describe('signIn', () => { @@ -90,6 +99,23 @@ describe('core/strategies/idb', () => { expect(userCred.operationType).to.eq(OperationType.SIGN_IN); expect(userCred.user.uid).to.eq('uid'); }); + + it('passes through the bypassAuthState flag', async () => { + const stub = sinon + .stub(credential, '_signInWithCredential') + .returns(Promise.resolve(({} as unknown) as UserCredentialImpl)); + await idpTasks._signIn({ + auth, + user, + requestUri: 'request-uri', + sessionId: 'session-id', + tenantId: 'tenant-id', + pendingToken: 'pending-token', + postBody: 'post-body', + bypassAuthState: true + }); + expect(stub.getCall(0).lastArg).to.be.true; + }); }); describe('reauth', () => { @@ -128,6 +154,23 @@ describe('core/strategies/idb', () => { expect(userCred.operationType).to.eq(OperationType.REAUTHENTICATE); expect(userCred.user.uid).to.eq('uid'); }); + + it('passes through the bypassAuthState flag', async () => { + const stub = sinon + .stub(reauthenticate, '_reauthenticate') + .returns(Promise.resolve(({} as unknown) as UserCredentialImpl)); + await idpTasks._reauth({ + auth, + user, + requestUri: 'request-uri', + sessionId: 'session-id', + tenantId: 'tenant-id', + pendingToken: 'pending-token', + postBody: 'post-body', + bypassAuthState: true + }); + expect(stub.getCall(0).lastArg).to.be.true; + }); }); describe('link', () => { @@ -168,5 +211,22 @@ describe('core/strategies/idb', () => { expect(userCred.operationType).to.eq(OperationType.LINK); expect(userCred.user.uid).to.eq('uid'); }); + + it('passes through the bypassAuthState flag', async () => { + const stub = sinon + .stub(linkUnlink, '_link') + .returns(Promise.resolve(({} as unknown) as UserCredentialImpl)); + await idpTasks._link({ + auth, + user, + requestUri: 'request-uri', + sessionId: 'session-id', + tenantId: 'tenant-id', + pendingToken: 'pending-token', + postBody: 'post-body', + bypassAuthState: true + }); + expect(stub.getCall(0).lastArg).to.be.true; + }); }); }); diff --git a/packages-exp/auth-exp/src/core/strategies/idp.ts b/packages-exp/auth-exp/src/core/strategies/idp.ts index 2312e7cf75d..3fc164532cf 100644 --- a/packages-exp/auth-exp/src/core/strategies/idp.ts +++ b/packages-exp/auth-exp/src/core/strategies/idp.ts @@ -40,6 +40,7 @@ export interface IdpTaskParams { postBody?: string; pendingToken?: string; user?: User; + bypassAuthState?: boolean; } /** @internal */ @@ -85,7 +86,8 @@ class IdpCredential extends AuthCredential { export function _signIn(params: IdpTaskParams): Promise { return _signInWithCredential( params.auth, - new IdpCredential(params) + new IdpCredential(params), + params.bypassAuthState ) as Promise; } @@ -93,12 +95,16 @@ export function _signIn(params: IdpTaskParams): Promise { export function _reauth(params: IdpTaskParams): Promise { const { auth, user } = params; assert(user, AuthErrorCode.INTERNAL_ERROR, { appName: auth.name }); - return _reauthenticate(user, new IdpCredential(params)); + return _reauthenticate( + user, + new IdpCredential(params), + params.bypassAuthState + ); } /** @internal */ export async function _link(params: IdpTaskParams): Promise { const { auth, user } = params; assert(user, AuthErrorCode.INTERNAL_ERROR, { appName: auth.name }); - return _linkUser(user, new IdpCredential(params)); + return _linkUser(user, new IdpCredential(params), params.bypassAuthState); } diff --git a/packages-exp/auth-exp/src/core/user/account_info.test.ts b/packages-exp/auth-exp/src/core/user/account_info.test.ts index 3744bbbff73..d87de40c490 100644 --- a/packages-exp/auth-exp/src/core/user/account_info.test.ts +++ b/packages-exp/auth-exp/src/core/user/account_info.test.ts @@ -73,7 +73,8 @@ describe('core/user/profile', () => { expect(ep.calls[0].request).to.eql({ idToken: 'access-token', displayName: 'displayname', - photoUrl: 'photo' + photoUrl: 'photo', + returnSecureToken: true }); }); @@ -118,7 +119,8 @@ describe('core/user/profile', () => { await updateEmail(user, 'hello@test.com'); expect(set.calls[0].request).to.eql({ idToken: 'access-token', - email: 'hello@test.com' + email: 'hello@test.com', + returnSecureToken: true }); expect(user.uid).to.eq('new-uid-to-prove-refresh-got-called'); @@ -135,7 +137,8 @@ describe('core/user/profile', () => { await updatePassword(user, 'pass'); expect(set.calls[0].request).to.eql({ idToken: 'access-token', - password: 'pass' + password: 'pass', + returnSecureToken: true }); expect(user.uid).to.eq('new-uid-to-prove-refresh-got-called'); diff --git a/packages-exp/auth-exp/src/core/user/account_info.ts b/packages-exp/auth-exp/src/core/user/account_info.ts index 3829082509b..1868eea5739 100644 --- a/packages-exp/auth-exp/src/core/user/account_info.ts +++ b/packages-exp/auth-exp/src/core/user/account_info.ts @@ -49,7 +49,12 @@ export async function updateProfile( const userInternal = user as User; const idToken = await user.getIdToken(); - const profileRequest = { idToken, displayName, photoUrl }; + const profileRequest = { + idToken, + displayName, + photoUrl, + returnSecureToken: true + }; const response = await _logoutIfInvalidated( userInternal, apiUpdateProfile(userInternal.auth, profileRequest) @@ -121,7 +126,10 @@ async function updateEmailOrPassword( ): Promise { const { auth } = user; const idToken = await user.getIdToken(); - const request: UpdateEmailPasswordRequest = { idToken }; + const request: UpdateEmailPasswordRequest = { + idToken, + returnSecureToken: true + }; if (email) { request.email = email; diff --git a/packages-exp/auth-exp/src/core/user/additional_user_info.test.ts b/packages-exp/auth-exp/src/core/user/additional_user_info.test.ts index 16107569707..642a443ef22 100644 --- a/packages-exp/auth-exp/src/core/user/additional_user_info.test.ts +++ b/packages-exp/auth-exp/src/core/user/additional_user_info.test.ts @@ -33,6 +33,7 @@ import { UserCredentialImpl } from './user_credential_impl'; import { Auth } from '../../model/auth'; import { User, UserCredential } from '../../model/user'; import { testAuth, testUser } from '../../../test/helpers/mock_auth'; +import { makeJWT } from '../../../test/helpers/jwt'; describe('core/user/additional_user_info', () => { const userProfileWithLogin: UserProfile = { @@ -158,8 +159,12 @@ describe('core/user/additional_user_info', () => { describe('creates generic AdditionalUserInfo', () => { it('for custom auth', () => { const idResponse = idTokenResponse({ - providerId: ProviderId.CUSTOM, - rawUserInfo: rawUserInfoWithLogin + rawUserInfo: rawUserInfoWithLogin, + idToken: makeJWT({ + firebase: { + 'sign_in_provider': 'custom' + } + }) }); const { isNewUser, @@ -175,8 +180,12 @@ describe('core/user/additional_user_info', () => { it('for anonymous auth', () => { const idResponse = idTokenResponse({ - providerId: ProviderId.ANONYMOUS, - rawUserInfo: rawUserInfoWithLogin + rawUserInfo: rawUserInfoWithLogin, + idToken: makeJWT({ + firebase: { + 'sign_in_provider': 'anonymous' + } + }) }); const { isNewUser, diff --git a/packages-exp/auth-exp/src/core/user/additional_user_info.ts b/packages-exp/auth-exp/src/core/user/additional_user_info.ts index 7e1badb6b62..1405629cf48 100644 --- a/packages-exp/auth-exp/src/core/user/additional_user_info.ts +++ b/packages-exp/auth-exp/src/core/user/additional_user_info.ts @@ -44,8 +44,8 @@ export function _fromIdTokenResponse( ]; if (signInProvider) { const filteredProviderId = - providerId !== externs.ProviderId.ANONYMOUS && - providerId !== externs.ProviderId.CUSTOM + signInProvider !== externs.ProviderId.ANONYMOUS && + signInProvider !== externs.ProviderId.CUSTOM ? (signInProvider as externs.ProviderId) : null; // Uses generic class in accordance with the legacy SDK. diff --git a/packages-exp/auth-exp/src/core/user/invalidation.test.ts b/packages-exp/auth-exp/src/core/user/invalidation.test.ts index 3629f0887ec..05f83bd4b5f 100644 --- a/packages-exp/auth-exp/src/core/user/invalidation.test.ts +++ b/packages-exp/auth-exp/src/core/user/invalidation.test.ts @@ -63,6 +63,14 @@ describe('core/user/invalidation', () => { expect(auth.currentUser).to.be.null; }); + it('does not log out if bypass auth state is true', async () => { + const error = makeError(AuthErrorCode.USER_DISABLED); + try { + await _logoutIfInvalidated(user, Promise.reject(error), true); + } catch {} + expect(auth.currentUser).to.eq(user); + }); + it('logs out the user if the error is token_expired', async () => { const error = makeError(AuthErrorCode.TOKEN_EXPIRED); await expect( diff --git a/packages-exp/auth-exp/src/core/user/invalidation.ts b/packages-exp/auth-exp/src/core/user/invalidation.ts index 74d29dab455..0ae3c3a4eaa 100644 --- a/packages-exp/auth-exp/src/core/user/invalidation.ts +++ b/packages-exp/auth-exp/src/core/user/invalidation.ts @@ -22,8 +22,12 @@ import { AuthErrorCode } from '../errors'; export async function _logoutIfInvalidated( user: User, - promise: Promise + promise: Promise, + bypassAuthState = false ): Promise { + if (bypassAuthState) { + return promise; + } try { return await promise; } catch (e) { diff --git a/packages-exp/auth-exp/src/core/user/link_unlink.ts b/packages-exp/auth-exp/src/core/user/link_unlink.ts index 077c5a97e62..48a52fb5328 100644 --- a/packages-exp/auth-exp/src/core/user/link_unlink.ts +++ b/packages-exp/auth-exp/src/core/user/link_unlink.ts @@ -63,11 +63,13 @@ export async function unlink( /** @internal */ export async function _link( user: User, - credential: AuthCredential + credential: AuthCredential, + bypassAuthState = false ): Promise { const response = await _logoutIfInvalidated( user, - credential._linkToIdToken(user.auth, await user.getIdToken()) + credential._linkToIdToken(user.auth, await user.getIdToken()), + bypassAuthState ); return UserCredentialImpl._forOperation( user, diff --git a/packages-exp/auth-exp/src/core/user/reauthenticate.ts b/packages-exp/auth-exp/src/core/user/reauthenticate.ts index 55982a749fd..296d89a8442 100644 --- a/packages-exp/auth-exp/src/core/user/reauthenticate.ts +++ b/packages-exp/auth-exp/src/core/user/reauthenticate.ts @@ -28,7 +28,8 @@ import { UserCredentialImpl } from './user_credential_impl'; export async function _reauthenticate( user: User, - credential: AuthCredential + credential: AuthCredential, + bypassAuthState = false ): Promise { const appName = user.auth.name; const operationType = OperationType.REAUTHENTICATE; @@ -41,7 +42,8 @@ export async function _reauthenticate( operationType, credential, user - ) + ), + bypassAuthState ); assert(response.idToken, AuthErrorCode.INTERNAL_ERROR, { appName }); const parsed = _parseToken(response.idToken); diff --git a/packages-exp/auth-exp/src/core/user/reload.test.ts b/packages-exp/auth-exp/src/core/user/reload.test.ts index f4983879b16..d0bcf69f090 100644 --- a/packages-exp/auth-exp/src/core/user/reload.test.ts +++ b/packages-exp/auth-exp/src/core/user/reload.test.ts @@ -32,6 +32,7 @@ import { } from '../../api/account_management/account'; import { _reloadWithoutSaving, reload } from './reload'; import { UserMetadata } from './user_metadata'; +import { User } from '../../model/user'; use(chaiAsPromised); use(sinonChai); @@ -166,4 +167,55 @@ describe('core/user/reload', () => { expect(cb).to.have.been.calledWith(user); expect(auth.persistenceLayer.lastObjectSet).to.eql(user.toJSON()); }); + + context('anonymous carryover', () => { + let user: User; + beforeEach(() => { + user = testUser(auth, 'abc', '', true); + }); + function setup( + isAnonStart: boolean, + emailStart: string, + passwordHash: string, + providerData: Array<{ providerId: string }> + ): void { + // Get around readonly property + const mutUser = (user as unknown) as Record; + mutUser.isAnonymous = isAnonStart; + mutUser.email = emailStart; + + mockEndpoint(Endpoint.GET_ACCOUNT_INFO, { + users: [ + { + providerUserInfo: [...providerData], + passwordHash + } + ] + }); + } + + it('user stays not anonymous even if reload user is', async () => { + setup(false, '', '', []); // After reload the user would count as anon + await _reloadWithoutSaving(user); + expect(user.isAnonymous).to.be.false; + }); + + it('user stays anonymous if reload user is anonymous', async () => { + setup(true, '', '', []); // After reload the user would count as anon + await _reloadWithoutSaving(user); + expect(user.isAnonymous).to.be.true; + }); + + it('user becomes not anonymous if reload user is not', async () => { + setup(true, '', '', [{ providerId: 'google' }]); // After reload the user would count as anon + await _reloadWithoutSaving(user); + expect(user.isAnonymous).to.be.false; + }); + + it('user becomes not anonymous if password hash set', async () => { + setup(true, 'email', 'pass', [{ providerId: 'google' }]); // After reload the user would count as anon + await _reloadWithoutSaving(user); + expect(user.isAnonymous).to.be.false; + }); + }); }); diff --git a/packages-exp/auth-exp/src/core/user/reload.ts b/packages-exp/auth-exp/src/core/user/reload.ts index b0d25465b79..8dd0ffd653b 100644 --- a/packages-exp/auth-exp/src/core/user/reload.ts +++ b/packages-exp/auth-exp/src/core/user/reload.ts @@ -46,6 +46,19 @@ export async function _reloadWithoutSaving(user: User): Promise { const newProviderData = coreAccount.providerUserInfo?.length ? extractProviderData(coreAccount.providerUserInfo) : []; + + const providerData = mergeProviderData(user.providerData, newProviderData); + + // Preserves the non-nonymous status of the stored user, even if no more + // credentials (federated or email/password) are linked to the user. If + // the user was previously anonymous, then use provider data to update. + // On the other hand, if it was not anonymous before, it should never be + // considered anonymous now. + const oldIsAnonymous = user.isAnonymous; + const newIsAnonymous = + !(user.email && coreAccount.passwordHash) && !providerData?.length; + const isAnonymous = !oldIsAnonymous ? false : newIsAnonymous; + const updates: Partial = { uid: coreAccount.localId, displayName: coreAccount.displayName || null, @@ -54,8 +67,9 @@ export async function _reloadWithoutSaving(user: User): Promise { emailVerified: coreAccount.emailVerified || false, phoneNumber: coreAccount.phoneNumber || null, tenantId: coreAccount.tenantId || null, - providerData: mergeProviderData(user.providerData, newProviderData), - metadata: new UserMetadata(coreAccount.createdAt, coreAccount.lastLoginAt) + providerData, + metadata: new UserMetadata(coreAccount.createdAt, coreAccount.lastLoginAt), + isAnonymous }; Object.assign(user, updates); diff --git a/packages-exp/auth-exp/src/core/user/token_manager.ts b/packages-exp/auth-exp/src/core/user/token_manager.ts index 289889e6029..4ee43be10c3 100644 --- a/packages-exp/auth-exp/src/core/user/token_manager.ts +++ b/packages-exp/auth-exp/src/core/user/token_manager.ts @@ -56,19 +56,24 @@ export class StsTokenManager { } async getToken(auth: Auth, forceRefresh = false): Promise { + assert( + !this.accessToken || this.refreshToken, + AuthErrorCode.TOKEN_EXPIRED, + { + appName: auth.name + } + ); + if (!forceRefresh && this.accessToken && !this.isExpired) { return this.accessToken; } - if (!this.refreshToken) { - assert(!this.accessToken, AuthErrorCode.TOKEN_EXPIRED, { - appName: auth.name - }); - return null; + if (this.refreshToken) { + await this.refresh(auth, this.refreshToken!); + return this.accessToken; } - await this.refresh(auth, this.refreshToken); - return this.accessToken; + return null; } clearRefreshToken(): void { diff --git a/packages-exp/auth-exp/src/model/popup_redirect.ts b/packages-exp/auth-exp/src/model/popup_redirect.ts index 6aa79da7a57..0376b866350 100644 --- a/packages-exp/auth-exp/src/model/popup_redirect.ts +++ b/packages-exp/auth-exp/src/model/popup_redirect.ts @@ -105,4 +105,11 @@ export interface PopupRedirectResolver extends externs.PopupRedirectResolver { cb: (support: boolean) => unknown ): void; _redirectPersistence: externs.Persistence; + + // This is needed so that auth does not have a hard dependency on redirect + _completeRedirectFn: ( + auth: externs.Auth, + resolver: externs.PopupRedirectResolver, + bypassAuthState: boolean + ) => Promise; } diff --git a/packages-exp/auth-exp/src/platform_browser/auth.test.ts b/packages-exp/auth-exp/src/platform_browser/auth.test.ts index d6cd470d6d4..9aa8017da34 100644 --- a/packages-exp/auth-exp/src/platform_browser/auth.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/auth.test.ts @@ -37,6 +37,9 @@ import { _getInstance } from '../core/util/instantiator'; import { _getClientVersion, ClientPlatform } from '../core/util/version'; import { Auth } from '../model/auth'; import { browserPopupRedirectResolver } from './popup_redirect'; +import { PopupRedirectResolver } from '../model/popup_redirect'; +import { UserCredentialImpl } from '../core/user/user_credential_impl'; +import { User } from '../model/user'; use(sinonChai); use(chaiAsPromised); @@ -96,6 +99,7 @@ describe('core/auth/initializeAuth', () => { let createManagerStub: sinon.SinonSpy; let reloadStub: sinon.SinonStub; let oldAuth: Auth; + let completeRedirectFnStub: sinon.SinonStub; beforeEach(async () => { oldAuth = await testAuth(); @@ -103,6 +107,12 @@ describe('core/auth/initializeAuth', () => { reloadStub = sinon .stub(reload, '_reloadWithoutSaving') .returns(Promise.resolve()); + completeRedirectFnStub = sinon + .stub( + _getInstance(browserPopupRedirectResolver), + '_completeRedirectFn' + ) + .returns(Promise.resolve(null)); }); async function initAndWait( @@ -255,5 +265,39 @@ describe('core/auth/initializeAuth', () => { sdkClientVersion: _getClientVersion(ClientPlatform.BROWSER) }); }); + + context('#tryRedirectSignIn', () => { + it('returns null and clears the redirect user in case of error', async () => { + const stub = sinon.stub( + _getInstance(browserSessionPersistence) + ); + stub._remove.returns(Promise.resolve()); + completeRedirectFnStub.returns(Promise.reject(new Error('no'))); + + await initAndWait([inMemoryPersistence], browserPopupRedirectResolver); + expect(stub._remove).to.have.been.called; + }); + + it('signs in the redirect user if found', async () => { + let user: User | null = null; + completeRedirectFnStub.callsFake((auth: Auth) => { + user = testUser(auth, 'uid', 'redirectUser@test.com'); + return Promise.resolve( + new UserCredentialImpl({ + operationType: externs.OperationType.SIGN_IN, + user, + providerId: null + }) + ); + }); + + const auth = await initAndWait( + [inMemoryPersistence], + browserPopupRedirectResolver + ); + expect(user).not.to.be.null; + expect(auth.currentUser).to.eq(user); + }); + }); }); }); diff --git a/packages-exp/auth-exp/src/platform_browser/popup_redirect.ts b/packages-exp/auth-exp/src/platform_browser/popup_redirect.ts index f92d5021370..1e01eee7eb5 100644 --- a/packages-exp/auth-exp/src/platform_browser/popup_redirect.ts +++ b/packages-exp/auth-exp/src/platform_browser/popup_redirect.ts @@ -40,6 +40,7 @@ import { _setWindowLocation } from './auth_window'; import { _openIframe } from './iframe/iframe'; import { browserSessionPersistence } from './persistence/session_storage'; import { _open, AuthPopup } from './util/popup'; +import { _getRedirectResult } from './strategies/redirect'; /** * URL for Authentication widget which will initiate the OAuth handshake @@ -198,6 +199,8 @@ class BrowserPopupRedirectResolver implements PopupRedirectResolver { return this.originValidationPromises[key]; } + + _completeRedirectFn = _getRedirectResult; } /** diff --git a/packages-exp/auth-exp/src/platform_browser/strategies/abstract_popup_redirect_operation.test.ts b/packages-exp/auth-exp/src/platform_browser/strategies/abstract_popup_redirect_operation.test.ts index 4b3efec3e13..b7ff55ee096 100644 --- a/packages-exp/auth-exp/src/platform_browser/strategies/abstract_popup_redirect_operation.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/strategies/abstract_popup_redirect_operation.test.ts @@ -185,7 +185,8 @@ describe('platform_browser/strategies/abstract_popup_redirect_operation', () => sessionId: BASE_AUTH_EVENT.sessionId!, tenantId: BASE_AUTH_EVENT.tenantId || undefined, postBody: BASE_AUTH_EVENT.postBody || undefined, - user: undefined + user: undefined, + bypassAuthState: false }; } @@ -236,6 +237,25 @@ describe('platform_browser/strategies/abstract_popup_redirect_operation', () => await operation.execute(); expect(idp._reauth).to.have.been.calledWith(expectedIdpTaskParams()); }); + + it('includes the bypassAuthState parameter', async () => { + operation = new WrapperOperation( + auth, + AuthEventType.REAUTH_VIA_REDIRECT, + resolver, + undefined, + /** bypassAuthState */ true + ); + + const type = AuthEventType.REAUTH_VIA_REDIRECT; + updateFilter(type); + finishPromise(authEvent({ type })); + await operation.execute(); + expect(idp._reauth).to.have.been.calledWith({ + ...expectedIdpTaskParams(), + bypassAuthState: true + }); + }); }); }); }); diff --git a/packages-exp/auth-exp/src/platform_browser/strategies/abstract_popup_redirect_operation.ts b/packages-exp/auth-exp/src/platform_browser/strategies/abstract_popup_redirect_operation.ts index 9a9260e066d..10fbc323901 100644 --- a/packages-exp/auth-exp/src/platform_browser/strategies/abstract_popup_redirect_operation.ts +++ b/packages-exp/auth-exp/src/platform_browser/strategies/abstract_popup_redirect_operation.ts @@ -57,7 +57,8 @@ export abstract class AbstractPopupRedirectOperation protected readonly auth: Auth, filter: AuthEventType | AuthEventType[], protected readonly resolver: PopupRedirectResolver, - protected user?: User + protected user?: User, + private readonly bypassAuthState = false ) { this.filter = Array.isArray(filter) ? filter : [filter]; } @@ -91,7 +92,8 @@ export abstract class AbstractPopupRedirectOperation sessionId: sessionId!, tenantId: tenantId || undefined, postBody: postBody || undefined, - user: this.user + user: this.user, + bypassAuthState: this.bypassAuthState }; try { diff --git a/packages-exp/auth-exp/src/platform_browser/strategies/phone.test.ts b/packages-exp/auth-exp/src/platform_browser/strategies/phone.test.ts index cd4e6a2ac95..c4974872e9f 100644 --- a/packages-exp/auth-exp/src/platform_browser/strategies/phone.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/strategies/phone.test.ts @@ -424,7 +424,8 @@ describe('platform_browser/strategies/phone', () => { users: [{ uid: 'uid' }] }); signInMock = mockEndpoint(Endpoint.SIGN_IN_WITH_PHONE_NUMBER, { - idToken: 'new-access-token' + idToken: 'new-access-token', + refreshToken: 'refresh-token' }); credential = PhoneAuthCredential._fromVerification( 'session-info', diff --git a/packages-exp/auth-exp/src/platform_browser/strategies/redirect.test.ts b/packages-exp/auth-exp/src/platform_browser/strategies/redirect.test.ts index 39573e9e69e..3d17b7fbee6 100644 --- a/packages-exp/auth-exp/src/platform_browser/strategies/redirect.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/strategies/redirect.test.ts @@ -51,7 +51,8 @@ import { getRedirectResult, linkWithRedirect, reauthenticateWithRedirect, - signInWithRedirect + signInWithRedirect, + _getRedirectResult } from './redirect'; import { FirebaseError } from '@firebase/util'; @@ -426,5 +427,29 @@ describe('platform_browser/strategies/redirect', () => { expect(auth.persistenceLayer.lastObjectSet?._redirectEventId).to.be .undefined; }); + + it('does not mutate authstate if bypassAuthState is true', async () => { + await reInitAuthWithRedirectUser(MATCHING_EVENT_ID); + const redirectPersistence: Persistence = _getInstance( + RedirectPersistence + ); + sinon.spy(redirectPersistence, '_remove'); + + const cred = new UserCredentialImpl({ + user: auth._currentUser!, + providerId: externs.ProviderId.GOOGLE, + operationType: externs.OperationType.LINK + }); + idpStubs._link.returns(Promise.resolve(cred)); + const promise = _getRedirectResult(auth, resolver, true); + iframeEvent({ + type: AuthEventType.LINK_VIA_REDIRECT + }); + expect(await promise).to.eq(cred); + expect(redirectPersistence._remove).not.to.have.been.called; + expect(auth._currentUser?._redirectEventId).not.to.be.undefined; + expect(auth.persistenceLayer.lastObjectSet?._redirectEventId).not.to.be + .undefined; + }); }); }); diff --git a/packages-exp/auth-exp/src/platform_browser/strategies/redirect.ts b/packages-exp/auth-exp/src/platform_browser/strategies/redirect.ts index b6c7615f345..f7217f5b599 100644 --- a/packages-exp/auth-exp/src/platform_browser/strategies/redirect.ts +++ b/packages-exp/auth-exp/src/platform_browser/strategies/redirect.ts @@ -230,16 +230,24 @@ export async function linkWithRedirect( export async function getRedirectResult( auth: externs.Auth, resolver?: externs.PopupRedirectResolver +): Promise { + return _getRedirectResult(auth, resolver, false); +} + +export async function _getRedirectResult( + auth: externs.Auth, + resolverExtern?: externs.PopupRedirectResolver, + bypassAuthState = false ): Promise { const authInternal = _castAuth(auth); - const resolverInternal = _withDefaultResolver(authInternal, resolver); - const action = new RedirectAction(authInternal, resolverInternal); + const resolver = _withDefaultResolver(authInternal, resolverExtern); + const action = new RedirectAction(authInternal, resolver, bypassAuthState); const result = await action.execute(); - if (result) { + if (result && !bypassAuthState) { delete result.user._redirectEventId; await authInternal._persistUserIfCurrent(result.user as User); - await authInternal._setRedirectUser(null, resolver); + await authInternal._setRedirectUser(null, resolverExtern); } return result; @@ -264,7 +272,11 @@ const redirectOutcomeMap: Map< class RedirectAction extends AbstractPopupRedirectOperation { eventId = null; - constructor(auth: Auth, resolver: PopupRedirectResolver) { + constructor( + auth: Auth, + resolver: PopupRedirectResolver, + bypassAuthState = false + ) { super( auth, [ @@ -273,7 +285,9 @@ class RedirectAction extends AbstractPopupRedirectOperation { AuthEventType.REAUTH_VIA_REDIRECT, AuthEventType.UNKNOWN ], - resolver + resolver, + undefined, + bypassAuthState ); } diff --git a/packages-exp/auth-exp/test/helpers/mock_popup_redirect_resolver.ts b/packages-exp/auth-exp/test/helpers/mock_popup_redirect_resolver.ts index 0d0aeb36fbd..ccae9824bc6 100644 --- a/packages-exp/auth-exp/test/helpers/mock_popup_redirect_resolver.ts +++ b/packages-exp/auth-exp/test/helpers/mock_popup_redirect_resolver.ts @@ -49,5 +49,7 @@ export function makeMockPopupRedirectResolver( } _redirectPersistence?: Persistence; + + async _completeRedirectFn(): Promise {} }; } diff --git a/packages-exp/auth-exp/test/integration/flows/phone.test.ts b/packages-exp/auth-exp/test/integration/flows/phone.test.ts index 297b4c368fc..48dd3bd888c 100644 --- a/packages-exp/auth-exp/test/integration/flows/phone.test.ts +++ b/packages-exp/auth-exp/test/integration/flows/phone.test.ts @@ -107,7 +107,8 @@ describe('Integration test: phone auth', () => { await unlink(user, ProviderId.PHONE); expect(auth.currentUser!.uid).to.eq(anonId); - expect(auth.currentUser!.isAnonymous).to.be.true; + // Is anonymous stays false even after unlinking + expect(auth.currentUser!.isAnonymous).to.be.false; expect(auth.currentUser!.phoneNumber).to.be.null; }); From 6ef39d4d346e7458f1559f15f82f734dec41611b Mon Sep 17 00:00:00 2001 From: Sam Stern Date: Fri, 30 Oct 2020 12:52:42 -0400 Subject: [PATCH 060/624] Add withFunctionsTriggersDisabled method to rules-unit-testing (#3928) --- .changeset/lazy-elephants-suffer.md | 5 + packages/rules-unit-testing/firebase.json | 6 + packages/rules-unit-testing/index.ts | 3 +- packages/rules-unit-testing/package.json | 5 +- packages/rules-unit-testing/src/api/index.ts | 178 +++++++++++------- .../rules-unit-testing/test/database.test.ts | 49 ++++- yarn.lock | 58 ++++++ 7 files changed, 229 insertions(+), 75 deletions(-) create mode 100644 .changeset/lazy-elephants-suffer.md diff --git a/.changeset/lazy-elephants-suffer.md b/.changeset/lazy-elephants-suffer.md new file mode 100644 index 00000000000..0343b48f493 --- /dev/null +++ b/.changeset/lazy-elephants-suffer.md @@ -0,0 +1,5 @@ +--- +'@firebase/rules-unit-testing': minor +--- + +Add withFunctionTriggersDisabled function which runs a user-provided setup function with emulated Cloud Functions triggers disabled. This can be used to import data into the Realtime Database or Cloud Firestore emulators without triggering locally emulated Cloud Functions. This method only works with Firebase CLI version 8.13.0 or higher. diff --git a/packages/rules-unit-testing/firebase.json b/packages/rules-unit-testing/firebase.json index a5b6bcc199c..1b237fe5922 100644 --- a/packages/rules-unit-testing/firebase.json +++ b/packages/rules-unit-testing/firebase.json @@ -1,4 +1,7 @@ { + "functions": { + "source": "." + }, "emulators": { "firestore": { "port": 9003 @@ -6,6 +9,9 @@ "database": { "port": 9002 }, + "functions": { + "port": 9004 + }, "ui": { "enabled": false } diff --git a/packages/rules-unit-testing/index.ts b/packages/rules-unit-testing/index.ts index 953477f842d..3bb2c596a6b 100644 --- a/packages/rules-unit-testing/index.ts +++ b/packages/rules-unit-testing/index.ts @@ -31,5 +31,6 @@ export { initializeAdminApp, initializeTestApp, loadDatabaseRules, - loadFirestoreRules + loadFirestoreRules, + withFunctionTriggersDisabled } from './src/api'; diff --git a/packages/rules-unit-testing/package.json b/packages/rules-unit-testing/package.json index 9bb90657fb1..fcf48018816 100644 --- a/packages/rules-unit-testing/package.json +++ b/packages/rules-unit-testing/package.json @@ -13,7 +13,7 @@ "build:deps": "lerna run --scope @firebase/rules-unit-testing --include-dependencies build", "dev": "rollup -c -w", "test:nyc": "TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --config ../../config/mocharc.node.js", - "test": "firebase --debug emulators:exec 'yarn test:nyc'", + "test": "firebase --project=foo --debug emulators:exec 'yarn test:nyc'", "test:ci": "node ../../scripts/run_tests_in_ci.js -s test", "prepare": "yarn build" }, @@ -28,7 +28,8 @@ "@google-cloud/firestore": "4.4.0", "@types/request": "2.48.5", "firebase-admin": "9.2.0", - "firebase-tools": "8.12.1", + "firebase-tools": "8.13.0", + "firebase-functions": "3.11.0", "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3" }, diff --git a/packages/rules-unit-testing/src/api/index.ts b/packages/rules-unit-testing/src/api/index.ts index 75d07908de3..680b195b09f 100644 --- a/packages/rules-unit-testing/src/api/index.ts +++ b/packages/rules-unit-testing/src/api/index.ts @@ -36,6 +36,11 @@ const FIRESTORE_ADDRESS_ENV: string = 'FIRESTORE_EMULATOR_HOST'; /** The default address for the local Firestore emulator. */ const FIRESTORE_ADDRESS_DEFAULT: string = 'localhost:8080'; +/** Environment variable to locate the Emulator Hub */ +const HUB_HOST_ENV: string = 'FIREBASE_EMULATOR_HUB'; +/** The default address for the Emulator hub */ +const HUB_HOST_DEFAULT: string = 'localhost:4400'; + /** The actual address for the database emulator */ let _databaseHost: string | undefined = undefined; @@ -307,7 +312,7 @@ export type LoadDatabaseRulesOptions = { databaseName: string; rules: string; }; -export function loadDatabaseRules( +export async function loadDatabaseRules( options: LoadDatabaseRulesOptions ): Promise { if (!options.databaseName) { @@ -318,33 +323,25 @@ export function loadDatabaseRules( throw Error('must provide rules to loadDatabaseRules'); } - return new Promise((resolve, reject) => { - request.put( - { - uri: `http://${getDatabaseHost()}/.settings/rules.json?ns=${ - options.databaseName - }`, - headers: { Authorization: 'Bearer owner' }, - body: options.rules - }, - (err, resp, body) => { - if (err) { - reject(err); - } else if (resp.statusCode !== 200) { - reject(JSON.parse(body).error); - } else { - resolve(); - } - } - ); + const resp = await requestPromise(request.put, { + method: 'PUT', + uri: `http://${getDatabaseHost()}/.settings/rules.json?ns=${ + options.databaseName + }`, + headers: { Authorization: 'Bearer owner' }, + body: options.rules }); + + if (resp.statusCode !== 200) { + throw new Error(JSON.parse(resp.body.error)); + } } export type LoadFirestoreRulesOptions = { projectId: string; rules: string; }; -export function loadFirestoreRules( +export async function loadFirestoreRules( options: LoadFirestoreRulesOptions ): Promise { if (!options.projectId) { @@ -355,64 +352,98 @@ export function loadFirestoreRules( throw new Error('must provide rules to loadFirestoreRules'); } - return new Promise((resolve, reject) => { - request.put( - { - uri: `http://${getFirestoreHost()}/emulator/v1/projects/${ - options.projectId - }:securityRules`, - body: JSON.stringify({ - rules: { - files: [{ content: options.rules }] - } - }) - }, - (err, resp, body) => { - if (err) { - reject(err); - } else if (resp.statusCode !== 200) { - console.log('body', body); - reject(JSON.parse(body).error); - } else { - resolve(); - } + const resp = await requestPromise(request.put, { + method: 'PUT', + uri: `http://${getFirestoreHost()}/emulator/v1/projects/${ + options.projectId + }:securityRules`, + body: JSON.stringify({ + rules: { + files: [{ content: options.rules }] } - ); + }) }); + + if (resp.statusCode !== 200) { + throw new Error(JSON.parse(resp.body.error)); + } } export type ClearFirestoreDataOptions = { projectId: string; }; -export function clearFirestoreData( +export async function clearFirestoreData( options: ClearFirestoreDataOptions ): Promise { if (!options.projectId) { throw new Error('projectId not specified'); } - return new Promise((resolve, reject) => { - request.delete( - { - uri: `http://${getFirestoreHost()}/emulator/v1/projects/${ - options.projectId - }/databases/(default)/documents`, - body: JSON.stringify({ - database: `projects/${options.projectId}/databases/(default)` - }) - }, - (err, resp, body) => { - if (err) { - reject(err); - } else if (resp.statusCode !== 200) { - console.log('body', body); - reject(JSON.parse(body).error); - } else { - resolve(); - } - } + const resp = await requestPromise(request.delete, { + method: 'DELETE', + uri: `http://${getFirestoreHost()}/emulator/v1/projects/${ + options.projectId + }/databases/(default)/documents`, + body: JSON.stringify({ + database: `projects/${options.projectId}/databases/(default)` + }) + }); + + if (resp.statusCode !== 200) { + throw new Error(JSON.parse(resp.body.error)); + } +} + +/** + * Run a setup function with background Cloud Functions triggers disabled. This can be used to + * import data into the Realtime Database or Cloud Firestore emulator without triggering locally + * emulated Cloud Functions. + * + * This method only works with Firebase CLI version 8.13.0 or higher. + * + * @param fn an function which returns a promise. + */ +export async function withFunctionTriggersDisabled( + fn: () => TResult | Promise +): Promise { + let hubHost = process.env[HUB_HOST_ENV]; + if (!hubHost) { + console.warn( + `${HUB_HOST_ENV} is not set, assuming the Emulator hub is running at ${HUB_HOST_DEFAULT}` ); + hubHost = HUB_HOST_DEFAULT; + } + + // Disable background triggers + const disableRes = await requestPromise(request.put, { + method: 'PUT', + uri: `http://${hubHost}/functions/disableBackgroundTriggers` }); + if (disableRes.statusCode !== 200) { + throw new Error( + `HTTP Error ${disableRes.statusCode} when disabling functions triggers, are you using firebase-tools 8.13.0 or higher?` + ); + } + + // Run the user's function + let result: TResult | undefined = undefined; + try { + result = await fn(); + } finally { + // Re-enable background triggers + const enableRes = await requestPromise(request.put, { + method: 'PUT', + uri: `http://${hubHost}/functions/enableBackgroundTriggers` + }); + if (enableRes.statusCode !== 200) { + throw new Error( + `HTTP Error ${enableRes.statusCode} when enabling functions triggers, are you using firebase-tools 8.13.0 or higher?` + ); + } + } + + // Return the user's function result + return result; } export function assertFails(pr: Promise): any { @@ -441,3 +472,22 @@ export function assertFails(pr: Promise): any { export function assertSucceeds(pr: Promise): any { return pr; } + +function requestPromise( + method: typeof request.get, + options: request.CoreOptions & request.UriOptions +): Promise<{ statusCode: number; body: any }> { + return new Promise((resolve, reject) => { + const callback: request.RequestCallback = (err, resp, body) => { + if (err) { + reject(err); + } else { + resolve({ statusCode: resp.statusCode, body }); + } + }; + + // Unfortunately request's default method is not very test-friendly so having + // the caler pass in the method here makes this whole thing compatible with sinon + method(options, callback); + }); +} diff --git a/packages/rules-unit-testing/test/database.test.ts b/packages/rules-unit-testing/test/database.test.ts index deb7b5c1863..d5929ee8666 100644 --- a/packages/rules-unit-testing/test/database.test.ts +++ b/packages/rules-unit-testing/test/database.test.ts @@ -17,6 +17,8 @@ import * as chai from 'chai'; import * as chaiAsPromised from 'chai-as-promised'; +import * as request from 'request'; +import * as sinon from 'sinon'; import * as firebase from '../src/api'; import { base64 } from '@firebase/util'; import { _FirebaseApp } from '@firebase/app-types/private'; @@ -28,6 +30,15 @@ before(() => { }); describe('Testing Module Tests', function () { + let sandbox: sinon.SinonSandbox; + beforeEach(function () { + sandbox = sinon.createSandbox(); + }); + + afterEach(function () { + sandbox && sandbox.restore(); + }); + it('assertSucceeds() iff success', async function () { const success = Promise.resolve('success'); const failure = Promise.reject('failure'); @@ -262,19 +273,19 @@ describe('Testing Module Tests', function () { it('loadDatabaseRules() throws if no databaseName or rules', async function () { // eslint-disable-next-line @typescript-eslint/no-explicit-any - await expect((firebase as any).loadDatabaseRules.bind(null, {})).to.throw( - /databaseName not specified/ - ); + await expect( + firebase.loadDatabaseRules({} as any) + ).to.eventually.be.rejectedWith(/databaseName not specified/); // eslint-disable-next-line @typescript-eslint/no-explicit-any await expect( - (firebase as any).loadDatabaseRules.bind(null, { + firebase.loadDatabaseRules({ databaseName: 'foo' - }) as Promise - ).to.throw(/must provide rules/); + } as any) + ).to.eventually.be.rejectedWith(/must provide rules/); await expect( // eslint-disable-next-line @typescript-eslint/no-explicit-any - (firebase as any).loadDatabaseRules.bind(null, { rules: '{}' }) - ).to.throw(/databaseName not specified/); + firebase.loadDatabaseRules({ rules: '{}' } as any) + ).to.eventually.be.rejectedWith(/databaseName not specified/); }); it('loadDatabaseRules() succeeds on valid input', async function () { @@ -318,4 +329,26 @@ describe('Testing Module Tests', function () { it('there is a way to get firestore timestamps', function () { expect(firebase.firestore.FieldValue.serverTimestamp()).not.to.be.null; }); + + it('disabling function triggers does not throw, returns value', async function () { + const putSpy = sandbox.spy(request, 'put'); + + const res = await firebase.withFunctionTriggersDisabled(() => { + return Promise.resolve(1234); + }); + + expect(res).to.eq(1234); + expect(putSpy.callCount).to.equal(2); + }); + + it('disabling function triggers always re-enables, event when the function throws', async function () { + const putSpy = sandbox.spy(request, 'put'); + + const res = firebase.withFunctionTriggersDisabled(() => { + throw new Error('I throw!'); + }); + + await expect(res).to.eventually.be.rejectedWith('I throw!'); + expect(putSpy.callCount).to.equal(2); + }); }); diff --git a/yarn.lock b/yarn.lock index 82cc1f120f2..fa023cc87b3 100644 --- a/yarn.lock +++ b/yarn.lock @@ -7280,6 +7280,64 @@ firebase-tools@8.12.1: winston "^3.0.0" ws "^7.2.3" +firebase-tools@8.13.0: + version "8.13.0" + resolved "https://registry.npmjs.org/firebase-tools/-/firebase-tools-8.13.0.tgz#324eb47d9c3987b85dfa6818aebd077df0fc431b" + integrity sha512-IlGJA5WVDTrjj02anUhuBwaCHe+WtB0gNbp9SjIRqIVYbMpJWPi25sqyiJ5kb4u7r7lZOcSGQbAYHqpDdzakfQ== + dependencies: + "@google-cloud/pubsub" "^1.7.0" + JSONStream "^1.2.1" + archiver "^3.0.0" + body-parser "^1.19.0" + chokidar "^3.0.2" + cjson "^0.3.1" + cli-color "^1.2.0" + cli-table "^0.3.1" + commander "^4.0.1" + configstore "^5.0.1" + cross-env "^5.1.3" + cross-spawn "^7.0.1" + csv-streamify "^3.0.4" + dotenv "^6.1.0" + exegesis-express "^2.0.0" + exit-code "^1.0.2" + express "^4.16.4" + filesize "^3.1.3" + fs-extra "^0.23.1" + glob "^7.1.2" + google-auth-library "^5.5.0" + google-gax "~1.12.0" + inquirer "~6.3.1" + js-yaml "^3.13.1" + jsonschema "^1.0.2" + jsonwebtoken "^8.2.1" + leven "^3.1.0" + lodash "^4.17.19" + marked "^0.7.0" + marked-terminal "^3.3.0" + minimatch "^3.0.4" + morgan "^1.10.0" + open "^6.3.0" + ora "^3.4.0" + plist "^3.0.1" + portfinder "^1.0.23" + progress "^2.0.3" + request "^2.87.0" + rimraf "^3.0.0" + semver "^5.7.1" + superstatic "^7.0.0" + tar "^4.3.0" + tcp-port-used "^1.0.1" + tmp "0.0.33" + triple-beam "^1.3.0" + tweetsodium "0.0.5" + universal-analytics "^0.4.16" + unzipper "^0.10.10" + update-notifier "^4.1.0" + uuid "^3.0.0" + winston "^3.0.0" + ws "^7.2.3" + flagged-respawn@^1.0.0: version "1.0.1" resolved "https://registry.npmjs.org/flagged-respawn/-/flagged-respawn-1.0.1.tgz#e7de6f1279ddd9ca9aac8a5971d618606b3aab41" From a74a1d167ddb16c9db4f259bbc0837325180e170 Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Mon, 2 Nov 2020 17:17:05 -0800 Subject: [PATCH 061/624] Functions compat package (#3739) --- packages-exp/app-exp/src/constants.ts | 2 + packages-exp/functions-compat/.eslintrc.js | 37 +++++ packages-exp/functions-compat/karma.conf.js | 35 +++++ packages-exp/functions-compat/package.json | 64 ++++++++ .../functions-compat/rollup.config.base.js | 100 ++++++++++++ .../functions-compat/rollup.config.js | 21 +++ .../functions-compat/rollup.config.release.js | 25 +++ .../functions-compat/src/callable.test.ts | 146 ++++++++++++++++++ .../functions-compat/src/index.node.ts | 23 +++ packages-exp/functions-compat/src/index.ts | 23 +++ packages-exp/functions-compat/src/register.ts | 64 ++++++++ .../functions-compat/src/service.test.ts | 95 ++++++++++++ packages-exp/functions-compat/src/service.ts | 81 ++++++++++ packages-exp/functions-compat/test/utils.ts | 38 +++++ packages-exp/functions-compat/tsconfig.json | 9 ++ packages-exp/functions-exp/package.json | 1 + 16 files changed, 764 insertions(+) create mode 100644 packages-exp/functions-compat/.eslintrc.js create mode 100644 packages-exp/functions-compat/karma.conf.js create mode 100644 packages-exp/functions-compat/package.json create mode 100644 packages-exp/functions-compat/rollup.config.base.js create mode 100644 packages-exp/functions-compat/rollup.config.js create mode 100644 packages-exp/functions-compat/rollup.config.release.js create mode 100644 packages-exp/functions-compat/src/callable.test.ts create mode 100644 packages-exp/functions-compat/src/index.node.ts create mode 100644 packages-exp/functions-compat/src/index.ts create mode 100644 packages-exp/functions-compat/src/register.ts create mode 100644 packages-exp/functions-compat/src/service.test.ts create mode 100644 packages-exp/functions-compat/src/service.ts create mode 100644 packages-exp/functions-compat/test/utils.ts create mode 100644 packages-exp/functions-compat/tsconfig.json diff --git a/packages-exp/app-exp/src/constants.ts b/packages-exp/app-exp/src/constants.ts index 8147920c734..61517c49794 100644 --- a/packages-exp/app-exp/src/constants.ts +++ b/packages-exp/app-exp/src/constants.ts @@ -21,6 +21,7 @@ import { name as analyticsName } from '../../../packages/analytics/package.json' import { name as authName } from '../../../packages/auth/package.json'; import { name as databaseName } from '../../../packages/database/package.json'; import { name as functionsName } from '../../../packages-exp/functions-exp/package.json'; +import { name as functionsCompatName } from '../../../packages-exp/functions-compat/package.json'; import { name as installationsName } from '../../../packages/installations/package.json'; import { name as messagingName } from '../../../packages/messaging/package.json'; import { name as performanceName } from '../../../packages/performance/package.json'; @@ -43,6 +44,7 @@ export const PLATFORM_LOG_STRING = { [authName]: 'fire-auth', [databaseName]: 'fire-rtdb', [functionsName]: 'fire-fn', + [functionsCompatName]: 'fire-fn-compat', [installationsName]: 'fire-iid', [messagingName]: 'fire-fcm', [performanceName]: 'fire-perf', diff --git a/packages-exp/functions-compat/.eslintrc.js b/packages-exp/functions-compat/.eslintrc.js new file mode 100644 index 00000000000..11fa60d3e6a --- /dev/null +++ b/packages-exp/functions-compat/.eslintrc.js @@ -0,0 +1,37 @@ +/* eslint-disable @typescript-eslint/no-require-imports */ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +const path = require('path'); + +module.exports = { + extends: '../../config/.eslintrc.js', + parserOptions: { + project: 'tsconfig.json', + // to make vscode-eslint work with monorepo + // https://github.com/typescript-eslint/typescript-eslint/issues/251#issuecomment-463943250 + tsconfigRootDir: __dirname + }, + rules: { + 'import/no-extraneous-dependencies': [ + 'error', + { + 'packageDir': [path.resolve(__dirname, '../../'), __dirname], + devDependencies: true + } + ] + } +}; diff --git a/packages-exp/functions-compat/karma.conf.js b/packages-exp/functions-compat/karma.conf.js new file mode 100644 index 00000000000..c0737457c55 --- /dev/null +++ b/packages-exp/functions-compat/karma.conf.js @@ -0,0 +1,35 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +const karmaBase = require('../../config/karma.base'); + +const files = ['test/**/*', 'src/**/*.test.ts']; + +module.exports = function (config) { + const karmaConfig = Object.assign({}, karmaBase, { + // files to load into karma + files: files, + // frameworks to use + // available frameworks: https://npmjs.org/browse/keyword/karma-adapter + preprocessors: { '**/*.ts': ['webpack', 'sourcemap'] }, + frameworks: ['mocha'] + }); + + config.set(karmaConfig); +}; + +module.exports.files = files; diff --git a/packages-exp/functions-compat/package.json b/packages-exp/functions-compat/package.json new file mode 100644 index 00000000000..d6c5b15eb1c --- /dev/null +++ b/packages-exp/functions-compat/package.json @@ -0,0 +1,64 @@ +{ + "name": "@firebase/functions-compat", + "version": "0.0.800", + "description": "", + "private": true, + "author": "Firebase (https://firebase.google.com/)", + "main": "dist/index.node.cjs.js", + "browser": "dist/index.esm5.js", + "module": "dist/index.esm5.js", + "esm2017": "dist/index.esm2017.js", + "files": [ + "dist" + ], + "license": "Apache-2.0", + "peerDependencies": { + "@firebase/app-compat": "0.x" + }, + "devDependencies": { + "@firebase/app-compat": "0.0.800", + "rollup": "2.29.0", + "@rollup/plugin-json": "4.1.0", + "rollup-plugin-typescript2": "0.27.3", + "typescript": "4.0.2" + }, + "repository": { + "directory": "packages-exp/functions-compat", + "type": "git", + "url": "https://github.com/firebase/firebase-js-sdk.git" + }, + "bugs": { + "url": "https://github.com/firebase/firebase-js-sdk/issues" + }, + "scripts": { + "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'", + "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'", + "build": "rollup -c", + "build:deps": "lerna run --scope @firebase/functions-compat --include-dependencies build", + "build:release": "rollup -c rollup.config.release.js", + "dev": "rollup -c -w", + "test": "run-p lint test:all", + "test:ci": "node ../../scripts/run_tests_in_ci.js -s test:all", + "test:all": "run-p test:browser test:node", + "test:browser": "karma start --single-run", + "test:browser:debug": "karma start --browsers=Chrome --auto-watch", + "test:node": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'src/{,!(browser)/**/}*.test.ts' --file src/index.node.ts --config ../../config/mocharc.node.js", + "test:emulator": "env FIREBASE_FUNCTIONS_HOST=http://localhost FIREBASE_FUNCTIONS_PORT=5005 run-p test:node", + "prepare": "yarn build:release" + }, + "typings": "dist/functions-compat-public.d.ts", + "dependencies": { + "@firebase/component": "0.1.20", + "@firebase/functions-exp": "0.0.800", + "@firebase/functions-types-exp": "0.0.800", + "@firebase/messaging-types": "0.5.0", + "@firebase/util": "0.3.3", + "tslib": "^1.11.1" + }, + "nyc": { + "extension": [ + ".ts" + ], + "reportDir": "./coverage/node" + } +} \ No newline at end of file diff --git a/packages-exp/functions-compat/rollup.config.base.js b/packages-exp/functions-compat/rollup.config.base.js new file mode 100644 index 00000000000..ebb941e4225 --- /dev/null +++ b/packages-exp/functions-compat/rollup.config.base.js @@ -0,0 +1,100 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import json from '@rollup/plugin-json'; +import typescriptPlugin from 'rollup-plugin-typescript2'; +import typescript from 'typescript'; +import pkg from './package.json'; + +const deps = Object.keys( + Object.assign({}, pkg.peerDependencies, pkg.dependencies) +); + +/** + * ES5 Builds + */ +export function getEs5Builds(additionalTypescriptPlugins = {}) { + const es5BuildPlugins = [ + typescriptPlugin({ + typescript, + abortOnError: false, + ...additionalTypescriptPlugins + }), + json() + ]; + return [ + /** + * Browser Builds + */ + { + input: 'src/index.ts', + output: [{ file: pkg.module, format: 'es', sourcemap: true }], + plugins: es5BuildPlugins, + external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)) + }, + /** + * Node.js Build + */ + { + input: 'src/index.node.ts', + output: [{ file: pkg.main, format: 'cjs', sourcemap: true }], + plugins: es5BuildPlugins, + external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)) + } + ]; +} + +/** + * ES2017 Builds + */ +export function getEs2017Builds(additionalTypescriptPlugins = {}) { + const es2017BuildPlugins = [ + typescriptPlugin({ + typescript, + abortOnError: false, + tsconfigOverride: { + compilerOptions: { + target: 'es2017' + } + }, + ...additionalTypescriptPlugins + }), + json({ preferConst: true }) + ]; + return [ + { + /** + * Browser Build + */ + input: 'src/index.ts', + output: { + file: pkg.esm2017, + format: 'es', + sourcemap: true + }, + plugins: es2017BuildPlugins, + external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)) + } + ]; +} + +export function getAllBuilds(additionalTypescriptPlugins = {}) { + return [ + ...getEs5Builds(additionalTypescriptPlugins), + ...getEs2017Builds(additionalTypescriptPlugins) + ]; +} diff --git a/packages-exp/functions-compat/rollup.config.js b/packages-exp/functions-compat/rollup.config.js new file mode 100644 index 00000000000..7746175a9a6 --- /dev/null +++ b/packages-exp/functions-compat/rollup.config.js @@ -0,0 +1,21 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { getAllBuilds } from './rollup.config.base'; + +// eslint-disable-next-line import/no-default-export +export default getAllBuilds({}); diff --git a/packages-exp/functions-compat/rollup.config.release.js b/packages-exp/functions-compat/rollup.config.release.js new file mode 100644 index 00000000000..d364683678a --- /dev/null +++ b/packages-exp/functions-compat/rollup.config.release.js @@ -0,0 +1,25 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { importPathTransformer } from '../../scripts/exp/ts-transform-import-path'; +import { getAllBuilds } from './rollup.config.base'; + +// eslint-disable-next-line import/no-default-export +export default getAllBuilds({ + clean: true, + transformers: [importPathTransformer] +}); diff --git a/packages-exp/functions-compat/src/callable.test.ts b/packages-exp/functions-compat/src/callable.test.ts new file mode 100644 index 00000000000..5eaf2db5714 --- /dev/null +++ b/packages-exp/functions-compat/src/callable.test.ts @@ -0,0 +1,146 @@ +/** + * @license + * Copyright 2017 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +import { expect } from 'chai'; +import { FirebaseApp } from '@firebase/app-types'; +import { FunctionsErrorCode } from '@firebase/functions-types-exp'; +import { createTestService } from '../test/utils'; +import { firebase } from '@firebase/app-compat'; + +// eslint-disable-next-line @typescript-eslint/no-require-imports +export const TEST_PROJECT = require('../../../config/project.json'); + +// Chai doesn't handle Error comparisons in a useful way. +// https://github.com/chaijs/chai/issues/608 +async function expectError( + promise: Promise, + code: FunctionsErrorCode, + message: string, + details?: any +): Promise { + let failed = false; + try { + await promise; + } catch (e) { + failed = true; + // Errors coming from callable functions usually have the functions-exp + // code in the message since it's thrown inside functions-exp. + expect(e.code).to.match(new RegExp(`functions.*/${code}`)); + expect(e.message).to.equal(message); + expect(e.details).to.deep.equal(details); + } + if (!failed) { + expect(false, 'Promise should have failed.').to.be.true; + } +} + +describe('Firebase Functions > Call', () => { + let app: FirebaseApp; + const region = 'us-central1'; + + before(() => { + const useEmulator = !!process.env.HOST; + const projectId = useEmulator + ? 'functions-integration-test' + : TEST_PROJECT.projectId; + const messagingSenderId = 'messaging-sender-id'; + + app = firebase.initializeApp({ projectId, messagingSenderId }); + }); + + after(async () => { + await app.delete(); + }); + + it('simple data', async () => { + const functions = createTestService(app, region); + // TODO(klimt): Should we add an API to create a "long" in JS? + const data = { + bool: true, + int: 2, + str: 'four', + array: [5, 6], + null: null + }; + + const func = functions.httpsCallable('dataTest'); + const result = await func(data); + + expect(result.data).to.deep.equal({ + message: 'stub response', + code: 42, + long: 420 + }); + }); + + it('scalars', async () => { + const functions = createTestService(app, region); + const func = functions.httpsCallable('scalarTest'); + const result = await func(17); + expect(result.data).to.equal(76); + }); + + it('null', async () => { + const functions = createTestService(app, region); + const func = functions.httpsCallable('nullTest'); + let result = await func(null); + expect(result.data).to.be.null; + + // Test with void arguments version. + result = await func(); + expect(result.data).to.be.null; + }); + + it('missing result', async () => { + const functions = createTestService(app, region); + const func = functions.httpsCallable('missingResultTest'); + await expectError(func(), 'internal', 'Response is missing data field.'); + }); + + it('unhandled error', async () => { + const functions = createTestService(app, region); + const func = functions.httpsCallable('unhandledErrorTest'); + await expectError(func(), 'internal', 'internal'); + }); + + it('unknown error', async () => { + const functions = createTestService(app, region); + const func = functions.httpsCallable('unknownErrorTest'); + await expectError(func(), 'internal', 'internal'); + }); + + it('explicit error', async () => { + const functions = createTestService(app, region); + const func = functions.httpsCallable('explicitErrorTest'); + await expectError(func(), 'out-of-range', 'explicit nope', { + start: 10, + end: 20, + long: 30 + }); + }); + + it('http error', async () => { + const functions = createTestService(app, region); + const func = functions.httpsCallable('httpErrorTest'); + await expectError(func(), 'invalid-argument', 'invalid-argument'); + }); + + it('timeout', async () => { + const functions = createTestService(app, region); + const func = functions.httpsCallable('timeoutTest', { timeout: 10 }); + await expectError(func(), 'deadline-exceeded', 'deadline-exceeded'); + }); +}); diff --git a/packages-exp/functions-compat/src/index.node.ts b/packages-exp/functions-compat/src/index.node.ts new file mode 100644 index 00000000000..f560f4aa251 --- /dev/null +++ b/packages-exp/functions-compat/src/index.node.ts @@ -0,0 +1,23 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { firebase } from '@firebase/app-compat'; +import { name, version } from '../package.json'; +import { registerFunctions } from './register'; + +registerFunctions(); +firebase.registerVersion(name, version, 'node'); diff --git a/packages-exp/functions-compat/src/index.ts b/packages-exp/functions-compat/src/index.ts new file mode 100644 index 00000000000..159d9a6590e --- /dev/null +++ b/packages-exp/functions-compat/src/index.ts @@ -0,0 +1,23 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { firebase } from '@firebase/app-compat'; +import { name, version } from '../package.json'; +import { registerFunctions } from './register'; + +registerFunctions(); +firebase.registerVersion(name, version); diff --git a/packages-exp/functions-compat/src/register.ts b/packages-exp/functions-compat/src/register.ts new file mode 100644 index 00000000000..de761d4521e --- /dev/null +++ b/packages-exp/functions-compat/src/register.ts @@ -0,0 +1,64 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import firebase from '@firebase/app-compat'; +import { _FirebaseNamespace } from '@firebase/app-types/private'; +import { FunctionsService } from './service'; +import '@firebase/functions-exp'; +import { + Component, + ComponentType, + InstanceFactory, + ComponentContainer +} from '@firebase/component'; +import { FirebaseApp } from '@firebase/app-types'; +import { Functions as FunctionsServiceExp } from '@firebase/functions-types-exp'; + +declare module '@firebase/component' { + interface NameServiceMapping { + 'app-compat': FirebaseApp; + 'functions-compat': FunctionsService; + 'functions-exp': FunctionsServiceExp; + } +} + +const factory: InstanceFactory<'functions-compat'> = ( + container: ComponentContainer, + regionOrCustomDomain?: string +) => { + // Dependencies + const app = container.getProvider('app-compat').getImmediate(); + const functionsServiceExp = container + .getProvider('functions-exp') + .getImmediate({ + identifier: regionOrCustomDomain + }); + + return new FunctionsService(app as FirebaseApp, functionsServiceExp); +}; + +export function registerFunctions(): void { + const namespaceExports = { + // no-inline + Functions: FunctionsService + }; + (firebase as _FirebaseNamespace).INTERNAL.registerComponent( + new Component('functions-compat', factory, ComponentType.PUBLIC) + .setServiceProps(namespaceExports) + .setMultipleInstances(true) + ); +} diff --git a/packages-exp/functions-compat/src/service.test.ts b/packages-exp/functions-compat/src/service.test.ts new file mode 100644 index 00000000000..e81b6ac7f0c --- /dev/null +++ b/packages-exp/functions-compat/src/service.test.ts @@ -0,0 +1,95 @@ +/** + * @license + * Copyright 2017 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +import { expect, use } from 'chai'; +import { createTestService } from '../test/utils'; +import { FunctionsService } from './service'; +import { firebase } from '@firebase/app-compat'; +import { FirebaseApp } from '@firebase/app-types'; +import * as functionsExp from '@firebase/functions-exp'; +import { stub, match, SinonStub } from 'sinon'; +import * as sinonChai from 'sinon-chai'; + +use(sinonChai); + +describe('Firebase Functions > Service', () => { + let app: FirebaseApp; + let service: FunctionsService; + let functionsEmulatorStub: SinonStub = stub(); + let httpsCallableStub: SinonStub = stub(); + + before(() => { + functionsEmulatorStub = stub(functionsExp, 'useFunctionsEmulator'); + httpsCallableStub = stub(functionsExp, 'httpsCallable'); + }); + + beforeEach(() => { + app = firebase.initializeApp({ + projectId: 'my-project', + messagingSenderId: 'messaging-sender-id' + }); + }); + + afterEach(async () => { + await app.delete(); + }); + + after(() => { + functionsEmulatorStub.restore(); + httpsCallableStub.restore(); + }); + + it('useFunctionsEmulator (deprecated) calls modular useEmulator', () => { + service = createTestService(app); + service.useFunctionsEmulator('http://localhost:5005'); + expect(functionsEmulatorStub).to.be.calledWith( + match.any, + 'localhost', + 5005 + ); + functionsEmulatorStub.resetHistory(); + }); + + it('useEmulator calls modular useEmulator', () => { + service = createTestService(app); + service.useEmulator('otherlocalhost', 5006); + expect(functionsEmulatorStub).to.be.calledWith( + match.any, + 'otherlocalhost', + 5006 + ); + functionsEmulatorStub.resetHistory(); + }); + + it('httpsCallable calls modular httpsCallable', () => { + service = createTestService(app); + service.httpsCallable('blah', { timeout: 2000 }); + expect(httpsCallableStub).to.be.calledWith(match.any, 'blah', { + timeout: 2000 + }); + httpsCallableStub.resetHistory(); + }); + + it('correctly sets region', () => { + service = createTestService(app, 'my-region'); + expect(service._region).to.equal('my-region'); + }); + + it('correctly sets custom domain', () => { + service = createTestService(app, 'https://mydomain.com'); + expect(service._customDomain).to.equal('https://mydomain.com'); + }); +}); diff --git a/packages-exp/functions-compat/src/service.ts b/packages-exp/functions-compat/src/service.ts new file mode 100644 index 00000000000..de71ceb1e45 --- /dev/null +++ b/packages-exp/functions-compat/src/service.ts @@ -0,0 +1,81 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { + httpsCallable as httpsCallableExp, + useFunctionsEmulator as useFunctionsEmulatorExp +} from '@firebase/functions-exp'; +import { FirebaseFunctions, HttpsCallable } from '@firebase/functions-types'; +import { + HttpsCallableOptions, + Functions as FunctionsServiceExp +} from '@firebase/functions-types-exp'; +import { FirebaseApp } from '@firebase/app-types'; +import { FirebaseError } from '@firebase/util'; + +export class FunctionsService implements FirebaseFunctions { + /** + * For testing. + * @internal + */ + _region: string; + /** + * For testing. + * @internal + */ + _customDomain: string | null; + + constructor( + public app: FirebaseApp, + private _functionsInstance: FunctionsServiceExp + ) { + this._region = this._functionsInstance.region; + this._customDomain = this._functionsInstance.customDomain; + } + httpsCallable(name: string, options?: HttpsCallableOptions): HttpsCallable { + return httpsCallableExp(this._functionsInstance, name, options); + } + /** + * Deprecated in pre-modularized repo, does not exist in modularized + * functions package, need to convert to "host" and "port" args that + * `useFunctionsEmulatorExp` takes. + * @deprecated + */ + useFunctionsEmulator(origin: string): void { + const match = origin.match('[a-zA-Z]+://([a-zA-Z0-9.-]+)(?::([0-9]+))?'); + if (match == null) { + throw new FirebaseError( + 'functions', + 'No origin provided to useFunctionsEmulator()' + ); + } + if (match[2] == null) { + throw new FirebaseError( + 'functions', + 'Port missing in origin provided to useFunctionsEmulator()' + ); + } + return useFunctionsEmulatorExp( + this._functionsInstance, + match[1], + Number(match[2]) + ); + } + useEmulator(host: string, port: number): void { + return useFunctionsEmulatorExp(this._functionsInstance, host, port); + } +} diff --git a/packages-exp/functions-compat/test/utils.ts b/packages-exp/functions-compat/test/utils.ts new file mode 100644 index 00000000000..b824c8eb32e --- /dev/null +++ b/packages-exp/functions-compat/test/utils.ts @@ -0,0 +1,38 @@ +/** + * @license + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { FirebaseApp } from '@firebase/app-types'; +import { FunctionsService } from '../src/service'; +import { getFunctions } from '@firebase/functions-exp'; + +export function createTestService( + app: FirebaseApp, + regionOrCustomDomain?: string +): FunctionsService { + const functions = new FunctionsService( + app, + getFunctions(app, regionOrCustomDomain) + ); + const useEmulator = !!process.env.FIREBASE_FUNCTIONS_EMULATOR_HOST; + if (useEmulator) { + functions.useEmulator( + process.env.FIREBASE_FUNCTIONS_EMULATOR_HOST!, + Number(process.env.FIREBASE_FUNCTIONS_EMULATOR_PORT!) + ); + } + return functions; +} diff --git a/packages-exp/functions-compat/tsconfig.json b/packages-exp/functions-compat/tsconfig.json new file mode 100644 index 00000000000..a06ed9a374c --- /dev/null +++ b/packages-exp/functions-compat/tsconfig.json @@ -0,0 +1,9 @@ +{ + "extends": "../../config/tsconfig.base.json", + "compilerOptions": { + "outDir": "dist" + }, + "exclude": [ + "dist/**/*" + ] +} \ No newline at end of file diff --git a/packages-exp/functions-exp/package.json b/packages-exp/functions-exp/package.json index aedc77d1d0a..9d883f5fa87 100644 --- a/packages-exp/functions-exp/package.json +++ b/packages-exp/functions-exp/package.json @@ -37,6 +37,7 @@ "devDependencies": { "@firebase/app-exp": "0.0.800", "rollup": "2.29.0", + "@rollup/plugin-json": "4.1.0", "rollup-plugin-typescript2": "0.27.3", "typescript": "4.0.5" }, From d7c6d62130bc8bf9de511142caebf511450e2a7d Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Tue, 3 Nov 2020 09:07:33 -0800 Subject: [PATCH 062/624] Fix to avoid false failures on changeset checker (#4012) --- .github/workflows/check-changeset.yml | 4 +++- scripts/check_changeset.ts | 1 + 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/check-changeset.yml b/.github/workflows/check-changeset.yml index d8082f09804..8eb8be911c8 100644 --- a/.github/workflows/check-changeset.yml +++ b/.github/workflows/check-changeset.yml @@ -24,6 +24,8 @@ jobs: id: check-changeset - name: Print changeset checker output run: echo "${{steps.check-changeset.outputs.CHANGESET_ERROR_MESSAGE}}" + - name: Print blocking failure status + run: echo "${{steps.check-changeset.outputs.BLOCKING_FAILURE}}" - name: Find Comment uses: peter-evans/find-comment@v1 id: fc @@ -59,5 +61,5 @@ jobs: - No changeset formatting errors detected. # Don't want it to throw before editing the comment. - name: Fail if checker script logged a blocking failure - if: ${{steps.check-changeset.outputs.BLOCKING_FAILURE}} + if: ${{steps.check-changeset.outputs.BLOCKING_FAILURE == 'true'}} run: exit 1 \ No newline at end of file diff --git a/scripts/check_changeset.ts b/scripts/check_changeset.ts index 41532423f03..aa1a4e25de8 100644 --- a/scripts/check_changeset.ts +++ b/scripts/check_changeset.ts @@ -87,6 +87,7 @@ async function main() { const errors = []; try { await exec('yarn changeset status'); + console.log(`::set-output name=BLOCKING_FAILURE::false`); } catch (e) { const messageLines = e.message.replace(/🦋 error /g, '').split('\n'); let formattedStatusError = From 007ddd1eb6be0a66df7b1c3264d8dff8857d8399 Mon Sep 17 00:00:00 2001 From: Sebastian Schmidt Date: Tue, 3 Nov 2020 10:17:09 -0800 Subject: [PATCH 063/624] Add changeset for Firestore (#4030) --- .changeset/my-random-name.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .changeset/my-random-name.md diff --git a/.changeset/my-random-name.md b/.changeset/my-random-name.md new file mode 100644 index 00000000000..317726cb720 --- /dev/null +++ b/.changeset/my-random-name.md @@ -0,0 +1,6 @@ + +--- +"@firebase/firestore": patch +--- + +Internal changes to support upcoming modular API. From 86971662ccb39ed56dfed6406417dc155e4c2fc2 Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Tue, 3 Nov 2020 15:16:48 -0800 Subject: [PATCH 064/624] Update functions-compat dep version and fix changeset script error (#4032) --- .changeset/config.json | 1 + packages-exp/functions-compat/package.json | 2 +- scripts/check_changeset.ts | 4 +--- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/.changeset/config.json b/.changeset/config.json index 9a8a347920c..9864da43f42 100644 --- a/.changeset/config.json +++ b/.changeset/config.json @@ -15,6 +15,7 @@ "@firebase/auth-exp", "@firebase/auth-compat", "@firebase/auth-types-exp", + "@firebase/functions-compat", "@firebase/functions-exp", "@firebase/functions-types-exp", "@firebase/installations-exp", diff --git a/packages-exp/functions-compat/package.json b/packages-exp/functions-compat/package.json index d6c5b15eb1c..4ea817f5fca 100644 --- a/packages-exp/functions-compat/package.json +++ b/packages-exp/functions-compat/package.json @@ -20,7 +20,7 @@ "rollup": "2.29.0", "@rollup/plugin-json": "4.1.0", "rollup-plugin-typescript2": "0.27.3", - "typescript": "4.0.2" + "typescript": "4.0.5" }, "repository": { "directory": "packages-exp/functions-compat", diff --git a/scripts/check_changeset.ts b/scripts/check_changeset.ts index aa1a4e25de8..12ed838178b 100644 --- a/scripts/check_changeset.ts +++ b/scripts/check_changeset.ts @@ -112,9 +112,7 @@ async function main() { } try { const diffData = await getDiffData(); - if (diffData == null) { - process.exit(); - } else { + if (diffData != null) { const { changedPackages, changesetFile } = diffData; const changesetPackages = await parseChangesetFile(changesetFile); const missingPackages = [...changedPackages].filter( From 39847b8ecf7dea42027f857d4a47179a14f0e5df Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Wed, 4 Nov 2020 11:12:26 -0800 Subject: [PATCH 065/624] Bump node memory limit for all test CI (#4035) --- .github/workflows/test-all.yml | 2 ++ .github/workflows/test-changed-auth.yml | 2 ++ .github/workflows/test-changed-fcm-integration.yml | 2 ++ .github/workflows/test-changed-firestore-integration.yml | 2 ++ .github/workflows/test-changed-firestore.yml | 2 ++ .github/workflows/test-changed-misc.yml | 2 ++ .github/workflows/test-changed.yml | 2 ++ .github/workflows/test-firebase-integration.yml | 2 ++ 8 files changed, 16 insertions(+) diff --git a/.github/workflows/test-all.yml b/.github/workflows/test-all.yml index 4a294bedfba..4291e6343ea 100644 --- a/.github/workflows/test-all.yml +++ b/.github/workflows/test-all.yml @@ -17,6 +17,8 @@ jobs: run: | sudo apt-get update sudo apt-get install google-chrome-stable + - name: Bump Node memory limit + run: echo "NODE_OPTIONS=--max_old_space_size=4096" >> $GITHUB_ENV - name: Test setup and yarn install run: | cp config/ci.config.json config/project.json diff --git a/.github/workflows/test-changed-auth.yml b/.github/workflows/test-changed-auth.yml index a18ffa13b40..7053231056a 100644 --- a/.github/workflows/test-changed-auth.yml +++ b/.github/workflows/test-changed-auth.yml @@ -21,6 +21,8 @@ jobs: run: | sudo apt-get update sudo apt-get install google-chrome-stable + - name: Bump Node memory limit + run: echo "NODE_OPTIONS=--max_old_space_size=4096" >> $GITHUB_ENV - name: Test setup and yarn install run: | cp config/ci.config.json config/project.json diff --git a/.github/workflows/test-changed-fcm-integration.yml b/.github/workflows/test-changed-fcm-integration.yml index 2a127d11a40..90bf59b5c50 100644 --- a/.github/workflows/test-changed-fcm-integration.yml +++ b/.github/workflows/test-changed-fcm-integration.yml @@ -21,6 +21,8 @@ jobs: run: | sudo apt-get update sudo apt-get install google-chrome-stable + - name: Bump Node memory limit + run: echo "NODE_OPTIONS=--max_old_space_size=4096" >> $GITHUB_ENV - name: Test setup and yarn install run: | cp config/ci.config.json config/project.json diff --git a/.github/workflows/test-changed-firestore-integration.yml b/.github/workflows/test-changed-firestore-integration.yml index 387701316b2..1cdbea7e89f 100644 --- a/.github/workflows/test-changed-firestore-integration.yml +++ b/.github/workflows/test-changed-firestore-integration.yml @@ -21,6 +21,8 @@ jobs: run: | sudo apt-get update sudo apt-get install google-chrome-stable + - name: Bump Node memory limit + run: echo "NODE_OPTIONS=--max_old_space_size=4096" >> $GITHUB_ENV - name: Test setup and yarn install run: | cp config/ci.config.json config/project.json diff --git a/.github/workflows/test-changed-firestore.yml b/.github/workflows/test-changed-firestore.yml index b4ced05b867..22bf4595563 100644 --- a/.github/workflows/test-changed-firestore.yml +++ b/.github/workflows/test-changed-firestore.yml @@ -21,6 +21,8 @@ jobs: run: | sudo apt-get update sudo apt-get install google-chrome-stable + - name: Bump Node memory limit + run: echo "NODE_OPTIONS=--max_old_space_size=4096" >> $GITHUB_ENV - name: Test setup and yarn install run: | cp config/ci.config.json config/project.json diff --git a/.github/workflows/test-changed-misc.yml b/.github/workflows/test-changed-misc.yml index 50aad8ea227..3ce5dc767ad 100644 --- a/.github/workflows/test-changed-misc.yml +++ b/.github/workflows/test-changed-misc.yml @@ -21,6 +21,8 @@ jobs: run: | sudo apt-get update sudo apt-get install google-chrome-stable + - name: Bump Node memory limit + run: echo "NODE_OPTIONS=--max_old_space_size=4096" >> $GITHUB_ENV - name: Test setup and yarn install run: | cp config/ci.config.json config/project.json diff --git a/.github/workflows/test-changed.yml b/.github/workflows/test-changed.yml index cb836d9c312..26434d3b678 100644 --- a/.github/workflows/test-changed.yml +++ b/.github/workflows/test-changed.yml @@ -21,6 +21,8 @@ jobs: run: | sudo apt-get update sudo apt-get install google-chrome-stable + - name: Bump Node memory limit + run: echo "NODE_OPTIONS=--max_old_space_size=4096" >> $GITHUB_ENV - name: Test setup and yarn install run: | cp config/ci.config.json config/project.json diff --git a/.github/workflows/test-firebase-integration.yml b/.github/workflows/test-firebase-integration.yml index c42c1c08687..5a05a8bd122 100644 --- a/.github/workflows/test-firebase-integration.yml +++ b/.github/workflows/test-firebase-integration.yml @@ -21,6 +21,8 @@ jobs: run: | sudo apt-get update sudo apt-get install google-chrome-stable + - name: Bump Node memory limit + run: echo "NODE_OPTIONS=--max_old_space_size=4096" >> $GITHUB_ENV - name: Test setup and yarn install run: | cp config/ci.config.json config/project.json From 9d424f5da108e476d570d2bdb42deaf118976ffc Mon Sep 17 00:00:00 2001 From: Sebastian Schmidt Date: Wed, 4 Nov 2020 15:09:56 -0800 Subject: [PATCH 066/624] Compat Layer for Firestore (#4003) --- .../test-changed-firestore-integration.yml | 2 +- .github/workflows/test-changed-firestore.yml | 2 +- packages/firestore/exp/src/api/database.ts | 25 +- packages/firestore/exp/test/shim.ts | 166 +------- packages/firestore/index.console.ts | 44 +- packages/firestore/index.memory.ts | 8 +- packages/firestore/index.node.memory.ts | 8 +- packages/firestore/index.node.ts | 13 +- packages/firestore/index.rn.memory.ts | 8 +- packages/firestore/index.rn.ts | 13 +- packages/firestore/index.ts | 13 +- packages/firestore/lite/src/api/components.ts | 2 +- packages/firestore/lite/src/api/database.ts | 82 ++-- packages/firestore/lite/src/api/reference.ts | 2 +- packages/firestore/src/api/database.ts | 392 ++++++------------ .../firestore/src/api/user_data_reader.ts | 35 +- packages/firestore/src/core/database_info.ts | 9 - .../test/integration/api/database.test.ts | 11 +- .../test/integration/api/type.test.ts | 6 +- .../test/integration/api/validation.test.ts | 161 +++---- .../integration/api_internal/database.test.ts | 2 +- .../test/integration/util/firebase_export.ts | 67 +-- .../test/integration/util/internal_helpers.ts | 2 +- .../firestore/test/unit/api/database.test.ts | 35 +- packages/firestore/test/util/api_helpers.ts | 27 +- scripts/ci-test/build_changed.ts | 23 + 26 files changed, 488 insertions(+), 670 deletions(-) diff --git a/.github/workflows/test-changed-firestore-integration.yml b/.github/workflows/test-changed-firestore-integration.yml index 1cdbea7e89f..d7f0ebde367 100644 --- a/.github/workflows/test-changed-firestore-integration.yml +++ b/.github/workflows/test-changed-firestore-integration.yml @@ -28,6 +28,6 @@ jobs: cp config/ci.config.json config/project.json yarn - name: build - run: yarn build:changed firestore-integration --buildAppExp + run: yarn build:changed firestore-integration --buildAppExp --buildAppCompat - name: Run tests if firestore or its dependencies has changed run: yarn test:changed firestore-integration diff --git a/.github/workflows/test-changed-firestore.yml b/.github/workflows/test-changed-firestore.yml index 22bf4595563..76924c1ce0c 100644 --- a/.github/workflows/test-changed-firestore.yml +++ b/.github/workflows/test-changed-firestore.yml @@ -28,6 +28,6 @@ jobs: cp config/ci.config.json config/project.json yarn - name: build - run: yarn build:changed firestore --buildAppExp + run: yarn build:changed firestore --buildAppExp --buildAppCompat - name: Run tests if firestore or its dependencies has changed run: yarn test:changed firestore diff --git a/packages/firestore/exp/src/api/database.ts b/packages/firestore/exp/src/api/database.ts index b14cd855a7f..7c5e957f64f 100644 --- a/packages/firestore/exp/src/api/database.ts +++ b/packages/firestore/exp/src/api/database.ts @@ -39,14 +39,14 @@ import { FirebaseFirestore as LiteFirestore, Settings as LiteSettings } from '../../../lite/src/api/database'; +import { DatabaseId } from '../../../src/core/database_info'; import { Code, FirestoreError } from '../../../src/util/error'; import { Deferred } from '../../../src/util/promise'; import { LRU_MINIMUM_CACHE_SIZE_BYTES } from '../../../src/local/lru_garbage_collector'; import { CACHE_SIZE_UNLIMITED, configureFirestore, - ensureFirestoreConfigured, - FirestoreCompat + ensureFirestoreConfigured } from '../../../src/api/database'; import { indexedDbClearPersistence, @@ -70,18 +70,19 @@ export interface Settings extends LiteSettings { */ export class FirebaseFirestore extends LiteFirestore - implements _FirebaseService, FirestoreCompat { + implements _FirebaseService { readonly _queue = new AsyncQueue(); readonly _persistenceKey: string; _firestoreClient: FirestoreClient | undefined; constructor( - app: FirebaseApp, + databaseIdOrApp: DatabaseId | FirebaseApp, authProvider: Provider ) { - super(app, authProvider); - this._persistenceKey = app.name; + super(databaseIdOrApp, authProvider); + this._persistenceKey = + 'name' in databaseIdOrApp ? databaseIdOrApp.name : '[DEFAULT]'; } _terminate(): Promise { @@ -165,13 +166,13 @@ export function getFirestore(app: FirebaseApp): FirebaseFirestore { * @return A promise that represents successfully enabling persistent storage. */ export function enableIndexedDbPersistence( - firestore: FirestoreCompat, + firestore: FirebaseFirestore, persistenceSettings?: PersistenceSettings ): Promise { verifyNotInitialized(firestore); const client = ensureFirestoreConfigured(firestore); - const settings = firestore._getSettings(); + const settings = firestore._freezeSettings(); const onlineComponentProvider = new OnlineComponentProvider(); const offlineComponentProvider = new IndexedDbOfflineComponentProvider( @@ -209,12 +210,12 @@ export function enableIndexedDbPersistence( * storage. */ export function enableMultiTabIndexedDbPersistence( - firestore: FirestoreCompat + firestore: FirebaseFirestore ): Promise { verifyNotInitialized(firestore); const client = ensureFirestoreConfigured(firestore); - const settings = firestore._getSettings(); + const settings = firestore._freezeSettings(); const onlineComponentProvider = new OnlineComponentProvider(); const offlineComponentProvider = new MultiTabOfflineComponentProvider( @@ -322,7 +323,7 @@ function canFallbackFromIndexedDbError( * cleared. Otherwise, the promise is rejected with an error. */ export function clearIndexedDbPersistence( - firestore: FirestoreCompat + firestore: FirebaseFirestore ): Promise { if (firestore._initialized && !firestore._terminated) { throw new FirestoreError( @@ -420,7 +421,7 @@ export function terminate(firestore: FirebaseFirestore): Promise { return firestore._delete(); } -function verifyNotInitialized(firestore: FirestoreCompat): void { +function verifyNotInitialized(firestore: FirebaseFirestore): void { if (firestore._initialized || firestore._terminated) { throw new FirestoreError( Code.FAILED_PRECONDITION, diff --git a/packages/firestore/exp/test/shim.ts b/packages/firestore/exp/test/shim.ts index 66a1c08c127..e7d4bb2491c 100644 --- a/packages/firestore/exp/test/shim.ts +++ b/packages/firestore/exp/test/shim.ts @@ -15,24 +15,15 @@ * limitations under the License. */ -import { FirebaseApp as FirebaseAppLegacy } from '@firebase/app-types'; -import { FirebaseApp as FirebaseAppExp } from '@firebase/app-types-exp'; -import { deleteApp } from '@firebase/app-exp'; import * as legacy from '@firebase/firestore-types'; import * as exp from '../index'; import { addDoc, - clearIndexedDbPersistence, collection, - collectionGroup, deleteDoc, - disableNetwork, doc, DocumentReference as DocumentReferenceExp, - enableIndexedDbPersistence, - enableMultiTabIndexedDbPersistence, - enableNetwork, FieldPath as FieldPathExp, getDoc, getDocFromCache, @@ -40,19 +31,13 @@ import { getDocs, getDocsFromCache, getDocsFromServer, - initializeFirestore, onSnapshot, - onSnapshotsInSync, query, queryEqual, refEqual, - runTransaction, setDoc, snapshotEqual, - terminate, updateDoc, - waitForPendingWrites, - writeBatch, endAt, endBefore, startAfter, @@ -70,9 +55,9 @@ import { validateSetOptions } from '../../src/util/input_validation'; import { Compat } from '../../src/compat/compat'; +import { Firestore } from '../../src/api/database'; export { GeoPoint, Timestamp } from '../index'; -export { FieldValue } from '../../src/compat/field_value'; /* eslint-disable @typescript-eslint/no-explicit-any */ @@ -80,105 +65,11 @@ export { FieldValue } from '../../src/compat/field_value'; // of the experimental SDK. This shim is used to run integration tests against // both SDK versions. -export class FirebaseApp - extends Compat - implements FirebaseAppLegacy { - name = this._delegate.name; - options = this._delegate.options; - automaticDataCollectionEnabled = this._delegate - .automaticDataCollectionEnabled; - - delete(): Promise { - return deleteApp(this._delegate); - } -} - -export class FirebaseFirestore - extends Compat - implements legacy.FirebaseFirestore { - app = new FirebaseApp(this._delegate.app); - - settings(settings: legacy.Settings): void { - initializeFirestore(this.app._delegate, settings); - } - - useEmulator(host: string, port: number): void { - this.settings({ host: `${host}:${port}`, ssl: false, merge: true }); - } - - enablePersistence(settings?: legacy.PersistenceSettings): Promise { - return settings?.synchronizeTabs - ? enableMultiTabIndexedDbPersistence(this._delegate) - : enableIndexedDbPersistence(this._delegate); - } - - collection(collectionPath: string): CollectionReference { - return new CollectionReference( - this, - collection(this._delegate, collectionPath) - ); - } - - doc(documentPath: string): DocumentReference { - return new DocumentReference(this, doc(this._delegate, documentPath)); - } - - collectionGroup(collectionId: string): Query { - return new Query(this, collectionGroup(this._delegate, collectionId)); - } - - runTransaction( - updateFunction: (transaction: legacy.Transaction) => Promise - ): Promise { - return runTransaction(this._delegate, t => - updateFunction(new Transaction(this, t)) - ); - } - - batch(): legacy.WriteBatch { - return new WriteBatch(writeBatch(this._delegate)); - } - - clearPersistence(): Promise { - return clearIndexedDbPersistence(this._delegate); - } - - enableNetwork(): Promise { - return enableNetwork(this._delegate); - } - - disableNetwork(): Promise { - return disableNetwork(this._delegate); - } - - waitForPendingWrites(): Promise { - return waitForPendingWrites(this._delegate); - } - - onSnapshotsInSync(observer: { - next?: (value: void) => void; - error?: (error: legacy.FirestoreError) => void; - complete?: () => void; - }): () => void; - onSnapshotsInSync(onSync: () => void): () => void; - onSnapshotsInSync(arg: any): () => void { - return onSnapshotsInSync(this._delegate, arg); - } - - terminate(): Promise { - return terminate(this._delegate); - } - - INTERNAL = { - delete: () => terminate(this._delegate) - }; -} - export class Transaction extends Compat implements legacy.Transaction { constructor( - private readonly _firestore: FirebaseFirestore, + private readonly _firestore: Firestore, delegate: exp.Transaction ) { super(delegate); @@ -301,7 +192,7 @@ export class DocumentReference extends Compat> implements legacy.DocumentReference { constructor( - readonly firestore: FirebaseFirestore, + readonly firestore: Firestore, delegate: exp.DocumentReference ) { super(delegate); @@ -424,7 +315,7 @@ export class DocumentSnapshot extends Compat> implements legacy.DocumentSnapshot { constructor( - private readonly _firestore: FirebaseFirestore, + private readonly _firestore: Firestore, delegate: exp.DocumentSnapshot ) { super(delegate); @@ -439,11 +330,14 @@ export class DocumentSnapshot } data(options?: legacy.SnapshotOptions): T | undefined { - return wrap(this._delegate.data(options)); + return wrap(this._firestore, this._delegate.data(options)); } get(fieldPath: string | FieldPath, options?: legacy.SnapshotOptions): any { - return wrap(this._delegate.get(unwrap(fieldPath), options)); + return wrap( + this._firestore, + this._delegate.get(unwrap(fieldPath), options) + ); } isEqual(other: DocumentSnapshot): boolean { @@ -454,22 +348,15 @@ export class DocumentSnapshot export class QueryDocumentSnapshot extends DocumentSnapshot implements legacy.QueryDocumentSnapshot { - constructor( - firestore: FirebaseFirestore, - readonly _delegate: exp.QueryDocumentSnapshot - ) { - super(firestore, _delegate); - } - data(options?: legacy.SnapshotOptions): T { - return this._delegate.data(options); + return this._delegate.data(options)!; } } export class Query extends Compat> implements legacy.Query { - constructor(readonly firestore: FirebaseFirestore, delegate: exp.Query) { + constructor(readonly firestore: Firestore, delegate: exp.Query) { super(delegate); } @@ -592,7 +479,7 @@ export class Query export class QuerySnapshot implements legacy.QuerySnapshot { constructor( - readonly _firestore: FirebaseFirestore, + readonly _firestore: Firestore, readonly _delegate: exp.QuerySnapshot ) {} @@ -633,7 +520,7 @@ export class QuerySnapshot export class DocumentChange implements legacy.DocumentChange { constructor( - private readonly _firestore: FirebaseFirestore, + private readonly _firestore: Firestore, private readonly _delegate: exp.DocumentChange ) {} readonly type = this._delegate.type; @@ -649,7 +536,7 @@ export class CollectionReference extends Query implements legacy.CollectionReference { constructor( - firestore: FirebaseFirestore, + readonly firestore: Firestore, readonly _delegate: exp.CollectionReference ) { super(firestore, _delegate); @@ -698,15 +585,11 @@ export class CollectionReference } } -export class FieldPath implements legacy.FieldPath { - private readonly fieldNames: string[]; - +export class FieldPath + extends Compat + implements legacy.FieldPath { constructor(...fieldNames: string[]) { - this.fieldNames = fieldNames; - } - - get _delegate(): FieldPathExp { - return new FieldPathExp(...this.fieldNames); + super(new FieldPathExp(...fieldNames)); } static documentId(): FieldPath { @@ -744,25 +627,20 @@ export class Blob extends Compat implements legacy.Blob { * Takes document data that uses the firestore-exp API types and replaces them * with the API types defined in this shim. */ -function wrap(value: any): any { +function wrap(firestore: Firestore, value: any): any { if (Array.isArray(value)) { - return value.map(v => wrap(v)); + return value.map(v => wrap(firestore, v)); } else if (value instanceof FieldPathExp) { return new FieldPath(...value._internalPath.toArray()); } else if (value instanceof BytesExp) { return new Blob(value); } else if (value instanceof DocumentReferenceExp) { - // TODO(mrschmidt): Ideally, we should use an existing instance of - // FirebaseFirestore here rather than instantiating a new instance - return new DocumentReference( - new FirebaseFirestore(value.firestore as exp.FirebaseFirestore), - value - ); + return new DocumentReference(firestore, value); } else if (isPlainObject(value)) { const obj: any = {}; for (const key in value) { if (value.hasOwnProperty(key)) { - obj[key] = wrap(value[key]); + obj[key] = wrap(firestore, value[key]); } } return obj; diff --git a/packages/firestore/index.console.ts b/packages/firestore/index.console.ts index 68a2eba4fef..9db3ba8d117 100644 --- a/packages/firestore/index.console.ts +++ b/packages/firestore/index.console.ts @@ -15,7 +15,15 @@ * limitations under the License. */ -export { Firestore } from './src/api/database'; +import { FirebaseFirestore as FirestoreExp } from './exp/src/api/database'; +import { + Firestore as FirestoreCompat, + MemoryPersistenceProvider +} from './src/api/database'; +import { Provider } from '@firebase/component'; +import { FirebaseAuthInternalName } from '@firebase/auth-interop-types'; +import { DatabaseId } from './src/core/database_info'; +import { Code, FirestoreError } from './src/util/error'; export { CollectionReference, DocumentReference, @@ -27,3 +35,37 @@ export { GeoPoint } from './src/api/geo_point'; export { FieldPath } from './src/api/field_path'; export { FieldValue } from './src/compat/field_value'; export { Timestamp } from './src/api/timestamp'; + +export interface FirestoreDatabase { + projectId: string; + database?: string; +} + +/** Firestore class that exposes the constructor expected by the Console. */ +export class Firestore extends FirestoreCompat { + constructor( + firestoreDatabase: FirestoreDatabase, + authProvider: Provider + ) { + super( + databaseIdFromFirestoreDatabase(firestoreDatabase), + new FirestoreExp( + databaseIdFromFirestoreDatabase(firestoreDatabase), + authProvider + ), + new MemoryPersistenceProvider() + ); + } +} + +function databaseIdFromFirestoreDatabase( + firestoreDatabase: FirestoreDatabase +): DatabaseId { + if (!firestoreDatabase.projectId) { + throw new FirestoreError(Code.INVALID_ARGUMENT, 'Must provide projectId'); + } + return new DatabaseId( + firestoreDatabase.projectId, + firestoreDatabase.database + ); +} diff --git a/packages/firestore/index.memory.ts b/packages/firestore/index.memory.ts index 9b313aad439..915cd1d4fdd 100644 --- a/packages/firestore/index.memory.ts +++ b/packages/firestore/index.memory.ts @@ -19,6 +19,7 @@ import firebase from '@firebase/app'; import { FirebaseNamespace } from '@firebase/app-types'; import { Firestore, MemoryPersistenceProvider } from './src/api/database'; +import { FirebaseFirestore } from './exp/src/api/database'; import { configureForFirebase } from './src/config'; import './register-module'; @@ -31,7 +32,12 @@ import { name, version } from './package.json'; export function registerFirestore(instance: FirebaseNamespace): void { configureForFirebase( instance, - (app, auth) => new Firestore(app, auth, new MemoryPersistenceProvider()) + (app, auth) => + new Firestore( + app, + new FirebaseFirestore(app, auth), + new MemoryPersistenceProvider() + ) ); instance.registerVersion(name, version); } diff --git a/packages/firestore/index.node.memory.ts b/packages/firestore/index.node.memory.ts index 0982b38fe46..ff098861c65 100644 --- a/packages/firestore/index.node.memory.ts +++ b/packages/firestore/index.node.memory.ts @@ -19,6 +19,7 @@ import firebase from '@firebase/app'; import { FirebaseNamespace } from '@firebase/app-types'; import { Firestore, MemoryPersistenceProvider } from './src/api/database'; +import { FirebaseFirestore } from './exp/src/api/database'; import { configureForFirebase } from './src/config'; import './register-module'; @@ -31,7 +32,12 @@ import { name, version } from './package.json'; export function registerFirestore(instance: FirebaseNamespace): void { configureForFirebase( instance, - (app, auth) => new Firestore(app, auth, new MemoryPersistenceProvider()) + (app, auth) => + new Firestore( + app, + new FirebaseFirestore(app, auth), + new MemoryPersistenceProvider() + ) ); instance.registerVersion(name, version, 'node'); } diff --git a/packages/firestore/index.node.ts b/packages/firestore/index.node.ts index 05d406ddb67..ddabccae41a 100644 --- a/packages/firestore/index.node.ts +++ b/packages/firestore/index.node.ts @@ -19,6 +19,7 @@ import { FirebaseNamespace } from '@firebase/app-types'; import { Firestore, IndexedDbPersistenceProvider } from './src/api/database'; import { configureForFirebase } from './src/config'; +import { FirebaseFirestore as ExpFirebaseFirestore } from './exp/src/api/database'; import './register-module'; @@ -29,9 +30,15 @@ import { name, version } from './package.json'; * Persistence can be enabled via `firebase.firestore().enablePersistence()`. */ export function registerFirestore(instance: FirebaseNamespace): void { - configureForFirebase(instance, (app, auth) => { - return new Firestore(app, auth, new IndexedDbPersistenceProvider()); - }); + configureForFirebase( + instance, + (app, auth) => + new Firestore( + app, + new ExpFirebaseFirestore(app, auth), + new IndexedDbPersistenceProvider() + ) + ); instance.registerVersion(name, version, 'node'); } diff --git a/packages/firestore/index.rn.memory.ts b/packages/firestore/index.rn.memory.ts index 4e6ce2537cc..ae767b0b053 100644 --- a/packages/firestore/index.rn.memory.ts +++ b/packages/firestore/index.rn.memory.ts @@ -18,6 +18,7 @@ import firebase from '@firebase/app'; import { FirebaseNamespace } from '@firebase/app-types'; +import { FirebaseFirestore as ExpFirebaseFirestore } from './exp/src/api/database'; import { Firestore, MemoryPersistenceProvider } from './src/api/database'; import { configureForFirebase } from './src/config'; @@ -32,7 +33,12 @@ import { name, version } from './package.json'; export function registerFirestore(instance: FirebaseNamespace): void { configureForFirebase( instance, - (app, auth) => new Firestore(app, auth, new MemoryPersistenceProvider()) + (app, auth) => + new Firestore( + app, + new ExpFirebaseFirestore(app, auth), + new MemoryPersistenceProvider() + ) ); instance.registerVersion(name, version, 'rn'); } diff --git a/packages/firestore/index.rn.ts b/packages/firestore/index.rn.ts index 84cdcf2ffa3..2b51d8a59c4 100644 --- a/packages/firestore/index.rn.ts +++ b/packages/firestore/index.rn.ts @@ -19,6 +19,7 @@ import { FirebaseNamespace } from '@firebase/app-types'; import { Firestore, IndexedDbPersistenceProvider } from './src/api/database'; import { configureForFirebase } from './src/config'; +import { FirebaseFirestore as ExpFirebaseFirestore } from './exp/src/api/database'; import './register-module'; import { name, version } from './package.json'; @@ -28,9 +29,15 @@ import { name, version } from './package.json'; * Persistence can be enabled via `firebase.firestore().enablePersistence()`. */ export function registerFirestore(instance: FirebaseNamespace): void { - configureForFirebase(instance, (app, auth) => { - return new Firestore(app, auth, new IndexedDbPersistenceProvider()); - }); + configureForFirebase( + instance, + (app, auth) => + new Firestore( + app, + new ExpFirebaseFirestore(app, auth), + new IndexedDbPersistenceProvider() + ) + ); instance.registerVersion(name, version, 'rn'); } diff --git a/packages/firestore/index.ts b/packages/firestore/index.ts index 5b40359f0bf..349e29356b4 100644 --- a/packages/firestore/index.ts +++ b/packages/firestore/index.ts @@ -19,6 +19,7 @@ import firebase from '@firebase/app'; import { FirebaseNamespace } from '@firebase/app-types'; import { Firestore, IndexedDbPersistenceProvider } from './src/api/database'; +import { FirebaseFirestore as ExpFirebaseFirestore } from './exp/src/api/database'; import { configureForFirebase } from './src/config'; import { name, version } from './package.json'; @@ -29,9 +30,15 @@ import './register-module'; * Persistence can be enabled via `firebase.firestore().enablePersistence()`. */ export function registerFirestore(instance: FirebaseNamespace): void { - configureForFirebase(instance, (app, auth) => { - return new Firestore(app, auth, new IndexedDbPersistenceProvider()); - }); + configureForFirebase( + instance, + (app, auth) => + new Firestore( + app, + new ExpFirebaseFirestore(app, auth), + new IndexedDbPersistenceProvider() + ) + ); instance.registerVersion(name, version); } diff --git a/packages/firestore/lite/src/api/components.ts b/packages/firestore/lite/src/api/components.ts index 43e4057a231..93ecb360a0c 100644 --- a/packages/firestore/lite/src/api/components.ts +++ b/packages/firestore/lite/src/api/components.ts @@ -55,7 +55,7 @@ export function getDatastore(firestore: FirebaseFirestore): Datastore { const databaseInfo = makeDatabaseInfo( firestore._databaseId, firestore._persistenceKey, - firestore._getSettings() + firestore._freezeSettings() ); const connection = newConnection(databaseInfo); const serializer = newSerializer(firestore._databaseId); diff --git a/packages/firestore/lite/src/api/database.ts b/packages/firestore/lite/src/api/database.ts index c42ab38f774..eac53329fee 100644 --- a/packages/firestore/lite/src/api/database.ts +++ b/packages/firestore/lite/src/api/database.ts @@ -24,8 +24,10 @@ import { DatabaseId, DatabaseInfo } from '../../../src/core/database_info'; import { FirebaseAuthInternalName } from '@firebase/auth-interop-types'; import { CredentialsProvider, + FirebaseCredentialsProvider, CredentialsSettings, - FirebaseCredentialsProvider + EmptyCredentialsProvider, + makeCredentialsProvider } from '../../../src/api/credentials'; import { removeComponents } from './components'; import { @@ -151,29 +153,45 @@ export class FirestoreSettings { */ export class FirebaseFirestore implements _FirebaseService { readonly _databaseId: DatabaseId; - readonly _credentials: CredentialsProvider; readonly _persistenceKey: string = '(lite)'; + _credentials: CredentialsProvider; - protected _settings?: Settings; + private _settings = new FirestoreSettings({}); private _settingsFrozen = false; // A task that is assigned when the terminate() is invoked and resolved when // all components have shut down. private _terminateTask?: Promise; - /** - * The {@link FirebaseApp app} associated with this `Firestore` service - * instance. - */ - readonly app: FirebaseApp; + private _app?: FirebaseApp; constructor( - app: FirebaseApp, + databaseIdOrApp: DatabaseId | FirebaseApp, authProvider: Provider ) { - this.app = app; - this._databaseId = FirebaseFirestore._databaseIdFromApp(app); - this._credentials = new FirebaseCredentialsProvider(authProvider); + if (databaseIdOrApp instanceof DatabaseId) { + this._databaseId = databaseIdOrApp; + this._credentials = new EmptyCredentialsProvider(); + } else { + this._app = databaseIdOrApp as FirebaseApp; + this._databaseId = databaseIdFromApp(databaseIdOrApp as FirebaseApp); + this._credentials = new FirebaseCredentialsProvider(authProvider); + } + } + + /** + * The {@link FirebaseApp app} associated with this `Firestore` service + * instance. + */ + get app(): FirebaseApp { + if (!this._app) { + throw new FirestoreError( + Code.FAILED_PRECONDITION, + "Firestore was not initialized using the Firebase SDK. 'app' is " + + 'not available' + ); + } + return this._app; } get _initialized(): boolean { @@ -184,35 +202,28 @@ export class FirebaseFirestore implements _FirebaseService { return this._terminateTask !== undefined; } - _setSettings(settings: Settings): void { + _setSettings(settings: PrivateSettings): void { if (this._settingsFrozen) { throw new FirestoreError( Code.FAILED_PRECONDITION, 'Firestore has already been started and its settings can no longer ' + - 'be changed. initializeFirestore() cannot be called after calling ' + - 'getFirestore().' + 'be changed. You can only modify settings before calling any other ' + + 'methods on a Firestore object.' ); } - this._settings = settings; + this._settings = new FirestoreSettings(settings); + if (settings.credentials !== undefined) { + this._credentials = makeCredentialsProvider(settings.credentials); + } } _getSettings(): FirestoreSettings { - if (!this._settings) { - this._settings = {}; - } - this._settingsFrozen = true; - return new FirestoreSettings(this._settings); + return this._settings; } - private static _databaseIdFromApp(app: FirebaseApp): DatabaseId { - if (!Object.prototype.hasOwnProperty.apply(app.options, ['projectId'])) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - '"projectId" not provided in firebase.initializeApp.' - ); - } - - return new DatabaseId(app.options.projectId!); + _freezeSettings(): FirestoreSettings { + this._settingsFrozen = true; + return this._settings; } _delete(): Promise { @@ -235,6 +246,17 @@ export class FirebaseFirestore implements _FirebaseService { } } +function databaseIdFromApp(app: FirebaseApp): DatabaseId { + if (!Object.prototype.hasOwnProperty.apply(app.options, ['projectId'])) { + throw new FirestoreError( + Code.INVALID_ARGUMENT, + '"projectId" not provided in firebase.initializeApp.' + ); + } + + return new DatabaseId(app.options.projectId!); +} + /** * Initializes a new instance of Cloud Firestore with the provided settings. * Can only be called before any other functions, including diff --git a/packages/firestore/lite/src/api/reference.ts b/packages/firestore/lite/src/api/reference.ts index 87bb7b4cc52..bd899a4edb7 100644 --- a/packages/firestore/lite/src/api/reference.ts +++ b/packages/firestore/lite/src/api/reference.ts @@ -1221,7 +1221,7 @@ export function queryEqual(left: Query, right: Query): boolean { export function newUserDataReader( firestore: FirebaseFirestore ): UserDataReader { - const settings = firestore._getSettings(); + const settings = firestore._freezeSettings(); const serializer = newSerializer(firestore._databaseId); return new UserDataReader( firestore._databaseId, diff --git a/packages/firestore/src/api/database.ts b/packages/firestore/src/api/database.ts index 7d9e8f799f5..813cad0138e 100644 --- a/packages/firestore/src/api/database.ts +++ b/packages/firestore/src/api/database.ts @@ -16,32 +16,6 @@ */ import { Value as ProtoValue } from '../protos/firestore_proto_api'; -import { - CollectionReference as PublicCollectionReference, - DocumentChange as PublicDocumentChange, - DocumentChangeType, - DocumentData, - DocumentReference as PublicDocumentReference, - DocumentSnapshot as PublicDocumentSnapshot, - FirebaseFirestore as PublicFirestore, - FirestoreDataConverter, - GetOptions, - LogLevel as PublicLogLevel, - OrderByDirection, - PersistenceSettings as PublicPersistenceSettings, - Query as PublicQuery, - QueryDocumentSnapshot as PublicQueryDocumentSnapshot, - QuerySnapshot as PublicQuerySnapshot, - SetOptions, - Settings as PublicSettings, - SnapshotListenOptions, - SnapshotMetadata as PublicSnapshotMetadata, - SnapshotOptions as PublicSnapshotOptions, - Transaction as PublicTransaction, - UpdateData, - WhereFilterOp, - WriteBatch as PublicWriteBatch -} from '@firebase/firestore-types'; import { FirebaseApp } from '@firebase/app-types'; import { _FirebaseApp, FirebaseService } from '@firebase/app-types/private'; @@ -50,16 +24,12 @@ import { DatabaseId } from '../core/database_info'; import { ListenOptions } from '../core/event_manager'; import { FirestoreClient, - firestoreClientAddSnapshotsInSyncListener, - firestoreClientDisableNetwork, - firestoreClientEnableNetwork, firestoreClientGetDocumentFromLocalCache, firestoreClientGetDocumentsFromLocalCache, firestoreClientGetDocumentsViaSnapshotListener, firestoreClientGetDocumentViaSnapshotListener, firestoreClientListen, firestoreClientTransaction, - firestoreClientWaitForPendingWrites, firestoreClientWrite } from '../core/firestore_client'; import { @@ -96,7 +66,6 @@ import { FieldPath, ResourcePath } from '../model/path'; import { isServerTimestamp } from '../model/server_timestamps'; import { refValue } from '../model/values'; import { debugAssert, fail } from '../util/assert'; -import { AsyncQueue } from '../util/async_queue'; import { Code, FirestoreError } from '../util/error'; import { cast, @@ -108,13 +77,7 @@ import { } from '../util/input_validation'; import { logWarn, setLogLevel as setClientLogLevel } from '../util/log'; import { AutoId } from '../util/misc'; -import { FieldPath as ExternalFieldPath } from './field_path'; -import { - CredentialsProvider, - EmptyCredentialsProvider, - FirebaseCredentialsProvider, - makeCredentialsProvider -} from './credentials'; +import { _BaseFieldPath, FieldPath as ExternalFieldPath } from './field_path'; import { CompleteFn, ErrorFn, @@ -134,18 +97,49 @@ import { UserDataReader } from './user_data_reader'; import { UserDataWriter } from './user_data_writer'; -import { FirebaseAuthInternalName } from '@firebase/auth-interop-types'; -import { Provider } from '@firebase/component'; import { clearIndexedDbPersistence, + disableNetwork, enableIndexedDbPersistence, - enableMultiTabIndexedDbPersistence + enableMultiTabIndexedDbPersistence, + enableNetwork, + FirebaseFirestore, + terminate, + waitForPendingWrites, + FirebaseFirestore as ExpFirebaseFirestore } from '../../exp/src/api/database'; +import { onSnapshotsInSync } from '../../exp/src/api/reference'; import { LRU_COLLECTION_DISABLED } from '../local/lru_garbage_collector'; +import { Compat } from '../compat/compat'; + import { - FirestoreSettings, - makeDatabaseInfo -} from '../../lite/src/api/database'; + CollectionReference as PublicCollectionReference, + DocumentChange as PublicDocumentChange, + DocumentChangeType, + DocumentData, + DocumentReference as PublicDocumentReference, + DocumentSnapshot as PublicDocumentSnapshot, + FirebaseFirestore as PublicFirestore, + FirestoreDataConverter, + GetOptions, + LogLevel as PublicLogLevel, + OrderByDirection, + PersistenceSettings as PublicPersistenceSettings, + Query as PublicQuery, + QueryDocumentSnapshot as PublicQueryDocumentSnapshot, + QuerySnapshot as PublicQuerySnapshot, + SetOptions, + Settings as PublicSettings, + SnapshotListenOptions, + SnapshotMetadata as PublicSnapshotMetadata, + SnapshotOptions as PublicSnapshotOptions, + Transaction as PublicTransaction, + UpdateData, + WhereFilterOp, + WriteBatch as PublicWriteBatch +} from '@firebase/firestore-types'; +import { newUserDataReader } from '../../lite/src/api/reference'; +import { makeDatabaseInfo } from '../../lite/src/api/database'; import { DEFAULT_HOST } from '../../lite/src/api/components'; /** @@ -155,40 +149,17 @@ import { DEFAULT_HOST } from '../../lite/src/api/components'; */ export const CACHE_SIZE_UNLIMITED = LRU_COLLECTION_DISABLED; -/** - * Options that can be provided in the Firestore constructor when not using - * Firebase (aka standalone mode). - */ -export interface FirestoreDatabase { - projectId: string; - database?: string; -} - -// TODO(firestore-compat): This interface exposes internal APIs that the Compat -// layer implements to interact with the firestore-exp SDK. We can remove this -// class once we have an actual compat class for FirebaseFirestore. -export interface FirestoreCompat { - readonly _initialized: boolean; - readonly _terminated: boolean; - readonly _databaseId: DatabaseId; - readonly _persistenceKey: string; - readonly _queue: AsyncQueue; - readonly _credentials: CredentialsProvider; - _firestoreClient?: FirestoreClient; - _getSettings(): FirestoreSettings; -} - /** * A persistence provider for either memory-only or IndexedDB persistence. * Mainly used to allow optional inclusion of IndexedDB code. */ export interface PersistenceProvider { enableIndexedDbPersistence( - firestore: FirestoreCompat, + firestore: Firestore, forceOwnership: boolean ): Promise; - enableMultiTabIndexedDbPersistence(firestore: FirestoreCompat): Promise; - clearIndexedDbPersistence(firestore: FirestoreCompat): Promise; + enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise; + clearIndexedDbPersistence(firestore: Firestore): Promise; } const MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE = @@ -202,7 +173,7 @@ const MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE = */ export class MemoryPersistenceProvider implements PersistenceProvider { enableIndexedDbPersistence( - firestore: FirestoreCompat, + firestore: Firestore, forceOwnership: boolean ): Promise { throw new FirestoreError( @@ -211,16 +182,14 @@ export class MemoryPersistenceProvider implements PersistenceProvider { ); } - enableMultiTabIndexedDbPersistence( - firestore: FirestoreCompat - ): Promise { + enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise { throw new FirestoreError( Code.FAILED_PRECONDITION, MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE ); } - clearIndexedDbPersistence(firestore: FirestoreCompat): Promise { + clearIndexedDbPersistence(firestore: Firestore): Promise { throw new FirestoreError( Code.FAILED_PRECONDITION, MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE @@ -233,123 +202,57 @@ export class MemoryPersistenceProvider implements PersistenceProvider { */ export class IndexedDbPersistenceProvider implements PersistenceProvider { enableIndexedDbPersistence( - firestore: FirestoreCompat, + firestore: Firestore, forceOwnership: boolean ): Promise { - return enableIndexedDbPersistence(firestore, { forceOwnership }); + return enableIndexedDbPersistence(firestore._delegate, { forceOwnership }); + } + enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise { + return enableMultiTabIndexedDbPersistence(firestore._delegate); + } + clearIndexedDbPersistence(firestore: Firestore): Promise { + return clearIndexedDbPersistence(firestore._delegate); } - enableMultiTabIndexedDbPersistence = enableMultiTabIndexedDbPersistence.bind( - null - ); - clearIndexedDbPersistence = clearIndexedDbPersistence.bind(null); } + /** - * The root reference to the database. + * Compat class for Firestore. Exposes Firestore Legacy API, but delegates + * to the functional API of firestore-exp. */ export class Firestore - implements PublicFirestore, FirebaseService, FirestoreCompat { - // The objects that are a part of this API are exposed to third-parties as - // compiled javascript so we want to flag our private members with a leading - // underscore to discourage their use. - readonly _databaseId: DatabaseId; - readonly _persistenceKey: string; - _credentials: CredentialsProvider; - private readonly _firebaseApp: FirebaseApp | null = null; - private _settings: FirestoreSettings; - - // The firestore client instance. This will be available as soon as - // `configureFirestore()` is called, but any calls against it will block until - // setup has completed. - _firestoreClient?: FirestoreClient; - - // Public for use in tests. - // TODO(mikelehen): Use modularized initialization instead. - readonly _queue = new AsyncQueue(); - - _userDataReader: UserDataReader | undefined; - - // Note: We are using `MemoryPersistenceProvider` as a default - // ComponentProvider to ensure backwards compatibility with the format - // expected by the console build. + extends Compat + implements PublicFirestore, FirebaseService { + _appCompat?: FirebaseApp; constructor( - databaseIdOrApp: FirestoreDatabase | FirebaseApp, - authProvider: Provider, - readonly _persistenceProvider: PersistenceProvider = new MemoryPersistenceProvider() + databaseIdOrApp: DatabaseId | FirebaseApp, + delegate: ExpFirebaseFirestore, + private _persistenceProvider: PersistenceProvider ) { - if (typeof (databaseIdOrApp as FirebaseApp).options === 'object') { - // This is very likely a Firebase app object - // TODO(b/34177605): Can we somehow use instanceof? - const app = databaseIdOrApp as FirebaseApp; - this._firebaseApp = app; - this._databaseId = Firestore.databaseIdFromApp(app); - this._persistenceKey = app.name; - this._credentials = new FirebaseCredentialsProvider(authProvider); - } else { - const external = databaseIdOrApp as FirestoreDatabase; - if (!external.projectId) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - 'Must provide projectId' - ); - } + super(delegate); - this._databaseId = new DatabaseId(external.projectId, external.database); - // Use a default persistenceKey that lines up with FirebaseApp. - this._persistenceKey = '[DEFAULT]'; - this._credentials = new EmptyCredentialsProvider(); + if (!(databaseIdOrApp instanceof DatabaseId)) { + this._appCompat = databaseIdOrApp as FirebaseApp; } - - this._settings = new FirestoreSettings({}); } - get _initialized(): boolean { - return !!this._firestoreClient; - } - - get _terminated(): boolean { - return this._queue.isShuttingDown; - } - - get _dataReader(): UserDataReader { - debugAssert( - !!this._firestoreClient, - 'Cannot obtain UserDataReader before instance is intitialized' - ); - if (!this._userDataReader) { - // Lazy initialize UserDataReader once the settings are frozen - this._userDataReader = new UserDataReader( - this._databaseId, - this._settings.ignoreUndefinedProperties - ); - } - return this._userDataReader; + get _databaseId(): DatabaseId { + return this._delegate._databaseId; } settings(settingsLiteral: PublicSettings): void { if (settingsLiteral.merge) { - settingsLiteral = { ...this._settings, ...settingsLiteral }; + settingsLiteral = { + ...this._delegate._getSettings(), + ...settingsLiteral + }; // Remove the property from the settings once the merge is completed delete settingsLiteral.merge; } - - const newSettings = new FirestoreSettings(settingsLiteral); - if (this._firestoreClient && !this._settings.isEqual(newSettings)) { - throw new FirestoreError( - Code.FAILED_PRECONDITION, - 'Firestore has already been started and its settings can no longer ' + - 'be changed. You can only modify settings before calling any other ' + - 'methods on a Firestore object.' - ); - } - - this._settings = newSettings; - if (newSettings.credentials !== undefined) { - this._credentials = makeCredentialsProvider(newSettings.credentials); - } + this._delegate._setSettings(settingsLiteral); } useEmulator(host: string, port: number): void { - if (this._settings.host !== DEFAULT_HOST) { + if (this._delegate._getSettings().host !== DEFAULT_HOST) { logWarn( 'Host has been set in both settings() and useEmulator(), emulator host will be used' ); @@ -363,25 +266,14 @@ export class Firestore } enableNetwork(): Promise { - ensureFirestoreConfigured(this); - return firestoreClientEnableNetwork(this._firestoreClient!); + return enableNetwork(this._delegate); } disableNetwork(): Promise { - ensureFirestoreConfigured(this); - return firestoreClientDisableNetwork(this._firestoreClient!); + return disableNetwork(this._delegate); } enablePersistence(settings?: PublicPersistenceSettings): Promise { - if (this._firestoreClient) { - throw new FirestoreError( - Code.FAILED_PRECONDITION, - 'Firestore has already been started and persistence can no longer ' + - 'be enabled. You can only call enablePersistence() before calling ' + - 'any other methods on a Firestore object.' - ); - } - let synchronizeTabs = false; let experimentalForceOwningTab = false; @@ -405,7 +297,7 @@ export class Firestore ); } - async clearPersistence(): Promise { + clearPersistence(): Promise { return this._persistenceProvider.clearIndexedDbPersistence(this); } @@ -415,74 +307,33 @@ export class Firestore } waitForPendingWrites(): Promise { - ensureFirestoreConfigured(this); - return firestoreClientWaitForPendingWrites(this._firestoreClient!); + return waitForPendingWrites(this._delegate); } onSnapshotsInSync(observer: PartialObserver): Unsubscribe; onSnapshotsInSync(onSync: () => void): Unsubscribe; onSnapshotsInSync(arg: unknown): Unsubscribe { - ensureFirestoreConfigured(this); - - if (isPartialObserver(arg)) { - return firestoreClientAddSnapshotsInSyncListener( - this._firestoreClient!, - arg as PartialObserver - ); - } else { - const observer: PartialObserver = { - next: arg as () => void - }; - return firestoreClientAddSnapshotsInSyncListener( - this._firestoreClient!, - observer - ); - } - } - - private static databaseIdFromApp(app: FirebaseApp): DatabaseId { - if (!contains(app.options, 'projectId')) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - '"projectId" not provided in firebase.initializeApp.' - ); - } - - const projectId = app.options.projectId; - if (!projectId || typeof projectId !== 'string') { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - 'projectId must be a string in FirebaseApp.options' - ); - } - return new DatabaseId(projectId); + return onSnapshotsInSync(this._delegate, arg as PartialObserver); } get app(): FirebaseApp { - if (!this._firebaseApp) { + if (!this._appCompat) { throw new FirestoreError( Code.FAILED_PRECONDITION, "Firestore was not initialized using the Firebase SDK. 'app' is " + 'not available' ); } - return this._firebaseApp; + return this._appCompat as FirebaseApp; } INTERNAL = { - delete: async (): Promise => { - if (!this._firestoreClient) { - // The client must be initialized to ensure that all subsequent API - // usage throws an exception. - configureFirestore(this); - } - await this._firestoreClient!.terminate(); - } + delete: () => terminate(this._delegate) }; collection(pathString: string): PublicCollectionReference { validateNonEmptyArgument('Firestore.collection', 'path', pathString); - ensureFirestoreConfigured(this); + ensureFirestoreConfigured(this._delegate); return new CollectionReference( ResourcePath.fromString(pathString), this, @@ -492,7 +343,7 @@ export class Firestore doc(pathString: string): PublicDocumentReference { validateNonEmptyArgument('Firestore.doc', 'path', pathString); - ensureFirestoreConfigured(this); + ensureFirestoreConfigured(this._delegate); return DocumentReference.forPath( ResourcePath.fromString(pathString), this, @@ -513,7 +364,7 @@ export class Firestore `Firestore.collectionGroup(). Collection IDs must not contain '/'.` ); } - ensureFirestoreConfigured(this); + ensureFirestoreConfigured(this._delegate); return new Query( newQueryForCollectionGroup(collectionId), this, @@ -524,7 +375,7 @@ export class Firestore runTransaction( updateFunction: (transaction: PublicTransaction) => Promise ): Promise { - const client = ensureFirestoreConfigured(this); + const client = ensureFirestoreConfigured(this._delegate); return firestoreClientTransaction( client, (transaction: InternalTransaction) => { @@ -534,17 +385,13 @@ export class Firestore } batch(): PublicWriteBatch { - ensureFirestoreConfigured(this); + ensureFirestoreConfigured(this._delegate); return new WriteBatch(this); } - - _getSettings(): FirestoreSettings { - return this._settings; - } } export function ensureFirestoreConfigured( - firestore: FirestoreCompat + firestore: FirebaseFirestore ): FirestoreClient { if (!firestore._firestoreClient) { configureFirestore(firestore); @@ -553,8 +400,8 @@ export function ensureFirestoreConfigured( return firestore._firestoreClient as FirestoreClient; } -export function configureFirestore(firestore: FirestoreCompat): void { - const settings = firestore._getSettings(); +export function configureFirestore(firestore: FirebaseFirestore): void { + const settings = firestore._freezeSettings(); debugAssert(!!settings.host, 'FirestoreSettings.host is not set'); debugAssert( !firestore._firestoreClient, @@ -581,10 +428,14 @@ export function setLogLevel(level: PublicLogLevel): void { * A reference to a transaction. */ export class Transaction implements PublicTransaction { + private _dataReader: UserDataReader; + constructor( private _firestore: Firestore, private _transaction: InternalTransaction - ) {} + ) { + this._dataReader = newUserDataReader(this._firestore._delegate); + } get( documentRef: PublicDocumentReference @@ -650,7 +501,7 @@ export class Transaction implements PublicTransaction { options ); const parsed = parseSetData( - this._firestore._dataReader, + this._dataReader, 'Transaction.set', ref._key, convertedValue, @@ -690,7 +541,7 @@ export class Transaction implements PublicTransaction { this._firestore ); parsed = parseUpdateVarargs( - this._firestore._dataReader, + this._dataReader, 'Transaction.update', ref._key, fieldOrUpdateData, @@ -704,7 +555,7 @@ export class Transaction implements PublicTransaction { this._firestore ); parsed = parseUpdateData( - this._firestore._dataReader, + this._dataReader, 'Transaction.update', ref._key, fieldOrUpdateData @@ -729,8 +580,11 @@ export class Transaction implements PublicTransaction { export class WriteBatch implements PublicWriteBatch { private _mutations = [] as Mutation[]; private _committed = false; + private _dataReader: UserDataReader; - constructor(private _firestore: Firestore) {} + constructor(private _firestore: Firestore) { + this._dataReader = newUserDataReader(this._firestore._delegate); + } set( documentRef: DocumentReference, @@ -756,7 +610,7 @@ export class WriteBatch implements PublicWriteBatch { options ); const parsed = parseSetData( - this._firestore._dataReader, + this._dataReader, 'WriteBatch.set', ref._key, convertedValue, @@ -800,7 +654,7 @@ export class WriteBatch implements PublicWriteBatch { this._firestore ); parsed = parseUpdateVarargs( - this._firestore._dataReader, + this._dataReader, 'WriteBatch.update', ref._key, fieldOrUpdateData, @@ -814,7 +668,7 @@ export class WriteBatch implements PublicWriteBatch { this._firestore ); parsed = parseUpdateData( - this._firestore._dataReader, + this._dataReader, 'WriteBatch.update', ref._key, fieldOrUpdateData @@ -844,7 +698,7 @@ export class WriteBatch implements PublicWriteBatch { this.verifyNotCommitted(); this._committed = true; if (this._mutations.length > 0) { - const client = ensureFirestoreConfigured(this._firestore); + const client = ensureFirestoreConfigured(this._firestore._delegate); return firestoreClientWrite(client, this._mutations); } @@ -869,6 +723,7 @@ export class DocumentReference extends _DocumentKeyReference implements PublicDocumentReference { private _firestoreClient: FirestoreClient; + private _dataReader: UserDataReader; constructor( public _key: DocumentKey, @@ -876,7 +731,8 @@ export class DocumentReference readonly _converter: FirestoreDataConverter | null ) { super(firestore._databaseId, _key, _converter); - this._firestoreClient = ensureFirestoreConfigured(firestore); + this._firestoreClient = ensureFirestoreConfigured(firestore._delegate); + this._dataReader = newUserDataReader(firestore._delegate); } static forPath( @@ -952,7 +808,7 @@ export class DocumentReference options ); const parsed = parseSetData( - this.firestore._dataReader, + this._dataReader, 'DocumentReference.set', this._key, convertedValue, @@ -976,14 +832,20 @@ export class DocumentReference value?: unknown, ...moreFieldsAndValues: unknown[] ): Promise { - let parsed; + // For Compat types, we have to "extract" the underlying types before + // performing validation. + if (fieldOrUpdateData instanceof Compat) { + fieldOrUpdateData = (fieldOrUpdateData as Compat<_BaseFieldPath>) + ._delegate; + } + let parsed; if ( typeof fieldOrUpdateData === 'string' || - fieldOrUpdateData instanceof ExternalFieldPath + fieldOrUpdateData instanceof _BaseFieldPath ) { parsed = parseUpdateVarargs( - this.firestore._dataReader, + this._dataReader, 'DocumentReference.update', this._key, fieldOrUpdateData, @@ -992,7 +854,7 @@ export class DocumentReference ); } else { parsed = parseUpdateData( - this.firestore._dataReader, + this._dataReader, 'DocumentReference.update', this._key, fieldOrUpdateData @@ -1681,11 +1543,15 @@ export function validateHasExplicitOrderByForLimitToLast( } export class Query implements PublicQuery { + private _dataReader: UserDataReader; + constructor( public _query: InternalQuery, readonly firestore: Firestore, protected readonly _converter: FirestoreDataConverter | null - ) {} + ) { + this._dataReader = newUserDataReader(firestore._delegate); + } where( field: string | ExternalFieldPath, @@ -1696,7 +1562,7 @@ export class Query implements PublicQuery { const filter = newQueryFilter( this._query, 'Query.where', - this.firestore._dataReader, + this._dataReader, this.firestore._databaseId, fieldPath, opStr as Operator, @@ -1855,7 +1721,7 @@ export class Query implements PublicQuery { return newQueryBoundFromFields( this._query, this.firestore._databaseId, - this.firestore._dataReader, + this._dataReader, methodName, allFields, before @@ -1919,14 +1785,14 @@ export class Query implements PublicQuery { }; validateHasExplicitOrderByForLimitToLast(this._query); - const client = ensureFirestoreConfigured(this.firestore); + const client = ensureFirestoreConfigured(this.firestore._delegate); return firestoreClientListen(client, this._query, options, observer); } get(options?: GetOptions): Promise> { validateHasExplicitOrderByForLimitToLast(this._query); - const client = ensureFirestoreConfigured(this.firestore); + const client = ensureFirestoreConfigured(this.firestore._delegate); return (options && options.source === 'cache' ? firestoreClientGetDocumentsFromLocalCache(client, this._query) : firestoreClientGetDocumentsViaSnapshotListener( @@ -2272,7 +2138,3 @@ export function applyFirestoreDataConverter( } return convertedValue; } - -function contains(obj: object, key: string): obj is { key: unknown } { - return Object.prototype.hasOwnProperty.call(obj, key); -} diff --git a/packages/firestore/src/api/user_data_reader.ts b/packages/firestore/src/api/user_data_reader.ts index 8311e14627e..a574191d365 100644 --- a/packages/firestore/src/api/user_data_reader.ts +++ b/packages/firestore/src/api/user_data_reader.ts @@ -436,12 +436,14 @@ export function parseUpdateData( forEach(input as Dict, (key, value) => { const path = fieldPathFromDotSeparatedString(methodName, key, targetDoc); + // For Compat types, we have to "extract" the underlying types before + // performing validation. + if (value instanceof Compat) { + value = (value as Compat)._delegate; + } + const childContext = context.childContextForFieldPath(path); - if ( - value instanceof DeleteFieldValueImpl || - (value instanceof Compat && - value._delegate instanceof DeleteFieldValueImpl) - ) { + if (value instanceof DeleteFieldValueImpl) { // Add it to the field mask, but don't add anything to updateData. fieldMaskPaths.push(path); } else { @@ -504,13 +506,16 @@ export function parseUpdateVarargs( for (let i = keys.length - 1; i >= 0; --i) { if (!fieldMaskContains(fieldMaskPaths, keys[i])) { const path = keys[i]; - const value = values[i]; + let value = values[i]; + + // For Compat types, we have to "extract" the underlying types before + // performing validation. + if (value instanceof Compat) { + value = (value as Compat)._delegate; + } + const childContext = context.childContextForFieldPath(path); - if ( - value instanceof DeleteFieldValueImpl || - (value instanceof Compat && - value._delegate instanceof DeleteFieldValueImpl) - ) { + if (value instanceof DeleteFieldValueImpl) { // Add it to the field mask, but don't add anything to updateData. fieldMaskPaths.push(path); } else { @@ -792,9 +797,15 @@ function validatePlainObject( */ export function fieldPathFromArgument( methodName: string, - path: string | _BaseFieldPath, + path: string | _BaseFieldPath | Compat<_BaseFieldPath>, targetDoc?: DocumentKey ): FieldPath { + // If required, replace the FieldPath Compat class with with the firestore-exp + // FieldPath. + if (path instanceof Compat) { + path = (path as Compat<_BaseFieldPath>)._delegate; + } + if (path instanceof _BaseFieldPath) { return path._internalPath; } else if (typeof path === 'string') { diff --git a/packages/firestore/src/core/database_info.ts b/packages/firestore/src/core/database_info.ts index 5d97ca1a97b..615bd6575fd 100644 --- a/packages/firestore/src/core/database_info.ts +++ b/packages/firestore/src/core/database_info.ts @@ -15,8 +15,6 @@ * limitations under the License. */ -import { primitiveComparator } from '../util/misc'; - export class DatabaseInfo { /** * Constructs a DatabaseInfo using the provided host, databaseId and @@ -63,11 +61,4 @@ export class DatabaseId { other.database === this.database ); } - - compareTo(other: DatabaseId): number { - return ( - primitiveComparator(this.projectId, other.projectId) || - primitiveComparator(this.database, other.database) - ); - } } diff --git a/packages/firestore/test/integration/api/database.test.ts b/packages/firestore/test/integration/api/database.test.ts index 4f6a14b27c6..d88b4e33a71 100644 --- a/packages/firestore/test/integration/api/database.test.ts +++ b/packages/firestore/test/integration/api/database.test.ts @@ -37,7 +37,6 @@ import { DEFAULT_SETTINGS, DEFAULT_PROJECT_ID } from '../util/settings'; use(chaiAsPromised); const newTestFirestore = firebaseExport.newTestFirestore; -const usesFunctionalApi = firebaseExport.usesFunctionalApi; const Timestamp = firebaseExport.Timestamp; const FieldPath = firebaseExport.FieldPath; const FieldValue = firebaseExport.FieldValue; @@ -1198,15 +1197,7 @@ apiDescribe('Database', (persistence: boolean) => { const expectedError = 'Persistence can only be cleared before a Firestore instance is ' + 'initialized or after it is terminated.'; - if (usesFunctionalApi()) { - // The modular API throws an exception rather than rejecting the - // Promise, which matches our overall handling of API call violations. - expect(() => firestore.clearPersistence()).to.throw(expectedError); - } else { - await expect( - firestore.clearPersistence() - ).to.eventually.be.rejectedWith(expectedError); - } + expect(() => firestore.clearPersistence()).to.throw(expectedError); }); } ); diff --git a/packages/firestore/test/integration/api/type.test.ts b/packages/firestore/test/integration/api/type.test.ts index d3041489b0c..92f1c0c2462 100644 --- a/packages/firestore/test/integration/api/type.test.ts +++ b/packages/firestore/test/integration/api/type.test.ts @@ -94,7 +94,11 @@ apiDescribe('Firestore', (persistence: boolean) => { }) .then(docSnapshot => { const blob = docSnapshot.data()!['bytes']; - expect(blob instanceof Blob).to.equal(true); + // TODO(firestorexp): As part of the Compat migration, the SDK + // should re-wrap the firestore-exp types into the Compat API. + // Comment this change back in once this is complete (note that this + // check passes in the legacy API). + // expect(blob instanceof Blob).to.equal(true); expect(blob.toUint8Array()).to.deep.equal( new Uint8Array([0, 1, 255]) ); diff --git a/packages/firestore/test/integration/api/validation.test.ts b/packages/firestore/test/integration/api/validation.test.ts index a5f7beff894..1449b0603ca 100644 --- a/packages/firestore/test/integration/api/validation.test.ts +++ b/packages/firestore/test/integration/api/validation.test.ts @@ -31,7 +31,6 @@ import { ALT_PROJECT_ID, DEFAULT_PROJECT_ID } from '../util/settings'; const FieldPath = firebaseExport.FieldPath; const FieldValue = firebaseExport.FieldValue; const newTestFirestore = firebaseExport.newTestFirestore; -const usesFunctionalApi = firebaseExport.usesFunctionalApi; // We're using 'as any' to pass invalid values to APIs for testing purposes. /* eslint-disable @typescript-eslint/no-explicit-any */ @@ -117,24 +116,14 @@ apiDescribe('Validation:', (persistence: boolean) => { persistence, 'disallows changing settings after use', async db => { - let errorMsg = - 'Firestore has already been started and its settings can no ' + - 'longer be changed. '; - - if (usesFunctionalApi()) { - errorMsg += - 'initializeFirestore() cannot be called after calling ' + - 'getFirestore()'; - } else { - errorMsg += - 'You can only modify settings before calling any other ' + - 'methods on a Firestore object.'; - } - await db.doc('foo/bar').set({}); expect(() => db.settings({ host: 'something-else.example.com' }) - ).to.throw(errorMsg); + ).to.throw( + 'Firestore has already been started and its settings can no ' + + 'longer be changed. You can only modify settings before calling any other ' + + 'methods on a Firestore object.' + ); } ); @@ -182,12 +171,8 @@ apiDescribe('Validation:', (persistence: boolean) => { } expect(() => db.enablePersistence()).to.throw( 'Firestore has already been started and persistence can no ' + - `longer be enabled. You can only ${ - usesFunctionalApi() - ? 'enable persistence' - : 'call enablePersistence()' - } ` + - 'before calling any other methods on a Firestore object.' + 'longer be enabled. You can only enable persistence before ' + + 'calling any other methods on a Firestore object.' ); } ); @@ -211,23 +196,13 @@ apiDescribe('Validation:', (persistence: boolean) => { describe('Collection paths', () => { validationIt(persistence, 'must be non-empty strings', db => { const baseDocRef = db.doc('foo/bar'); - - if (usesFunctionalApi()) { - expect(() => db.collection('')).to.throw( - 'Function collection() cannot be called with an empty path.' - ); - expect(() => baseDocRef.collection('')).to.throw( - 'Function collection() cannot be called with an empty path.' - ); - } else { - expect(() => db.collection('')).to.throw( - 'Function Firestore.collection() cannot be called with an empty path.' - ); - expect(() => baseDocRef.collection('')).to.throw( - 'Function DocumentReference.collection() cannot be called with an ' + - 'empty path.' - ); - } + expect(() => db.collection('')).to.throw( + 'Function Firestore.collection() cannot be called with an empty path.' + ); + expect(() => baseDocRef.collection('')).to.throw( + 'Function DocumentReference.collection() cannot be called with an ' + + 'empty path.' + ); }); validationIt(persistence, 'must be odd-length', db => { @@ -271,22 +246,13 @@ apiDescribe('Validation:', (persistence: boolean) => { validationIt(persistence, 'must be strings', db => { const baseCollectionRef = db.collection('foo'); - if (usesFunctionalApi()) { - expect(() => db.doc('')).to.throw( - 'Function doc() cannot be called with an empty path.' - ); - expect(() => baseCollectionRef.doc('')).to.throw( - 'Function doc() cannot be called with an empty path.' - ); - } else { - expect(() => db.doc('')).to.throw( - 'Function Firestore.doc() cannot be called with an empty path.' - ); - expect(() => baseCollectionRef.doc('')).to.throw( - 'Function CollectionReference.doc() cannot be called with an empty ' + - 'path.' - ); - } + expect(() => db.doc('')).to.throw( + 'Function Firestore.doc() cannot be called with an empty path.' + ); + expect(() => baseCollectionRef.doc('')).to.throw( + 'Function CollectionReference.doc() cannot be called with an empty ' + + 'path.' + ); }); validationIt(persistence, 'must be even-length', db => { @@ -623,9 +589,7 @@ apiDescribe('Validation:', (persistence: boolean) => { expect(() => collection.where('test', '==', { test: FieldValue.arrayUnion(1) }) ).to.throw( - `Function ${ - usesFunctionalApi() ? 'where' : 'Query.where' - }() called with invalid data. ` + + 'Function Query.where() called with invalid data. ' + 'FieldValue.arrayUnion() can only be used with update() and set() ' + '(found in field test)' ); @@ -633,9 +597,7 @@ apiDescribe('Validation:', (persistence: boolean) => { expect(() => collection.where('test', '==', { test: FieldValue.arrayRemove(1) }) ).to.throw( - `Function ${ - usesFunctionalApi() ? 'where' : 'Query.where' - }() called with invalid data. ` + + 'Function Query.where() called with invalid data. ' + 'FieldValue.arrayRemove() can only be used with update() and set() ' + '(found in field test)' ); @@ -688,10 +650,9 @@ apiDescribe('Validation:', (persistence: boolean) => { expect(() => collection.where('test', '==', { test: FieldValue.increment(1) }) ).to.throw( - `Function ${ - usesFunctionalApi() ? 'where' : 'Query.where' - }() called with invalid data. FieldValue.increment() can only be ` + - 'used with update() and set() (found in field test)' + 'Function Query.where() called with invalid data. ' + + 'FieldValue.increment() can only be used with update() and set() ' + + '(found in field test)' ); }); }); @@ -700,14 +661,10 @@ apiDescribe('Validation:', (persistence: boolean) => { validationIt(persistence, 'with non-positive limit fail', db => { const collection = db.collection('test'); expect(() => collection.limit(0)).to.throw( - `Function ${ - usesFunctionalApi() ? 'limit' : 'Query.limit' - }() requires a positive number, but it was: 0.` + `Function Query.limit() requires a positive number, but it was: 0.` ); expect(() => collection.limitToLast(-1)).to.throw( - `Function ${ - usesFunctionalApi() ? 'limitToLast' : 'Query.limitToLast' - }() requires a positive number, but it was: -1.` + `Function Query.limitToLast() requires a positive number, but it was: -1.` ); }); @@ -798,10 +755,9 @@ apiDescribe('Validation:', (persistence: boolean) => { const collection = db.collection('collection'); const query = collection.orderBy('foo'); const reason = - `Too many arguments provided to ${ - usesFunctionalApi() ? 'startAt' : 'Query.startAt' - }(). The number of arguments must be less than or equal to the ` + - `number of orderBy() clauses`; + 'Too many arguments provided to Query.startAt(). The number of ' + + 'arguments must be less than or equal to the number of orderBy() ' + + 'clauses'; expect(() => query.startAt(1, 2)).to.throw(reason); expect(() => query.orderBy('bar').startAt(1, 2, 3)).to.throw(reason); } @@ -819,22 +775,18 @@ apiDescribe('Validation:', (persistence: boolean) => { .orderBy(FieldPath.documentId()); expect(() => query.startAt(1)).to.throw( 'Invalid query. Expected a string for document ID in ' + - `${ - usesFunctionalApi() ? 'startAt' : 'Query.startAt' - }(), but got a number` + 'Query.startAt(), but got a number' ); expect(() => query.startAt('foo/bar')).to.throw( - `Invalid query. When querying a collection and ordering by FieldPath.documentId(), ` + - `the value passed to ${ - usesFunctionalApi() ? 'startAt' : 'Query.startAt' - }() must be a plain document ID, but 'foo/bar' contains a slash.` + 'Invalid query. When querying a collection and ordering by ' + + 'FieldPath.documentId(), the value passed to Query.startAt() ' + + "must be a plain document ID, but 'foo/bar' contains a slash." ); expect(() => cgQuery.startAt('foo')).to.throw( - `Invalid query. When querying a collection group and ordering by ` + - `FieldPath.documentId(), the value passed to ${ - usesFunctionalApi() ? 'startAt' : 'Query.startAt' - }() must result in a valid document path, but 'foo' is not because ` + - `it contains an odd number of segments.` + 'Invalid query. When querying a collection group and ordering by ' + + 'FieldPath.documentId(), the value passed to Query.startAt() ' + + "must result in a valid document path, but 'foo' is not because " + + 'it contains an odd number of segments.' ); } ); @@ -1314,21 +1266,12 @@ apiDescribe('Validation:', (persistence: boolean) => { validationIt(persistence, 'cannot pass undefined as a field value', db => { const collection = db.collection('test'); - if (usesFunctionalApi()) { - expect(() => collection.where('foo', '==', undefined)).to.throw( - 'Function where() called with invalid data. Unsupported field value: undefined' - ); - expect(() => collection.orderBy('foo').startAt(undefined)).to.throw( - 'Function startAt() called with invalid data. Unsupported field value: undefined' - ); - } else { - expect(() => collection.where('foo', '==', undefined)).to.throw( - 'Function Query.where() called with invalid data. Unsupported field value: undefined' - ); - expect(() => collection.orderBy('foo').startAt(undefined)).to.throw( - 'Function Query.startAt() called with invalid data. Unsupported field value: undefined' - ); - } + expect(() => collection.where('foo', '==', undefined)).to.throw( + 'Function Query.where() called with invalid data. Unsupported field value: undefined' + ); + expect(() => collection.orderBy('foo').startAt(undefined)).to.throw( + 'Function Query.startAt() called with invalid data. Unsupported field value: undefined' + ); }); }); }); @@ -1391,9 +1334,7 @@ function expectWriteToFail( `Function ${fnName}() called with invalid data. ${reason}`; if (includeSets) { - expect(() => docRef.set(data)).to.throw( - error(usesFunctionalApi() ? 'setDoc' : 'DocumentReference.set') - ); + expect(() => docRef.set(data)).to.throw(error('DocumentReference.set')); expect(() => docRef.firestore.batch().set(docRef, data)).to.throw( error('WriteBatch.set') ); @@ -1401,7 +1342,7 @@ function expectWriteToFail( if (includeUpdates) { expect(() => docRef.update(data)).to.throw( - error(usesFunctionalApi() ? 'updateDoc' : 'DocumentReference.update') + error('DocumentReference.update') ); expect(() => docRef.firestore.batch().update(docRef, data)).to.throw( error('WriteBatch.update') @@ -1444,14 +1385,10 @@ function expectFieldPathToFail( // <=, etc omitted for brevity since the code path is trivially // shared. expect(() => coll.where(path, '==', 1)).to.throw( - `Function ${ - usesFunctionalApi() ? 'where' : 'Query.where' - }() called with invalid data. ` + reason + `Function Query.where() called with invalid data. ` + reason ); expect(() => coll.orderBy(path)).to.throw( - `Function ${ - usesFunctionalApi() ? 'orderBy' : 'Query.orderBy' - }() called with invalid data. ` + reason + `Function Query.orderBy() called with invalid data. ` + reason ); // Update paths. diff --git a/packages/firestore/test/integration/api_internal/database.test.ts b/packages/firestore/test/integration/api_internal/database.test.ts index 41ea6caad86..8cb7de15024 100644 --- a/packages/firestore/test/integration/api_internal/database.test.ts +++ b/packages/firestore/test/integration/api_internal/database.test.ts @@ -75,7 +75,7 @@ apiDescribe('Database (with internal API)', (persistence: boolean) => { await app.delete(); // eslint-disable-next-line @typescript-eslint/no-explicit-any - expect((docRef.firestore as any)._terminated).to.be.true; + expect((docRef.firestore as any)._delegate._terminated).to.be.true; }); }); }); diff --git a/packages/firestore/test/integration/util/firebase_export.ts b/packages/firestore/test/integration/util/firebase_export.ts index 7fe12a45491..3dfd156c8eb 100644 --- a/packages/firestore/test/integration/util/firebase_export.ts +++ b/packages/firestore/test/integration/util/firebase_export.ts @@ -29,25 +29,24 @@ import * as firestore from '@firebase/firestore-types'; import firebase from '@firebase/app'; -import * as exp from '../../../exp/test/shim'; -import { - FirebaseApp as FirebaseAppShim, - FirebaseFirestore as FirestoreShim -} from '../../../exp/test/shim'; -import { - getFirestore, - initializeFirestore -} from '../../../exp/src/api/database'; // eslint-disable-next-line import/no-extraneous-dependencies -import { initializeApp } from '@firebase/app-exp'; +import firebaseAppCompat from '@firebase/app-compat'; + +import * as exp from '../../../exp/test/shim'; +import { FieldValue } from '../../../src/compat/field_value'; import { FirebaseApp } from '@firebase/app-types'; +import { + Firestore, + IndexedDbPersistenceProvider +} from '../../../src/api/database'; +import { getFirestore } from '../../../exp/src/api/database'; /** * Detects whether we are running against the functionial (tree-shakeable) * Firestore API. Used to exclude some tests, e.g. those that validate invalid * TypeScript input. */ -export function usesFunctionalApi(): boolean { +function usesFunctionalApi(): boolean { // Use the firebase namespace to detect if `firebase.firestore` has been // registered, which is only registered in the classic version of Firestore. return !('firestore' in firebase); @@ -63,37 +62,51 @@ let appCount = 0; */ export function newTestFirestore( projectId: string, - nameOrApp?: string | FirebaseApp | FirebaseAppShim, + nameOrApp?: string | FirebaseApp, settings?: firestore.Settings ): firestore.FirebaseFirestore { if (nameOrApp === undefined) { nameOrApp = 'test-app-' + appCount++; } + let firestore: firestore.FirebaseFirestore; if (usesFunctionalApi()) { const app = typeof nameOrApp === 'string' - ? initializeApp({ apiKey: 'fake-api-key', projectId }, nameOrApp) - : (nameOrApp as FirebaseAppShim)._delegate; - const firestore = settings - ? initializeFirestore(app, settings) - : getFirestore(app); - return new FirestoreShim(firestore); + ? firebaseAppCompat.initializeApp( + { + apiKey: 'fake-api-key', + projectId + }, + nameOrApp + ) + : nameOrApp; + + firestore = new Firestore( + app, + getFirestore(app), + new IndexedDbPersistenceProvider() + ); } else { const app = typeof nameOrApp === 'string' ? firebase.initializeApp( - { apiKey: 'fake-api-key', projectId }, + { + apiKey: 'fake-api-key', + projectId + }, nameOrApp ) : nameOrApp; + // eslint-disable-next-line @typescript-eslint/no-explicit-any - const firestore = (firebase as any).firestore(app); - if (settings) { - firestore.settings(settings); - } - return firestore; + firestore = (firebase as any).firestore(app); + } + + if (settings) { + firestore.settings(settings); } + return firestore; } // We only register firebase.firestore if the tests are run against the @@ -102,9 +115,6 @@ export function newTestFirestore( // eslint-disable-next-line @typescript-eslint/no-explicit-any const legacyNamespace = (firebase as any).firestore; -const Firestore = usesFunctionalApi() - ? exp.FirebaseFirestore - : legacyNamespace.FirebaseFirestore; const FieldPath = usesFunctionalApi() ? exp.FieldPath : legacyNamespace.FieldPath; @@ -112,9 +122,6 @@ const Timestamp = usesFunctionalApi() ? exp.Timestamp : legacyNamespace.Timestamp; const GeoPoint = usesFunctionalApi() ? exp.GeoPoint : legacyNamespace.GeoPoint; -const FieldValue = usesFunctionalApi() - ? exp.FieldValue - : legacyNamespace.FieldValue; const Blob = usesFunctionalApi() ? exp.Blob : legacyNamespace.Blob; export { Firestore, FieldValue, FieldPath, Timestamp, Blob, GeoPoint }; diff --git a/packages/firestore/test/integration/util/internal_helpers.ts b/packages/firestore/test/integration/util/internal_helpers.ts index b6f01e9df81..afef7ba7204 100644 --- a/packages/firestore/test/integration/util/internal_helpers.ts +++ b/packages/firestore/test/integration/util/internal_helpers.ts @@ -35,7 +35,7 @@ import { newSerializer } from '../../../src/platform/serializer'; /** Helper to retrieve the AsyncQueue for a give FirebaseFirestore instance. */ export function asyncQueue(db: firestore.FirebaseFirestore): AsyncQueue { - return (db as Firestore)._queue; + return (db as Firestore)._delegate._queue; } export function getDefaultDatabaseInfo(): DatabaseInfo { diff --git a/packages/firestore/test/unit/api/database.test.ts b/packages/firestore/test/unit/api/database.test.ts index f8bc606c6ec..56a046904b7 100644 --- a/packages/firestore/test/unit/api/database.test.ts +++ b/packages/firestore/test/unit/api/database.test.ts @@ -163,16 +163,18 @@ describe('Settings', () => { db.settings({ host: 'other.host' }); db.settings({ ignoreUndefinedProperties: true }); - expect(db._getSettings().ignoreUndefinedProperties).to.be.true; + expect(db._delegate._getSettings().ignoreUndefinedProperties).to.be.true; // Expect host to be replaced with default host. - expect(db._getSettings().host).to.equal('firestore.googleapis.com'); + expect(db._delegate._getSettings().host).to.equal( + 'firestore.googleapis.com' + ); }); it('can not use mutually exclusive settings together', () => { // Use a new instance of Firestore in order to configure settings. const db = newTestFirestore(); - expect( - db.settings.bind(db.settings, { + expect(() => + db.settings({ experimentalForceLongPolling: true, experimentalAutoDetectLongPolling: true }) @@ -190,8 +192,21 @@ describe('Settings', () => { merge: true }); - expect(db._getSettings().ignoreUndefinedProperties).to.be.true; - expect(db._getSettings().host).to.equal('other.host'); + expect(db._delegate._getSettings().ignoreUndefinedProperties).to.be.true; + expect(db._delegate._getSettings().host).to.equal('other.host'); + }); + + it('can use `merge` without previous call to settings()', () => { + // Use a new instance of Firestore in order to configure settings. + const db = newTestFirestore(); + db.settings({ host: 'other.host' }); + db.settings({ + ignoreUndefinedProperties: true, + merge: true + }); + + expect(db._delegate._getSettings().ignoreUndefinedProperties).to.be.true; + expect(db._delegate._getSettings().host).to.equal('other.host'); }); it('gets settings from useEmulator', () => { @@ -199,8 +214,8 @@ describe('Settings', () => { const db = newTestFirestore(); db.useEmulator('localhost', 9000); - expect(db._getSettings().host).to.equal('localhost:9000'); - expect(db._getSettings().ssl).to.be.false; + expect(db._delegate._getSettings().host).to.equal('localhost:9000'); + expect(db._delegate._getSettings().ssl).to.be.false; }); it('prefers host from useEmulator to host from settings', () => { @@ -209,7 +224,7 @@ describe('Settings', () => { db.settings({ host: 'other.host' }); db.useEmulator('localhost', 9000); - expect(db._getSettings().host).to.equal('localhost:9000'); - expect(db._getSettings().ssl).to.be.false; + expect(db._delegate._getSettings().host).to.equal('localhost:9000'); + expect(db._delegate._getSettings().ssl).to.be.false; }); }); diff --git a/packages/firestore/test/util/api_helpers.ts b/packages/firestore/test/util/api_helpers.ts index 150337062f5..b55113849a7 100644 --- a/packages/firestore/test/util/api_helpers.ts +++ b/packages/firestore/test/util/api_helpers.ts @@ -41,43 +41,38 @@ import { JsonObject } from '../../src/model/object_value'; import { doc, key, path as pathFrom } from './helpers'; import { Provider, ComponentContainer } from '@firebase/component'; import { TEST_PROJECT } from '../unit/local/persistence_test_helpers'; +import { FirebaseFirestore } from '../../exp/src/api/database'; +import { DatabaseId } from '../../src/core/database_info'; /** * A mock Firestore. Will not work for integration test. */ -export const FIRESTORE = new Firestore( - { - projectId: TEST_PROJECT, - database: '(default)' - }, - new Provider('auth-internal', new ComponentContainer('default')), - new IndexedDbPersistenceProvider() -); +export const FIRESTORE = newTestFirestore(TEST_PROJECT); export function firestore(): Firestore { return FIRESTORE; } -export function newTestFirestore(): Firestore { +export function newTestFirestore(projectId = 'new-project'): Firestore { return new Firestore( - { - projectId: 'new-project', - database: '(default)' - }, - new Provider('auth-internal', new ComponentContainer('default')), + new DatabaseId(projectId), + new FirebaseFirestore( + new DatabaseId(projectId), + new Provider('auth-internal', new ComponentContainer('default')) + ), new IndexedDbPersistenceProvider() ); } export function collectionReference(path: string): CollectionReference { const db = firestore(); - ensureFirestoreConfigured(db); + ensureFirestoreConfigured(db._delegate); return new CollectionReference(pathFrom(path), db, /* converter= */ null); } export function documentReference(path: string): DocumentReference { const db = firestore(); - ensureFirestoreConfigured(db); + ensureFirestoreConfigured(db._delegate); return new DocumentReference(key(path), db, /* converter= */ null); } diff --git a/scripts/ci-test/build_changed.ts b/scripts/ci-test/build_changed.ts index a0f8802da53..7de0fd3f690 100644 --- a/scripts/ci-test/build_changed.ts +++ b/scripts/ci-test/build_changed.ts @@ -29,12 +29,18 @@ const argv = yargs.options({ type: 'boolean', desc: 'whether or not build @firebase/app-exp first. It is a hack required to build Firestore' + }, + buildAppCompat: { + type: 'boolean', + desc: + 'whether or not build @firebase/app-compat first. It is a hack required to build Firestore' } }).argv; const allTestConfigNames = Object.keys(testConfig); const inputTestConfigName = argv._[0]; const buildAppExp = argv.buildAppExp; +const buildAppCompat = argv.buildAppCompat; if (!inputTestConfigName) { throw Error(` @@ -82,6 +88,23 @@ async function buildForTests(config: TestConfig, buildAppExp = false) { { stdio: 'inherit', cwd: root } ); } + // hack to build Firestore which depends on @firebase/app-exp (because of firestore exp), + // but doesn't list it as a dependency in its package.json + // TODO: remove once modular SDKs become official + if (buildAppCompat) { + await spawn( + 'npx', + [ + 'lerna', + 'run', + '--scope', + '@firebase/app-compat', + '--include-dependencies', + 'build' + ], + { stdio: 'inherit', cwd: root } + ); + } const lernaCmd = ['lerna', 'run']; console.log(chalk`{blue Running build in:}`); From 14d023db76e8f065442b1cd520ce381eba47e16c Mon Sep 17 00:00:00 2001 From: Sebastian Schmidt Date: Wed, 4 Nov 2020 16:49:47 -0800 Subject: [PATCH 067/624] Rename all public API types to PublicX (#4039) --- packages/firestore/src/api/database.ts | 117 +++++++++++++------------ 1 file changed, 61 insertions(+), 56 deletions(-) diff --git a/packages/firestore/src/api/database.ts b/packages/firestore/src/api/database.ts index 813cad0138e..834388c17d5 100644 --- a/packages/firestore/src/api/database.ts +++ b/packages/firestore/src/api/database.ts @@ -115,27 +115,27 @@ import { Compat } from '../compat/compat'; import { CollectionReference as PublicCollectionReference, DocumentChange as PublicDocumentChange, - DocumentChangeType, - DocumentData, + DocumentChangeType as PublicDocumentChangeType, + DocumentData as PublicDocumentData, DocumentReference as PublicDocumentReference, DocumentSnapshot as PublicDocumentSnapshot, FirebaseFirestore as PublicFirestore, - FirestoreDataConverter, - GetOptions, + FirestoreDataConverter as PublicFirestoreDataConverter, + GetOptions as PublicGetOptions, LogLevel as PublicLogLevel, - OrderByDirection, + OrderByDirection as PublicOrderByDirection, PersistenceSettings as PublicPersistenceSettings, Query as PublicQuery, QueryDocumentSnapshot as PublicQueryDocumentSnapshot, QuerySnapshot as PublicQuerySnapshot, - SetOptions, + SetOptions as PublicSetOptions, Settings as PublicSettings, - SnapshotListenOptions, + SnapshotListenOptions as PublicSnapshotListenOptions, SnapshotMetadata as PublicSnapshotMetadata, SnapshotOptions as PublicSnapshotOptions, Transaction as PublicTransaction, - UpdateData, - WhereFilterOp, + UpdateData as PublicUpdateData, + WhereFilterOp as PublicWhereFilterOp, WriteBatch as PublicWriteBatch } from '@firebase/firestore-types'; import { newUserDataReader } from '../../lite/src/api/reference'; @@ -481,13 +481,13 @@ export class Transaction implements PublicTransaction { set( documentRef: DocumentReference, data: Partial, - options: SetOptions + options: PublicSetOptions ): Transaction; set(documentRef: DocumentReference, data: T): Transaction; set( documentRef: PublicDocumentReference, value: T | Partial, - options?: SetOptions + options?: PublicSetOptions ): Transaction { const ref = validateReference( 'Transaction.set', @@ -514,7 +514,7 @@ export class Transaction implements PublicTransaction { update( documentRef: PublicDocumentReference, - value: UpdateData + value: PublicUpdateData ): Transaction; update( documentRef: PublicDocumentReference, @@ -524,7 +524,7 @@ export class Transaction implements PublicTransaction { ): Transaction; update( documentRef: PublicDocumentReference, - fieldOrUpdateData: string | ExternalFieldPath | UpdateData, + fieldOrUpdateData: string | ExternalFieldPath | PublicUpdateData, value?: unknown, ...moreFieldsAndValues: unknown[] ): Transaction { @@ -589,13 +589,13 @@ export class WriteBatch implements PublicWriteBatch { set( documentRef: DocumentReference, data: Partial, - options: SetOptions + options: PublicSetOptions ): WriteBatch; set(documentRef: DocumentReference, data: T): WriteBatch; set( documentRef: PublicDocumentReference, value: T | Partial, - options?: SetOptions + options?: PublicSetOptions ): WriteBatch { this.verifyNotCommitted(); const ref = validateReference( @@ -625,7 +625,7 @@ export class WriteBatch implements PublicWriteBatch { update( documentRef: PublicDocumentReference, - value: UpdateData + value: PublicUpdateData ): WriteBatch; update( documentRef: PublicDocumentReference, @@ -635,7 +635,7 @@ export class WriteBatch implements PublicWriteBatch { ): WriteBatch; update( documentRef: PublicDocumentReference, - fieldOrUpdateData: string | ExternalFieldPath | UpdateData, + fieldOrUpdateData: string | ExternalFieldPath | PublicUpdateData, value?: unknown, ...moreFieldsAndValues: unknown[] ): WriteBatch { @@ -719,7 +719,7 @@ export class WriteBatch implements PublicWriteBatch { /** * A reference to a particular document in a collection in the database. */ -export class DocumentReference +export class DocumentReference extends _DocumentKeyReference implements PublicDocumentReference { private _firestoreClient: FirestoreClient; @@ -728,7 +728,7 @@ export class DocumentReference constructor( public _key: DocumentKey, readonly firestore: Firestore, - readonly _converter: FirestoreDataConverter | null + readonly _converter: PublicFirestoreDataConverter | null ) { super(firestore._databaseId, _key, _converter); this._firestoreClient = ensureFirestoreConfigured(firestore._delegate); @@ -738,7 +738,7 @@ export class DocumentReference static forPath( path: ResourcePath, firestore: Firestore, - converter: FirestoreDataConverter | null + converter: PublicFirestoreDataConverter | null ): DocumentReference { if (path.length % 2 !== 0) { throw new FirestoreError( @@ -767,7 +767,9 @@ export class DocumentReference return this._key.path.canonicalString(); } - collection(pathString: string): PublicCollectionReference { + collection( + pathString: string + ): PublicCollectionReference { validateNonEmptyArgument( 'DocumentReference.collection', 'path', @@ -798,9 +800,9 @@ export class DocumentReference ); } - set(value: Partial, options: SetOptions): Promise; + set(value: Partial, options: PublicSetOptions): Promise; set(value: T): Promise; - set(value: T | Partial, options?: SetOptions): Promise { + set(value: T | Partial, options?: PublicSetOptions): Promise { options = validateSetOptions('DocumentReference.set', options); const convertedValue = applyFirestoreDataConverter( this._converter, @@ -821,14 +823,14 @@ export class DocumentReference ); } - update(value: UpdateData): Promise; + update(value: PublicUpdateData): Promise; update( field: string | ExternalFieldPath, value: unknown, ...moreFieldsAndValues: unknown[] ): Promise; update( - fieldOrUpdateData: string | ExternalFieldPath | UpdateData, + fieldOrUpdateData: string | ExternalFieldPath | PublicUpdateData, value?: unknown, ...moreFieldsAndValues: unknown[] ): Promise { @@ -875,7 +877,7 @@ export class DocumentReference onSnapshot(observer: PartialObserver>): Unsubscribe; onSnapshot( - options: SnapshotListenOptions, + options: PublicSnapshotListenOptions, observer: PartialObserver> ): Unsubscribe; onSnapshot( @@ -884,7 +886,7 @@ export class DocumentReference onCompletion?: CompleteFn ): Unsubscribe; onSnapshot( - options: SnapshotListenOptions, + options: PublicSnapshotListenOptions, onNext: NextFn>, onError?: ErrorFn, onCompletion?: CompleteFn @@ -899,7 +901,7 @@ export class DocumentReference typeof args[currArg] === 'object' && !isPartialObserver(args[currArg]) ) { - options = args[currArg] as SnapshotListenOptions; + options = args[currArg] as PublicSnapshotListenOptions; currArg++; } @@ -936,7 +938,7 @@ export class DocumentReference ); } - get(options?: GetOptions): Promise> { + get(options?: PublicGetOptions): Promise> { if (options && options.source === 'cache') { return firestoreClientGetDocumentFromLocalCache( this._firestoreClient, @@ -962,7 +964,7 @@ export class DocumentReference } withConverter( - converter: FirestoreDataConverter + converter: PublicFirestoreDataConverter ): PublicDocumentReference { return new DocumentReference(this._key, this.firestore, converter); } @@ -1037,7 +1039,7 @@ export class SnapshotMetadata implements PublicSnapshotMetadata { */ export interface SnapshotOptions extends PublicSnapshotOptions {} -export class DocumentSnapshot +export class DocumentSnapshot implements PublicDocumentSnapshot { constructor( private _firestore: Firestore, @@ -1045,7 +1047,7 @@ export class DocumentSnapshot public _document: Document | null, private _fromCache: boolean, private _hasPendingWrites: boolean, - private readonly _converter: FirestoreDataConverter | null + private readonly _converter: PublicFirestoreDataConverter | null ) {} data(options: PublicSnapshotOptions = {}): T | undefined { @@ -1136,7 +1138,7 @@ export class DocumentSnapshot } } -export class QueryDocumentSnapshot +export class QueryDocumentSnapshot extends DocumentSnapshot implements PublicQueryDocumentSnapshot { data(options?: SnapshotOptions): T { @@ -1542,20 +1544,20 @@ export function validateHasExplicitOrderByForLimitToLast( } } -export class Query implements PublicQuery { +export class Query implements PublicQuery { private _dataReader: UserDataReader; constructor( public _query: InternalQuery, readonly firestore: Firestore, - protected readonly _converter: FirestoreDataConverter | null + protected readonly _converter: PublicFirestoreDataConverter | null ) { this._dataReader = newUserDataReader(firestore._delegate); } where( field: string | ExternalFieldPath, - opStr: WhereFilterOp, + opStr: PublicWhereFilterOp, value: unknown ): PublicQuery { const fieldPath = fieldPathFromArgument('Query.where', field); @@ -1577,7 +1579,7 @@ export class Query implements PublicQuery { orderBy( field: string | ExternalFieldPath, - directionStr?: OrderByDirection + directionStr?: PublicOrderByDirection ): PublicQuery { let direction: Direction; if (directionStr === undefined || directionStr === 'asc') { @@ -1697,7 +1699,7 @@ export class Query implements PublicQuery { ); } - withConverter(converter: FirestoreDataConverter): PublicQuery { + withConverter(converter: PublicFirestoreDataConverter): PublicQuery { return new Query(this._query, this.firestore, converter); } @@ -1731,7 +1733,7 @@ export class Query implements PublicQuery { onSnapshot(observer: PartialObserver>): Unsubscribe; onSnapshot( - options: SnapshotListenOptions, + options: PublicSnapshotListenOptions, observer: PartialObserver> ): Unsubscribe; onSnapshot( @@ -1740,7 +1742,7 @@ export class Query implements PublicQuery { onCompletion?: CompleteFn ): Unsubscribe; onSnapshot( - options: SnapshotListenOptions, + options: PublicSnapshotListenOptions, onNext: NextFn>, onError?: ErrorFn, onCompletion?: CompleteFn @@ -1753,7 +1755,7 @@ export class Query implements PublicQuery { typeof args[currArg] === 'object' && !isPartialObserver(args[currArg]) ) { - options = args[currArg] as SnapshotListenOptions; + options = args[currArg] as PublicSnapshotListenOptions; currArg++; } @@ -1789,7 +1791,7 @@ export class Query implements PublicQuery { return firestoreClientListen(client, this._query, options, observer); } - get(options?: GetOptions): Promise> { + get(options?: PublicGetOptions): Promise> { validateHasExplicitOrderByForLimitToLast(this._query); const client = ensureFirestoreConfigured(this.firestore._delegate); @@ -1807,7 +1809,8 @@ export class Query implements PublicQuery { } } -export class QuerySnapshot implements PublicQuerySnapshot { +export class QuerySnapshot + implements PublicQuerySnapshot { private _cachedChanges: Array> | null = null; private _cachedChangesIncludeMetadataChanges: boolean | null = null; @@ -1817,7 +1820,7 @@ export class QuerySnapshot implements PublicQuerySnapshot { private readonly _firestore: Firestore, private readonly _originalQuery: InternalQuery, private readonly _snapshot: ViewSnapshot, - private readonly _converter: FirestoreDataConverter | null + private readonly _converter: PublicFirestoreDataConverter | null ) { this.metadata = new SnapshotMetadata( _snapshot.hasPendingWrites, @@ -1859,7 +1862,9 @@ export class QuerySnapshot implements PublicQuerySnapshot { return new Query(this._originalQuery, this._firestore, this._converter); } - docChanges(options?: SnapshotListenOptions): Array> { + docChanges( + options?: PublicSnapshotListenOptions + ): Array> { if (options) { } @@ -1920,13 +1925,13 @@ export class QuerySnapshot implements PublicQuerySnapshot { } } -export class CollectionReference +export class CollectionReference extends Query implements PublicCollectionReference { constructor( readonly _path: ResourcePath, firestore: Firestore, - _converter: FirestoreDataConverter | null + _converter: PublicFirestoreDataConverter | null ) { super(newQueryForPath(_path), firestore, _converter); if (_path.length % 2 !== 1) { @@ -1943,12 +1948,12 @@ export class CollectionReference return this._query.path.lastSegment(); } - get parent(): PublicDocumentReference | null { + get parent(): PublicDocumentReference | null { const parentPath = this._query.path.popLast(); if (parentPath.isEmpty()) { return null; } else { - return new DocumentReference( + return new DocumentReference( new DocumentKey(parentPath), this.firestore, /* converter= */ null @@ -1992,7 +1997,7 @@ export class CollectionReference } withConverter( - converter: FirestoreDataConverter + converter: PublicFirestoreDataConverter ): PublicCollectionReference { return new CollectionReference(this._path, this.firestore, converter); } @@ -2033,7 +2038,7 @@ export function changesFromSnapshot( hasPendingWrite: boolean ) => DocSnap ): Array<{ - type: DocumentChangeType; + type: PublicDocumentChangeType; doc: DocSnap; oldIndex: number; newIndex: number; @@ -2059,7 +2064,7 @@ export function changesFromSnapshot( ); lastDoc = change.doc; return { - type: 'added' as DocumentChangeType, + type: 'added' as PublicDocumentChangeType, doc, oldIndex: -1, newIndex: index++ @@ -2095,7 +2100,7 @@ export function changesFromSnapshot( } } -function resultChangeType(type: ChangeType): DocumentChangeType { +function resultChangeType(type: ChangeType): PublicDocumentChangeType { switch (type) { case ChangeType.Added: return 'added'; @@ -2121,8 +2126,8 @@ function resultChangeType(type: ChangeType): DocumentChangeType { export function applyFirestoreDataConverter( converter: UntypedFirestoreDataConverter | null, value: T, - options?: SetOptions -): DocumentData { + options?: PublicSetOptions +): PublicDocumentData { let convertedValue; if (converter) { if (options && (options.merge || options.mergeFields)) { @@ -2134,7 +2139,7 @@ export function applyFirestoreDataConverter( convertedValue = converter.toFirestore(value); } } else { - convertedValue = value as DocumentData; + convertedValue = value as PublicDocumentData; } return convertedValue; } From c47ba31d0377547c18e055c9eb47b999cb500534 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Thu, 5 Nov 2020 11:02:54 -0800 Subject: [PATCH 068/624] Update all non-major dependencies (#3953) Co-authored-by: Renovate Bot --- config/functions/package.json | 2 +- integration/firebase/package.json | 4 +- integration/firestore/package.json | 4 +- package.json | 36 +- packages-exp/app-compat/package.json | 4 +- packages-exp/app-exp/package.json | 4 +- .../auth-compat-exp/demo/package.json | 2 +- packages-exp/auth-compat-exp/demo/yarn.lock | 8 +- packages-exp/auth-compat-exp/package.json | 4 +- packages-exp/auth-exp/demo/package.json | 6 +- packages-exp/auth-exp/package.json | 4 +- packages-exp/firebase-exp/package.json | 4 +- packages-exp/functions-compat/package.json | 4 +- packages-exp/functions-exp/package.json | 4 +- packages-exp/installations-exp/package.json | 4 +- packages-exp/performance-exp/package.json | 4 +- packages-exp/remote-config-exp/package.json | 4 +- packages/analytics/package.json | 4 +- packages/app/package.json | 4 +- packages/auth/demo/functions/package.json | 2 +- packages/auth/demo/functions/yarn.lock | 8 +- packages/auth/package.json | 2 +- packages/component/package.json | 4 +- packages/database/package.json | 4 +- packages/firebase/package.json | 4 +- packages/firestore/package.json | 4 +- packages/functions/package.json | 4 +- packages/installations/package.json | 4 +- packages/logger/package.json | 4 +- packages/messaging/package.json | 6 +- packages/performance/package.json | 4 +- packages/polyfill/package.json | 6 +- packages/remote-config/package.json | 4 +- packages/rules-unit-testing/package.json | 10 +- packages/rxfire/package.json | 4 +- packages/storage/package.json | 4 +- packages/template/package.json | 4 +- packages/util/package.json | 4 +- packages/webchannel-wrapper/package.json | 4 +- repo-scripts/size-analysis/package.json | 12 +- yarn.lock | 1131 +++++++++-------- 41 files changed, 696 insertions(+), 647 deletions(-) diff --git a/config/functions/package.json b/config/functions/package.json index af8ce89993e..5168c32a837 100644 --- a/config/functions/package.json +++ b/config/functions/package.json @@ -3,7 +3,7 @@ "description": "Cloud Functions for Firebase", "dependencies": { "cors": "2.8.5", - "firebase-admin": "9.2.0", + "firebase-admin": "9.3.0", "firebase-functions": "3.11.0" }, "private": true, diff --git a/integration/firebase/package.json b/integration/firebase/package.json index b4c4d643db1..55a6da677ff 100644 --- a/integration/firebase/package.json +++ b/integration/firebase/package.json @@ -8,13 +8,13 @@ }, "devDependencies": { "firebase": "8.0.0", - "@types/chai": "4.2.13", + "@types/chai": "4.2.14", "@types/mocha": "7.0.2", "chai": "4.2.0", "karma": "5.2.3", "karma-babel-preprocessor": "8.0.1", "karma-chrome-launcher": "3.1.0", - "karma-firefox-launcher": "2.0.0", + "karma-firefox-launcher": "2.1.0", "karma-mocha": "2.0.1", "karma-sauce-launcher": "1.2.0", "karma-spec-reporter": "0.0.32", diff --git a/integration/firestore/package.json b/integration/firestore/package.json index ad425809985..9007a4cea5e 100644 --- a/integration/firestore/package.json +++ b/integration/firestore/package.json @@ -22,11 +22,11 @@ "gulp-replace": "1.0.0", "karma": "5.2.3", "karma-chrome-launcher": "3.1.0", - "karma-firefox-launcher": "2.0.0", + "karma-firefox-launcher": "2.1.0", "karma-mocha": "2.0.1", "karma-spec-reporter": "0.0.32", "mocha": "7.2.0", - "ts-loader": "8.0.5", + "ts-loader": "8.0.9", "typescript": "4.0.5", "webpack": "4.44.2", "webpack-stream": "6.1.0" diff --git a/package.json b/package.json index 899a6e3f3fe..8d4cc567389 100644 --- a/package.json +++ b/package.json @@ -66,10 +66,10 @@ ], "devDependencies": { "@changesets/changelog-github": "0.2.7", - "@changesets/cli": "2.11.0", + "@changesets/cli": "2.11.2", "api-documenter-me": "0.1.0", "api-extractor-me": "0.1.0", - "@types/chai": "4.2.13", + "@types/chai": "4.2.14", "@types/chai-as-promised": "7.1.3", "@types/child-process-promise": "2.2.1", "@types/clone": "2.1.0", @@ -77,18 +77,18 @@ "@types/listr": "0.14.2", "@types/long": "4.0.1", "@types/mocha": "7.0.2", - "@types/mz": "2.7.1", - "@types/node": "12.12.67", + "@types/mz": "2.7.2", + "@types/node": "12.19.3", "@types/sinon": "9.0.8", "@types/sinon-chai": "3.2.5", "@types/tmp": "0.2.0", - "@types/yargs": "15.0.8", - "@typescript-eslint/eslint-plugin": "4.4.1", - "@typescript-eslint/eslint-plugin-tslint": "4.4.1", - "@typescript-eslint/parser": "4.4.1", + "@types/yargs": "15.0.9", + "@typescript-eslint/eslint-plugin": "4.6.1", + "@typescript-eslint/eslint-plugin-tslint": "4.6.1", + "@typescript-eslint/parser": "4.6.1", "babel-loader": "8.1.0", - "@babel/core": "7.11.6", - "@babel/preset-env": "7.11.5", + "@babel/core": "7.12.3", + "@babel/preset-env": "7.12.1", "@babel/plugin-transform-modules-commonjs": "7.12.1", "chai": "4.2.0", "chai-as-promised": "7.1.1", @@ -98,12 +98,12 @@ "coveralls": "3.1.0", "del": "6.0.0", "dependency-graph": "0.9.0", - "eslint": "7.11.0", + "eslint": "7.12.1", "eslint-plugin-import": "2.22.1", "express": "4.17.1", "find-free-port": "2.0.0", "firebase-functions": "3.11.0", - "firebase-tools": "8.12.1", + "firebase-tools": "8.15.0", "git-rev-sync": "3.0.1", "glob": "7.1.6", "http-server": "0.12.3", @@ -116,7 +116,7 @@ "karma-chrome-launcher": "3.1.0", "karma-cli": "2.0.0", "karma-coverage-istanbul-reporter": "2.1.1", - "karma-firefox-launcher": "2.0.0", + "karma-firefox-launcher": "2.1.0", "karma-mocha": "2.0.1", "karma-mocha-reporter": "2.2.5", "karma-safari-launcher": "1.0.0", @@ -143,18 +143,18 @@ "rxjs": "6.6.3", "semver": "7.3.2", "simple-git": "2.21.0", - "sinon": "9.2.0", + "sinon": "9.2.1", "sinon-chai": "3.5.0", - "source-map-loader": "1.1.1", - "terser": "5.3.5", - "ts-loader": "8.0.5", + "source-map-loader": "1.1.2", + "terser": "5.3.8", + "ts-loader": "8.0.9", "ts-node": "9.0.0", "tslint": "6.1.3", "typedoc": "0.16.11", "typescript": "4.0.5", "watch": "1.0.2", "webpack": "4.44.2", - "yargs": "16.0.3" + "yargs": "16.1.0" }, "husky": { "hooks": { diff --git a/packages-exp/app-compat/package.json b/packages-exp/app-compat/package.json index 1fc5d2b1cc3..31942e50909 100644 --- a/packages-exp/app-compat/package.json +++ b/packages-exp/app-compat/package.json @@ -37,10 +37,10 @@ "xmlhttprequest": "1.8.0" }, "devDependencies": { - "rollup": "2.29.0", + "rollup": "2.33.1", "@rollup/plugin-json": "4.1.0", "rollup-plugin-replace": "2.2.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup-plugin-typescript2": "0.29.0", "typescript": "4.0.5" }, "repository": { diff --git a/packages-exp/app-exp/package.json b/packages-exp/app-exp/package.json index 99fd7a615d6..35817ccc8a0 100644 --- a/packages-exp/app-exp/package.json +++ b/packages-exp/app-exp/package.json @@ -38,10 +38,10 @@ }, "license": "Apache-2.0", "devDependencies": { - "rollup": "2.29.0", + "rollup": "2.33.1", "@rollup/plugin-json": "4.1.0", "rollup-plugin-replace": "2.2.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup-plugin-typescript2": "0.29.0", "typescript": "4.0.5" }, "repository": { diff --git a/packages-exp/auth-compat-exp/demo/package.json b/packages-exp/auth-compat-exp/demo/package.json index 8152c3b3947..39e9d42b1d8 100644 --- a/packages-exp/auth-compat-exp/demo/package.json +++ b/packages-exp/auth-compat-exp/demo/package.json @@ -33,7 +33,7 @@ "rollup-plugin-license": "0.14.0", "@rollup/plugin-node-resolve": "9.0.0", "rollup-plugin-sourcemaps": "0.6.3", - "rollup-plugin-typescript2": "0.27.3", + "rollup-plugin-typescript2": "0.29.0", "rollup-plugin-uglify": "6.0.4", "typescript": "4.0.5" }, diff --git a/packages-exp/auth-compat-exp/demo/yarn.lock b/packages-exp/auth-compat-exp/demo/yarn.lock index 6c6ab10ca95..660a62aa5cb 100644 --- a/packages-exp/auth-compat-exp/demo/yarn.lock +++ b/packages-exp/auth-compat-exp/demo/yarn.lock @@ -4450,10 +4450,10 @@ rollup-plugin-sourcemaps@0.6.3: "@rollup/pluginutils" "^3.0.9" source-map-resolve "^0.6.0" -rollup-plugin-typescript2@0.27.3: - version "0.27.3" - resolved "https://registry.npmjs.org/rollup-plugin-typescript2/-/rollup-plugin-typescript2-0.27.3.tgz#cd9455ac026d325b20c5728d2cc54a08a771b68b" - integrity sha512-gmYPIFmALj9D3Ga1ZbTZAKTXq1JKlTQBtj299DXhqYz9cL3g/AQfUvbb2UhH+Nf++cCq941W2Mv7UcrcgLzJJg== +rollup-plugin-typescript2@0.29.0: + version "0.29.0" + resolved "https://registry.npmjs.org/rollup-plugin-typescript2/-/rollup-plugin-typescript2-0.29.0.tgz#b7ad83f5241dbc5bdf1e98d9c3fca005ffe39e1a" + integrity sha512-YytahBSZCIjn/elFugEGQR5qTsVhxhUwGZIsA9TmrSsC88qroGo65O5HZP/TTArH2dm0vUmYWhKchhwi2wL9bw== dependencies: "@rollup/pluginutils" "^3.1.0" find-cache-dir "^3.3.1" diff --git a/packages-exp/auth-compat-exp/package.json b/packages-exp/auth-compat-exp/package.json index 81b1357cd24..15ee2d82d1b 100644 --- a/packages-exp/auth-compat-exp/package.json +++ b/packages-exp/auth-compat-exp/package.json @@ -37,10 +37,10 @@ "license": "Apache-2.0", "devDependencies": { "@firebase/app-compat": "0.x", - "rollup": "2.29.0", + "rollup": "2.33.1", "@rollup/plugin-json": "4.1.0", "rollup-plugin-replace": "2.2.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup-plugin-typescript2": "0.29.0", "typescript": "4.0.5" }, "repository": { diff --git a/packages-exp/auth-exp/demo/package.json b/packages-exp/auth-exp/demo/package.json index 7521dccb76c..9e292e63ba5 100644 --- a/packages-exp/auth-exp/demo/package.json +++ b/packages-exp/auth-exp/demo/package.json @@ -21,17 +21,17 @@ "@firebase/auth-exp": "0.0.800", "@firebase/auth-types-exp": "0.0.800", "@firebase/logger": "0.2.6", - "@firebase/util": "0.3.2", + "@firebase/util": "0.3.3", "tslib": "^1.11.1" }, "license": "Apache-2.0", "devDependencies": { "@rollup/plugin-strip": "2.0.0", - "rollup": "2.29.0", + "rollup": "2.33.1", "@rollup/plugin-json": "4.1.0", "rollup-plugin-replace": "2.2.0", "rollup-plugin-terser": "6.1.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup-plugin-typescript2": "0.29.0", "rollup-plugin-uglify": "6.0.4", "@rollup/plugin-node-resolve": "9.0.0", "lerna": "3.22.1" diff --git a/packages-exp/auth-exp/package.json b/packages-exp/auth-exp/package.json index 77c7052ad91..ddd28f5bbfc 100644 --- a/packages-exp/auth-exp/package.json +++ b/packages-exp/auth-exp/package.json @@ -48,10 +48,10 @@ "license": "Apache-2.0", "devDependencies": { "@firebase/app-exp": "0.0.800", - "rollup": "2.29.0", + "rollup": "2.33.1", "@rollup/plugin-json": "4.1.0", "rollup-plugin-sourcemaps": "0.6.3", - "rollup-plugin-typescript2": "0.27.3", + "rollup-plugin-typescript2": "0.29.0", "@rollup/plugin-strip": "2.0.0", "typescript": "4.0.5" }, diff --git a/packages-exp/firebase-exp/package.json b/packages-exp/firebase-exp/package.json index 22bd7538462..02630b3126c 100644 --- a/packages-exp/firebase-exp/package.json +++ b/packages-exp/firebase-exp/package.json @@ -45,13 +45,13 @@ "@firebase/performance-exp": "0.0.800" }, "devDependencies": { - "rollup": "2.29.0", + "rollup": "2.33.1", "@rollup/plugin-commonjs": "15.1.0", "rollup-plugin-license": "2.2.0", "@rollup/plugin-node-resolve": "9.0.0", "rollup-plugin-sourcemaps": "0.6.3", "rollup-plugin-terser": "7.0.2", - "rollup-plugin-typescript2": "0.27.3", + "rollup-plugin-typescript2": "0.29.0", "rollup-plugin-uglify": "6.0.4", "gulp": "4.0.2", "gulp-sourcemaps": "2.6.5", diff --git a/packages-exp/functions-compat/package.json b/packages-exp/functions-compat/package.json index 4ea817f5fca..e1281b8f73e 100644 --- a/packages-exp/functions-compat/package.json +++ b/packages-exp/functions-compat/package.json @@ -17,9 +17,9 @@ }, "devDependencies": { "@firebase/app-compat": "0.0.800", - "rollup": "2.29.0", + "rollup": "2.33.1", "@rollup/plugin-json": "4.1.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup-plugin-typescript2": "0.29.0", "typescript": "4.0.5" }, "repository": { diff --git a/packages-exp/functions-exp/package.json b/packages-exp/functions-exp/package.json index 9d883f5fa87..cdb17973eb1 100644 --- a/packages-exp/functions-exp/package.json +++ b/packages-exp/functions-exp/package.json @@ -36,9 +36,9 @@ }, "devDependencies": { "@firebase/app-exp": "0.0.800", - "rollup": "2.29.0", + "rollup": "2.33.1", "@rollup/plugin-json": "4.1.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup-plugin-typescript2": "0.29.0", "typescript": "4.0.5" }, "repository": { diff --git a/packages-exp/installations-exp/package.json b/packages-exp/installations-exp/package.json index 743924504f2..4a92787e1ad 100644 --- a/packages-exp/installations-exp/package.json +++ b/packages-exp/installations-exp/package.json @@ -41,11 +41,11 @@ }, "devDependencies": { "@firebase/app-exp": "0.0.800", - "rollup": "2.29.0", + "rollup": "2.33.1", "@rollup/plugin-commonjs": "15.1.0", "@rollup/plugin-json": "4.1.0", "@rollup/plugin-node-resolve": "9.0.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup-plugin-typescript2": "0.29.0", "rollup-plugin-uglify": "6.0.4", "typescript": "4.0.5" }, diff --git a/packages-exp/performance-exp/package.json b/packages-exp/performance-exp/package.json index 7522cb4a9bc..49016873d0b 100644 --- a/packages-exp/performance-exp/package.json +++ b/packages-exp/performance-exp/package.json @@ -42,9 +42,9 @@ "license": "Apache-2.0", "devDependencies": { "@firebase/app-exp": "0.0.800", - "rollup": "2.29.0", + "rollup": "2.33.1", "@rollup/plugin-json": "4.1.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup-plugin-typescript2": "0.29.0", "typescript": "4.0.5" }, "repository": { diff --git a/packages-exp/remote-config-exp/package.json b/packages-exp/remote-config-exp/package.json index 407dc6ee6b9..fcf563a67fa 100644 --- a/packages-exp/remote-config-exp/package.json +++ b/packages-exp/remote-config-exp/package.json @@ -42,8 +42,8 @@ "license": "Apache-2.0", "devDependencies": { "@firebase/app-exp": "0.0.800", - "rollup": "2.29.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup": "2.33.1", + "rollup-plugin-typescript2": "0.29.0", "typescript": "4.0.5" }, "repository": { diff --git a/packages/analytics/package.json b/packages/analytics/package.json index 27af462bdf0..61f136a126c 100644 --- a/packages/analytics/package.json +++ b/packages/analytics/package.json @@ -35,11 +35,11 @@ "license": "Apache-2.0", "devDependencies": { "@firebase/app": "0.6.12", - "rollup": "2.29.0", + "rollup": "2.33.1", "@rollup/plugin-commonjs": "15.1.0", "@rollup/plugin-json": "4.1.0", "@rollup/plugin-node-resolve": "9.0.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup-plugin-typescript2": "0.29.0", "typescript": "4.0.5" }, "repository": { diff --git a/packages/app/package.json b/packages/app/package.json index a3e7d2a3829..2c7cbc1de97 100644 --- a/packages/app/package.json +++ b/packages/app/package.json @@ -36,10 +36,10 @@ "xmlhttprequest": "1.8.0" }, "devDependencies": { - "rollup": "2.29.0", + "rollup": "2.33.1", "@rollup/plugin-json": "4.1.0", "rollup-plugin-replace": "2.2.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup-plugin-typescript2": "0.29.0", "typescript": "4.0.5" }, "repository": { diff --git a/packages/auth/demo/functions/package.json b/packages/auth/demo/functions/package.json index e932de95421..1166869cbe8 100644 --- a/packages/auth/demo/functions/package.json +++ b/packages/auth/demo/functions/package.json @@ -9,7 +9,7 @@ "logs": "firebase functions:log" }, "dependencies": { - "firebase-admin": "9.2.0", + "firebase-admin": "9.3.0", "firebase-functions": "3.11.0" }, "private": true diff --git a/packages/auth/demo/functions/yarn.lock b/packages/auth/demo/functions/yarn.lock index 98e83bfcd7f..302e15aeb0b 100644 --- a/packages/auth/demo/functions/yarn.lock +++ b/packages/auth/demo/functions/yarn.lock @@ -670,10 +670,10 @@ find-up@^4.1.0: locate-path "^5.0.0" path-exists "^4.0.0" -firebase-admin@9.2.0: - version "9.2.0" - resolved "https://registry.npmjs.org/firebase-admin/-/firebase-admin-9.2.0.tgz#df5176e2d0c5711df6dbf7012320492a703538ea" - integrity sha512-LhnMYl71B4gP1FlTLfwaYlOWhBCAcNF+byb2CPTfaW/T4hkp4qlXOgo2bws/zbAv5X9GTFqGir3KexMslVGsIA== +firebase-admin@9.3.0: + version "9.3.0" + resolved "https://registry.npmjs.org/firebase-admin/-/firebase-admin-9.3.0.tgz#05f3efb1bb97f17b2c562f4b59820a381d2f903f" + integrity sha512-qMUITOp2QKLLc2o0/wSiDC2OO2knejjieZN/8Or9AzfFk8ftTcUKq5ALNlQXu+7aUzGe0IwSJq9TVnkIU0h1xw== dependencies: "@firebase/database" "^0.6.10" "@firebase/database-types" "^0.5.2" diff --git a/packages/auth/package.json b/packages/auth/package.json index 7bdaff80a48..a5132d31edd 100644 --- a/packages/auth/package.json +++ b/packages/auth/package.json @@ -25,7 +25,7 @@ "@firebase/auth-types": "0.10.1" }, "devDependencies": { - "firebase-tools": "8.12.1", + "firebase-tools": "8.15.0", "google-closure-compiler": "20200112.0.0", "google-closure-library": "20200830.0.0", "gulp": "4.0.2", diff --git a/packages/component/package.json b/packages/component/package.json index ce99acd8602..02fcb25f4bc 100644 --- a/packages/component/package.json +++ b/packages/component/package.json @@ -27,8 +27,8 @@ }, "license": "Apache-2.0", "devDependencies": { - "rollup": "2.29.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup": "2.33.1", + "rollup-plugin-typescript2": "0.29.0", "typescript": "4.0.5" }, "repository": { diff --git a/packages/database/package.json b/packages/database/package.json index 2139ecb319a..33fac70ac98 100644 --- a/packages/database/package.json +++ b/packages/database/package.json @@ -36,8 +36,8 @@ "devDependencies": { "@firebase/app": "0.6.12", "@firebase/app-types": "0.6.1", - "rollup": "2.29.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup": "2.33.1", + "rollup-plugin-typescript2": "0.29.0", "typescript": "4.0.5" }, "repository": { diff --git a/packages/firebase/package.json b/packages/firebase/package.json index 30e9cd7d507..7ca20032f36 100644 --- a/packages/firebase/package.json +++ b/packages/firebase/package.json @@ -61,13 +61,13 @@ "@firebase/util": "0.3.3" }, "devDependencies": { - "rollup": "2.29.0", + "rollup": "2.33.1", "@rollup/plugin-commonjs": "15.1.0", "rollup-plugin-license": "2.2.0", "@rollup/plugin-node-resolve": "9.0.0", "rollup-plugin-sourcemaps": "0.6.3", "rollup-plugin-terser": "7.0.2", - "rollup-plugin-typescript2": "0.27.3", + "rollup-plugin-typescript2": "0.29.0", "rollup-plugin-uglify": "6.0.4", "typescript": "4.0.5" }, diff --git a/packages/firestore/package.json b/packages/firestore/package.json index 0f3caec1929..7c31e55bf3f 100644 --- a/packages/firestore/package.json +++ b/packages/firestore/package.json @@ -83,14 +83,14 @@ "@types/json-stable-stringify": "1.0.32", "json-stable-stringify": "1.0.1", "protobufjs": "6.10.1", - "rollup": "2.29.0", + "rollup": "2.33.1", "rollup-plugin-copy-assets": "1.1.0", "@rollup/plugin-json": "4.1.0", "@rollup/plugin-node-resolve": "9.0.0", "rollup-plugin-replace": "2.2.0", "rollup-plugin-sourcemaps": "0.6.3", "rollup-plugin-terser": "7.0.2", - "rollup-plugin-typescript2": "0.27.3", + "rollup-plugin-typescript2": "0.29.0", "ts-node": "9.0.0", "typescript": "4.0.5" }, diff --git a/packages/functions/package.json b/packages/functions/package.json index 4ab59582328..94bc6c6ab71 100644 --- a/packages/functions/package.json +++ b/packages/functions/package.json @@ -31,8 +31,8 @@ "devDependencies": { "@firebase/app": "0.6.12", "@firebase/messaging": "0.7.2", - "rollup": "2.29.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup": "2.33.1", + "rollup-plugin-typescript2": "0.29.0", "typescript": "4.0.5" }, "repository": { diff --git a/packages/installations/package.json b/packages/installations/package.json index e8019eaedaa..21cbd16f961 100644 --- a/packages/installations/package.json +++ b/packages/installations/package.json @@ -31,11 +31,11 @@ }, "devDependencies": { "@firebase/app": "0.6.12", - "rollup": "2.29.0", + "rollup": "2.33.1", "@rollup/plugin-commonjs": "15.1.0", "@rollup/plugin-json": "4.1.0", "@rollup/plugin-node-resolve": "9.0.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup-plugin-typescript2": "0.29.0", "rollup-plugin-uglify": "6.0.4", "typescript": "4.0.5" }, diff --git a/packages/logger/package.json b/packages/logger/package.json index 4d3cfb5f9cf..007cbb41af4 100644 --- a/packages/logger/package.json +++ b/packages/logger/package.json @@ -23,8 +23,8 @@ }, "license": "Apache-2.0", "devDependencies": { - "rollup": "2.29.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup": "2.33.1", + "rollup-plugin-typescript2": "0.29.0", "typescript": "4.0.5" }, "repository": { diff --git a/packages/messaging/package.json b/packages/messaging/package.json index 4f890b6815a..a1b3909c557 100644 --- a/packages/messaging/package.json +++ b/packages/messaging/package.json @@ -35,9 +35,9 @@ }, "devDependencies": { "@firebase/app": "0.6.12", - "rollup": "2.29.0", - "rollup-plugin-typescript2": "0.27.3", - "ts-essentials": "7.0.0", + "rollup": "2.33.1", + "rollup-plugin-typescript2": "0.29.0", + "ts-essentials": "7.0.1", "typescript": "4.0.5" }, "repository": { diff --git a/packages/performance/package.json b/packages/performance/package.json index 9538fd0d6f3..3a1dd0e6c0d 100644 --- a/packages/performance/package.json +++ b/packages/performance/package.json @@ -36,9 +36,9 @@ "license": "Apache-2.0", "devDependencies": { "@firebase/app": "0.6.12", - "rollup": "2.29.0", + "rollup": "2.33.1", "@rollup/plugin-json": "4.1.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup-plugin-typescript2": "0.29.0", "typescript": "4.0.5" }, "repository": { diff --git a/packages/polyfill/package.json b/packages/polyfill/package.json index 92bbbd4d706..beaf2c43fb4 100644 --- a/packages/polyfill/package.json +++ b/packages/polyfill/package.json @@ -18,12 +18,12 @@ "license": "Apache-2.0", "dependencies": { "core-js": "3.6.5", - "promise-polyfill": "8.1.3", + "promise-polyfill": "8.2.0", "whatwg-fetch": "2.0.4" }, "devDependencies": { - "rollup": "2.29.0", - "rollup-plugin-typescript2": "0.27.3" + "rollup": "2.33.1", + "rollup-plugin-typescript2": "0.29.0" }, "repository": { "directory": "packages/polyfill", diff --git a/packages/remote-config/package.json b/packages/remote-config/package.json index 7705a6cd462..51e94ff67b4 100644 --- a/packages/remote-config/package.json +++ b/packages/remote-config/package.json @@ -36,8 +36,8 @@ "license": "Apache-2.0", "devDependencies": { "@firebase/app": "0.6.12", - "rollup": "2.29.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup": "2.33.1", + "rollup-plugin-typescript2": "0.29.0", "typescript": "4.0.5" }, "repository": { diff --git a/packages/rules-unit-testing/package.json b/packages/rules-unit-testing/package.json index fcf48018816..36addb65d40 100644 --- a/packages/rules-unit-testing/package.json +++ b/packages/rules-unit-testing/package.json @@ -25,13 +25,13 @@ "request": "2.88.2" }, "devDependencies": { - "@google-cloud/firestore": "4.4.0", + "@google-cloud/firestore": "4.7.0", "@types/request": "2.48.5", - "firebase-admin": "9.2.0", - "firebase-tools": "8.13.0", + "firebase-admin": "9.3.0", + "firebase-tools": "8.15.0", "firebase-functions": "3.11.0", - "rollup": "2.29.0", - "rollup-plugin-typescript2": "0.27.3" + "rollup": "2.33.1", + "rollup-plugin-typescript2": "0.29.0" }, "peerDependencies": { "@google-cloud/firestore": "^4.2.0", diff --git a/packages/rxfire/package.json b/packages/rxfire/package.json index 05edbd306f1..01a9baf3c3e 100644 --- a/packages/rxfire/package.json +++ b/packages/rxfire/package.json @@ -41,10 +41,10 @@ }, "devDependencies": { "firebase": "8.0.0", - "rollup": "2.29.0", + "rollup": "2.33.1", "@rollup/plugin-commonjs": "15.1.0", "@rollup/plugin-node-resolve": "9.0.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup-plugin-typescript2": "0.29.0", "rollup-plugin-uglify": "6.0.4", "typescript": "4.0.5" }, diff --git a/packages/storage/package.json b/packages/storage/package.json index 86a5291aadf..829d7ccbd3e 100644 --- a/packages/storage/package.json +++ b/packages/storage/package.json @@ -35,8 +35,8 @@ "devDependencies": { "@firebase/app": "0.6.12", "@firebase/auth": "0.15.1", - "rollup": "2.29.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup": "2.33.1", + "rollup-plugin-typescript2": "0.29.0", "typescript": "4.0.5" }, "repository": { diff --git a/packages/template/package.json b/packages/template/package.json index 85b5e666d94..a2a95b00621 100644 --- a/packages/template/package.json +++ b/packages/template/package.json @@ -33,8 +33,8 @@ "license": "Apache-2.0", "devDependencies": { "@firebase/app": "0.6.12", - "rollup": "2.29.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup": "2.33.1", + "rollup-plugin-typescript2": "0.29.0", "typescript": "4.0.5" }, "repository": { diff --git a/packages/util/package.json b/packages/util/package.json index 632859ae8ee..0a5f939ceca 100644 --- a/packages/util/package.json +++ b/packages/util/package.json @@ -26,8 +26,8 @@ "tslib": "^1.11.1" }, "devDependencies": { - "rollup": "2.29.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup": "2.33.1", + "rollup-plugin-typescript2": "0.29.0", "typescript": "4.0.5" }, "repository": { diff --git a/packages/webchannel-wrapper/package.json b/packages/webchannel-wrapper/package.json index 83bbf1666ca..f79124cf33a 100644 --- a/packages/webchannel-wrapper/package.json +++ b/packages/webchannel-wrapper/package.json @@ -20,10 +20,10 @@ "google-closure-library": "20200830.0.0", "gulp": "4.0.2", "gulp-sourcemaps": "2.6.5", - "rollup": "2.29.0", + "rollup": "2.33.1", "@rollup/plugin-commonjs": "15.1.0", "rollup-plugin-sourcemaps": "0.6.3", - "rollup-plugin-typescript2": "0.27.3", + "rollup-plugin-typescript2": "0.29.0", "typescript": "4.0.5" }, "repository": { diff --git a/repo-scripts/size-analysis/package.json b/repo-scripts/size-analysis/package.json index f46e702bae0..1b908cd0778 100644 --- a/repo-scripts/size-analysis/package.json +++ b/repo-scripts/size-analysis/package.json @@ -16,22 +16,22 @@ "test:node": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha **/*.test.ts --config ../../config/mocharc.node.js --timeout 60000" }, "dependencies": { - "rollup": "2.29.0", + "rollup": "2.33.1", "@rollup/plugin-commonjs": "15.1.0", "@rollup/plugin-json": "4.1.0", "@rollup/plugin-node-resolve": "9.0.0", "rollup-plugin-replace": "2.2.0", - "rollup-plugin-typescript2": "0.27.3", + "rollup-plugin-typescript2": "0.29.0", "@rollup/plugin-virtual": "2.0.3", "webpack": "4.44.2", - "@types/webpack": "4.41.22", - "webpack-virtual-modules": "0.3.1", + "@types/webpack": "4.41.24", + "webpack-virtual-modules": "0.3.2", "child-process-promise": "2.2.1", "memfs": "3.2.0", "tmp": "0.2.1", "typescript": "4.0.5", - "terser": "5.3.5", - "yargs": "16.0.3", + "terser": "5.3.8", + "yargs": "16.1.0", "@firebase/util": "0.3.3", "gzip-size": "5.1.1" }, diff --git a/yarn.lock b/yarn.lock index fa023cc87b3..f564a6d9db4 100644 --- a/yarn.lock +++ b/yarn.lock @@ -18,16 +18,34 @@ dependencies: "@babel/highlight" "^7.10.4" -"@babel/compat-data@^7.10.4", "@babel/compat-data@^7.11.0": - version "7.11.0" - resolved "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.11.0.tgz#e9f73efe09af1355b723a7f39b11bad637d7c99c" - integrity sha512-TPSvJfv73ng0pfnEOh17bYMPQbI95+nGWc71Ss4vZdRBHTDqmM9Z8ZV4rYz8Ks7sfzc95n30k6ODIq5UGnXcYQ== +"@babel/compat-data@^7.12.1", "@babel/compat-data@^7.12.5": + version "7.12.5" + resolved "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.12.5.tgz#f56db0c4bb1bbbf221b4e81345aab4141e7cb0e9" + integrity sha512-DTsS7cxrsH3by8nqQSpFSyjSfSYl57D6Cf4q8dW3LK83tBKBDCkfcay1nYkXq1nIHXnpX8WMMb/O25HOy3h1zg== + +"@babel/core@7.12.3": + version "7.12.3" + resolved "https://registry.npmjs.org/@babel/core/-/core-7.12.3.tgz#1b436884e1e3bff6fb1328dc02b208759de92ad8" + integrity sha512-0qXcZYKZp3/6N2jKYVxZv0aNCsxTSVCiK72DTiTYZAu7sjg73W0/aynWjMbiGd87EQL4WyA8reiJVh92AVla9g== dependencies: - browserslist "^4.12.0" - invariant "^2.2.4" - semver "^5.5.0" + "@babel/code-frame" "^7.10.4" + "@babel/generator" "^7.12.1" + "@babel/helper-module-transforms" "^7.12.1" + "@babel/helpers" "^7.12.1" + "@babel/parser" "^7.12.3" + "@babel/template" "^7.10.4" + "@babel/traverse" "^7.12.1" + "@babel/types" "^7.12.1" + convert-source-map "^1.7.0" + debug "^4.1.0" + gensync "^1.0.0-beta.1" + json5 "^2.1.2" + lodash "^4.17.19" + resolve "^1.3.2" + semver "^5.4.1" + source-map "^0.5.0" -"@babel/core@7.11.6", "@babel/core@^7.7.5": +"@babel/core@^7.7.5": version "7.11.6" resolved "https://registry.npmjs.org/@babel/core/-/core-7.11.6.tgz#3a9455dc7387ff1bac45770650bc13ba04a15651" integrity sha512-Wpcv03AGnmkgm6uS6k8iwhIwTrcP0m17TL1n1sy7qD0qelDu4XNeW0dN0mHfa+Gei211yDaLoEe/VlbXQzM4Bg== @@ -67,6 +85,15 @@ jsesc "^2.5.1" source-map "^0.5.0" +"@babel/generator@^7.12.5": + version "7.12.5" + resolved "https://registry.npmjs.org/@babel/generator/-/generator-7.12.5.tgz#a2c50de5c8b6d708ab95be5e6053936c1884a4de" + integrity sha512-m16TQQJ8hPt7E+OS/XVQg/7U184MLXtvuGbCdA7na61vha+ImkyyNM/9DDA0unYCVZn3ZOhng+qz48/KBOT96A== + dependencies: + "@babel/types" "^7.12.5" + jsesc "^2.5.1" + source-map "^0.5.0" + "@babel/helper-annotate-as-pure@^7.10.4": version "7.10.4" resolved "https://registry.npmjs.org/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.10.4.tgz#5bf0d495a3f757ac3bda48b5bf3b3ba309c72ba3" @@ -82,27 +109,25 @@ "@babel/helper-explode-assignable-expression" "^7.10.4" "@babel/types" "^7.10.4" -"@babel/helper-compilation-targets@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.10.4.tgz#804ae8e3f04376607cc791b9d47d540276332bd2" - integrity sha512-a3rYhlsGV0UHNDvrtOXBg8/OpfV0OKTkxKPzIplS1zpx7CygDcWWxckxZeDd3gzPzC4kUT0A4nVFDK0wGMh4MQ== +"@babel/helper-compilation-targets@^7.12.1": + version "7.12.5" + resolved "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.12.5.tgz#cb470c76198db6a24e9dbc8987275631e5d29831" + integrity sha512-+qH6NrscMolUlzOYngSBMIOQpKUGPPsc61Bu5W10mg84LxZ7cmvnBHzARKbDoFxVvqqAbj6Tg6N7bSrWSPXMyw== dependencies: - "@babel/compat-data" "^7.10.4" - browserslist "^4.12.0" - invariant "^2.2.4" - levenary "^1.1.1" + "@babel/compat-data" "^7.12.5" + "@babel/helper-validator-option" "^7.12.1" + browserslist "^4.14.5" semver "^5.5.0" -"@babel/helper-create-class-features-plugin@^7.10.4": - version "7.10.5" - resolved "https://registry.npmjs.org/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.10.5.tgz#9f61446ba80e8240b0a5c85c6fdac8459d6f259d" - integrity sha512-0nkdeijB7VlZoLT3r/mY3bUkw3T8WG/hNw+FATs/6+pG2039IJWjTYL0VTISqsNHMUTEnwbVnc89WIJX9Qed0A== +"@babel/helper-create-class-features-plugin@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.12.1.tgz#3c45998f431edd4a9214c5f1d3ad1448a6137f6e" + integrity sha512-hkL++rWeta/OVOBTRJc9a5Azh5mt5WgZUGAKMD8JM141YsE08K//bp1unBBieO6rUKkIPyUE0USQ30jAy3Sk1w== dependencies: "@babel/helper-function-name" "^7.10.4" - "@babel/helper-member-expression-to-functions" "^7.10.5" + "@babel/helper-member-expression-to-functions" "^7.12.1" "@babel/helper-optimise-call-expression" "^7.10.4" - "@babel/helper-plugin-utils" "^7.10.4" - "@babel/helper-replace-supers" "^7.10.4" + "@babel/helper-replace-supers" "^7.12.1" "@babel/helper-split-export-declaration" "^7.10.4" "@babel/helper-create-regexp-features-plugin@^7.10.4": @@ -114,6 +139,15 @@ "@babel/helper-regex" "^7.10.4" regexpu-core "^4.7.0" +"@babel/helper-create-regexp-features-plugin@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/helper-create-regexp-features-plugin/-/helper-create-regexp-features-plugin-7.12.1.tgz#18b1302d4677f9dc4740fe8c9ed96680e29d37e8" + integrity sha512-rsZ4LGvFTZnzdNZR5HZdmJVuXK8834R5QkF3WvcnBhrlVtF0HSIUC6zbreL9MgjTywhKokn8RIYRiq99+DLAxA== + dependencies: + "@babel/helper-annotate-as-pure" "^7.10.4" + "@babel/helper-regex" "^7.10.4" + regexpu-core "^4.7.1" + "@babel/helper-define-map@^7.10.4": version "7.10.5" resolved "https://registry.npmjs.org/@babel/helper-define-map/-/helper-define-map-7.10.5.tgz#b53c10db78a640800152692b13393147acb9bb30" @@ -153,7 +187,7 @@ dependencies: "@babel/types" "^7.10.4" -"@babel/helper-member-expression-to-functions@^7.10.4", "@babel/helper-member-expression-to-functions@^7.10.5": +"@babel/helper-member-expression-to-functions@^7.10.4": version "7.11.0" resolved "https://registry.npmjs.org/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.11.0.tgz#ae69c83d84ee82f4b42f96e2a09410935a8f26df" integrity sha512-JbFlKHFntRV5qKw3YC0CvQnDZ4XMwgzzBbld7Ly4Mj4cbFy3KywcR8NtNctRToMWJOVvLINJv525Gd6wwVEx/Q== @@ -181,7 +215,7 @@ dependencies: "@babel/types" "^7.12.1" -"@babel/helper-module-transforms@^7.10.4", "@babel/helper-module-transforms@^7.10.5", "@babel/helper-module-transforms@^7.11.0": +"@babel/helper-module-transforms@^7.11.0": version "7.11.0" resolved "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.11.0.tgz#b16f250229e47211abdd84b34b64737c2ab2d359" integrity sha512-02EVu8COMuTRO1TAzdMtpBPbe6aQ1w/8fePD2YgQmxZU4gpNWaL9gK3Jp7dxlkUlUCJOTaSeA+Hrm1BRQwqIhg== @@ -228,15 +262,14 @@ dependencies: lodash "^4.17.19" -"@babel/helper-remap-async-to-generator@^7.10.4": - version "7.11.4" - resolved "https://registry.npmjs.org/@babel/helper-remap-async-to-generator/-/helper-remap-async-to-generator-7.11.4.tgz#4474ea9f7438f18575e30b0cac784045b402a12d" - integrity sha512-tR5vJ/vBa9wFy3m5LLv2faapJLnDFxNWff2SAYkSE4rLUdbp7CdObYFgI7wK4T/Mj4UzpjPwzR8Pzmr5m7MHGA== +"@babel/helper-remap-async-to-generator@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/helper-remap-async-to-generator/-/helper-remap-async-to-generator-7.12.1.tgz#8c4dbbf916314f6047dc05e6a2217074238347fd" + integrity sha512-9d0KQCRM8clMPcDwo8SevNs+/9a8yWVVmaE80FGJcEP8N1qToREmWEGnBn8BUlJhYRFz6fqxeRL1sl5Ogsed7A== dependencies: "@babel/helper-annotate-as-pure" "^7.10.4" "@babel/helper-wrap-function" "^7.10.4" - "@babel/template" "^7.10.4" - "@babel/types" "^7.10.4" + "@babel/types" "^7.12.1" "@babel/helper-replace-supers@^7.10.4": version "7.10.4" @@ -273,12 +306,12 @@ dependencies: "@babel/types" "^7.12.1" -"@babel/helper-skip-transparent-expression-wrappers@^7.11.0": - version "7.11.0" - resolved "https://registry.npmjs.org/@babel/helper-skip-transparent-expression-wrappers/-/helper-skip-transparent-expression-wrappers-7.11.0.tgz#eec162f112c2f58d3af0af125e3bb57665146729" - integrity sha512-0XIdiQln4Elglgjbwo9wuJpL/K7AGCY26kmEt0+pRP0TAj4jjyNq1MjoRvikrTVqKcx4Gysxt4cXvVFXP/JO2Q== +"@babel/helper-skip-transparent-expression-wrappers@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/helper-skip-transparent-expression-wrappers/-/helper-skip-transparent-expression-wrappers-7.12.1.tgz#462dc63a7e435ade8468385c63d2b84cce4b3cbf" + integrity sha512-Mf5AUuhG1/OCChOJ/HcADmvcHM42WJockombn8ATJG3OnyiSxBK/Mm5x78BQWvmtXZKHgbjdGL2kin/HOLlZGA== dependencies: - "@babel/types" "^7.11.0" + "@babel/types" "^7.12.1" "@babel/helper-split-export-declaration@^7.10.4", "@babel/helper-split-export-declaration@^7.11.0": version "7.11.0" @@ -292,6 +325,11 @@ resolved "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.10.4.tgz#a78c7a7251e01f616512d31b10adcf52ada5e0d2" integrity sha512-3U9y+43hz7ZM+rzG24Qe2mufW5KhvFg/NhnNph+i9mgCtdTCtMJuI1TMkrIUiK7Ix4PYlRF9I5dhqaLYA/ADXw== +"@babel/helper-validator-option@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/helper-validator-option/-/helper-validator-option-7.12.1.tgz#175567380c3e77d60ff98a54bb015fe78f2178d9" + integrity sha512-YpJabsXlJVWP0USHjnC/AQDTLlZERbON577YUVO/wLpqyj6HAtVYnWaQaN0iUN+1/tWn3c+uKKXjRut5115Y2A== + "@babel/helper-wrap-function@^7.10.4": version "7.10.4" resolved "https://registry.npmjs.org/@babel/helper-wrap-function/-/helper-wrap-function-7.10.4.tgz#8a6f701eab0ff39f765b5a1cfef409990e624b87" @@ -311,6 +349,15 @@ "@babel/traverse" "^7.10.4" "@babel/types" "^7.10.4" +"@babel/helpers@^7.12.1": + version "7.12.5" + resolved "https://registry.npmjs.org/@babel/helpers/-/helpers-7.12.5.tgz#1a1ba4a768d9b58310eda516c449913fe647116e" + integrity sha512-lgKGMQlKqA8meJqKsW6rUnc4MdUk35Ln0ATDqdM1a/UpARODdI4j5Y5lVfUScnSNkJcdCRAaWkspykNoFg9sJA== + dependencies: + "@babel/template" "^7.10.4" + "@babel/traverse" "^7.12.5" + "@babel/types" "^7.12.5" + "@babel/highlight@^7.10.4": version "7.10.4" resolved "https://registry.npmjs.org/@babel/highlight/-/highlight-7.10.4.tgz#7d1bdfd65753538fabe6c38596cdb76d9ac60143" @@ -330,106 +377,119 @@ resolved "https://registry.npmjs.org/@babel/parser/-/parser-7.12.3.tgz#a305415ebe7a6c7023b40b5122a0662d928334cd" integrity sha512-kFsOS0IbsuhO5ojF8Hc8z/8vEIOkylVBrjiZUbLTE3XFe0Qi+uu6HjzQixkFaqr0ZPAMZcBVxEwmsnsLPZ2Xsw== -"@babel/plugin-proposal-async-generator-functions@^7.10.4": - version "7.10.5" - resolved "https://registry.npmjs.org/@babel/plugin-proposal-async-generator-functions/-/plugin-proposal-async-generator-functions-7.10.5.tgz#3491cabf2f7c179ab820606cec27fed15e0e8558" - integrity sha512-cNMCVezQbrRGvXJwm9fu/1sJj9bHdGAgKodZdLqOQIpfoH3raqmRPBM17+lh7CzhiKRRBrGtZL9WcjxSoGYUSg== +"@babel/parser@^7.12.3", "@babel/parser@^7.12.5": + version "7.12.5" + resolved "https://registry.npmjs.org/@babel/parser/-/parser-7.12.5.tgz#b4af32ddd473c0bfa643bd7ff0728b8e71b81ea0" + integrity sha512-FVM6RZQ0mn2KCf1VUED7KepYeUWoVShczewOCfm3nzoBybaih51h+sYVVGthW9M6lPByEPTQf+xm27PBdlpwmQ== + +"@babel/plugin-proposal-async-generator-functions@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-proposal-async-generator-functions/-/plugin-proposal-async-generator-functions-7.12.1.tgz#dc6c1170e27d8aca99ff65f4925bd06b1c90550e" + integrity sha512-d+/o30tJxFxrA1lhzJqiUcEJdI6jKlNregCv5bASeGf2Q4MXmnwH7viDo7nhx1/ohf09oaH8j1GVYG/e3Yqk6A== dependencies: "@babel/helper-plugin-utils" "^7.10.4" - "@babel/helper-remap-async-to-generator" "^7.10.4" + "@babel/helper-remap-async-to-generator" "^7.12.1" "@babel/plugin-syntax-async-generators" "^7.8.0" -"@babel/plugin-proposal-class-properties@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-proposal-class-properties/-/plugin-proposal-class-properties-7.10.4.tgz#a33bf632da390a59c7a8c570045d1115cd778807" - integrity sha512-vhwkEROxzcHGNu2mzUC0OFFNXdZ4M23ib8aRRcJSsW8BZK9pQMD7QB7csl97NBbgGZO7ZyHUyKDnxzOaP4IrCg== +"@babel/plugin-proposal-class-properties@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-proposal-class-properties/-/plugin-proposal-class-properties-7.12.1.tgz#a082ff541f2a29a4821065b8add9346c0c16e5de" + integrity sha512-cKp3dlQsFsEs5CWKnN7BnSHOd0EOW8EKpEjkoz1pO2E5KzIDNV9Ros1b0CnmbVgAGXJubOYVBOGCT1OmJwOI7w== dependencies: - "@babel/helper-create-class-features-plugin" "^7.10.4" + "@babel/helper-create-class-features-plugin" "^7.12.1" "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-proposal-dynamic-import@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-proposal-dynamic-import/-/plugin-proposal-dynamic-import-7.10.4.tgz#ba57a26cb98b37741e9d5bca1b8b0ddf8291f17e" - integrity sha512-up6oID1LeidOOASNXgv/CFbgBqTuKJ0cJjz6An5tWD+NVBNlp3VNSBxv2ZdU7SYl3NxJC7agAQDApZusV6uFwQ== +"@babel/plugin-proposal-dynamic-import@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-proposal-dynamic-import/-/plugin-proposal-dynamic-import-7.12.1.tgz#43eb5c2a3487ecd98c5c8ea8b5fdb69a2749b2dc" + integrity sha512-a4rhUSZFuq5W8/OO8H7BL5zspjnc1FLd9hlOxIK/f7qG4a0qsqk8uvF/ywgBA8/OmjsapjpvaEOYItfGG1qIvQ== dependencies: "@babel/helper-plugin-utils" "^7.10.4" "@babel/plugin-syntax-dynamic-import" "^7.8.0" -"@babel/plugin-proposal-export-namespace-from@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-proposal-export-namespace-from/-/plugin-proposal-export-namespace-from-7.10.4.tgz#570d883b91031637b3e2958eea3c438e62c05f54" - integrity sha512-aNdf0LY6/3WXkhh0Fdb6Zk9j1NMD8ovj3F6r0+3j837Pn1S1PdNtcwJ5EG9WkVPNHPxyJDaxMaAOVq4eki0qbg== +"@babel/plugin-proposal-export-namespace-from@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-proposal-export-namespace-from/-/plugin-proposal-export-namespace-from-7.12.1.tgz#8b9b8f376b2d88f5dd774e4d24a5cc2e3679b6d4" + integrity sha512-6CThGf0irEkzujYS5LQcjBx8j/4aQGiVv7J9+2f7pGfxqyKh3WnmVJYW3hdrQjyksErMGBPQrCnHfOtna+WLbw== dependencies: "@babel/helper-plugin-utils" "^7.10.4" "@babel/plugin-syntax-export-namespace-from" "^7.8.3" -"@babel/plugin-proposal-json-strings@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-proposal-json-strings/-/plugin-proposal-json-strings-7.10.4.tgz#593e59c63528160233bd321b1aebe0820c2341db" - integrity sha512-fCL7QF0Jo83uy1K0P2YXrfX11tj3lkpN7l4dMv9Y9VkowkhkQDwFHFd8IiwyK5MZjE8UpbgokkgtcReH88Abaw== +"@babel/plugin-proposal-json-strings@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-proposal-json-strings/-/plugin-proposal-json-strings-7.12.1.tgz#d45423b517714eedd5621a9dfdc03fa9f4eb241c" + integrity sha512-GoLDUi6U9ZLzlSda2Df++VSqDJg3CG+dR0+iWsv6XRw1rEq+zwt4DirM9yrxW6XWaTpmai1cWJLMfM8qQJf+yw== dependencies: "@babel/helper-plugin-utils" "^7.10.4" "@babel/plugin-syntax-json-strings" "^7.8.0" -"@babel/plugin-proposal-logical-assignment-operators@^7.11.0": - version "7.11.0" - resolved "https://registry.npmjs.org/@babel/plugin-proposal-logical-assignment-operators/-/plugin-proposal-logical-assignment-operators-7.11.0.tgz#9f80e482c03083c87125dee10026b58527ea20c8" - integrity sha512-/f8p4z+Auz0Uaf+i8Ekf1iM7wUNLcViFUGiPxKeXvxTSl63B875YPiVdUDdem7hREcI0E0kSpEhS8tF5RphK7Q== +"@babel/plugin-proposal-logical-assignment-operators@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-proposal-logical-assignment-operators/-/plugin-proposal-logical-assignment-operators-7.12.1.tgz#f2c490d36e1b3c9659241034a5d2cd50263a2751" + integrity sha512-k8ZmVv0JU+4gcUGeCDZOGd0lCIamU/sMtIiX3UWnUc5yzgq6YUGyEolNYD+MLYKfSzgECPcqetVcJP9Afe/aCA== dependencies: "@babel/helper-plugin-utils" "^7.10.4" "@babel/plugin-syntax-logical-assignment-operators" "^7.10.4" -"@babel/plugin-proposal-nullish-coalescing-operator@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-proposal-nullish-coalescing-operator/-/plugin-proposal-nullish-coalescing-operator-7.10.4.tgz#02a7e961fc32e6d5b2db0649e01bf80ddee7e04a" - integrity sha512-wq5n1M3ZUlHl9sqT2ok1T2/MTt6AXE0e1Lz4WzWBr95LsAZ5qDXe4KnFuauYyEyLiohvXFMdbsOTMyLZs91Zlw== +"@babel/plugin-proposal-nullish-coalescing-operator@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-proposal-nullish-coalescing-operator/-/plugin-proposal-nullish-coalescing-operator-7.12.1.tgz#3ed4fff31c015e7f3f1467f190dbe545cd7b046c" + integrity sha512-nZY0ESiaQDI1y96+jk6VxMOaL4LPo/QDHBqL+SF3/vl6dHkTwHlOI8L4ZwuRBHgakRBw5zsVylel7QPbbGuYgg== dependencies: "@babel/helper-plugin-utils" "^7.10.4" "@babel/plugin-syntax-nullish-coalescing-operator" "^7.8.0" -"@babel/plugin-proposal-numeric-separator@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-proposal-numeric-separator/-/plugin-proposal-numeric-separator-7.10.4.tgz#ce1590ff0a65ad12970a609d78855e9a4c1aef06" - integrity sha512-73/G7QoRoeNkLZFxsoCCvlg4ezE4eM+57PnOqgaPOozd5myfj7p0muD1mRVJvbUWbOzD+q3No2bWbaKy+DJ8DA== +"@babel/plugin-proposal-numeric-separator@^7.12.1": + version "7.12.5" + resolved "https://registry.npmjs.org/@babel/plugin-proposal-numeric-separator/-/plugin-proposal-numeric-separator-7.12.5.tgz#b1ce757156d40ed79d59d467cb2b154a5c4149ba" + integrity sha512-UiAnkKuOrCyjZ3sYNHlRlfuZJbBHknMQ9VMwVeX97Ofwx7RpD6gS2HfqTCh8KNUQgcOm8IKt103oR4KIjh7Q8g== dependencies: "@babel/helper-plugin-utils" "^7.10.4" "@babel/plugin-syntax-numeric-separator" "^7.10.4" -"@babel/plugin-proposal-object-rest-spread@^7.11.0": - version "7.11.0" - resolved "https://registry.npmjs.org/@babel/plugin-proposal-object-rest-spread/-/plugin-proposal-object-rest-spread-7.11.0.tgz#bd81f95a1f746760ea43b6c2d3d62b11790ad0af" - integrity sha512-wzch41N4yztwoRw0ak+37wxwJM2oiIiy6huGCoqkvSTA9acYWcPfn9Y4aJqmFFJ70KTJUu29f3DQ43uJ9HXzEA== +"@babel/plugin-proposal-object-rest-spread@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-proposal-object-rest-spread/-/plugin-proposal-object-rest-spread-7.12.1.tgz#def9bd03cea0f9b72283dac0ec22d289c7691069" + integrity sha512-s6SowJIjzlhx8o7lsFx5zmY4At6CTtDvgNQDdPzkBQucle58A6b/TTeEBYtyDgmcXjUTM+vE8YOGHZzzbc/ioA== dependencies: "@babel/helper-plugin-utils" "^7.10.4" "@babel/plugin-syntax-object-rest-spread" "^7.8.0" - "@babel/plugin-transform-parameters" "^7.10.4" + "@babel/plugin-transform-parameters" "^7.12.1" -"@babel/plugin-proposal-optional-catch-binding@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-proposal-optional-catch-binding/-/plugin-proposal-optional-catch-binding-7.10.4.tgz#31c938309d24a78a49d68fdabffaa863758554dd" - integrity sha512-LflT6nPh+GK2MnFiKDyLiqSqVHkQnVf7hdoAvyTnnKj9xB3docGRsdPuxp6qqqW19ifK3xgc9U5/FwrSaCNX5g== +"@babel/plugin-proposal-optional-catch-binding@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-proposal-optional-catch-binding/-/plugin-proposal-optional-catch-binding-7.12.1.tgz#ccc2421af64d3aae50b558a71cede929a5ab2942" + integrity sha512-hFvIjgprh9mMw5v42sJWLI1lzU5L2sznP805zeT6rySVRA0Y18StRhDqhSxlap0oVgItRsB6WSROp4YnJTJz0g== dependencies: "@babel/helper-plugin-utils" "^7.10.4" "@babel/plugin-syntax-optional-catch-binding" "^7.8.0" -"@babel/plugin-proposal-optional-chaining@^7.11.0": - version "7.11.0" - resolved "https://registry.npmjs.org/@babel/plugin-proposal-optional-chaining/-/plugin-proposal-optional-chaining-7.11.0.tgz#de5866d0646f6afdaab8a566382fe3a221755076" - integrity sha512-v9fZIu3Y8562RRwhm1BbMRxtqZNFmFA2EG+pT2diuU8PT3H6T/KXoZ54KgYisfOFZHV6PfvAiBIZ9Rcz+/JCxA== +"@babel/plugin-proposal-optional-chaining@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-proposal-optional-chaining/-/plugin-proposal-optional-chaining-7.12.1.tgz#cce122203fc8a32794296fc377c6dedaf4363797" + integrity sha512-c2uRpY6WzaVDzynVY9liyykS+kVU+WRZPMPYpkelXH8KBt1oXoI89kPbZKKG/jDT5UK92FTW2fZkZaJhdiBabw== dependencies: "@babel/helper-plugin-utils" "^7.10.4" - "@babel/helper-skip-transparent-expression-wrappers" "^7.11.0" + "@babel/helper-skip-transparent-expression-wrappers" "^7.12.1" "@babel/plugin-syntax-optional-chaining" "^7.8.0" -"@babel/plugin-proposal-private-methods@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-proposal-private-methods/-/plugin-proposal-private-methods-7.10.4.tgz#b160d972b8fdba5c7d111a145fc8c421fc2a6909" - integrity sha512-wh5GJleuI8k3emgTg5KkJK6kHNsGEr0uBTDBuQUBJwckk9xs1ez79ioheEVVxMLyPscB0LfkbVHslQqIzWV6Bw== +"@babel/plugin-proposal-private-methods@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-proposal-private-methods/-/plugin-proposal-private-methods-7.12.1.tgz#86814f6e7a21374c980c10d38b4493e703f4a389" + integrity sha512-mwZ1phvH7/NHK6Kf8LP7MYDogGV+DKB1mryFOEwx5EBNQrosvIczzZFTUmWaeujd5xT6G1ELYWUz3CutMhjE1w== + dependencies: + "@babel/helper-create-class-features-plugin" "^7.12.1" + "@babel/helper-plugin-utils" "^7.10.4" + +"@babel/plugin-proposal-unicode-property-regex@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-proposal-unicode-property-regex/-/plugin-proposal-unicode-property-regex-7.12.1.tgz#2a183958d417765b9eae334f47758e5d6a82e072" + integrity sha512-MYq+l+PvHuw/rKUz1at/vb6nCnQ2gmJBNaM62z0OgH7B2W1D9pvkpYtlti9bGtizNIU1K3zm4bZF9F91efVY0w== dependencies: - "@babel/helper-create-class-features-plugin" "^7.10.4" + "@babel/helper-create-regexp-features-plugin" "^7.12.1" "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-proposal-unicode-property-regex@^7.10.4", "@babel/plugin-proposal-unicode-property-regex@^7.4.4": +"@babel/plugin-proposal-unicode-property-regex@^7.4.4": version "7.10.4" resolved "https://registry.npmjs.org/@babel/plugin-proposal-unicode-property-regex/-/plugin-proposal-unicode-property-regex-7.10.4.tgz#4483cda53041ce3413b7fe2f00022665ddfaa75d" integrity sha512-H+3fOgPnEXFL9zGYtKQe4IDOPKYlZdF1kqFDQRRb8PK4B8af1vAGK04tF5iQAAsui+mHNBQSAtd2/ndEDe9wuA== @@ -444,10 +504,10 @@ dependencies: "@babel/helper-plugin-utils" "^7.8.0" -"@babel/plugin-syntax-class-properties@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-syntax-class-properties/-/plugin-syntax-class-properties-7.10.4.tgz#6644e6a0baa55a61f9e3231f6c9eeb6ee46c124c" - integrity sha512-GCSBF7iUle6rNugfURwNmCGG3Z/2+opxAMLs1nND4bhEG5PuxTIggDBoeYYSujAlLtsupzOHYJQgPS3pivwXIA== +"@babel/plugin-syntax-class-properties@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-syntax-class-properties/-/plugin-syntax-class-properties-7.12.1.tgz#bcb297c5366e79bebadef509549cd93b04f19978" + integrity sha512-U40A76x5gTwmESz+qiqssqmeEsKvcSyvtgktrm0uzcARAmM9I1jR221f6Oq+GmHrcD+LvZDag1UTOTe2fL3TeA== dependencies: "@babel/helper-plugin-utils" "^7.10.4" @@ -514,72 +574,80 @@ dependencies: "@babel/helper-plugin-utils" "^7.8.0" -"@babel/plugin-syntax-top-level-await@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-syntax-top-level-await/-/plugin-syntax-top-level-await-7.10.4.tgz#4bbeb8917b54fcf768364e0a81f560e33a3ef57d" - integrity sha512-ni1brg4lXEmWyafKr0ccFWkJG0CeMt4WV1oyeBW6EFObF4oOHclbkj5cARxAPQyAQ2UTuplJyK4nfkXIMMFvsQ== +"@babel/plugin-syntax-top-level-await@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-syntax-top-level-await/-/plugin-syntax-top-level-await-7.12.1.tgz#dd6c0b357ac1bb142d98537450a319625d13d2a0" + integrity sha512-i7ooMZFS+a/Om0crxZodrTzNEPJHZrlMVGMTEpFAj6rYY/bKCddB0Dk/YxfPuYXOopuhKk/e1jV6h+WUU9XN3A== dependencies: "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-arrow-functions@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.10.4.tgz#e22960d77e697c74f41c501d44d73dbf8a6a64cd" - integrity sha512-9J/oD1jV0ZCBcgnoFWFq1vJd4msoKb/TCpGNFyyLt0zABdcvgK3aYikZ8HjzB14c26bc7E3Q1yugpwGy2aTPNA== +"@babel/plugin-transform-arrow-functions@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.12.1.tgz#8083ffc86ac8e777fbe24b5967c4b2521f3cb2b3" + integrity sha512-5QB50qyN44fzzz4/qxDPQMBCTHgxg3n0xRBLJUmBlLoU/sFvxVWGZF/ZUfMVDQuJUKXaBhbupxIzIfZ6Fwk/0A== dependencies: "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-async-to-generator@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-async-to-generator/-/plugin-transform-async-to-generator-7.10.4.tgz#41a5017e49eb6f3cda9392a51eef29405b245a37" - integrity sha512-F6nREOan7J5UXTLsDsZG3DXmZSVofr2tGNwfdrVwkDWHfQckbQXnXSPfD7iO+c/2HGqycwyLST3DnZ16n+cBJQ== +"@babel/plugin-transform-async-to-generator@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-async-to-generator/-/plugin-transform-async-to-generator-7.12.1.tgz#3849a49cc2a22e9743cbd6b52926d30337229af1" + integrity sha512-SDtqoEcarK1DFlRJ1hHRY5HvJUj5kX4qmtpMAm2QnhOlyuMC4TMdCRgW6WXpv93rZeYNeLP22y8Aq2dbcDRM1A== dependencies: - "@babel/helper-module-imports" "^7.10.4" + "@babel/helper-module-imports" "^7.12.1" "@babel/helper-plugin-utils" "^7.10.4" - "@babel/helper-remap-async-to-generator" "^7.10.4" + "@babel/helper-remap-async-to-generator" "^7.12.1" -"@babel/plugin-transform-block-scoped-functions@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-block-scoped-functions/-/plugin-transform-block-scoped-functions-7.10.4.tgz#1afa595744f75e43a91af73b0d998ecfe4ebc2e8" - integrity sha512-WzXDarQXYYfjaV1szJvN3AD7rZgZzC1JtjJZ8dMHUyiK8mxPRahynp14zzNjU3VkPqPsO38CzxiWO1c9ARZ8JA== +"@babel/plugin-transform-block-scoped-functions@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-block-scoped-functions/-/plugin-transform-block-scoped-functions-7.12.1.tgz#f2a1a365bde2b7112e0a6ded9067fdd7c07905d9" + integrity sha512-5OpxfuYnSgPalRpo8EWGPzIYf0lHBWORCkj5M0oLBwHdlux9Ri36QqGW3/LR13RSVOAoUUMzoPI/jpE4ABcHoA== dependencies: "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-block-scoping@^7.10.4": - version "7.11.1" - resolved "https://registry.npmjs.org/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.11.1.tgz#5b7efe98852bef8d652c0b28144cd93a9e4b5215" - integrity sha512-00dYeDE0EVEHuuM+26+0w/SCL0BH2Qy7LwHuI4Hi4MH5gkC8/AqMN5uWFJIsoXZrAphiMm1iXzBw6L2T+eA0ew== +"@babel/plugin-transform-block-scoping@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.12.1.tgz#f0ee727874b42a208a48a586b84c3d222c2bbef1" + integrity sha512-zJyAC9sZdE60r1nVQHblcfCj29Dh2Y0DOvlMkcqSo0ckqjiCwNiUezUKw+RjOCwGfpLRwnAeQ2XlLpsnGkvv9w== dependencies: "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-classes@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-classes/-/plugin-transform-classes-7.10.4.tgz#405136af2b3e218bc4a1926228bc917ab1a0adc7" - integrity sha512-2oZ9qLjt161dn1ZE0Ms66xBncQH4In8Sqw1YWgBUZuGVJJS5c0OFZXL6dP2MRHrkU/eKhWg8CzFJhRQl50rQxA== +"@babel/plugin-transform-classes@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-classes/-/plugin-transform-classes-7.12.1.tgz#65e650fcaddd3d88ddce67c0f834a3d436a32db6" + integrity sha512-/74xkA7bVdzQTBeSUhLLJgYIcxw/dpEpCdRDiHgPJ3Mv6uC11UhjpOhl72CgqbBCmt1qtssCyB2xnJm1+PFjog== dependencies: "@babel/helper-annotate-as-pure" "^7.10.4" "@babel/helper-define-map" "^7.10.4" "@babel/helper-function-name" "^7.10.4" "@babel/helper-optimise-call-expression" "^7.10.4" "@babel/helper-plugin-utils" "^7.10.4" - "@babel/helper-replace-supers" "^7.10.4" + "@babel/helper-replace-supers" "^7.12.1" "@babel/helper-split-export-declaration" "^7.10.4" globals "^11.1.0" -"@babel/plugin-transform-computed-properties@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-computed-properties/-/plugin-transform-computed-properties-7.10.4.tgz#9ded83a816e82ded28d52d4b4ecbdd810cdfc0eb" - integrity sha512-JFwVDXcP/hM/TbyzGq3l/XWGut7p46Z3QvqFMXTfk6/09m7xZHJUN9xHfsv7vqqD4YnfI5ueYdSJtXqqBLyjBw== +"@babel/plugin-transform-computed-properties@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-computed-properties/-/plugin-transform-computed-properties-7.12.1.tgz#d68cf6c9b7f838a8a4144badbe97541ea0904852" + integrity sha512-vVUOYpPWB7BkgUWPo4C44mUQHpTZXakEqFjbv8rQMg7TC6S6ZhGZ3otQcRH6u7+adSlE5i0sp63eMC/XGffrzg== dependencies: "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-destructuring@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.10.4.tgz#70ddd2b3d1bea83d01509e9bb25ddb3a74fc85e5" - integrity sha512-+WmfvyfsyF603iPa6825mq6Qrb7uLjTOsa3XOFzlYcYDHSS4QmpOWOL0NNBY5qMbvrcf3tq0Cw+v4lxswOBpgA== +"@babel/plugin-transform-destructuring@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.12.1.tgz#b9a570fe0d0a8d460116413cb4f97e8e08b2f847" + integrity sha512-fRMYFKuzi/rSiYb2uRLiUENJOKq4Gnl+6qOv5f8z0TZXg3llUwUhsNNwrwaT/6dUhJTzNpBr+CUvEWBtfNY1cw== + dependencies: + "@babel/helper-plugin-utils" "^7.10.4" + +"@babel/plugin-transform-dotall-regex@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-dotall-regex/-/plugin-transform-dotall-regex-7.12.1.tgz#a1d16c14862817b6409c0a678d6f9373ca9cd975" + integrity sha512-B2pXeRKoLszfEW7J4Hg9LoFaWEbr/kzo3teWHmtFCszjRNa/b40f9mfeqZsIDLLt/FjwQ6pz/Gdlwy85xNckBA== dependencies: + "@babel/helper-create-regexp-features-plugin" "^7.12.1" "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-dotall-regex@^7.10.4", "@babel/plugin-transform-dotall-regex@^7.4.4": +"@babel/plugin-transform-dotall-regex@^7.4.4": version "7.10.4" resolved "https://registry.npmjs.org/@babel/plugin-transform-dotall-regex/-/plugin-transform-dotall-regex-7.10.4.tgz#469c2062105c1eb6a040eaf4fac4b488078395ee" integrity sha512-ZEAVvUTCMlMFAbASYSVQoxIbHm2OkG2MseW6bV2JjIygOjdVv8tuxrCTzj1+Rynh7ODb8GivUy7dzEXzEhuPaA== @@ -587,60 +655,60 @@ "@babel/helper-create-regexp-features-plugin" "^7.10.4" "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-duplicate-keys@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-duplicate-keys/-/plugin-transform-duplicate-keys-7.10.4.tgz#697e50c9fee14380fe843d1f306b295617431e47" - integrity sha512-GL0/fJnmgMclHiBTTWXNlYjYsA7rDrtsazHG6mglaGSTh0KsrW04qml+Bbz9FL0LcJIRwBWL5ZqlNHKTkU3xAA== +"@babel/plugin-transform-duplicate-keys@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-duplicate-keys/-/plugin-transform-duplicate-keys-7.12.1.tgz#745661baba295ac06e686822797a69fbaa2ca228" + integrity sha512-iRght0T0HztAb/CazveUpUQrZY+aGKKaWXMJ4uf9YJtqxSUe09j3wteztCUDRHs+SRAL7yMuFqUsLoAKKzgXjw== dependencies: "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-exponentiation-operator@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-exponentiation-operator/-/plugin-transform-exponentiation-operator-7.10.4.tgz#5ae338c57f8cf4001bdb35607ae66b92d665af2e" - integrity sha512-S5HgLVgkBcRdyQAHbKj+7KyuWx8C6t5oETmUuwz1pt3WTWJhsUV0WIIXuVvfXMxl/QQyHKlSCNNtaIamG8fysw== +"@babel/plugin-transform-exponentiation-operator@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-exponentiation-operator/-/plugin-transform-exponentiation-operator-7.12.1.tgz#b0f2ed356ba1be1428ecaf128ff8a24f02830ae0" + integrity sha512-7tqwy2bv48q+c1EHbXK0Zx3KXd2RVQp6OC7PbwFNt/dPTAV3Lu5sWtWuAj8owr5wqtWnqHfl2/mJlUmqkChKug== dependencies: "@babel/helper-builder-binary-assignment-operator-visitor" "^7.10.4" "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-for-of@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-for-of/-/plugin-transform-for-of-7.10.4.tgz#c08892e8819d3a5db29031b115af511dbbfebae9" - integrity sha512-ItdQfAzu9AlEqmusA/65TqJ79eRcgGmpPPFvBnGILXZH975G0LNjP1yjHvGgfuCxqrPPueXOPe+FsvxmxKiHHQ== +"@babel/plugin-transform-for-of@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-for-of/-/plugin-transform-for-of-7.12.1.tgz#07640f28867ed16f9511c99c888291f560921cfa" + integrity sha512-Zaeq10naAsuHo7heQvyV0ptj4dlZJwZgNAtBYBnu5nNKJoW62m0zKcIEyVECrUKErkUkg6ajMy4ZfnVZciSBhg== dependencies: "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-function-name@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-function-name/-/plugin-transform-function-name-7.10.4.tgz#6a467880e0fc9638514ba369111811ddbe2644b7" - integrity sha512-OcDCq2y5+E0dVD5MagT5X+yTRbcvFjDI2ZVAottGH6tzqjx/LKpgkUepu3hp/u4tZBzxxpNGwLsAvGBvQ2mJzg== +"@babel/plugin-transform-function-name@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-function-name/-/plugin-transform-function-name-7.12.1.tgz#2ec76258c70fe08c6d7da154003a480620eba667" + integrity sha512-JF3UgJUILoFrFMEnOJLJkRHSk6LUSXLmEFsA23aR2O5CSLUxbeUX1IZ1YQ7Sn0aXb601Ncwjx73a+FVqgcljVw== dependencies: "@babel/helper-function-name" "^7.10.4" "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-literals@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-literals/-/plugin-transform-literals-7.10.4.tgz#9f42ba0841100a135f22712d0e391c462f571f3c" - integrity sha512-Xd/dFSTEVuUWnyZiMu76/InZxLTYilOSr1UlHV+p115Z/Le2Fi1KXkJUYz0b42DfndostYlPub3m8ZTQlMaiqQ== +"@babel/plugin-transform-literals@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-literals/-/plugin-transform-literals-7.12.1.tgz#d73b803a26b37017ddf9d3bb8f4dc58bfb806f57" + integrity sha512-+PxVGA+2Ag6uGgL0A5f+9rklOnnMccwEBzwYFL3EUaKuiyVnUipyXncFcfjSkbimLrODoqki1U9XxZzTvfN7IQ== dependencies: "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-member-expression-literals@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-member-expression-literals/-/plugin-transform-member-expression-literals-7.10.4.tgz#b1ec44fcf195afcb8db2c62cd8e551c881baf8b7" - integrity sha512-0bFOvPyAoTBhtcJLr9VcwZqKmSjFml1iVxvPL0ReomGU53CX53HsM4h2SzckNdkQcHox1bpAqzxBI1Y09LlBSw== +"@babel/plugin-transform-member-expression-literals@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-member-expression-literals/-/plugin-transform-member-expression-literals-7.12.1.tgz#496038602daf1514a64d43d8e17cbb2755e0c3ad" + integrity sha512-1sxePl6z9ad0gFMB9KqmYofk34flq62aqMt9NqliS/7hPEpURUCMbyHXrMPlo282iY7nAvUB1aQd5mg79UD9Jg== dependencies: "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-modules-amd@^7.10.4": - version "7.10.5" - resolved "https://registry.npmjs.org/@babel/plugin-transform-modules-amd/-/plugin-transform-modules-amd-7.10.5.tgz#1b9cddaf05d9e88b3aad339cb3e445c4f020a9b1" - integrity sha512-elm5uruNio7CTLFItVC/rIzKLfQ17+fX7EVz5W0TMgIHFo1zY0Ozzx+lgwhL4plzl8OzVn6Qasx5DeEFyoNiRw== +"@babel/plugin-transform-modules-amd@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-modules-amd/-/plugin-transform-modules-amd-7.12.1.tgz#3154300b026185666eebb0c0ed7f8415fefcf6f9" + integrity sha512-tDW8hMkzad5oDtzsB70HIQQRBiTKrhfgwC/KkJeGsaNFTdWhKNt/BiE8c5yj19XiGyrxpbkOfH87qkNg1YGlOQ== dependencies: - "@babel/helper-module-transforms" "^7.10.5" + "@babel/helper-module-transforms" "^7.12.1" "@babel/helper-plugin-utils" "^7.10.4" babel-plugin-dynamic-import-node "^2.3.3" -"@babel/plugin-transform-modules-commonjs@7.12.1": +"@babel/plugin-transform-modules-commonjs@7.12.1", "@babel/plugin-transform-modules-commonjs@^7.12.1": version "7.12.1" resolved "https://registry.npmjs.org/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.12.1.tgz#fa403124542636c786cf9b460a0ffbb48a86e648" integrity sha512-dY789wq6l0uLY8py9c1B48V8mVL5gZh/+PQ5ZPrylPYsnAvnEMjqsUXkuoDVPeVK+0VyGar+D08107LzDQ6pag== @@ -650,162 +718,152 @@ "@babel/helper-simple-access" "^7.12.1" babel-plugin-dynamic-import-node "^2.3.3" -"@babel/plugin-transform-modules-commonjs@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.10.4.tgz#66667c3eeda1ebf7896d41f1f16b17105a2fbca0" - integrity sha512-Xj7Uq5o80HDLlW64rVfDBhao6OX89HKUmb+9vWYaLXBZOma4gA6tw4Ni1O5qVDoZWUV0fxMYA0aYzOawz0l+1w== - dependencies: - "@babel/helper-module-transforms" "^7.10.4" - "@babel/helper-plugin-utils" "^7.10.4" - "@babel/helper-simple-access" "^7.10.4" - babel-plugin-dynamic-import-node "^2.3.3" - -"@babel/plugin-transform-modules-systemjs@^7.10.4": - version "7.10.5" - resolved "https://registry.npmjs.org/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.10.5.tgz#6270099c854066681bae9e05f87e1b9cadbe8c85" - integrity sha512-f4RLO/OL14/FP1AEbcsWMzpbUz6tssRaeQg11RH1BP/XnPpRoVwgeYViMFacnkaw4k4wjRSjn3ip1Uw9TaXuMw== +"@babel/plugin-transform-modules-systemjs@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.12.1.tgz#663fea620d593c93f214a464cd399bf6dc683086" + integrity sha512-Hn7cVvOavVh8yvW6fLwveFqSnd7rbQN3zJvoPNyNaQSvgfKmDBO9U1YL9+PCXGRlZD9tNdWTy5ACKqMuzyn32Q== dependencies: "@babel/helper-hoist-variables" "^7.10.4" - "@babel/helper-module-transforms" "^7.10.5" + "@babel/helper-module-transforms" "^7.12.1" "@babel/helper-plugin-utils" "^7.10.4" + "@babel/helper-validator-identifier" "^7.10.4" babel-plugin-dynamic-import-node "^2.3.3" -"@babel/plugin-transform-modules-umd@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-modules-umd/-/plugin-transform-modules-umd-7.10.4.tgz#9a8481fe81b824654b3a0b65da3df89f3d21839e" - integrity sha512-mohW5q3uAEt8T45YT7Qc5ws6mWgJAaL/8BfWD9Dodo1A3RKWli8wTS+WiQ/knF+tXlPirW/1/MqzzGfCExKECA== +"@babel/plugin-transform-modules-umd@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-modules-umd/-/plugin-transform-modules-umd-7.12.1.tgz#eb5a218d6b1c68f3d6217b8fa2cc82fec6547902" + integrity sha512-aEIubCS0KHKM0zUos5fIoQm+AZUMt1ZvMpqz0/H5qAQ7vWylr9+PLYurT+Ic7ID/bKLd4q8hDovaG3Zch2uz5Q== dependencies: - "@babel/helper-module-transforms" "^7.10.4" + "@babel/helper-module-transforms" "^7.12.1" "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-named-capturing-groups-regex@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.10.4.tgz#78b4d978810b6f3bcf03f9e318f2fc0ed41aecb6" - integrity sha512-V6LuOnD31kTkxQPhKiVYzYC/Jgdq53irJC/xBSmqcNcqFGV+PER4l6rU5SH2Vl7bH9mLDHcc0+l9HUOe4RNGKA== +"@babel/plugin-transform-named-capturing-groups-regex@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.12.1.tgz#b407f5c96be0d9f5f88467497fa82b30ac3e8753" + integrity sha512-tB43uQ62RHcoDp9v2Nsf+dSM8sbNodbEicbQNA53zHz8pWUhsgHSJCGpt7daXxRydjb0KnfmB+ChXOv3oADp1Q== dependencies: - "@babel/helper-create-regexp-features-plugin" "^7.10.4" + "@babel/helper-create-regexp-features-plugin" "^7.12.1" -"@babel/plugin-transform-new-target@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-new-target/-/plugin-transform-new-target-7.10.4.tgz#9097d753cb7b024cb7381a3b2e52e9513a9c6888" - integrity sha512-YXwWUDAH/J6dlfwqlWsztI2Puz1NtUAubXhOPLQ5gjR/qmQ5U96DY4FQO8At33JN4XPBhrjB8I4eMmLROjjLjw== +"@babel/plugin-transform-new-target@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-new-target/-/plugin-transform-new-target-7.12.1.tgz#80073f02ee1bb2d365c3416490e085c95759dec0" + integrity sha512-+eW/VLcUL5L9IvJH7rT1sT0CzkdUTvPrXC2PXTn/7z7tXLBuKvezYbGdxD5WMRoyvyaujOq2fWoKl869heKjhw== dependencies: "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-object-super@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-object-super/-/plugin-transform-object-super-7.10.4.tgz#d7146c4d139433e7a6526f888c667e314a093894" - integrity sha512-5iTw0JkdRdJvr7sY0vHqTpnruUpTea32JHmq/atIWqsnNussbRzjEDyWep8UNztt1B5IusBYg8Irb0bLbiEBCQ== +"@babel/plugin-transform-object-super@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-object-super/-/plugin-transform-object-super-7.12.1.tgz#4ea08696b8d2e65841d0c7706482b048bed1066e" + integrity sha512-AvypiGJH9hsquNUn+RXVcBdeE3KHPZexWRdimhuV59cSoOt5kFBmqlByorAeUlGG2CJWd0U+4ZtNKga/TB0cAw== dependencies: "@babel/helper-plugin-utils" "^7.10.4" - "@babel/helper-replace-supers" "^7.10.4" + "@babel/helper-replace-supers" "^7.12.1" -"@babel/plugin-transform-parameters@^7.10.4": - version "7.10.5" - resolved "https://registry.npmjs.org/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.10.5.tgz#59d339d58d0b1950435f4043e74e2510005e2c4a" - integrity sha512-xPHwUj5RdFV8l1wuYiu5S9fqWGM2DrYc24TMvUiRrPVm+SM3XeqU9BcokQX/kEUe+p2RBwy+yoiR1w/Blq6ubw== +"@babel/plugin-transform-parameters@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.12.1.tgz#d2e963b038771650c922eff593799c96d853255d" + integrity sha512-xq9C5EQhdPK23ZeCdMxl8bbRnAgHFrw5EOC3KJUsSylZqdkCaFEXxGSBuTSObOpiiHHNyb82es8M1QYgfQGfNg== dependencies: - "@babel/helper-get-function-arity" "^7.10.4" "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-property-literals@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-property-literals/-/plugin-transform-property-literals-7.10.4.tgz#f6fe54b6590352298785b83edd815d214c42e3c0" - integrity sha512-ofsAcKiUxQ8TY4sScgsGeR2vJIsfrzqvFb9GvJ5UdXDzl+MyYCaBj/FGzXuv7qE0aJcjWMILny1epqelnFlz8g== +"@babel/plugin-transform-property-literals@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-property-literals/-/plugin-transform-property-literals-7.12.1.tgz#41bc81200d730abb4456ab8b3fbd5537b59adecd" + integrity sha512-6MTCR/mZ1MQS+AwZLplX4cEySjCpnIF26ToWo942nqn8hXSm7McaHQNeGx/pt7suI1TWOWMfa/NgBhiqSnX0cQ== dependencies: "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-regenerator@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.10.4.tgz#2015e59d839074e76838de2159db421966fd8b63" - integrity sha512-3thAHwtor39A7C04XucbMg17RcZ3Qppfxr22wYzZNcVIkPHfpM9J0SO8zuCV6SZa265kxBJSrfKTvDCYqBFXGw== +"@babel/plugin-transform-regenerator@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.12.1.tgz#5f0a28d842f6462281f06a964e88ba8d7ab49753" + integrity sha512-gYrHqs5itw6i4PflFX3OdBPMQdPbF4bj2REIUxlMRUFk0/ZOAIpDFuViuxPjUL7YC8UPnf+XG7/utJvqXdPKng== dependencies: regenerator-transform "^0.14.2" -"@babel/plugin-transform-reserved-words@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-reserved-words/-/plugin-transform-reserved-words-7.10.4.tgz#8f2682bcdcef9ed327e1b0861585d7013f8a54dd" - integrity sha512-hGsw1O6Rew1fkFbDImZIEqA8GoidwTAilwCyWqLBM9f+e/u/sQMQu7uX6dyokfOayRuuVfKOW4O7HvaBWM+JlQ== +"@babel/plugin-transform-reserved-words@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-reserved-words/-/plugin-transform-reserved-words-7.12.1.tgz#6fdfc8cc7edcc42b36a7c12188c6787c873adcd8" + integrity sha512-pOnUfhyPKvZpVyBHhSBoX8vfA09b7r00Pmm1sH+29ae2hMTKVmSp4Ztsr8KBKjLjx17H0eJqaRC3bR2iThM54A== dependencies: "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-shorthand-properties@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-shorthand-properties/-/plugin-transform-shorthand-properties-7.10.4.tgz#9fd25ec5cdd555bb7f473e5e6ee1c971eede4dd6" - integrity sha512-AC2K/t7o07KeTIxMoHneyX90v3zkm5cjHJEokrPEAGEy3UCp8sLKfnfOIGdZ194fyN4wfX/zZUWT9trJZ0qc+Q== +"@babel/plugin-transform-shorthand-properties@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-shorthand-properties/-/plugin-transform-shorthand-properties-7.12.1.tgz#0bf9cac5550fce0cfdf043420f661d645fdc75e3" + integrity sha512-GFZS3c/MhX1OusqB1MZ1ct2xRzX5ppQh2JU1h2Pnfk88HtFTM+TWQqJNfwkmxtPQtb/s1tk87oENfXJlx7rSDw== dependencies: "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-spread@^7.11.0": - version "7.11.0" - resolved "https://registry.npmjs.org/@babel/plugin-transform-spread/-/plugin-transform-spread-7.11.0.tgz#fa84d300f5e4f57752fe41a6d1b3c554f13f17cc" - integrity sha512-UwQYGOqIdQJe4aWNyS7noqAnN2VbaczPLiEtln+zPowRNlD+79w3oi2TWfYe0eZgd+gjZCbsydN7lzWysDt+gw== +"@babel/plugin-transform-spread@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-spread/-/plugin-transform-spread-7.12.1.tgz#527f9f311be4ec7fdc2b79bb89f7bf884b3e1e1e" + integrity sha512-vuLp8CP0BE18zVYjsEBZ5xoCecMK6LBMMxYzJnh01rxQRvhNhH1csMMmBfNo5tGpGO+NhdSNW2mzIvBu3K1fng== dependencies: "@babel/helper-plugin-utils" "^7.10.4" - "@babel/helper-skip-transparent-expression-wrappers" "^7.11.0" + "@babel/helper-skip-transparent-expression-wrappers" "^7.12.1" -"@babel/plugin-transform-sticky-regex@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-sticky-regex/-/plugin-transform-sticky-regex-7.10.4.tgz#8f3889ee8657581130a29d9cc91d7c73b7c4a28d" - integrity sha512-Ddy3QZfIbEV0VYcVtFDCjeE4xwVTJWTmUtorAJkn6u/92Z/nWJNV+mILyqHKrUxXYKA2EoCilgoPePymKL4DvQ== +"@babel/plugin-transform-sticky-regex@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-sticky-regex/-/plugin-transform-sticky-regex-7.12.1.tgz#5c24cf50de396d30e99afc8d1c700e8bce0f5caf" + integrity sha512-CiUgKQ3AGVk7kveIaPEET1jNDhZZEl1RPMWdTBE1799bdz++SwqDHStmxfCtDfBhQgCl38YRiSnrMuUMZIWSUQ== dependencies: "@babel/helper-plugin-utils" "^7.10.4" "@babel/helper-regex" "^7.10.4" -"@babel/plugin-transform-template-literals@^7.10.4": - version "7.10.5" - resolved "https://registry.npmjs.org/@babel/plugin-transform-template-literals/-/plugin-transform-template-literals-7.10.5.tgz#78bc5d626a6642db3312d9d0f001f5e7639fde8c" - integrity sha512-V/lnPGIb+KT12OQikDvgSuesRX14ck5FfJXt6+tXhdkJ+Vsd0lDCVtF6jcB4rNClYFzaB2jusZ+lNISDk2mMMw== +"@babel/plugin-transform-template-literals@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-template-literals/-/plugin-transform-template-literals-7.12.1.tgz#b43ece6ed9a79c0c71119f576d299ef09d942843" + integrity sha512-b4Zx3KHi+taXB1dVRBhVJtEPi9h1THCeKmae2qP0YdUHIFhVjtpqqNfxeVAa1xeHVhAy4SbHxEwx5cltAu5apw== dependencies: - "@babel/helper-annotate-as-pure" "^7.10.4" "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-typeof-symbol@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-typeof-symbol/-/plugin-transform-typeof-symbol-7.10.4.tgz#9509f1a7eec31c4edbffe137c16cc33ff0bc5bfc" - integrity sha512-QqNgYwuuW0y0H+kUE/GWSR45t/ccRhe14Fs/4ZRouNNQsyd4o3PG4OtHiIrepbM2WKUBDAXKCAK/Lk4VhzTaGA== +"@babel/plugin-transform-typeof-symbol@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-typeof-symbol/-/plugin-transform-typeof-symbol-7.12.1.tgz#9ca6be343d42512fbc2e68236a82ae64bc7af78a" + integrity sha512-EPGgpGy+O5Kg5pJFNDKuxt9RdmTgj5sgrus2XVeMp/ZIbOESadgILUbm50SNpghOh3/6yrbsH+NB5+WJTmsA7Q== dependencies: "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-unicode-escapes@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-unicode-escapes/-/plugin-transform-unicode-escapes-7.10.4.tgz#feae523391c7651ddac115dae0a9d06857892007" - integrity sha512-y5XJ9waMti2J+e7ij20e+aH+fho7Wb7W8rNuu72aKRwCHFqQdhkdU2lo3uZ9tQuboEJcUFayXdARhcxLQ3+6Fg== +"@babel/plugin-transform-unicode-escapes@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-unicode-escapes/-/plugin-transform-unicode-escapes-7.12.1.tgz#5232b9f81ccb07070b7c3c36c67a1b78f1845709" + integrity sha512-I8gNHJLIc7GdApm7wkVnStWssPNbSRMPtgHdmH3sRM1zopz09UWPS4x5V4n1yz/MIWTVnJ9sp6IkuXdWM4w+2Q== dependencies: "@babel/helper-plugin-utils" "^7.10.4" -"@babel/plugin-transform-unicode-regex@^7.10.4": - version "7.10.4" - resolved "https://registry.npmjs.org/@babel/plugin-transform-unicode-regex/-/plugin-transform-unicode-regex-7.10.4.tgz#e56d71f9282fac6db09c82742055576d5e6d80a8" - integrity sha512-wNfsc4s8N2qnIwpO/WP2ZiSyjfpTamT2C9V9FDH/Ljub9zw6P3SjkXcFmc0RQUt96k2fmIvtla2MMjgTwIAC+A== +"@babel/plugin-transform-unicode-regex@^7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/plugin-transform-unicode-regex/-/plugin-transform-unicode-regex-7.12.1.tgz#cc9661f61390db5c65e3febaccefd5c6ac3faecb" + integrity sha512-SqH4ClNngh/zGwHZOOQMTD+e8FGWexILV+ePMyiDJttAWRh5dhDL8rcl5lSgU3Huiq6Zn6pWTMvdPAb21Dwdyg== dependencies: - "@babel/helper-create-regexp-features-plugin" "^7.10.4" + "@babel/helper-create-regexp-features-plugin" "^7.12.1" "@babel/helper-plugin-utils" "^7.10.4" -"@babel/preset-env@7.11.5": - version "7.11.5" - resolved "https://registry.npmjs.org/@babel/preset-env/-/preset-env-7.11.5.tgz#18cb4b9379e3e92ffea92c07471a99a2914e4272" - integrity sha512-kXqmW1jVcnB2cdueV+fyBM8estd5mlNfaQi6lwLgRwCby4edpavgbFhiBNjmWA3JpB/yZGSISa7Srf+TwxDQoA== +"@babel/preset-env@7.12.1": + version "7.12.1" + resolved "https://registry.npmjs.org/@babel/preset-env/-/preset-env-7.12.1.tgz#9c7e5ca82a19efc865384bb4989148d2ee5d7ac2" + integrity sha512-H8kxXmtPaAGT7TyBvSSkoSTUK6RHh61So05SyEbpmr0MCZrsNYn7mGMzzeYoOUCdHzww61k8XBft2TaES+xPLg== dependencies: - "@babel/compat-data" "^7.11.0" - "@babel/helper-compilation-targets" "^7.10.4" - "@babel/helper-module-imports" "^7.10.4" + "@babel/compat-data" "^7.12.1" + "@babel/helper-compilation-targets" "^7.12.1" + "@babel/helper-module-imports" "^7.12.1" "@babel/helper-plugin-utils" "^7.10.4" - "@babel/plugin-proposal-async-generator-functions" "^7.10.4" - "@babel/plugin-proposal-class-properties" "^7.10.4" - "@babel/plugin-proposal-dynamic-import" "^7.10.4" - "@babel/plugin-proposal-export-namespace-from" "^7.10.4" - "@babel/plugin-proposal-json-strings" "^7.10.4" - "@babel/plugin-proposal-logical-assignment-operators" "^7.11.0" - "@babel/plugin-proposal-nullish-coalescing-operator" "^7.10.4" - "@babel/plugin-proposal-numeric-separator" "^7.10.4" - "@babel/plugin-proposal-object-rest-spread" "^7.11.0" - "@babel/plugin-proposal-optional-catch-binding" "^7.10.4" - "@babel/plugin-proposal-optional-chaining" "^7.11.0" - "@babel/plugin-proposal-private-methods" "^7.10.4" - "@babel/plugin-proposal-unicode-property-regex" "^7.10.4" + "@babel/helper-validator-option" "^7.12.1" + "@babel/plugin-proposal-async-generator-functions" "^7.12.1" + "@babel/plugin-proposal-class-properties" "^7.12.1" + "@babel/plugin-proposal-dynamic-import" "^7.12.1" + "@babel/plugin-proposal-export-namespace-from" "^7.12.1" + "@babel/plugin-proposal-json-strings" "^7.12.1" + "@babel/plugin-proposal-logical-assignment-operators" "^7.12.1" + "@babel/plugin-proposal-nullish-coalescing-operator" "^7.12.1" + "@babel/plugin-proposal-numeric-separator" "^7.12.1" + "@babel/plugin-proposal-object-rest-spread" "^7.12.1" + "@babel/plugin-proposal-optional-catch-binding" "^7.12.1" + "@babel/plugin-proposal-optional-chaining" "^7.12.1" + "@babel/plugin-proposal-private-methods" "^7.12.1" + "@babel/plugin-proposal-unicode-property-regex" "^7.12.1" "@babel/plugin-syntax-async-generators" "^7.8.0" - "@babel/plugin-syntax-class-properties" "^7.10.4" + "@babel/plugin-syntax-class-properties" "^7.12.1" "@babel/plugin-syntax-dynamic-import" "^7.8.0" "@babel/plugin-syntax-export-namespace-from" "^7.8.3" "@babel/plugin-syntax-json-strings" "^7.8.0" @@ -815,45 +873,42 @@ "@babel/plugin-syntax-object-rest-spread" "^7.8.0" "@babel/plugin-syntax-optional-catch-binding" "^7.8.0" "@babel/plugin-syntax-optional-chaining" "^7.8.0" - "@babel/plugin-syntax-top-level-await" "^7.10.4" - "@babel/plugin-transform-arrow-functions" "^7.10.4" - "@babel/plugin-transform-async-to-generator" "^7.10.4" - "@babel/plugin-transform-block-scoped-functions" "^7.10.4" - "@babel/plugin-transform-block-scoping" "^7.10.4" - "@babel/plugin-transform-classes" "^7.10.4" - "@babel/plugin-transform-computed-properties" "^7.10.4" - "@babel/plugin-transform-destructuring" "^7.10.4" - "@babel/plugin-transform-dotall-regex" "^7.10.4" - "@babel/plugin-transform-duplicate-keys" "^7.10.4" - "@babel/plugin-transform-exponentiation-operator" "^7.10.4" - "@babel/plugin-transform-for-of" "^7.10.4" - "@babel/plugin-transform-function-name" "^7.10.4" - "@babel/plugin-transform-literals" "^7.10.4" - "@babel/plugin-transform-member-expression-literals" "^7.10.4" - "@babel/plugin-transform-modules-amd" "^7.10.4" - "@babel/plugin-transform-modules-commonjs" "^7.10.4" - "@babel/plugin-transform-modules-systemjs" "^7.10.4" - "@babel/plugin-transform-modules-umd" "^7.10.4" - "@babel/plugin-transform-named-capturing-groups-regex" "^7.10.4" - "@babel/plugin-transform-new-target" "^7.10.4" - "@babel/plugin-transform-object-super" "^7.10.4" - "@babel/plugin-transform-parameters" "^7.10.4" - "@babel/plugin-transform-property-literals" "^7.10.4" - "@babel/plugin-transform-regenerator" "^7.10.4" - "@babel/plugin-transform-reserved-words" "^7.10.4" - "@babel/plugin-transform-shorthand-properties" "^7.10.4" - "@babel/plugin-transform-spread" "^7.11.0" - "@babel/plugin-transform-sticky-regex" "^7.10.4" - "@babel/plugin-transform-template-literals" "^7.10.4" - "@babel/plugin-transform-typeof-symbol" "^7.10.4" - "@babel/plugin-transform-unicode-escapes" "^7.10.4" - "@babel/plugin-transform-unicode-regex" "^7.10.4" + "@babel/plugin-syntax-top-level-await" "^7.12.1" + "@babel/plugin-transform-arrow-functions" "^7.12.1" + "@babel/plugin-transform-async-to-generator" "^7.12.1" + "@babel/plugin-transform-block-scoped-functions" "^7.12.1" + "@babel/plugin-transform-block-scoping" "^7.12.1" + "@babel/plugin-transform-classes" "^7.12.1" + "@babel/plugin-transform-computed-properties" "^7.12.1" + "@babel/plugin-transform-destructuring" "^7.12.1" + "@babel/plugin-transform-dotall-regex" "^7.12.1" + "@babel/plugin-transform-duplicate-keys" "^7.12.1" + "@babel/plugin-transform-exponentiation-operator" "^7.12.1" + "@babel/plugin-transform-for-of" "^7.12.1" + "@babel/plugin-transform-function-name" "^7.12.1" + "@babel/plugin-transform-literals" "^7.12.1" + "@babel/plugin-transform-member-expression-literals" "^7.12.1" + "@babel/plugin-transform-modules-amd" "^7.12.1" + "@babel/plugin-transform-modules-commonjs" "^7.12.1" + "@babel/plugin-transform-modules-systemjs" "^7.12.1" + "@babel/plugin-transform-modules-umd" "^7.12.1" + "@babel/plugin-transform-named-capturing-groups-regex" "^7.12.1" + "@babel/plugin-transform-new-target" "^7.12.1" + "@babel/plugin-transform-object-super" "^7.12.1" + "@babel/plugin-transform-parameters" "^7.12.1" + "@babel/plugin-transform-property-literals" "^7.12.1" + "@babel/plugin-transform-regenerator" "^7.12.1" + "@babel/plugin-transform-reserved-words" "^7.12.1" + "@babel/plugin-transform-shorthand-properties" "^7.12.1" + "@babel/plugin-transform-spread" "^7.12.1" + "@babel/plugin-transform-sticky-regex" "^7.12.1" + "@babel/plugin-transform-template-literals" "^7.12.1" + "@babel/plugin-transform-typeof-symbol" "^7.12.1" + "@babel/plugin-transform-unicode-escapes" "^7.12.1" + "@babel/plugin-transform-unicode-regex" "^7.12.1" "@babel/preset-modules" "^0.1.3" - "@babel/types" "^7.11.5" - browserslist "^4.12.0" + "@babel/types" "^7.12.1" core-js-compat "^3.6.2" - invariant "^2.2.2" - levenary "^1.1.1" semver "^5.5.0" "@babel/preset-modules@^0.1.3": @@ -913,6 +968,21 @@ globals "^11.1.0" lodash "^4.17.19" +"@babel/traverse@^7.12.5": + version "7.12.5" + resolved "https://registry.npmjs.org/@babel/traverse/-/traverse-7.12.5.tgz#78a0c68c8e8a35e4cacfd31db8bb303d5606f095" + integrity sha512-xa15FbQnias7z9a62LwYAA5SZZPkHIXpd42C6uW68o8uTuua96FHZy1y61Va5P/i83FAAcMpW8+A/QayntzuqA== + dependencies: + "@babel/code-frame" "^7.10.4" + "@babel/generator" "^7.12.5" + "@babel/helper-function-name" "^7.10.4" + "@babel/helper-split-export-declaration" "^7.11.0" + "@babel/parser" "^7.12.5" + "@babel/types" "^7.12.5" + debug "^4.1.0" + globals "^11.1.0" + lodash "^4.17.19" + "@babel/types@^7.10.4", "@babel/types@^7.10.5", "@babel/types@^7.11.0", "@babel/types@^7.11.5", "@babel/types@^7.4.0", "@babel/types@^7.4.4": version "7.11.5" resolved "https://registry.npmjs.org/@babel/types/-/types-7.11.5.tgz#d9de577d01252d77c6800cee039ee64faf75662d" @@ -931,6 +1001,15 @@ lodash "^4.17.19" to-fast-properties "^2.0.0" +"@babel/types@^7.12.5": + version "7.12.6" + resolved "https://registry.npmjs.org/@babel/types/-/types-7.12.6.tgz#ae0e55ef1cce1fbc881cd26f8234eb3e657edc96" + integrity sha512-hwyjw6GvjBLiyy3W0YQf0Z5Zf4NpYejUnKFcfcUhZCSffoBBp30w6wP2Wn6pk31jMYZvcOrB/1b7cGXvEoKogA== + dependencies: + "@babel/helper-validator-identifier" "^7.10.4" + lodash "^4.17.19" + to-fast-properties "^2.0.0" + "@changesets/apply-release-plan@^4.0.0": version "4.0.0" resolved "https://registry.npmjs.org/@changesets/apply-release-plan/-/apply-release-plan-4.0.0.tgz#e78efb56a4e459a8dab814ba43045f2ace0f27c9" @@ -970,10 +1049,10 @@ "@changesets/types" "^3.0.0" dotenv "^8.1.0" -"@changesets/cli@2.11.0": - version "2.11.0" - resolved "https://registry.npmjs.org/@changesets/cli/-/cli-2.11.0.tgz#048449289da95f24d96b187f3148c2955065d609" - integrity sha512-imsXWxl+QpLt6PYHSiuZS7xPdKrGs2c8saSG4ENzeZBgnTBMiJdxDloOT6Bmv15ICggHZj9mnaUBNOMPbvnlbA== +"@changesets/cli@2.11.2": + version "2.11.2" + resolved "https://registry.npmjs.org/@changesets/cli/-/cli-2.11.2.tgz#6c2d9470a9c89e7389db5ac80069a77072079413" + integrity sha512-Lfw4MWj46H7dgPzgYmRJ8QbpDxi02dK+21zuWzBjVtsf3AqJgy7oVdXl4Yga/JhBq8eeoxBS9NoCVw8/JOZBcg== dependencies: "@babel/runtime" "^7.10.4" "@changesets/apply-release-plan" "^4.0.0" @@ -997,14 +1076,14 @@ fs-extra "^7.0.1" human-id "^1.0.2" is-ci "^2.0.0" - meow "^5.0.0" + meow "^6.0.0" outdent "^0.5.0" p-limit "^2.2.0" preferred-pm "^3.0.0" semver "^5.4.1" spawndamnit "^2.0.0" term-size "^2.1.0" - tty-table "^2.7.0" + tty-table "^2.8.10" "@changesets/config@^1.2.0": version "1.3.0" @@ -1157,10 +1236,10 @@ enabled "2.0.x" kuler "^2.0.0" -"@eslint/eslintrc@^0.1.3": - version "0.1.3" - resolved "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-0.1.3.tgz#7d1a2b2358552cc04834c0979bd4275362e37085" - integrity sha512-4YVwPkANLeNtRjMekzux1ci8hIaH5eGKktGqR0d3LWsKNn5B2X/1Z6Trxy7jQXl9EBGE6Yj02O+t09FMeRllaA== +"@eslint/eslintrc@^0.2.1": + version "0.2.1" + resolved "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-0.2.1.tgz#f72069c330461a06684d119384435e12a5d76e3c" + integrity sha512-XRUeBZ5zBWLYgSANMpThFddrZZkEbGHgUdt5UJjZfnlN9BGCiUBrf+nvbRupSjMvqzwnQN0qwCmOxITt1cfywA== dependencies: ajv "^6.12.4" debug "^4.1.1" @@ -1297,7 +1376,16 @@ retry-request "^4.1.1" teeny-request "^7.0.0" -"@google-cloud/firestore@4.4.0", "@google-cloud/firestore@^4.0.0": +"@google-cloud/firestore@4.7.0": + version "4.7.0" + resolved "https://registry.npmjs.org/@google-cloud/firestore/-/firestore-4.7.0.tgz#8a176e41773b2a06320e1281d93994624b321541" + integrity sha512-srkT0LxbKBEo3hWlgjJenT6+bPJK4D+vuKiV/EZFc6sWhDNQwgOgKF6Rf16mggHwKOL9Sx08Veu0BUaX1uyh4g== + dependencies: + fast-deep-equal "^3.1.1" + functional-red-black-tree "^1.0.1" + google-gax "^2.2.0" + +"@google-cloud/firestore@^4.0.0": version "4.4.0" resolved "https://registry.npmjs.org/@google-cloud/firestore/-/firestore-4.4.0.tgz#6cdbd462f32a8f94e138c57ef81195156c79e680" integrity sha512-nixsumd4C7eL+hHEgyihspzhBBNe3agsvNFRX0xfqO3uR/6ro4CUj9XdcCvdnSSd3yTyqKfdBSRK2fEj1jIbYg== @@ -2589,10 +2677,10 @@ resolved "https://registry.npmjs.org/@types/chai/-/chai-4.2.12.tgz#6160ae454cd89dae05adc3bb97997f488b608201" integrity sha512-aN5IAC8QNtSUdQzxu7lGBgYAOuU1tmRU4c9dIq5OKGf/SBVjXo+ffM2wEjudAWbgpOhy60nLoAGH1xm8fpCKFQ== -"@types/chai@4.2.13": - version "4.2.13" - resolved "https://registry.npmjs.org/@types/chai/-/chai-4.2.13.tgz#8a3801f6655179d1803d81e94a2e4aaf317abd16" - integrity sha512-o3SGYRlOpvLFpwJA6Sl1UPOwKFEvE4FxTEB/c9XHI2whdnd4kmPVkNLL8gY4vWGBxWWDumzLbKsAhEH5SKn37Q== +"@types/chai@4.2.14": + version "4.2.14" + resolved "https://registry.npmjs.org/@types/chai/-/chai-4.2.14.tgz#44d2dd0b5de6185089375d976b4ec5caf6861193" + integrity sha512-G+ITQPXkwTrslfG5L/BksmbLUA0M1iybEsmCWPqzSxsRRhJZimBKJkoMi8fr/CPygPTj4zO5pJH7I2/cm9M7SQ== "@types/child-process-promise@2.2.1": version "2.2.1" @@ -2724,10 +2812,10 @@ resolved "https://registry.npmjs.org/@types/mocha/-/mocha-7.0.2.tgz#b17f16cf933597e10d6d78eae3251e692ce8b0ce" integrity sha512-ZvO2tAcjmMi8V/5Z3JsyofMe3hasRcaw88cto5etSVMwVQfeivGAlEYmaQgceUSVYFofVjT+ioHsATjdWcFt1w== -"@types/mz@2.7.1": - version "2.7.1" - resolved "https://registry.npmjs.org/@types/mz/-/mz-2.7.1.tgz#1ac1d69b039c8b3cbe603972b5c12d3167a84f58" - integrity sha512-H86h7KmRDVs9UeSiQvtUeVhS+WYpJSYSsZrRvNYpGWGiytEqxwEtvgRnINESQtCgnojIH2wS2WgaMTJP0firBw== +"@types/mz@2.7.2": + version "2.7.2" + resolved "https://registry.npmjs.org/@types/mz/-/mz-2.7.2.tgz#48de03aacc98aeb40cfdeb8c58fff9fb8a2d8dfc" + integrity sha512-a6E4fuAakzq/uRHEohiYo9M5G+NV33FodRGCU+N4W65CAk6PPJo9KWPH8hxkqiiUgfs8EgUFuKPxclcUEahsRw== dependencies: "@types/node" "*" @@ -2749,10 +2837,10 @@ resolved "https://registry.npmjs.org/@types/node/-/node-10.17.13.tgz#ccebcdb990bd6139cd16e84c39dc2fb1023ca90c" integrity sha512-pMCcqU2zT4TjqYFrWtYHKal7Sl30Ims6ulZ4UFXxI4xbtQqK/qqKwkDoBFCfooRqqmRu9vY3xaJRwxSh673aYg== -"@types/node@12.12.67": - version "12.12.67" - resolved "https://registry.npmjs.org/@types/node/-/node-12.12.67.tgz#4f86badb292e822e3b13730a1f9713ed2377f789" - integrity sha512-R48tgL2izApf+9rYNH+3RBMbRpPeW3N8f0I9HMhggeq4UXwBDqumJ14SDs4ctTMhG11pIOduZ4z3QWGOiMc9Vg== +"@types/node@12.19.3": + version "12.19.3" + resolved "https://registry.npmjs.org/@types/node/-/node-12.19.3.tgz#a6e252973214079155f749e8bef99cc80af182fa" + integrity sha512-8Jduo8wvvwDzEVJCOvS/G6sgilOLvvhn1eMmK3TW8/T217O7u1jdrK6ImKLv80tVryaPSVeKu6sjDEiFjd4/eg== "@types/node@^10.10.0": version "10.17.35" @@ -2899,10 +2987,10 @@ "@types/source-list-map" "*" source-map "^0.7.3" -"@types/webpack@4.41.22": - version "4.41.22" - resolved "https://registry.npmjs.org/@types/webpack/-/webpack-4.41.22.tgz#ff9758a17c6bd499e459b91e78539848c32d0731" - integrity sha512-JQDJK6pj8OMV9gWOnN1dcLCyU9Hzs6lux0wBO4lr1+gyEhIBR9U3FMrz12t2GPkg110XAxEAw2WHF6g7nZIbRQ== +"@types/webpack@4.41.24": + version "4.41.24" + resolved "https://registry.npmjs.org/@types/webpack/-/webpack-4.41.24.tgz#75b664abe3d5bcfe54e64313ca3b43e498550422" + integrity sha512-1A0MXPwZiMOD3DPMuOKUKcpkdPo8Lq33UGggZ7xio6wJ/jV1dAu5cXDrOfGDnldUroPIRLsr/DT43/GqOA4RFQ== dependencies: "@types/anymatch" "*" "@types/node" "*" @@ -2916,10 +3004,10 @@ resolved "https://registry.npmjs.org/@types/yargs-parser/-/yargs-parser-15.0.0.tgz#cb3f9f741869e20cce330ffbeb9271590483882d" integrity sha512-FA/BWv8t8ZWJ+gEOnLLd8ygxH/2UFbAvgEonyfN6yWGLKc7zVjbpl2Y4CTjid9h2RfgPP6SEt6uHwEOply00yw== -"@types/yargs@15.0.8": - version "15.0.8" - resolved "https://registry.npmjs.org/@types/yargs/-/yargs-15.0.8.tgz#7644904cad7427eb704331ea9bf1ee5499b82e23" - integrity sha512-b0BYzFUzBpOhPjpl1wtAHU994jBeKF4TKVlT7ssFv44T617XNcPdRoG4AzHLVshLzlrF7i3lTelH7UbuNYV58Q== +"@types/yargs@15.0.9": + version "15.0.9" + resolved "https://registry.npmjs.org/@types/yargs/-/yargs-15.0.9.tgz#524cd7998fe810cdb02f26101b699cccd156ff19" + integrity sha512-HmU8SeIRhZCWcnRskCs36Q1Q00KBV6Cqh/ora8WN1+22dY07AZdn6Gel8QZ3t26XYPImtcL8WV/eqjhVmMEw4g== dependencies: "@types/yargs-parser" "*" @@ -2930,69 +3018,69 @@ dependencies: "@types/node" "*" -"@typescript-eslint/eslint-plugin-tslint@4.4.1": - version "4.4.1" - resolved "https://registry.npmjs.org/@typescript-eslint/eslint-plugin-tslint/-/eslint-plugin-tslint-4.4.1.tgz#b2fe38ab8e07f6c9de228dd99a1014672aa20513" - integrity sha512-5IVPQjhS2NzWjRpP18SuPnip5ep7zChPZLkPJr1onHg0TADDBolg35hCk9/55FedjBin8LIjzTbyMn24XXr+QQ== +"@typescript-eslint/eslint-plugin-tslint@4.6.1": + version "4.6.1" + resolved "https://registry.npmjs.org/@typescript-eslint/eslint-plugin-tslint/-/eslint-plugin-tslint-4.6.1.tgz#a4efbe58469897717e55d900fe33e64242ef17c1" + integrity sha512-mcFnLShw4pXoEGOsZgLo3b7q2OuEWWGj2sHrcn2mZx0dDlF9e+Q12XmLlqw6Q14mQVIUQrmg1E13xTWTpaagmw== dependencies: - "@typescript-eslint/experimental-utils" "4.4.1" + "@typescript-eslint/experimental-utils" "4.6.1" lodash "^4.17.15" -"@typescript-eslint/eslint-plugin@4.4.1": - version "4.4.1" - resolved "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-4.4.1.tgz#b8acea0373bd2a388ac47df44652f00bf8b368f5" - integrity sha512-O+8Utz8pb4OmcA+Nfi5THQnQpHSD2sDUNw9AxNHpuYOo326HZTtG8gsfT+EAYuVrFNaLyNb2QnUNkmTRDskuRA== +"@typescript-eslint/eslint-plugin@4.6.1": + version "4.6.1" + resolved "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-4.6.1.tgz#99d77eb7a016fd5a5e749d2c44a7e4c317eb7da3" + integrity sha512-SNZyflefTMK2JyrPfFFzzoy2asLmZvZJ6+/L5cIqg4HfKGiW2Gr1Go1OyEVqne/U4QwmoasuMwppoBHWBWF2nA== dependencies: - "@typescript-eslint/experimental-utils" "4.4.1" - "@typescript-eslint/scope-manager" "4.4.1" + "@typescript-eslint/experimental-utils" "4.6.1" + "@typescript-eslint/scope-manager" "4.6.1" debug "^4.1.1" functional-red-black-tree "^1.0.1" regexpp "^3.0.0" semver "^7.3.2" tsutils "^3.17.1" -"@typescript-eslint/experimental-utils@4.4.1": - version "4.4.1" - resolved "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-4.4.1.tgz#40613b9757fa0170de3e0043254dbb077cafac0c" - integrity sha512-Nt4EVlb1mqExW9cWhpV6pd1a3DkUbX9DeyYsdoeziKOpIJ04S2KMVDO+SEidsXRH/XHDpbzXykKcMTLdTXH6cQ== +"@typescript-eslint/experimental-utils@4.6.1": + version "4.6.1" + resolved "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-4.6.1.tgz#a9c691dfd530a9570274fe68907c24c07a06c4aa" + integrity sha512-qyPqCFWlHZXkEBoV56UxHSoXW2qnTr4JrWVXOh3soBP3q0o7p4pUEMfInDwIa0dB/ypdtm7gLOS0hg0a73ijfg== dependencies: "@types/json-schema" "^7.0.3" - "@typescript-eslint/scope-manager" "4.4.1" - "@typescript-eslint/types" "4.4.1" - "@typescript-eslint/typescript-estree" "4.4.1" + "@typescript-eslint/scope-manager" "4.6.1" + "@typescript-eslint/types" "4.6.1" + "@typescript-eslint/typescript-estree" "4.6.1" eslint-scope "^5.0.0" eslint-utils "^2.0.0" -"@typescript-eslint/parser@4.4.1": - version "4.4.1" - resolved "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-4.4.1.tgz#25fde9c080611f303f2f33cedb145d2c59915b80" - integrity sha512-S0fuX5lDku28Au9REYUsV+hdJpW/rNW0gWlc4SXzF/kdrRaAVX9YCxKpziH7djeWT/HFAjLZcnY7NJD8xTeUEg== +"@typescript-eslint/parser@4.6.1": + version "4.6.1" + resolved "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-4.6.1.tgz#b801bff67b536ecc4a840ac9289ba2be57e02428" + integrity sha512-lScKRPt1wM9UwyKkGKyQDqf0bh6jm8DQ5iN37urRIXDm16GEv+HGEmum2Fc423xlk5NUOkOpfTnKZc/tqKZkDQ== dependencies: - "@typescript-eslint/scope-manager" "4.4.1" - "@typescript-eslint/types" "4.4.1" - "@typescript-eslint/typescript-estree" "4.4.1" + "@typescript-eslint/scope-manager" "4.6.1" + "@typescript-eslint/types" "4.6.1" + "@typescript-eslint/typescript-estree" "4.6.1" debug "^4.1.1" -"@typescript-eslint/scope-manager@4.4.1": - version "4.4.1" - resolved "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-4.4.1.tgz#d19447e60db2ce9c425898d62fa03b2cce8ea3f9" - integrity sha512-2oD/ZqD4Gj41UdFeWZxegH3cVEEH/Z6Bhr/XvwTtGv66737XkR4C9IqEkebCuqArqBJQSj4AgNHHiN1okzD/wQ== +"@typescript-eslint/scope-manager@4.6.1": + version "4.6.1" + resolved "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-4.6.1.tgz#21872b91cbf7adfc7083f17b8041149148baf992" + integrity sha512-f95+80r6VdINYscJY1KDUEDcxZ3prAWHulL4qRDfNVD0I5QAVSGqFkwHERDoLYJJWmEAkUMdQVvx7/c2Hp+Bjg== dependencies: - "@typescript-eslint/types" "4.4.1" - "@typescript-eslint/visitor-keys" "4.4.1" + "@typescript-eslint/types" "4.6.1" + "@typescript-eslint/visitor-keys" "4.6.1" -"@typescript-eslint/types@4.4.1": - version "4.4.1" - resolved "https://registry.npmjs.org/@typescript-eslint/types/-/types-4.4.1.tgz#c507b35cf523bc7ba00aae5f75ee9b810cdabbc1" - integrity sha512-KNDfH2bCyax5db+KKIZT4rfA8rEk5N0EJ8P0T5AJjo5xrV26UAzaiqoJCxeaibqc0c/IvZxp7v2g3difn2Pn3w== +"@typescript-eslint/types@4.6.1": + version "4.6.1" + resolved "https://registry.npmjs.org/@typescript-eslint/types/-/types-4.6.1.tgz#d3ad7478f53f22e7339dc006ab61aac131231552" + integrity sha512-k2ZCHhJ96YZyPIsykickez+OMHkz06xppVLfJ+DY90i532/Cx2Z+HiRMH8YZQo7a4zVd/TwNBuRCdXlGK4yo8w== -"@typescript-eslint/typescript-estree@4.4.1": - version "4.4.1" - resolved "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-4.4.1.tgz#598f6de488106c2587d47ca2462c60f6e2797cb8" - integrity sha512-wP/V7ScKzgSdtcY1a0pZYBoCxrCstLrgRQ2O9MmCUZDtmgxCO/TCqOTGRVwpP4/2hVfqMz/Vw1ZYrG8cVxvN3g== +"@typescript-eslint/typescript-estree@4.6.1": + version "4.6.1" + resolved "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-4.6.1.tgz#6025cce724329413f57e4959b2d676fceeca246f" + integrity sha512-/J/kxiyjQQKqEr5kuKLNQ1Finpfb8gf/NpbwqFFYEBjxOsZ621r9AqwS9UDRA1Rrr/eneX/YsbPAIhU2rFLjXQ== dependencies: - "@typescript-eslint/types" "4.4.1" - "@typescript-eslint/visitor-keys" "4.4.1" + "@typescript-eslint/types" "4.6.1" + "@typescript-eslint/visitor-keys" "4.6.1" debug "^4.1.1" globby "^11.0.1" is-glob "^4.0.1" @@ -3000,12 +3088,12 @@ semver "^7.3.2" tsutils "^3.17.1" -"@typescript-eslint/visitor-keys@4.4.1": - version "4.4.1" - resolved "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-4.4.1.tgz#1769dc7a9e2d7d2cfd3318b77ed8249187aed5c3" - integrity sha512-H2JMWhLaJNeaylSnMSQFEhT/S/FsJbebQALmoJxMPMxLtlVAMy2uJP/Z543n9IizhjRayLSqoInehCeNW9rWcw== +"@typescript-eslint/visitor-keys@4.6.1": + version "4.6.1" + resolved "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-4.6.1.tgz#6b125883402d8939df7b54528d879e88f7ba3614" + integrity sha512-owABze4toX7QXwOLT3/D5a8NecZEjEWU1srqxENTfqsY3bwVnl3YYbOh6s1rp2wQKO9RTHFGjKes08FgE7SVMw== dependencies: - "@typescript-eslint/types" "4.4.1" + "@typescript-eslint/types" "4.6.1" eslint-visitor-keys "^2.0.0" "@webassemblyjs/ast@1.9.0": @@ -4348,7 +4436,17 @@ browserify-zlib@^0.2.0: dependencies: pako "~1.0.5" -browserslist@^4.12.0, browserslist@^4.8.5: +browserslist@^4.14.5: + version "4.14.6" + resolved "https://registry.npmjs.org/browserslist/-/browserslist-4.14.6.tgz#97702a9c212e0c6b6afefad913d3a1538e348457" + integrity sha512-zeFYcUo85ENhc/zxHbiIp0LGzzTrE2Pv2JhxvS7kpUb9Q9D38kUX6Bie7pGutJ/5iF5rOxE7CepAuWD56xJ33A== + dependencies: + caniuse-lite "^1.0.30001154" + electron-to-chromium "^1.3.585" + escalade "^3.1.1" + node-releases "^1.1.65" + +browserslist@^4.8.5: version "4.14.5" resolved "https://registry.npmjs.org/browserslist/-/browserslist-4.14.5.tgz#1c751461a102ddc60e40993639b709be7f2c4015" integrity sha512-Z+vsCZIvCBvqLoYkBFTwEYH3v5MCQbsAjp50ERycpOjnPmolg1Gjy4+KaWWpm8QOJt9GHkhdqAl14NpCX73CWA== @@ -4606,6 +4704,11 @@ caniuse-lite@^1.0.30001135: resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001141.tgz#214a196d81aa938b268fb0cb6d8fab23fdf14378" integrity sha512-EHfInJHoQTmlMdVZrEc5gmwPc0zyN/hVufmGHPbVNQwlk7tJfCmQ2ysRZMY2MeleBivALUTyyxXnQjK18XrVpA== +caniuse-lite@^1.0.30001154: + version "1.0.30001156" + resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001156.tgz#75c20937b6012fe2b02ab58b30d475bf0718de97" + integrity sha512-z7qztybA2eFZTB6Z3yvaQBIoJpQtsewRD74adw2UbRWwsRq3jIPvgrQGawBMbfafekQaD21FWuXNcywtTDGGCw== + capture-stack-trace@^1.0.0: version "1.0.1" resolved "https://registry.npmjs.org/capture-stack-trace/-/capture-stack-trace-1.0.1.tgz#a6c0bbe1f38f3aa0b92238ecb6ff42c344d4135d" @@ -4917,10 +5020,10 @@ cliui@^6.0.0: strip-ansi "^6.0.0" wrap-ansi "^6.2.0" -cliui@^7.0.0: - version "7.0.1" - resolved "https://registry.npmjs.org/cliui/-/cliui-7.0.1.tgz#a4cb67aad45cd83d8d05128fc9f4d8fbb887e6b3" - integrity sha512-rcvHOWyGyid6I1WjT/3NatKj2kDt9OdSHSXpyLXaMWFbKpGACNW8pRhhdPUq9MWUOdwn8Rz9AVETjF4105rZZQ== +cliui@^7.0.2: + version "7.0.3" + resolved "https://registry.npmjs.org/cliui/-/cliui-7.0.3.tgz#ef180f26c8d9bff3927ee52428bfec2090427981" + integrity sha512-Gj3QHTkVMPKqwP3f7B4KPkBZRMR9r4rfi5bXFpg1a+Svvj8l7q5CnkBkVQzfxT5DFSsGk2+PascOgL0JYkL2kw== dependencies: string-width "^4.2.0" strip-ansi "^6.0.0" @@ -6213,6 +6316,11 @@ electron-to-chromium@^1.3.571: resolved "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.576.tgz#2e70234484e03d7c7e90310d7d79fd3775379c34" integrity sha512-uSEI0XZ//5ic+0NdOqlxp0liCD44ck20OAGyLMSymIWTEAtHKVJi6JM18acOnRgUgX7Q65QqnI+sNncNvIy8ew== +electron-to-chromium@^1.3.585: + version "1.3.588" + resolved "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.588.tgz#c6515571737bfb42678115a5eaa818384593a9a5" + integrity sha512-0zr+ZfytnLeJZxGgmEpPTcItu5Mm4A5zHPZXLfHcGp0mdsk95rmD7ePNewYtK1yIdLbk8Z1U2oTRRfOtR4gbYg== + elegant-spinner@^1.0.1: version "1.0.1" resolved "https://registry.npmjs.org/elegant-spinner/-/elegant-spinner-1.0.1.tgz#db043521c95d7e303fd8f345bedc3349cfb0729e" @@ -6462,11 +6570,16 @@ es6-weak-map@^2.0.1, es6-weak-map@^2.0.2: es6-iterator "^2.0.3" es6-symbol "^3.1.1" -escalade@^3.0.2, escalade@^3.1.0: +escalade@^3.1.0: version "3.1.0" resolved "https://registry.npmjs.org/escalade/-/escalade-3.1.0.tgz#e8e2d7c7a8b76f6ee64c2181d6b8151441602d4e" integrity sha512-mAk+hPSO8fLDkhV7V0dXazH5pDc6MrjBTPyD3VeKzxnVFjH1MIxbCdqGZB9O8+EwWakZs3ZCbDS4IpRt79V1ig== +escalade@^3.1.1: + version "3.1.1" + resolved "https://registry.npmjs.org/escalade/-/escalade-3.1.1.tgz#d8cfdc7000965c5a0174b4a82eaa5c0552742e40" + integrity sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw== + escape-goat@^2.0.0: version "2.1.1" resolved "https://registry.npmjs.org/escape-goat/-/escape-goat-2.1.1.tgz#1b2dc77003676c457ec760b2dc68edb648188675" @@ -6550,13 +6663,13 @@ eslint-visitor-keys@^2.0.0: resolved "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-2.0.0.tgz#21fdc8fbcd9c795cc0321f0563702095751511a8" integrity sha512-QudtT6av5WXels9WjIM7qz1XD1cWGvX4gGXvp/zBn9nXG02D0utdU3Em2m/QjTnrsk6bBjmCygl3rmj118msQQ== -eslint@7.11.0: - version "7.11.0" - resolved "https://registry.npmjs.org/eslint/-/eslint-7.11.0.tgz#aaf2d23a0b5f1d652a08edacea0c19f7fadc0b3b" - integrity sha512-G9+qtYVCHaDi1ZuWzBsOWo2wSwd70TXnU6UHA3cTYHp7gCTXZcpggWFoUVAMRarg68qtPoNfFbzPh+VdOgmwmw== +eslint@7.12.1: + version "7.12.1" + resolved "https://registry.npmjs.org/eslint/-/eslint-7.12.1.tgz#bd9a81fa67a6cfd51656cdb88812ce49ccec5801" + integrity sha512-HlMTEdr/LicJfN08LB3nM1rRYliDXOmfoO4vj39xN6BLpFzF00hbwBoqHk8UcJ2M/3nlARZWy/mslvGEuZFvsg== dependencies: "@babel/code-frame" "^7.0.0" - "@eslint/eslintrc" "^0.1.3" + "@eslint/eslintrc" "^0.2.1" ajv "^6.10.0" chalk "^4.0.0" cross-spawn "^7.0.2" @@ -7197,10 +7310,10 @@ fined@^1.0.1: object.pick "^1.2.0" parse-filepath "^1.0.1" -firebase-admin@9.2.0: - version "9.2.0" - resolved "https://registry.npmjs.org/firebase-admin/-/firebase-admin-9.2.0.tgz#df5176e2d0c5711df6dbf7012320492a703538ea" - integrity sha512-LhnMYl71B4gP1FlTLfwaYlOWhBCAcNF+byb2CPTfaW/T4hkp4qlXOgo2bws/zbAv5X9GTFqGir3KexMslVGsIA== +firebase-admin@9.3.0: + version "9.3.0" + resolved "https://registry.npmjs.org/firebase-admin/-/firebase-admin-9.3.0.tgz#05f3efb1bb97f17b2c562f4b59820a381d2f903f" + integrity sha512-qMUITOp2QKLLc2o0/wSiDC2OO2knejjieZN/8Or9AzfFk8ftTcUKq5ALNlQXu+7aUzGe0IwSJq9TVnkIU0h1xw== dependencies: "@firebase/database" "^0.6.10" "@firebase/database-types" "^0.5.2" @@ -7222,68 +7335,10 @@ firebase-functions@3.11.0: express "^4.17.1" lodash "^4.17.14" -firebase-tools@8.12.1: - version "8.12.1" - resolved "https://registry.npmjs.org/firebase-tools/-/firebase-tools-8.12.1.tgz#360b291cbe26545231764ab1f8fbd265ee8c48d3" - integrity sha512-nNXtLdlVTjBz5PEMMmInhEp23mBD5NRJ791j2BONTFwd+KH8dXBopAhLuSkRtGp8XNDSNcRwjaNPCoLYE5RoZg== - dependencies: - "@google-cloud/pubsub" "^1.7.0" - JSONStream "^1.2.1" - archiver "^3.0.0" - body-parser "^1.19.0" - chokidar "^3.0.2" - cjson "^0.3.1" - cli-color "^1.2.0" - cli-table "^0.3.1" - commander "^4.0.1" - configstore "^5.0.1" - cross-env "^5.1.3" - cross-spawn "^7.0.1" - csv-streamify "^3.0.4" - dotenv "^6.1.0" - exegesis-express "^2.0.0" - exit-code "^1.0.2" - express "^4.16.4" - filesize "^3.1.3" - fs-extra "^0.23.1" - glob "^7.1.2" - google-auth-library "^5.5.0" - google-gax "~1.12.0" - inquirer "~6.3.1" - js-yaml "^3.13.1" - jsonschema "^1.0.2" - jsonwebtoken "^8.2.1" - leven "^3.1.0" - lodash "^4.17.19" - marked "^0.7.0" - marked-terminal "^3.3.0" - minimatch "^3.0.4" - morgan "^1.10.0" - open "^6.3.0" - ora "^3.4.0" - plist "^3.0.1" - portfinder "^1.0.23" - progress "^2.0.3" - request "^2.87.0" - rimraf "^3.0.0" - semver "^5.7.1" - superstatic "^7.0.0" - tar "^4.3.0" - tcp-port-used "^1.0.1" - tmp "0.0.33" - triple-beam "^1.3.0" - tweetsodium "0.0.5" - universal-analytics "^0.4.16" - unzipper "^0.10.10" - update-notifier "^4.1.0" - uuid "^3.0.0" - winston "^3.0.0" - ws "^7.2.3" - -firebase-tools@8.13.0: - version "8.13.0" - resolved "https://registry.npmjs.org/firebase-tools/-/firebase-tools-8.13.0.tgz#324eb47d9c3987b85dfa6818aebd077df0fc431b" - integrity sha512-IlGJA5WVDTrjj02anUhuBwaCHe+WtB0gNbp9SjIRqIVYbMpJWPi25sqyiJ5kb4u7r7lZOcSGQbAYHqpDdzakfQ== +firebase-tools@8.15.0: + version "8.15.0" + resolved "https://registry.npmjs.org/firebase-tools/-/firebase-tools-8.15.0.tgz#cfbad03c33f48e3854371c4d034b3ab43fa6794f" + integrity sha512-NE+RtSqYw8Qjs1Ud5D4HsBIepFBUuL65ZlU6KUtm7dgZl6b7N9gC2nsjagNzdDYV27vgvnR+2mf2W1dCRsD0Fw== dependencies: "@google-cloud/pubsub" "^1.7.0" JSONStream "^1.2.1" @@ -7317,6 +7372,7 @@ firebase-tools@8.13.0: marked-terminal "^3.3.0" minimatch "^3.0.4" morgan "^1.10.0" + node-fetch "^2.6.1" open "^6.3.0" ora "^3.4.0" plist "^3.0.1" @@ -8950,7 +9006,7 @@ interpret@^1.0.0, interpret@^1.4.0: resolved "https://registry.npmjs.org/interpret/-/interpret-1.4.0.tgz#665ab8bc4da27a774a40584e812e3e0fa45b1a1e" integrity sha512-agE4QfB2Lkp9uICn7BAqoscw4SZP9kTE2hxiFI3jBPmXJfdqiahTbUuKGsMoN2GtqL9AxhYioAcVvgsb1HvRbA== -invariant@^2.2.2, invariant@^2.2.4: +invariant@^2.2.2: version "2.2.4" resolved "https://registry.npmjs.org/invariant/-/invariant-2.2.4.tgz#610f3c92c9359ce1db616e538008d23ff35158e6" integrity sha512-phJfQVBuaJM5raOpJjSfkiD6BpbCE4Ns//LaXl6wGYtUBY83nWS6Rf9tXm2e8VaK60JEjYldbPif/A2B1C2gNA== @@ -9964,10 +10020,10 @@ karma-coverage-istanbul-reporter@2.1.1: istanbul-api "^2.1.6" minimatch "^3.0.4" -karma-firefox-launcher@2.0.0: - version "2.0.0" - resolved "https://registry.npmjs.org/karma-firefox-launcher/-/karma-firefox-launcher-2.0.0.tgz#01319c50e452222311cfd92c06483ced6b934af9" - integrity sha512-BVq24Qwa//531LXRwvqu14ba04wcHNAX/m3lFF5v90w1rzUgck1FPBwQqlAIgKfkN5uHjT0PcxUqUNUctbQGVA== +karma-firefox-launcher@2.1.0: + version "2.1.0" + resolved "https://registry.npmjs.org/karma-firefox-launcher/-/karma-firefox-launcher-2.1.0.tgz#d0d328c93dfcf9b46f1ac83b4bb32f43aadb2050" + integrity sha512-dkiyqN2R6fCWt78rciOXJLFDWcQ7QEQi++HgebPJlw1y0ycDjGNDHuSrhdh48QG02fzZKK20WHFWVyBZ6CPngg== dependencies: is-wsl "^2.2.0" which "^2.0.1" @@ -10236,13 +10292,6 @@ leven@^3.1.0: resolved "https://registry.npmjs.org/leven/-/leven-3.1.0.tgz#77891de834064cccba82ae7842bb6b14a13ed7f2" integrity sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A== -levenary@^1.1.1: - version "1.1.1" - resolved "https://registry.npmjs.org/levenary/-/levenary-1.1.1.tgz#842a9ee98d2075aa7faeedbe32679e9205f46f77" - integrity sha512-mkAdOIt79FD6irqjYSs4rdbnlT5vRonMEvBVPVb3XmevfS8kgRXwfes0dhPdEtzTWD/1eNE/Bm/G1iRt6DcnQQ== - dependencies: - leven "^3.1.0" - levn@^0.4.1: version "0.4.1" resolved "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz#ae4562c007473b932a6200d403268dd2fffc6ade" @@ -10998,20 +11047,22 @@ meow@^4.0.0: redent "^2.0.0" trim-newlines "^2.0.0" -meow@^5.0.0: - version "5.0.0" - resolved "https://registry.npmjs.org/meow/-/meow-5.0.0.tgz#dfc73d63a9afc714a5e371760eb5c88b91078aa4" - integrity sha512-CbTqYU17ABaLefO8vCU153ZZlprKYWDljcndKKDCFcYQITzWCXZAVk4QMFZPgvzrnUQ3uItnIE/LoUOwrT15Ig== +meow@^6.0.0: + version "6.1.1" + resolved "https://registry.npmjs.org/meow/-/meow-6.1.1.tgz#1ad64c4b76b2a24dfb2f635fddcadf320d251467" + integrity sha512-3YffViIt2QWgTy6Pale5QpopX/IvU3LPL03jOTqp6pGj3VjesdO/U8CuHMKpnQr4shCNCM5fd5XFFvIIl6JBHg== dependencies: - camelcase-keys "^4.0.0" - decamelize-keys "^1.0.0" - loud-rejection "^1.0.0" - minimist-options "^3.0.1" - normalize-package-data "^2.3.4" - read-pkg-up "^3.0.0" - redent "^2.0.0" - trim-newlines "^2.0.0" - yargs-parser "^10.0.0" + "@types/minimist" "^1.2.0" + camelcase-keys "^6.2.2" + decamelize-keys "^1.1.0" + hard-rejection "^2.1.0" + minimist-options "^4.0.2" + normalize-package-data "^2.5.0" + read-pkg-up "^7.0.1" + redent "^3.0.0" + trim-newlines "^3.0.0" + type-fest "^0.13.1" + yargs-parser "^18.1.3" meow@^7.0.0: version "7.1.1" @@ -11154,7 +11205,7 @@ minimatch@3.0.4, minimatch@^3.0.0, minimatch@^3.0.3, minimatch@^3.0.4: dependencies: brace-expansion "^1.1.7" -minimist-options@4.1.0: +minimist-options@4.1.0, minimist-options@^4.0.2: version "4.1.0" resolved "https://registry.npmjs.org/minimist-options/-/minimist-options-4.1.0.tgz#c0655713c53a8a2ebd77ffa247d342c40f010619" integrity sha512-Q4r8ghd80yhO/0j1O3B2BjweX3fiHg9cdOwjJd2J76Q135c+NDxGCqdYKQ1SKBuFfgWbAUzBfvYjPUEeNgqN1A== @@ -11600,6 +11651,11 @@ node-releases@^1.1.61: resolved "https://registry.npmjs.org/node-releases/-/node-releases-1.1.61.tgz#707b0fca9ce4e11783612ba4a2fcba09047af16e" integrity sha512-DD5vebQLg8jLCOzwupn954fbIiZht05DAZs0k2u8NStSe6h9XdsuIQL8hSRKYiU8WUQRznmSDrKGbv3ObOmC7g== +node-releases@^1.1.65: + version "1.1.65" + resolved "https://registry.npmjs.org/node-releases/-/node-releases-1.1.65.tgz#52d9579176bd60f23eba05c4438583f341944b81" + integrity sha512-YpzJOe2WFIW0V4ZkJQd/DGR/zdVwc/pI4Nl1CZrBO19FdRcSTmsuhdttw9rsTzzJLrNcSloLiBbEYx1C4f6gpA== + node-status-codes@^1.0.0: version "1.0.0" resolved "https://registry.npmjs.org/node-status-codes/-/node-status-codes-1.0.0.tgz#5ae5541d024645d32a58fcddc9ceecea7ae3ac2f" @@ -12682,10 +12738,10 @@ promise-inflight@^1.0.1: resolved "https://registry.npmjs.org/promise-inflight/-/promise-inflight-1.0.1.tgz#98472870bf228132fcbdd868129bad12c3c029e3" integrity sha1-mEcocL8igTL8vdhoEputEsPAKeM= -promise-polyfill@8.1.3: - version "8.1.3" - resolved "https://registry.npmjs.org/promise-polyfill/-/promise-polyfill-8.1.3.tgz#8c99b3cf53f3a91c68226ffde7bde81d7f904116" - integrity sha512-MG5r82wBzh7pSKDRa9y+vllNHz3e3d4CNj1PQE4BQYxLme0gKYYBm9YENq+UkEikyZ0XbiGWxYlVw3Rl9O/U8g== +promise-polyfill@8.2.0: + version "8.2.0" + resolved "https://registry.npmjs.org/promise-polyfill/-/promise-polyfill-8.2.0.tgz#367394726da7561457aba2133c9ceefbd6267da0" + integrity sha512-k/TC0mIcPVF6yHhUvwAp7cvL6I2fFV7TzF1DuGPI8mBh4QQazf36xCKEHKTZKRysEoTQoQdKyP25J8MPJp7j5g== promise-polyfill@^6.0.1: version "6.1.0" @@ -13237,7 +13293,7 @@ regexpp@^3.0.0, regexpp@^3.1.0: resolved "https://registry.npmjs.org/regexpp/-/regexpp-3.1.0.tgz#206d0ad0a5648cffbdb8ae46438f3dc51c9f78e2" integrity sha512-ZOIzd8yVsQQA7j8GCSlPGXwg5PfmA1mrq0JP4nGhh54LaKN3xdai/vHUDu74pKwV8OxseMS65u2NImosQcSD0Q== -regexpu-core@^4.7.0: +regexpu-core@^4.7.0, regexpu-core@^4.7.1: version "4.7.1" resolved "https://registry.npmjs.org/regexpu-core/-/regexpu-core-4.7.1.tgz#2dea5a9a07233298fbf0db91fa9abc4c6e0f8ad6" integrity sha512-ywH2VUraA44DZQuRKzARmw6S66mr48pQVva4LBeRhcOltJ6hExvWly5ZjFLYo67xbIxb6W1q4bAGtgfEl20zfQ== @@ -13592,10 +13648,10 @@ rollup-plugin-terser@7.0.2: serialize-javascript "^4.0.0" terser "^5.0.0" -rollup-plugin-typescript2@0.27.3: - version "0.27.3" - resolved "https://registry.npmjs.org/rollup-plugin-typescript2/-/rollup-plugin-typescript2-0.27.3.tgz#cd9455ac026d325b20c5728d2cc54a08a771b68b" - integrity sha512-gmYPIFmALj9D3Ga1ZbTZAKTXq1JKlTQBtj299DXhqYz9cL3g/AQfUvbb2UhH+Nf++cCq941W2Mv7UcrcgLzJJg== +rollup-plugin-typescript2@0.29.0: + version "0.29.0" + resolved "https://registry.npmjs.org/rollup-plugin-typescript2/-/rollup-plugin-typescript2-0.29.0.tgz#b7ad83f5241dbc5bdf1e98d9c3fca005ffe39e1a" + integrity sha512-YytahBSZCIjn/elFugEGQR5qTsVhxhUwGZIsA9TmrSsC88qroGo65O5HZP/TTArH2dm0vUmYWhKchhwi2wL9bw== dependencies: "@rollup/pluginutils" "^3.1.0" find-cache-dir "^3.3.1" @@ -13620,10 +13676,10 @@ rollup-pluginutils@^2.6.0: dependencies: estree-walker "^0.6.1" -rollup@2.29.0: - version "2.29.0" - resolved "https://registry.npmjs.org/rollup/-/rollup-2.29.0.tgz#0c5c5968530b21ca0e32f8b94b7cd9346cfb0eec" - integrity sha512-gtU0sjxMpsVlpuAf4QXienPmUAhd6Kc7owQ4f5lypoxBW18fw2UNYZ4NssLGsri6WhUZkE/Ts3EMRebN+gNLiQ== +rollup@2.33.1: + version "2.33.1" + resolved "https://registry.npmjs.org/rollup/-/rollup-2.33.1.tgz#802795164164ee63cd47769d8879c33ec8ae0c40" + integrity sha512-uY4O/IoL9oNW8MMcbA5hcOaz6tZTMIh7qJHx/tzIJm+n1wLoY38BLn6fuy7DhR57oNFLMbDQtDeJoFURt5933w== optionalDependencies: fsevents "~2.1.2" @@ -13988,10 +14044,10 @@ sinon-chai@3.5.0: resolved "https://registry.npmjs.org/sinon-chai/-/sinon-chai-3.5.0.tgz#c9a78304b0e15befe57ef68e8a85a00553f5c60e" integrity sha512-IifbusYiQBpUxxFJkR3wTU68xzBN0+bxCScEaKMjBvAQERg6FnTTc1F17rseLb1tjmkJ23730AXpFI0c47FgAg== -sinon@9.2.0: - version "9.2.0" - resolved "https://registry.npmjs.org/sinon/-/sinon-9.2.0.tgz#1d333967e30023609f7347351ebc0dc964c0f3c9" - integrity sha512-eSNXz1XMcGEMHw08NJXSyTHIu6qTCOiN8x9ODACmZpNQpr0aXTBXBnI4xTzQzR+TEpOmLiKowGf9flCuKIzsbw== +sinon@9.2.1: + version "9.2.1" + resolved "https://registry.npmjs.org/sinon/-/sinon-9.2.1.tgz#64cc88beac718557055bd8caa526b34a2231be6d" + integrity sha512-naPfsamB5KEE1aiioaoqJ6MEhdUs/2vtI5w1hPAXX/UwvoPjXcwh1m5HiKx0HGgKR8lQSoFIgY5jM6KK8VrS9w== dependencies: "@sinonjs/commons" "^1.8.1" "@sinonjs/fake-timers" "^6.0.1" @@ -14164,10 +14220,10 @@ source-list-map@^2.0.0: resolved "https://registry.npmjs.org/source-list-map/-/source-list-map-2.0.1.tgz#3993bd873bfc48479cca9ea3a547835c7c154b34" integrity sha512-qnQ7gVMxGNxsiL4lEuJwe/To8UnK7fAnmbGEEH8RpLouuKbeEm0lhbQVFIrNSuB+G7tVrAlVsZgETT5nljf+Iw== -source-map-loader@1.1.1: - version "1.1.1" - resolved "https://registry.npmjs.org/source-map-loader/-/source-map-loader-1.1.1.tgz#1dd964294cfcc3d9bab65f46af97a38d8ae0c65d" - integrity sha512-m2HjSWP2R1yR9P31e4+ciGHFOPvW6GmqHgZkneOkrME2VvWysXTGi4o0yS28iKWWP3vAUmAoa+3x5ZRI2BIX6A== +source-map-loader@1.1.2: + version "1.1.2" + resolved "https://registry.npmjs.org/source-map-loader/-/source-map-loader-1.1.2.tgz#5b782bf08496d3a7f355e1780df0e25190a80991" + integrity sha512-bjf6eSENOYBX4JZDfl9vVLNsGAQ6Uz90fLmOazcmMcyDYOBFsGxPNn83jXezWLY9bJsVAo1ObztxPcV8HAbjVA== dependencies: abab "^2.0.5" iconv-lite "^0.6.2" @@ -14885,10 +14941,10 @@ terser-webpack-plugin@^1.4.3: webpack-sources "^1.4.0" worker-farm "^1.7.0" -terser@5.3.5: - version "5.3.5" - resolved "https://registry.npmjs.org/terser/-/terser-5.3.5.tgz#9e080baa0568f96654621b20eb9effa440b1484e" - integrity sha512-Qw3CZAMmmfU824AoGKalx+riwocSI5Cs0PoGp9RdSLfmxkmJgyBxqLBP/isDNtFyhHnitikvRMZzyVgeq+U+Tg== +terser@5.3.8: + version "5.3.8" + resolved "https://registry.npmjs.org/terser/-/terser-5.3.8.tgz#991ae8ba21a3d990579b54aa9af11586197a75dd" + integrity sha512-zVotuHoIfnYjtlurOouTazciEfL7V38QMAOhGqpXDEg6yT13cF4+fEP9b0rrCEQTn+tT46uxgFsTZzhygk+CzQ== dependencies: commander "^2.20.0" source-map "~0.7.2" @@ -15202,15 +15258,15 @@ try-require@^1.0.0: resolved "https://registry.npmjs.org/try-require/-/try-require-1.2.1.tgz#34489a2cac0c09c1cc10ed91ba011594d4333be2" integrity sha1-NEiaLKwMCcHMEO2RugEVlNQzO+I= -ts-essentials@7.0.0: - version "7.0.0" - resolved "https://registry.npmjs.org/ts-essentials/-/ts-essentials-7.0.0.tgz#eb807945d65e258bae8914f541543758f879f6c5" - integrity sha512-DptrzFAwb5afnsTdKxfScHqLbVZHl7YsxvDT+iT8tbXWFGSzbXALhfWlal25HBesqlX0NZd6wz9KBGnJcWScdQ== +ts-essentials@7.0.1: + version "7.0.1" + resolved "https://registry.npmjs.org/ts-essentials/-/ts-essentials-7.0.1.tgz#d205508cae0cdadfb73c89503140cf2228389e2d" + integrity sha512-8lwh3QJtIc1UWhkQtr9XuksXu3O0YQdEE5g79guDfhCaU1FWTDIEDZ1ZSx4HTHUmlJZ8L812j3BZQ4a0aOUkSA== -ts-loader@8.0.5: - version "8.0.5" - resolved "https://registry.npmjs.org/ts-loader/-/ts-loader-8.0.5.tgz#fa42b9305247eb964843df1ecb0e589b1bff0f77" - integrity sha512-MvLXmjDxl2Mhv17nvkrB6BrpC8FTwSb7K38oIgdUI6BMx4XgVbljmcoOzlrYn4wyjNTFQ3utd7s2TyigJyR3YA== +ts-loader@8.0.9: + version "8.0.9" + resolved "https://registry.npmjs.org/ts-loader/-/ts-loader-8.0.9.tgz#890fc25f49a99124268f4e738ed22d00f666dc37" + integrity sha512-rQd+iIfz5z4HSVzhhRFP4M2OQ0QmihilWWauYvvowBfnRvr4DW+gqA2om70xp/07EQj1qBkLMWobnXsgmWMbmg== dependencies: chalk "^2.3.0" enhanced-resolve "^4.0.0" @@ -15297,7 +15353,7 @@ tty-browserify@^0.0.1: resolved "https://registry.npmjs.org/tty-browserify/-/tty-browserify-0.0.1.tgz#3f05251ee17904dfd0677546670db9651682b811" integrity sha512-C3TaO7K81YvjCgQH9Q1S3R3P3BtN3RIM8n+OvX4il1K1zgE8ZhI0op7kClgkxtutIE8hQrcrHBXvIheqKUUCxw== -tty-table@^2.7.0: +tty-table@^2.8.10: version "2.8.13" resolved "https://registry.npmjs.org/tty-table/-/tty-table-2.8.13.tgz#d484a416381973eaebbdf19c79136b390e5c6d70" integrity sha512-eVV/+kB6fIIdx+iUImhXrO22gl7f6VmmYh0Zbu6C196fe1elcHXd7U6LcLXu0YoVPc2kNesWiukYcdK8ZmJ6aQ== @@ -16017,10 +16073,10 @@ webpack-stream@6.1.0: vinyl "^2.1.0" webpack "^4.26.1" -webpack-virtual-modules@0.3.1: - version "0.3.1" - resolved "https://registry.npmjs.org/webpack-virtual-modules/-/webpack-virtual-modules-0.3.1.tgz#78cbf1a41a699890a706e789a682dd1120558bf4" - integrity sha512-C9Zbb9rny/SaZJ7gTgJjyB2Qt4G4dbT5rVZywYpyk3L6qyf006RepODREXC4rcQCiTPdZnqnebRq5Chsxg+SgQ== +webpack-virtual-modules@0.3.2: + version "0.3.2" + resolved "https://registry.npmjs.org/webpack-virtual-modules/-/webpack-virtual-modules-0.3.2.tgz#b7baa30971a22d99451f897db053af48ec29ad2c" + integrity sha512-RXQXioY6MhzM4CNQwmBwKXYgBs6ulaiQ8bkNQEl2J6Z+V+s7lgl/wGvaI/I0dLnYKB8cKsxQc17QOAVIphPLDw== dependencies: debug "^3.0.0" @@ -16407,10 +16463,10 @@ y18n@^4.0.0: resolved "https://registry.npmjs.org/y18n/-/y18n-4.0.0.tgz#95ef94f85ecc81d007c264e190a120f0a3c8566b" integrity sha512-r9S/ZyXu/Xu9q1tYlpsLIsa3EeLXXk0VwlxqTcFRfg9EhMW+17kbt9G0NrgCmhGb5vT2hyhJZLfDGx+7+5Uj/w== -y18n@^5.0.1: - version "5.0.2" - resolved "https://registry.npmjs.org/y18n/-/y18n-5.0.2.tgz#48218df5da2731b4403115c39a1af709c873f829" - integrity sha512-CkwaeZw6dQgqgPGeTWKMXCRmMcBgETFlTml1+ZOO+q7kGst8NREJ+eWwFNPVUQ4QGdAaklbqCZHH6Zuep1RjiA== +y18n@^5.0.2: + version "5.0.5" + resolved "https://registry.npmjs.org/y18n/-/y18n-5.0.5.tgz#8769ec08d03b1ea2df2500acef561743bbb9ab18" + integrity sha512-hsRUr4FFrvhhRH12wOdfs38Gy7k2FFzB9qgN9v3aLykRq0dRcdcpz5C9FxdS2NuhOrI/628b/KSTJ3rwHysYSg== yallist@^2.1.2: version "2.1.2" @@ -16448,13 +16504,6 @@ yargs-parser@5.0.0-security.0: camelcase "^3.0.0" object.assign "^4.1.0" -yargs-parser@^10.0.0: - version "10.1.0" - resolved "https://registry.npmjs.org/yargs-parser/-/yargs-parser-10.1.0.tgz#7202265b89f7e9e9f2e5765e0fe735a905edbaa8" - integrity sha512-VCIyR1wJoEBZUqk5PA+oOBF6ypbwh5aNB3I50guxAL/quggdfs4TtNHQrSazFA3fYZ+tEqfs0zIGlv0c/rgjbQ== - dependencies: - camelcase "^4.1.0" - yargs-parser@^15.0.1: version "15.0.1" resolved "https://registry.npmjs.org/yargs-parser/-/yargs-parser-15.0.1.tgz#54786af40b820dcb2fb8025b11b4d659d76323b3" @@ -16471,10 +16520,10 @@ yargs-parser@^18.1.2, yargs-parser@^18.1.3: camelcase "^5.0.0" decamelize "^1.2.0" -yargs-parser@^20.0.0: - version "20.2.1" - resolved "https://registry.npmjs.org/yargs-parser/-/yargs-parser-20.2.1.tgz#28f3773c546cdd8a69ddae68116b48a5da328e77" - integrity sha512-yYsjuSkjbLMBp16eaOt7/siKTjNVjMm3SoJnIg3sEh/JsvqVVDyjRKmaJV4cl+lNIgq6QEco2i3gDebJl7/vLA== +yargs-parser@^20.2.2: + version "20.2.3" + resolved "https://registry.npmjs.org/yargs-parser/-/yargs-parser-20.2.3.tgz#92419ba867b858c868acf8bae9bf74af0dd0ce26" + integrity sha512-emOFRT9WVHw03QSvN5qor9QQT9+sw5vwxfYweivSMHTcAXPefwVae2FjO7JJjj8hCE4CzPOPeFM83VwT29HCww== yargs-unparser@1.6.0: version "1.6.0" @@ -16501,18 +16550,18 @@ yargs@13.3.2, yargs@^13.3.0: y18n "^4.0.0" yargs-parser "^13.1.2" -yargs@16.0.3: - version "16.0.3" - resolved "https://registry.npmjs.org/yargs/-/yargs-16.0.3.tgz#7a919b9e43c90f80d4a142a89795e85399a7e54c" - integrity sha512-6+nLw8xa9uK1BOEOykaiYAJVh6/CjxWXK/q9b5FpRgNslt8s22F2xMBqVIKgCRjNgGvGPBy8Vog7WN7yh4amtA== +yargs@16.1.0: + version "16.1.0" + resolved "https://registry.npmjs.org/yargs/-/yargs-16.1.0.tgz#fc333fe4791660eace5a894b39d42f851cd48f2a" + integrity sha512-upWFJOmDdHN0syLuESuvXDmrRcWd1QafJolHskzaw79uZa7/x53gxQKiR07W59GWY1tFhhU/Th9DrtSfpS782g== dependencies: - cliui "^7.0.0" - escalade "^3.0.2" + cliui "^7.0.2" + escalade "^3.1.1" get-caller-file "^2.0.5" require-directory "^2.1.1" string-width "^4.2.0" - y18n "^5.0.1" - yargs-parser "^20.0.0" + y18n "^5.0.2" + yargs-parser "^20.2.2" yargs@^14.2.2: version "14.2.3" From fc358f6e4650545428fbab889ae12ddfe0c9c204 Mon Sep 17 00:00:00 2001 From: Google Open Source Bot <26440463+google-oss-bot@users.noreply.github.com> Date: Thu, 5 Nov 2020 11:09:52 -0800 Subject: [PATCH 069/624] Version Packages (#4033) Co-authored-by: github-actions[bot] --- .changeset/fluffy-panthers-hide.md | 6 ------ .changeset/fuzzy-impalas-brake.md | 5 ----- .changeset/lazy-elephants-suffer.md | 5 ----- .changeset/my-random-name.md | 6 ------ integration/firebase/package.json | 2 +- integration/firestore/package.json | 4 ++-- integration/messaging/package.json | 2 +- packages-exp/app-compat/package.json | 4 ++-- packages-exp/app-exp/package.json | 4 ++-- packages-exp/auth-compat-exp/package.json | 4 ++-- packages-exp/auth-exp/package.json | 4 ++-- packages-exp/firebase-exp/package.json | 2 +- packages-exp/functions-compat/package.json | 10 ++++----- packages-exp/functions-exp/package.json | 4 ++-- packages-exp/installations-exp/package.json | 4 ++-- packages-exp/performance-exp/package.json | 4 ++-- packages-exp/remote-config-exp/package.json | 4 ++-- packages/analytics/CHANGELOG.md | 9 ++++++++ packages/analytics/package.json | 10 ++++----- packages/app/CHANGELOG.md | 8 +++++++ packages/app/package.json | 6 +++--- packages/component/CHANGELOG.md | 7 ++++++ packages/component/package.json | 4 ++-- packages/database/CHANGELOG.md | 8 +++++++ packages/database/package.json | 8 +++---- packages/firebase/CHANGELOG.md | 17 +++++++++++++++ packages/firebase/package.json | 24 ++++++++++----------- packages/firestore/CHANGELOG.md | 10 +++++++++ packages/firestore/package.json | 8 +++---- packages/functions/CHANGELOG.md | 7 ++++++ packages/functions/package.json | 8 +++---- packages/installations/CHANGELOG.md | 8 +++++++ packages/installations/package.json | 8 +++---- packages/messaging/CHANGELOG.md | 11 ++++++++++ packages/messaging/package.json | 10 ++++----- packages/performance/CHANGELOG.md | 9 ++++++++ packages/performance/package.json | 10 ++++----- packages/remote-config/CHANGELOG.md | 9 ++++++++ packages/remote-config/package.json | 10 ++++----- packages/rules-unit-testing/CHANGELOG.md | 12 +++++++++++ packages/rules-unit-testing/package.json | 6 +++--- packages/rxfire/package.json | 2 +- packages/storage/CHANGELOG.md | 8 +++++++ packages/storage/package.json | 8 +++---- packages/template/package.json | 2 +- packages/util/CHANGELOG.md | 6 ++++++ packages/util/package.json | 2 +- repo-scripts/size-analysis/package.json | 4 ++-- 48 files changed, 219 insertions(+), 114 deletions(-) delete mode 100644 .changeset/fluffy-panthers-hide.md delete mode 100644 .changeset/fuzzy-impalas-brake.md delete mode 100644 .changeset/lazy-elephants-suffer.md delete mode 100644 .changeset/my-random-name.md diff --git a/.changeset/fluffy-panthers-hide.md b/.changeset/fluffy-panthers-hide.md deleted file mode 100644 index 6a62355c638..00000000000 --- a/.changeset/fluffy-panthers-hide.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'@firebase/messaging': patch ---- - -Adds a timeout for `onBackgroundMessage` hook so that silent-push warnings won't show if `showNotification` is called inside the hook within 1s. -This fixes the issue where the silent-push warning is displayed along with the message shown with [ServiceWorkerRegistration.showNotification](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/showNotification). diff --git a/.changeset/fuzzy-impalas-brake.md b/.changeset/fuzzy-impalas-brake.md deleted file mode 100644 index 5f171a2958e..00000000000 --- a/.changeset/fuzzy-impalas-brake.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@firebase/util": patch ---- - -Do not merge `__proto__` in `deepExtend` to prevent `__proto__` pollution. diff --git a/.changeset/lazy-elephants-suffer.md b/.changeset/lazy-elephants-suffer.md deleted file mode 100644 index 0343b48f493..00000000000 --- a/.changeset/lazy-elephants-suffer.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@firebase/rules-unit-testing': minor ---- - -Add withFunctionTriggersDisabled function which runs a user-provided setup function with emulated Cloud Functions triggers disabled. This can be used to import data into the Realtime Database or Cloud Firestore emulators without triggering locally emulated Cloud Functions. This method only works with Firebase CLI version 8.13.0 or higher. diff --git a/.changeset/my-random-name.md b/.changeset/my-random-name.md deleted file mode 100644 index 317726cb720..00000000000 --- a/.changeset/my-random-name.md +++ /dev/null @@ -1,6 +0,0 @@ - ---- -"@firebase/firestore": patch ---- - -Internal changes to support upcoming modular API. diff --git a/integration/firebase/package.json b/integration/firebase/package.json index b4c4d643db1..9722fed65e1 100644 --- a/integration/firebase/package.json +++ b/integration/firebase/package.json @@ -7,7 +7,7 @@ "test:ci": "node ../../scripts/run_tests_in_ci.js -s test" }, "devDependencies": { - "firebase": "8.0.0", + "firebase": "8.0.1", "@types/chai": "4.2.13", "@types/mocha": "7.0.2", "chai": "4.2.0", diff --git a/integration/firestore/package.json b/integration/firestore/package.json index ad425809985..87a7b0fd3c4 100644 --- a/integration/firestore/package.json +++ b/integration/firestore/package.json @@ -14,8 +14,8 @@ "test:memory:debug": "yarn build:memory; karma start --auto-watch --browsers Chrome" }, "devDependencies": { - "@firebase/app": "0.6.12", - "@firebase/firestore": "2.0.0", + "@firebase/app": "0.6.13", + "@firebase/firestore": "2.0.1", "@types/mocha": "7.0.2", "gulp": "4.0.2", "gulp-filter": "6.0.0", diff --git a/integration/messaging/package.json b/integration/messaging/package.json index 6485e723a61..5eb8367f0de 100644 --- a/integration/messaging/package.json +++ b/integration/messaging/package.json @@ -9,7 +9,7 @@ "test:manual": "mocha --exit" }, "devDependencies": { - "firebase": "8.0.0", + "firebase": "8.0.1", "chai": "4.2.0", "chromedriver": "86.0.0", "express": "4.17.1", diff --git a/packages-exp/app-compat/package.json b/packages-exp/app-compat/package.json index 1fc5d2b1cc3..35bb0e4ddf6 100644 --- a/packages-exp/app-compat/package.json +++ b/packages-exp/app-compat/package.json @@ -29,9 +29,9 @@ "license": "Apache-2.0", "dependencies": { "@firebase/app-exp": "0.0.800", - "@firebase/util": "0.3.3", + "@firebase/util": "0.3.4", "@firebase/logger": "0.2.6", - "@firebase/component": "0.1.20", + "@firebase/component": "0.1.21", "tslib": "^1.11.1", "dom-storage": "2.1.0", "xmlhttprequest": "1.8.0" diff --git a/packages-exp/app-exp/package.json b/packages-exp/app-exp/package.json index 99fd7a615d6..f3cf8e4b4d8 100644 --- a/packages-exp/app-exp/package.json +++ b/packages-exp/app-exp/package.json @@ -31,9 +31,9 @@ }, "dependencies": { "@firebase/app-types-exp": "0.0.800", - "@firebase/util": "0.3.3", + "@firebase/util": "0.3.4", "@firebase/logger": "0.2.6", - "@firebase/component": "0.1.20", + "@firebase/component": "0.1.21", "tslib": "^1.11.1" }, "license": "Apache-2.0", diff --git a/packages-exp/auth-compat-exp/package.json b/packages-exp/auth-compat-exp/package.json index 81b1357cd24..208157a7d16 100644 --- a/packages-exp/auth-compat-exp/package.json +++ b/packages-exp/auth-compat-exp/package.json @@ -30,8 +30,8 @@ "@firebase/auth-types": "0.10.1", "@firebase/auth-exp": "0.0.800", "@firebase/auth-types-exp": "0.0.800", - "@firebase/component": "0.1.20", - "@firebase/util": "0.3.3", + "@firebase/component": "0.1.21", + "@firebase/util": "0.3.4", "tslib": "^1.11.1" }, "license": "Apache-2.0", diff --git a/packages-exp/auth-exp/package.json b/packages-exp/auth-exp/package.json index 77c7052ad91..bcc31214302 100644 --- a/packages-exp/auth-exp/package.json +++ b/packages-exp/auth-exp/package.json @@ -39,8 +39,8 @@ }, "dependencies": { "@firebase/logger": "0.2.6", - "@firebase/util": "0.3.3", - "@firebase/component": "0.1.20", + "@firebase/util": "0.3.4", + "@firebase/component": "0.1.21", "@firebase/auth-types-exp": "0.0.800", "node-fetch": "2.6.1", "tslib": "^1.11.1" diff --git a/packages-exp/firebase-exp/package.json b/packages-exp/firebase-exp/package.json index 22bd7538462..a36595f5a14 100644 --- a/packages-exp/firebase-exp/package.json +++ b/packages-exp/firebase-exp/package.json @@ -41,7 +41,7 @@ "@firebase/app-compat": "0.0.800", "@firebase/auth-exp": "0.0.800", "@firebase/functions-exp": "0.0.800", - "@firebase/firestore": "2.0.0", + "@firebase/firestore": "2.0.1", "@firebase/performance-exp": "0.0.800" }, "devDependencies": { diff --git a/packages-exp/functions-compat/package.json b/packages-exp/functions-compat/package.json index 4ea817f5fca..ddc62d6ca9a 100644 --- a/packages-exp/functions-compat/package.json +++ b/packages-exp/functions-compat/package.json @@ -8,9 +8,7 @@ "browser": "dist/index.esm5.js", "module": "dist/index.esm5.js", "esm2017": "dist/index.esm2017.js", - "files": [ - "dist" - ], + "files": ["dist"], "license": "Apache-2.0", "peerDependencies": { "@firebase/app-compat": "0.x" @@ -48,11 +46,11 @@ }, "typings": "dist/functions-compat-public.d.ts", "dependencies": { - "@firebase/component": "0.1.20", + "@firebase/component": "0.1.21", "@firebase/functions-exp": "0.0.800", "@firebase/functions-types-exp": "0.0.800", "@firebase/messaging-types": "0.5.0", - "@firebase/util": "0.3.3", + "@firebase/util": "0.3.4", "tslib": "^1.11.1" }, "nyc": { @@ -61,4 +59,4 @@ ], "reportDir": "./coverage/node" } -} \ No newline at end of file +} diff --git a/packages-exp/functions-exp/package.json b/packages-exp/functions-exp/package.json index 9d883f5fa87..24382963f8f 100644 --- a/packages-exp/functions-exp/package.json +++ b/packages-exp/functions-exp/package.json @@ -51,10 +51,10 @@ }, "typings": "dist/functions-exp-public.d.ts", "dependencies": { - "@firebase/component": "0.1.20", + "@firebase/component": "0.1.21", "@firebase/functions-types-exp": "0.0.800", "@firebase/messaging-types": "0.5.0", - "@firebase/util": "0.3.3", + "@firebase/util": "0.3.4", "node-fetch": "2.6.1", "tslib": "^1.11.1" }, diff --git a/packages-exp/installations-exp/package.json b/packages-exp/installations-exp/package.json index 743924504f2..789afa23248 100644 --- a/packages-exp/installations-exp/package.json +++ b/packages-exp/installations-exp/package.json @@ -55,8 +55,8 @@ }, "dependencies": { "@firebase/installations-types-exp": "0.0.800", - "@firebase/util": "0.3.3", - "@firebase/component": "0.1.20", + "@firebase/util": "0.3.4", + "@firebase/component": "0.1.21", "idb": "3.0.2", "tslib": "^1.11.1" } diff --git a/packages-exp/performance-exp/package.json b/packages-exp/performance-exp/package.json index 7522cb4a9bc..8d155468087 100644 --- a/packages-exp/performance-exp/package.json +++ b/packages-exp/performance-exp/package.json @@ -34,9 +34,9 @@ "dependencies": { "@firebase/logger": "0.2.6", "@firebase/installations-exp": "0.0.800", - "@firebase/util": "0.3.3", + "@firebase/util": "0.3.4", "@firebase/performance-types-exp": "0.0.800", - "@firebase/component": "0.1.20", + "@firebase/component": "0.1.21", "tslib": "^1.11.1" }, "license": "Apache-2.0", diff --git a/packages-exp/remote-config-exp/package.json b/packages-exp/remote-config-exp/package.json index 407dc6ee6b9..0278692f3f8 100644 --- a/packages-exp/remote-config-exp/package.json +++ b/packages-exp/remote-config-exp/package.json @@ -35,8 +35,8 @@ "@firebase/installations-exp": "0.0.800", "@firebase/logger": "0.2.6", "@firebase/remote-config-types-exp": "0.0.800", - "@firebase/util": "0.3.3", - "@firebase/component": "0.1.20", + "@firebase/util": "0.3.4", + "@firebase/component": "0.1.21", "tslib": "^1.11.1" }, "license": "Apache-2.0", diff --git a/packages/analytics/CHANGELOG.md b/packages/analytics/CHANGELOG.md index 639eb8890b5..c88b5b8c751 100644 --- a/packages/analytics/CHANGELOG.md +++ b/packages/analytics/CHANGELOG.md @@ -1,5 +1,14 @@ # @firebase/analytics +## 0.6.2 + +### Patch Changes + +- Updated dependencies [[`9cf727fcc`](https://github.com/firebase/firebase-js-sdk/commit/9cf727fcc3d049551b16ae0698ac33dc2fe45ada)]: + - @firebase/util@0.3.4 + - @firebase/component@0.1.21 + - @firebase/installations@0.4.19 + ## 0.6.1 ### Patch Changes diff --git a/packages/analytics/package.json b/packages/analytics/package.json index 27af462bdf0..045ddebd323 100644 --- a/packages/analytics/package.json +++ b/packages/analytics/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/analytics", - "version": "0.6.1", + "version": "0.6.2", "description": "A analytics package for new firebase packages", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.cjs.js", @@ -26,15 +26,15 @@ }, "dependencies": { "@firebase/analytics-types": "0.4.0", - "@firebase/installations": "0.4.18", + "@firebase/installations": "0.4.19", "@firebase/logger": "0.2.6", - "@firebase/util": "0.3.3", - "@firebase/component": "0.1.20", + "@firebase/util": "0.3.4", + "@firebase/component": "0.1.21", "tslib": "^1.11.1" }, "license": "Apache-2.0", "devDependencies": { - "@firebase/app": "0.6.12", + "@firebase/app": "0.6.13", "rollup": "2.29.0", "@rollup/plugin-commonjs": "15.1.0", "@rollup/plugin-json": "4.1.0", diff --git a/packages/app/CHANGELOG.md b/packages/app/CHANGELOG.md index 2c78b864bb6..42fef2f48ca 100644 --- a/packages/app/CHANGELOG.md +++ b/packages/app/CHANGELOG.md @@ -1,5 +1,13 @@ # @firebase/app +## 0.6.13 + +### Patch Changes + +- Updated dependencies [[`9cf727fcc`](https://github.com/firebase/firebase-js-sdk/commit/9cf727fcc3d049551b16ae0698ac33dc2fe45ada)]: + - @firebase/util@0.3.4 + - @firebase/component@0.1.21 + ## 0.6.12 ### Patch Changes diff --git a/packages/app/package.json b/packages/app/package.json index a3e7d2a3829..6f5dff768bd 100644 --- a/packages/app/package.json +++ b/packages/app/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/app", - "version": "0.6.12", + "version": "0.6.13", "description": "The primary entrypoint to the Firebase JS SDK", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.node.cjs.js", @@ -28,9 +28,9 @@ "license": "Apache-2.0", "dependencies": { "@firebase/app-types": "0.6.1", - "@firebase/util": "0.3.3", + "@firebase/util": "0.3.4", "@firebase/logger": "0.2.6", - "@firebase/component": "0.1.20", + "@firebase/component": "0.1.21", "tslib": "^1.11.1", "dom-storage": "2.1.0", "xmlhttprequest": "1.8.0" diff --git a/packages/component/CHANGELOG.md b/packages/component/CHANGELOG.md index 4b2c6ceacec..445a00f18bc 100644 --- a/packages/component/CHANGELOG.md +++ b/packages/component/CHANGELOG.md @@ -1,5 +1,12 @@ # @firebase/component +## 0.1.21 + +### Patch Changes + +- Updated dependencies [[`9cf727fcc`](https://github.com/firebase/firebase-js-sdk/commit/9cf727fcc3d049551b16ae0698ac33dc2fe45ada)]: + - @firebase/util@0.3.4 + ## 0.1.20 ### Patch Changes diff --git a/packages/component/package.json b/packages/component/package.json index ce99acd8602..7f089504979 100644 --- a/packages/component/package.json +++ b/packages/component/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/component", - "version": "0.1.20", + "version": "0.1.21", "description": "Firebase Component Platform", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.cjs.js", @@ -22,7 +22,7 @@ "prepare": "yarn build" }, "dependencies": { - "@firebase/util": "0.3.3", + "@firebase/util": "0.3.4", "tslib": "^1.11.1" }, "license": "Apache-2.0", diff --git a/packages/database/CHANGELOG.md b/packages/database/CHANGELOG.md index 6a6604a2c46..49dbf9c32df 100644 --- a/packages/database/CHANGELOG.md +++ b/packages/database/CHANGELOG.md @@ -1,5 +1,13 @@ # Unreleased +## 0.7.1 + +### Patch Changes + +- Updated dependencies [[`9cf727fcc`](https://github.com/firebase/firebase-js-sdk/commit/9cf727fcc3d049551b16ae0698ac33dc2fe45ada)]: + - @firebase/util@0.3.4 + - @firebase/component@0.1.21 + ## 0.7.0 ### Minor Changes diff --git a/packages/database/package.json b/packages/database/package.json index 2139ecb319a..942f049ce82 100644 --- a/packages/database/package.json +++ b/packages/database/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/database", - "version": "0.7.0", + "version": "0.7.1", "description": "", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.node.cjs.js", @@ -27,14 +27,14 @@ "dependencies": { "@firebase/database-types": "0.6.0", "@firebase/logger": "0.2.6", - "@firebase/util": "0.3.3", - "@firebase/component": "0.1.20", + "@firebase/util": "0.3.4", + "@firebase/component": "0.1.21", "@firebase/auth-interop-types": "0.1.5", "faye-websocket": "0.11.3", "tslib": "^1.11.1" }, "devDependencies": { - "@firebase/app": "0.6.12", + "@firebase/app": "0.6.13", "@firebase/app-types": "0.6.1", "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", diff --git a/packages/firebase/CHANGELOG.md b/packages/firebase/CHANGELOG.md index 097b2b54644..2491c4817d3 100644 --- a/packages/firebase/CHANGELOG.md +++ b/packages/firebase/CHANGELOG.md @@ -1,5 +1,22 @@ # firebase +## 8.0.1 + +### Patch Changes + +- Updated dependencies [[`54a46f89c`](https://github.com/firebase/firebase-js-sdk/commit/54a46f89c1c45435c76412fa2ed296e986c2f6ab), [`9cf727fcc`](https://github.com/firebase/firebase-js-sdk/commit/9cf727fcc3d049551b16ae0698ac33dc2fe45ada), [`007ddd1eb`](https://github.com/firebase/firebase-js-sdk/commit/007ddd1eb6be0a66df7b1c3264d8dff8857d8399)]: + - @firebase/messaging@0.7.3 + - @firebase/util@0.3.4 + - @firebase/firestore@2.0.1 + - @firebase/functions@0.6.1 + - @firebase/analytics@0.6.2 + - @firebase/app@0.6.13 + - @firebase/database@0.7.1 + - @firebase/installations@0.4.19 + - @firebase/performance@0.4.4 + - @firebase/remote-config@0.1.30 + - @firebase/storage@0.4.1 + ## 8.0.0 ### Major Changes diff --git a/packages/firebase/package.json b/packages/firebase/package.json index 30e9cd7d507..bb88fe4281b 100644 --- a/packages/firebase/package.json +++ b/packages/firebase/package.json @@ -1,6 +1,6 @@ { "name": "firebase", - "version": "8.0.0", + "version": "8.0.1", "description": "Firebase JavaScript library for web and Node.js", "author": "Firebase (https://firebase.google.com/)", "license": "Apache-2.0", @@ -45,20 +45,20 @@ "module": "dist/index.esm.js", "react-native": "dist/index.rn.cjs.js", "dependencies": { - "@firebase/app": "0.6.12", + "@firebase/app": "0.6.13", "@firebase/app-types": "0.6.1", "@firebase/auth": "0.15.1", - "@firebase/database": "0.7.0", - "@firebase/firestore": "2.0.0", - "@firebase/functions": "0.6.0", - "@firebase/installations": "0.4.18", - "@firebase/messaging": "0.7.2", + "@firebase/database": "0.7.1", + "@firebase/firestore": "2.0.1", + "@firebase/functions": "0.6.1", + "@firebase/installations": "0.4.19", + "@firebase/messaging": "0.7.3", "@firebase/polyfill": "0.3.36", - "@firebase/storage": "0.4.0", - "@firebase/performance": "0.4.3", - "@firebase/remote-config": "0.1.29", - "@firebase/analytics": "0.6.1", - "@firebase/util": "0.3.3" + "@firebase/storage": "0.4.1", + "@firebase/performance": "0.4.4", + "@firebase/remote-config": "0.1.30", + "@firebase/analytics": "0.6.2", + "@firebase/util": "0.3.4" }, "devDependencies": { "rollup": "2.29.0", diff --git a/packages/firestore/CHANGELOG.md b/packages/firestore/CHANGELOG.md index 01b0973d6ac..070a058da66 100644 --- a/packages/firestore/CHANGELOG.md +++ b/packages/firestore/CHANGELOG.md @@ -1,5 +1,15 @@ # @firebase/firestore +## 2.0.1 + +### Patch Changes + +- [`007ddd1eb`](https://github.com/firebase/firebase-js-sdk/commit/007ddd1eb6be0a66df7b1c3264d8dff8857d8399) [#4030](https://github.com/firebase/firebase-js-sdk/pull/4030) - Internal changes to support upcoming modular API. + +- Updated dependencies [[`9cf727fcc`](https://github.com/firebase/firebase-js-sdk/commit/9cf727fcc3d049551b16ae0698ac33dc2fe45ada)]: + - @firebase/util@0.3.4 + - @firebase/component@0.1.21 + ## 2.0.0 ### Major Changes diff --git a/packages/firestore/package.json b/packages/firestore/package.json index 0f3caec1929..4a081c9dc68 100644 --- a/packages/firestore/package.json +++ b/packages/firestore/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/firestore", - "version": "2.0.0", + "version": "2.0.1", "engines": { "node": "^8.13.0 || >=10.10.0" }, @@ -63,10 +63,10 @@ "memory/package.json" ], "dependencies": { - "@firebase/component": "0.1.20", + "@firebase/component": "0.1.21", "@firebase/firestore-types": "2.0.0", "@firebase/logger": "0.2.6", - "@firebase/util": "0.3.3", + "@firebase/util": "0.3.4", "@firebase/webchannel-wrapper": "0.4.0", "@grpc/grpc-js": "^1.0.0", "@grpc/proto-loader": "^0.5.0", @@ -78,7 +78,7 @@ "@firebase/app-types": "0.x" }, "devDependencies": { - "@firebase/app": "0.6.12", + "@firebase/app": "0.6.13", "@rollup/plugin-alias": "3.1.1", "@types/json-stable-stringify": "1.0.32", "json-stable-stringify": "1.0.1", diff --git a/packages/functions/CHANGELOG.md b/packages/functions/CHANGELOG.md index e9c129b0ae5..977167b621b 100644 --- a/packages/functions/CHANGELOG.md +++ b/packages/functions/CHANGELOG.md @@ -1,5 +1,12 @@ # @firebase/functions +## 0.6.1 + +### Patch Changes + +- Updated dependencies []: + - @firebase/component@0.1.21 + ## 0.6.0 ### Minor Changes diff --git a/packages/functions/package.json b/packages/functions/package.json index 4ab59582328..40878eac7b3 100644 --- a/packages/functions/package.json +++ b/packages/functions/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/functions", - "version": "0.6.0", + "version": "0.6.1", "description": "", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.node.cjs.js", @@ -29,8 +29,8 @@ "@firebase/app-types": "0.x" }, "devDependencies": { - "@firebase/app": "0.6.12", - "@firebase/messaging": "0.7.2", + "@firebase/app": "0.6.13", + "@firebase/messaging": "0.7.3", "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", "typescript": "4.0.5" @@ -45,7 +45,7 @@ }, "typings": "dist/index.d.ts", "dependencies": { - "@firebase/component": "0.1.20", + "@firebase/component": "0.1.21", "@firebase/functions-types": "0.4.0", "@firebase/messaging-types": "0.5.0", "node-fetch": "2.6.1", diff --git a/packages/installations/CHANGELOG.md b/packages/installations/CHANGELOG.md index 40c4fa57a2b..669897b68df 100644 --- a/packages/installations/CHANGELOG.md +++ b/packages/installations/CHANGELOG.md @@ -1,5 +1,13 @@ # @firebase/installations +## 0.4.19 + +### Patch Changes + +- Updated dependencies [[`9cf727fcc`](https://github.com/firebase/firebase-js-sdk/commit/9cf727fcc3d049551b16ae0698ac33dc2fe45ada)]: + - @firebase/util@0.3.4 + - @firebase/component@0.1.21 + ## 0.4.18 ### Patch Changes diff --git a/packages/installations/package.json b/packages/installations/package.json index e8019eaedaa..9926a262258 100644 --- a/packages/installations/package.json +++ b/packages/installations/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/installations", - "version": "0.4.18", + "version": "0.4.19", "main": "dist/index.cjs.js", "module": "dist/index.esm.js", "esm2017": "dist/index.esm2017.js", @@ -30,7 +30,7 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "devDependencies": { - "@firebase/app": "0.6.12", + "@firebase/app": "0.6.13", "rollup": "2.29.0", "@rollup/plugin-commonjs": "15.1.0", "@rollup/plugin-json": "4.1.0", @@ -45,8 +45,8 @@ }, "dependencies": { "@firebase/installations-types": "0.3.4", - "@firebase/util": "0.3.3", - "@firebase/component": "0.1.20", + "@firebase/util": "0.3.4", + "@firebase/component": "0.1.21", "idb": "3.0.2", "tslib": "^1.11.1" } diff --git a/packages/messaging/CHANGELOG.md b/packages/messaging/CHANGELOG.md index a4fc93fcf8d..0e54880e903 100644 --- a/packages/messaging/CHANGELOG.md +++ b/packages/messaging/CHANGELOG.md @@ -1,5 +1,16 @@ # @firebase/messaging +## 0.7.3 + +### Patch Changes + +- [`54a46f89c`](https://github.com/firebase/firebase-js-sdk/commit/54a46f89c1c45435c76412fa2ed296e986c2f6ab) [#3780](https://github.com/firebase/firebase-js-sdk/pull/3780) - Adds a timeout for `onBackgroundMessage` hook so that silent-push warnings won't show if `showNotification` is called inside the hook within 1s. + This fixes the issue where the silent-push warning is displayed along with the message shown with [ServiceWorkerRegistration.showNotification](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/showNotification). +- Updated dependencies [[`9cf727fcc`](https://github.com/firebase/firebase-js-sdk/commit/9cf727fcc3d049551b16ae0698ac33dc2fe45ada)]: + - @firebase/util@0.3.4 + - @firebase/component@0.1.21 + - @firebase/installations@0.4.19 + ## 0.7.2 ### Patch Changes diff --git a/packages/messaging/package.json b/packages/messaging/package.json index 4f890b6815a..0a0c3073600 100644 --- a/packages/messaging/package.json +++ b/packages/messaging/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/messaging", - "version": "0.7.2", + "version": "0.7.3", "description": "", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.cjs.js", @@ -26,15 +26,15 @@ "@firebase/app-types": "0.x" }, "dependencies": { - "@firebase/installations": "0.4.18", + "@firebase/installations": "0.4.19", "@firebase/messaging-types": "0.5.0", - "@firebase/util": "0.3.3", - "@firebase/component": "0.1.20", + "@firebase/util": "0.3.4", + "@firebase/component": "0.1.21", "idb": "3.0.2", "tslib": "^1.11.1" }, "devDependencies": { - "@firebase/app": "0.6.12", + "@firebase/app": "0.6.13", "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", "ts-essentials": "7.0.0", diff --git a/packages/performance/CHANGELOG.md b/packages/performance/CHANGELOG.md index cb17ae0649b..8d68150840b 100644 --- a/packages/performance/CHANGELOG.md +++ b/packages/performance/CHANGELOG.md @@ -1,5 +1,14 @@ # @firebase/performance +## 0.4.4 + +### Patch Changes + +- Updated dependencies [[`9cf727fcc`](https://github.com/firebase/firebase-js-sdk/commit/9cf727fcc3d049551b16ae0698ac33dc2fe45ada)]: + - @firebase/util@0.3.4 + - @firebase/component@0.1.21 + - @firebase/installations@0.4.19 + ## 0.4.3 ### Patch Changes diff --git a/packages/performance/package.json b/packages/performance/package.json index 9538fd0d6f3..d4d6744c736 100644 --- a/packages/performance/package.json +++ b/packages/performance/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/performance", - "version": "0.4.3", + "version": "0.4.4", "description": "Firebase performance for web", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.cjs.js", @@ -27,15 +27,15 @@ }, "dependencies": { "@firebase/logger": "0.2.6", - "@firebase/installations": "0.4.18", - "@firebase/util": "0.3.3", + "@firebase/installations": "0.4.19", + "@firebase/util": "0.3.4", "@firebase/performance-types": "0.0.13", - "@firebase/component": "0.1.20", + "@firebase/component": "0.1.21", "tslib": "^1.11.1" }, "license": "Apache-2.0", "devDependencies": { - "@firebase/app": "0.6.12", + "@firebase/app": "0.6.13", "rollup": "2.29.0", "@rollup/plugin-json": "4.1.0", "rollup-plugin-typescript2": "0.27.3", diff --git a/packages/remote-config/CHANGELOG.md b/packages/remote-config/CHANGELOG.md index 7b76a97a5a3..c9b625a74c6 100644 --- a/packages/remote-config/CHANGELOG.md +++ b/packages/remote-config/CHANGELOG.md @@ -1,5 +1,14 @@ # @firebase/remote-config +## 0.1.30 + +### Patch Changes + +- Updated dependencies [[`9cf727fcc`](https://github.com/firebase/firebase-js-sdk/commit/9cf727fcc3d049551b16ae0698ac33dc2fe45ada)]: + - @firebase/util@0.3.4 + - @firebase/component@0.1.21 + - @firebase/installations@0.4.19 + ## 0.1.29 ### Patch Changes diff --git a/packages/remote-config/package.json b/packages/remote-config/package.json index 7705a6cd462..690dd0bc9fa 100644 --- a/packages/remote-config/package.json +++ b/packages/remote-config/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/remote-config", - "version": "0.1.29", + "version": "0.1.30", "description": "The Remote Config package of the Firebase JS SDK", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.cjs.js", @@ -26,16 +26,16 @@ "@firebase/app-types": "0.x" }, "dependencies": { - "@firebase/installations": "0.4.18", + "@firebase/installations": "0.4.19", "@firebase/logger": "0.2.6", "@firebase/remote-config-types": "0.1.9", - "@firebase/util": "0.3.3", - "@firebase/component": "0.1.20", + "@firebase/util": "0.3.4", + "@firebase/component": "0.1.21", "tslib": "^1.11.1" }, "license": "Apache-2.0", "devDependencies": { - "@firebase/app": "0.6.12", + "@firebase/app": "0.6.13", "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", "typescript": "4.0.5" diff --git a/packages/rules-unit-testing/CHANGELOG.md b/packages/rules-unit-testing/CHANGELOG.md index dd1a80d052c..a7cf943b74e 100644 --- a/packages/rules-unit-testing/CHANGELOG.md +++ b/packages/rules-unit-testing/CHANGELOG.md @@ -1,5 +1,17 @@ # @firebase/rules-unit-testing +## 1.1.0 + +### Minor Changes + +- [`6ef39d4d3`](https://github.com/firebase/firebase-js-sdk/commit/6ef39d4d346e7458f1559f15f82f734dec41611b) [#3928](https://github.com/firebase/firebase-js-sdk/pull/3928) - Add withFunctionTriggersDisabled function which runs a user-provided setup function with emulated Cloud Functions triggers disabled. This can be used to import data into the Realtime Database or Cloud Firestore emulators without triggering locally emulated Cloud Functions. This method only works with Firebase CLI version 8.13.0 or higher. + +### Patch Changes + +- Updated dependencies [[`9cf727fcc`](https://github.com/firebase/firebase-js-sdk/commit/9cf727fcc3d049551b16ae0698ac33dc2fe45ada)]: + - @firebase/util@0.3.4 + - firebase@8.0.1 + ## 1.0.9 ### Patch Changes diff --git a/packages/rules-unit-testing/package.json b/packages/rules-unit-testing/package.json index fcf48018816..dac765f5e80 100644 --- a/packages/rules-unit-testing/package.json +++ b/packages/rules-unit-testing/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/rules-unit-testing", - "version": "1.0.9", + "version": "1.1.0", "description": "", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.cjs.js", @@ -19,9 +19,9 @@ }, "license": "Apache-2.0", "dependencies": { - "firebase": "8.0.0", + "firebase": "8.0.1", "@firebase/logger": "0.2.6", - "@firebase/util": "0.3.3", + "@firebase/util": "0.3.4", "request": "2.88.2" }, "devDependencies": { diff --git a/packages/rxfire/package.json b/packages/rxfire/package.json index 05edbd306f1..481866c7e88 100644 --- a/packages/rxfire/package.json +++ b/packages/rxfire/package.json @@ -40,7 +40,7 @@ "rxjs": "6.x.x" }, "devDependencies": { - "firebase": "8.0.0", + "firebase": "8.0.1", "rollup": "2.29.0", "@rollup/plugin-commonjs": "15.1.0", "@rollup/plugin-node-resolve": "9.0.0", diff --git a/packages/storage/CHANGELOG.md b/packages/storage/CHANGELOG.md index 45a9c9df684..82d3ee39283 100644 --- a/packages/storage/CHANGELOG.md +++ b/packages/storage/CHANGELOG.md @@ -1,5 +1,13 @@ #Unreleased +## 0.4.1 + +### Patch Changes + +- Updated dependencies [[`9cf727fcc`](https://github.com/firebase/firebase-js-sdk/commit/9cf727fcc3d049551b16ae0698ac33dc2fe45ada)]: + - @firebase/util@0.3.4 + - @firebase/component@0.1.21 + ## 0.4.0 ### Minor Changes diff --git a/packages/storage/package.json b/packages/storage/package.json index 86a5291aadf..45f18fc19e5 100644 --- a/packages/storage/package.json +++ b/packages/storage/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/storage", - "version": "0.4.0", + "version": "0.4.1", "description": "", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.cjs.js", @@ -24,8 +24,8 @@ "license": "Apache-2.0", "dependencies": { "@firebase/storage-types": "0.3.13", - "@firebase/util": "0.3.3", - "@firebase/component": "0.1.20", + "@firebase/util": "0.3.4", + "@firebase/component": "0.1.21", "tslib": "^1.11.1" }, "peerDependencies": { @@ -33,7 +33,7 @@ "@firebase/app-types": "0.x" }, "devDependencies": { - "@firebase/app": "0.6.12", + "@firebase/app": "0.6.13", "@firebase/auth": "0.15.1", "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", diff --git a/packages/template/package.json b/packages/template/package.json index 85b5e666d94..682949f8e0c 100644 --- a/packages/template/package.json +++ b/packages/template/package.json @@ -32,7 +32,7 @@ }, "license": "Apache-2.0", "devDependencies": { - "@firebase/app": "0.6.12", + "@firebase/app": "0.6.13", "rollup": "2.29.0", "rollup-plugin-typescript2": "0.27.3", "typescript": "4.0.5" diff --git a/packages/util/CHANGELOG.md b/packages/util/CHANGELOG.md index 165a29da248..7ff60bb6186 100644 --- a/packages/util/CHANGELOG.md +++ b/packages/util/CHANGELOG.md @@ -1,5 +1,11 @@ # @firebase/util +## 0.3.4 + +### Patch Changes + +- [`9cf727fcc`](https://github.com/firebase/firebase-js-sdk/commit/9cf727fcc3d049551b16ae0698ac33dc2fe45ada) [#4001](https://github.com/firebase/firebase-js-sdk/pull/4001) - Do not merge `__proto__` in `deepExtend` to prevent `__proto__` pollution. + ## 0.3.3 ### Patch Changes diff --git a/packages/util/package.json b/packages/util/package.json index 632859ae8ee..60684678b85 100644 --- a/packages/util/package.json +++ b/packages/util/package.json @@ -1,6 +1,6 @@ { "name": "@firebase/util", - "version": "0.3.3", + "version": "0.3.4", "description": "", "author": "Firebase (https://firebase.google.com/)", "main": "dist/index.node.cjs.js", diff --git a/repo-scripts/size-analysis/package.json b/repo-scripts/size-analysis/package.json index f46e702bae0..2d1fc146bdc 100644 --- a/repo-scripts/size-analysis/package.json +++ b/repo-scripts/size-analysis/package.json @@ -32,13 +32,13 @@ "typescript": "4.0.5", "terser": "5.3.5", "yargs": "16.0.3", - "@firebase/util": "0.3.3", + "@firebase/util": "0.3.4", "gzip-size": "5.1.1" }, "license": "Apache-2.0", "devDependencies": { "@firebase/logger": "0.2.6", - "@firebase/app": "0.6.12" + "@firebase/app": "0.6.13" }, "repository": { "directory": "repo-scripts/size-analysis", From f9dc50e3520d50b70eecd28b81887e0053f9f636 Mon Sep 17 00:00:00 2001 From: Christina Holland Date: Thu, 5 Nov 2020 16:40:49 -0800 Subject: [PATCH 070/624] Set up Storage modularization (#3499) Refactor storage for modularization. --- .changeset/silly-boats-roll.md | 5 + config/.eslintrc.js | 2 +- packages/storage/.eslintrc.js | 6 +- packages/storage/api-extractor.json | 10 + packages/storage/compat/index.ts | 109 ++++ packages/storage/compat/list.ts | 42 ++ packages/storage/compat/reference.ts | 215 ++++++++ packages/storage/compat/service.ts | 89 +++ packages/storage/compat/task.ts | 107 ++++ packages/storage/compat/tasksnapshot.ts | 43 ++ packages/storage/exp/index.ts | 78 +++ packages/storage/exp/package.json | 12 + packages/storage/karma.conf.js | 2 - packages/storage/package.json | 14 +- packages/storage/rollup.config.compat.js | 77 +++ packages/storage/rollup.config.exp.js | 68 +++ .../storage/src/implementation/backoff.ts | 6 - packages/storage/src/implementation/blob.ts | 2 +- packages/storage/src/implementation/error.ts | 32 +- .../storage/src/implementation/failrequest.ts | 2 - packages/storage/src/implementation/fs.ts | 6 +- .../storage/src/implementation/location.ts | 10 +- .../storage/src/implementation/metadata.ts | 7 +- .../storage/src/implementation/observer.ts | 51 +- .../storage/src/implementation/request.ts | 17 +- .../storage/src/implementation/requests.ts | 1 - packages/storage/src/implementation/string.ts | 26 +- .../storage/src/implementation/taskenums.ts | 3 - packages/storage/src/implementation/type.ts | 7 - packages/storage/src/implementation/url.ts | 1 - packages/storage/src/implementation/xhrio.ts | 6 +- .../src/implementation/xhrio_network.ts | 25 +- packages/storage/src/list.ts | 16 +- packages/storage/src/metadata.ts | 16 +- packages/storage/src/reference.ts | 506 +++++++++--------- packages/storage/src/service.ts | 327 +++++------ packages/storage/src/task.ts | 482 +++++++++-------- packages/storage/src/tasksnapshot.ts | 2 +- .../test/integration/integration.test.ts | 2 +- ...rence.test.ts => reference.compat.test.ts} | 219 +++----- .../storage/test/unit/reference.exp.test.ts | 306 +++++++++++ ...service.test.ts => service.compat.test.ts} | 150 +++--- .../storage/test/unit/service.exp.test.ts | 321 +++++++++++ packages/storage/test/unit/task.test.ts | 77 ++- packages/storage/test/unit/testshared.ts | 9 +- packages/storage/test/unit/xhrio.ts | 11 +- 46 files changed, 2470 insertions(+), 1055 deletions(-) create mode 100644 .changeset/silly-boats-roll.md create mode 100644 packages/storage/api-extractor.json create mode 100644 packages/storage/compat/index.ts create mode 100644 packages/storage/compat/list.ts create mode 100644 packages/storage/compat/reference.ts create mode 100644 packages/storage/compat/service.ts create mode 100644 packages/storage/compat/task.ts create mode 100644 packages/storage/compat/tasksnapshot.ts create mode 100644 packages/storage/exp/index.ts create mode 100644 packages/storage/exp/package.json create mode 100644 packages/storage/rollup.config.compat.js create mode 100644 packages/storage/rollup.config.exp.js rename packages/storage/test/unit/{reference.test.ts => reference.compat.test.ts} (56%) create mode 100644 packages/storage/test/unit/reference.exp.test.ts rename packages/storage/test/unit/{service.test.ts => service.compat.test.ts} (72%) create mode 100644 packages/storage/test/unit/service.exp.test.ts diff --git a/.changeset/silly-boats-roll.md b/.changeset/silly-boats-roll.md new file mode 100644 index 00000000000..b27cd48f2b0 --- /dev/null +++ b/.changeset/silly-boats-roll.md @@ -0,0 +1,5 @@ +--- +'@firebase/storage': patch +--- + +Refactored Storage to allow for modularization. diff --git a/config/.eslintrc.js b/config/.eslintrc.js index a7c60820a24..0c84ff67a9a 100644 --- a/config/.eslintrc.js +++ b/config/.eslintrc.js @@ -184,7 +184,7 @@ module.exports = { 'assertionStyle': 'as' } ], - '@typescript-eslint/no-explicit-any': 'error', + '@typescript-eslint/no-explicit-any': ['error', { 'ignoreRestArgs': true }], '@typescript-eslint/no-namespace': [ 'error', { diff --git a/packages/storage/.eslintrc.js b/packages/storage/.eslintrc.js index e636d931c1f..00bf88df31c 100644 --- a/packages/storage/.eslintrc.js +++ b/packages/storage/.eslintrc.js @@ -37,7 +37,11 @@ module.exports = { 'import/no-extraneous-dependencies': [ 'error', { - 'packageDir': [path.resolve(__dirname, '../../'), __dirname] + 'packageDir': [ + path.resolve(__dirname, '../../'), + __dirname, + path.resolve(__dirname, 'exp') + ] } ] } diff --git a/packages/storage/api-extractor.json b/packages/storage/api-extractor.json new file mode 100644 index 00000000000..c85607441f0 --- /dev/null +++ b/packages/storage/api-extractor.json @@ -0,0 +1,10 @@ +{ + "extends": "../../config/api-extractor.json", + // Point it to your entry point d.ts file. + "mainEntryPointFilePath": "/exp/dist/exp/index.d.ts", + "dtsRollup": { + "enabled": true, + "untrimmedFilePath": "/exp/dist/.d.ts", + "publicTrimmedFilePath": "/exp/dist/-public.d.ts" + } +} \ No newline at end of file diff --git a/packages/storage/compat/index.ts b/packages/storage/compat/index.ts new file mode 100644 index 00000000000..661d908fa15 --- /dev/null +++ b/packages/storage/compat/index.ts @@ -0,0 +1,109 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import firebase from '@firebase/app'; +import { _FirebaseNamespace } from '@firebase/app-types/private'; +import { StringFormat } from '../src/implementation/string'; +import { TaskEvent, TaskState } from '../src/implementation/taskenums'; + +import { XhrIoPool } from '../src/implementation/xhriopool'; +import { ReferenceCompat } from './reference'; +import { StorageServiceCompat } from './service'; +import { StorageService } from '../src/service'; +import * as types from '@firebase/storage-types'; +import { + Component, + ComponentType, + ComponentContainer +} from '@firebase/component'; + +import { name, version } from '../package.json'; + +/** + * Type constant for Firebase Storage. + */ +const STORAGE_TYPE = 'storage'; + +function factory( + container: ComponentContainer, + url?: string +): types.FirebaseStorage { + // Dependencies + // TODO: This should eventually be 'app-compat' + const app = container.getProvider('app').getImmediate(); + const authProvider = container.getProvider('auth-internal'); + + // TODO: get StorageService instance from component framework instead + // of creating a new one. + const storageServiceCompat: StorageServiceCompat = new StorageServiceCompat( + app, + new StorageService(app, authProvider, new XhrIoPool(), url) + ); + return storageServiceCompat; +} + +export function registerStorage(instance: _FirebaseNamespace): void { + const namespaceExports = { + // no-inline + TaskState, + TaskEvent, + StringFormat, + Storage: StorageService, + Reference: ReferenceCompat + }; + instance.INTERNAL.registerComponent( + new Component(STORAGE_TYPE, factory, ComponentType.PUBLIC) + .setServiceProps(namespaceExports) + .setMultipleInstances(true) + ); + + instance.registerVersion(name, version); +} + +registerStorage(firebase as _FirebaseNamespace); + +/** + * Define extension behavior for `registerStorage` + */ +declare module '@firebase/app-types' { + interface FirebaseNamespace { + storage?: { + (app?: FirebaseApp): types.FirebaseStorage; + Storage: typeof types.FirebaseStorage; + + StringFormat: { + BASE64: types.StringFormat; + BASE64URL: types.StringFormat; + DATA_URL: types.StringFormat; + RAW: types.StringFormat; + }; + TaskEvent: { + STATE_CHANGED: types.TaskEvent; + }; + TaskState: { + CANCELED: types.TaskState; + ERROR: types.TaskState; + PAUSED: types.TaskState; + RUNNING: types.TaskState; + SUCCESS: types.TaskState; + }; + }; + } + interface FirebaseApp { + storage?(storageBucket?: string): types.FirebaseStorage; + } +} diff --git a/packages/storage/compat/list.ts b/packages/storage/compat/list.ts new file mode 100644 index 00000000000..46553b924f0 --- /dev/null +++ b/packages/storage/compat/list.ts @@ -0,0 +1,42 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import * as types from '@firebase/storage-types'; +import { ListResult } from '../src/list'; +import { ReferenceCompat } from './reference'; +import { StorageServiceCompat } from './service'; + +export class ListResultCompat implements types.ListResult { + constructor( + private readonly _delegate: ListResult, + private readonly _service: StorageServiceCompat + ) {} + + get prefixes(): ReferenceCompat[] { + return this._delegate.prefixes.map( + ref => new ReferenceCompat(ref, this._service) + ); + } + get items(): ReferenceCompat[] { + return this._delegate.items.map( + ref => new ReferenceCompat(ref, this._service) + ); + } + get nextPageToken(): string | null { + return this._delegate.nextPageToken || null; + } +} diff --git a/packages/storage/compat/reference.ts b/packages/storage/compat/reference.ts new file mode 100644 index 00000000000..bacace86ade --- /dev/null +++ b/packages/storage/compat/reference.ts @@ -0,0 +1,215 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { + Reference, + getChild, + uploadBytesResumable, + uploadString, + list, + listAll, + getDownloadURL, + getMetadata, + updateMetadata, + deleteObject +} from '../src/reference'; +import * as types from '@firebase/storage-types'; +import { Metadata } from '../src/metadata'; +import { StringFormat } from '../src/implementation/string'; +import { ListOptions } from '../src/list'; +import { UploadTaskCompat } from './task'; +import { ListResultCompat } from './list'; +import { StorageServiceCompat } from './service'; +import { invalidRootOperation } from '../src/implementation/error'; + +export class ReferenceCompat implements types.Reference { + constructor( + private readonly _delegate: Reference, + public storage: StorageServiceCompat + ) {} + + get name(): string { + return this._delegate.name; + } + + get bucket(): string { + return this._delegate.bucket; + } + + get fullPath(): string { + return this._delegate.fullPath; + } + + toString(): string { + return this._delegate.toString(); + } + + /** + * @returns A reference to the object obtained by + * appending childPath, removing any duplicate, beginning, or trailing + * slashes. + */ + child(childPath: string): types.Reference { + const reference = getChild(this._delegate, childPath); + return new ReferenceCompat(reference, this.storage); + } + + get root(): types.Reference { + return new ReferenceCompat(this._delegate.root, this.storage); + } + + /** + * @returns A reference to the parent of the + * current object, or null if the current object is the root. + */ + get parent(): types.Reference | null { + const reference = this._delegate.parent; + if (reference == null) { + return null; + } + return new ReferenceCompat(reference, this.storage); + } + + /** + * Uploads a blob to this object's location. + * @param data - The blob to upload. + * @returns An UploadTask that lets you control and + * observe the upload. + */ + put( + data: Blob | Uint8Array | ArrayBuffer, + metadata?: Metadata + ): types.UploadTask { + this._throwIfRoot('put'); + return new UploadTaskCompat( + uploadBytesResumable(this._delegate, data, metadata), + this + ); + } + + /** + * Uploads a string to this object's location. + * @param value - The string to upload. + * @param format - The format of the string to upload. + * @returns An UploadTask that lets you control and + * observe the upload. + */ + putString( + value: string, + format: StringFormat = StringFormat.RAW, + metadata?: Metadata + ): types.UploadTask { + this._throwIfRoot('putString'); + return new UploadTaskCompat( + uploadString(this._delegate, value, format, metadata), + this + ); + } + + /** + * List all items (files) and prefixes (folders) under this storage reference. + * + * This is a helper method for calling list() repeatedly until there are + * no more results. The default pagination size is 1000. + * + * Note: The results may not be consistent if objects are changed while this + * operation is running. + * + * Warning: listAll may potentially consume too many resources if there are + * too many results. + * + * @returns A Promise that resolves with all the items and prefixes under + * the current storage reference. `prefixes` contains references to + * sub-directories and `items` contains references to objects in this + * folder. `nextPageToken` is never returned. + */ + listAll(): Promise { + return listAll(this._delegate).then( + r => new ListResultCompat(r, this.storage) + ); + } + + /** + * List items (files) and prefixes (folders) under this storage reference. + * + * List API is only available for Firebase Rules Version 2. + * + * GCS is a key-blob store. Firebase Storage imposes the semantic of '/' + * delimited folder structure. Refer to GCS's List API if you want to learn more. + * + * To adhere to Firebase Rules's Semantics, Firebase Storage does not + * support objects whose paths end with "/" or contain two consecutive + * "/"s. Firebase Storage List API will filter these unsupported objects. + * list() may fail if there are too many unsupported objects in the bucket. + * + * @param options - See ListOptions for details. + * @returns A Promise that resolves with the items and prefixes. + * `prefixes` contains references to sub-folders and `items` + * contains references to objects in this folder. `nextPageToken` + * can be used to get the rest of the results. + */ + list(options?: ListOptions | null): Promise { + return list(this._delegate, options).then( + r => new ListResultCompat(r, this.storage) + ); + } + + /** + * A promise that resolves with the metadata for this object. If this + * object doesn't exist or metadata cannot be retreived, the promise is + * rejected. + */ + getMetadata(): Promise { + return getMetadata(this._delegate); + } + + /** + * Updates the metadata for this object. + * @param metadata - The new metadata for the object. + * Only values that have been explicitly set will be changed. Explicitly + * setting a value to null will remove the metadata. + * @returns A promise that resolves + * with the new metadata for this object. + * @see firebaseStorage.Reference.prototype.getMetadata + */ + updateMetadata(metadata: Metadata): Promise { + return updateMetadata(this._delegate, metadata); + } + + /** + * @returns A promise that resolves with the download + * URL for this object. + */ + getDownloadURL(): Promise { + return getDownloadURL(this._delegate); + } + + /** + * Deletes the object at this location. + * @returns A promise that resolves if the deletion succeeds. + */ + delete(): Promise { + this._throwIfRoot('delete'); + return deleteObject(this._delegate); + } + + private _throwIfRoot(name: string): void { + if (this._delegate._location.path === '') { + throw invalidRootOperation(name); + } + } +} diff --git a/packages/storage/compat/service.ts b/packages/storage/compat/service.ts new file mode 100644 index 00000000000..e6159855d45 --- /dev/null +++ b/packages/storage/compat/service.ts @@ -0,0 +1,89 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import * as types from '@firebase/storage-types'; +import { StorageService, isUrl, ref } from '../src/service'; +import { Location } from '../src/implementation/location'; +import { ReferenceCompat } from './reference'; +import { invalidArgument } from '../src/implementation/error'; +import { FirebaseApp } from '@firebase/app-types'; + +/** + * A service that provides firebaseStorage.Reference instances. + * @param opt_url gs:// url to a custom Storage Bucket + */ +export class StorageServiceCompat implements types.FirebaseStorage { + constructor(public app: FirebaseApp, readonly _delegate: StorageService) {} + + INTERNAL = { + /** + * Called when the associated app is deleted. + */ + delete: () => { + return this._delegate._delete(); + } + }; + + get maxOperationRetryTime(): number { + return this._delegate.maxOperationRetryTime; + } + + get maxUploadRetryTime(): number { + return this._delegate.maxUploadRetryTime; + } + + /** + * Returns a firebaseStorage.Reference for the given path in the default + * bucket. + */ + ref(path?: string): types.Reference { + if (isUrl(path)) { + throw invalidArgument( + 'ref() expected a child path but got a URL, use refFromURL instead.' + ); + } + return new ReferenceCompat(ref(this._delegate, path), this); + } + + /** + * Returns a firebaseStorage.Reference object for the given absolute URL, + * which must be a gs:// or http[s]:// URL. + */ + refFromURL(url: string): types.Reference { + if (!isUrl(url)) { + throw invalidArgument( + 'refFromURL() expected a full URL but got a child path, use ref() instead.' + ); + } + try { + Location.makeFromUrl(url); + } catch (e) { + throw invalidArgument( + 'refFromUrl() expected a valid full URL but got an invalid one.' + ); + } + return new ReferenceCompat(ref(this._delegate, url), this); + } + + setMaxUploadRetryTime(time: number): void { + this._delegate.maxUploadRetryTime = time; + } + + setMaxOperationRetryTime(time: number): void { + this._delegate.maxOperationRetryTime = time; + } +} diff --git a/packages/storage/compat/task.ts b/packages/storage/compat/task.ts new file mode 100644 index 00000000000..9c97765253e --- /dev/null +++ b/packages/storage/compat/task.ts @@ -0,0 +1,107 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { UploadTask } from '../src/task'; +import { UploadTaskSnapshotCompat } from './tasksnapshot'; +import { TaskEvent } from '../src/implementation/taskenums'; +import * as types from '@firebase/storage-types'; +import { + StorageObserver, + ErrorFn, + CompleteFn, + Subscribe, + Unsubscribe +} from '../src/implementation/observer'; +import { UploadTaskSnapshot } from '../src/tasksnapshot'; +import { ReferenceCompat } from './reference'; +import { FirebaseStorageError } from '../src/implementation/error'; + +export class UploadTaskCompat implements types.UploadTask { + private readonly _snapshot: UploadTaskSnapshotCompat; + constructor( + private readonly _delegate: UploadTask, + private readonly _ref: ReferenceCompat + ) { + this._snapshot = new UploadTaskSnapshotCompat( + this._delegate.snapshot, + this, + this._ref + ); + } + + get snapshot(): UploadTaskSnapshotCompat { + return this._snapshot; + } + + cancel = this._delegate.cancel.bind(this._delegate); + catch = this._delegate.catch.bind(this._delegate); + pause = this._delegate.pause.bind(this._delegate); + resume = this._delegate.resume.bind(this._delegate); + + then( + onFulfilled?: ((a: UploadTaskSnapshotCompat) => unknown) | null, + onRejected?: ((a: FirebaseStorageError) => unknown) | null + ): Promise { + return this._delegate.then(snapshot => { + if (onFulfilled) { + return onFulfilled( + new UploadTaskSnapshotCompat(snapshot, this, this._ref) + ); + } + }, onRejected); + } + + on( + type: TaskEvent, + nextOrObserver?: + | types.StorageObserver + | null + | ((a: UploadTaskSnapshotCompat) => unknown), + error?: ErrorFn | null, + completed?: CompleteFn | null + ): Unsubscribe | Subscribe { + let wrappedNextOrObserver: + | StorageObserver + | undefined + | ((a: UploadTaskSnapshot) => unknown) = undefined; + if (!!nextOrObserver) { + if (typeof nextOrObserver === 'function') { + wrappedNextOrObserver = (taskSnapshot: UploadTaskSnapshot) => + nextOrObserver( + new UploadTaskSnapshotCompat(taskSnapshot, this, this._ref) + ); + } else { + wrappedNextOrObserver = { + next: !!nextOrObserver.next + ? (taskSnapshot: UploadTaskSnapshot) => + nextOrObserver.next!( + new UploadTaskSnapshotCompat(taskSnapshot, this, this._ref) + ) + : undefined, + complete: nextOrObserver.complete || undefined, + error: nextOrObserver.error || undefined + }; + } + } + return this._delegate.on( + type, + wrappedNextOrObserver, + error || undefined, + completed || undefined + ); + } +} diff --git a/packages/storage/compat/tasksnapshot.ts b/packages/storage/compat/tasksnapshot.ts new file mode 100644 index 00000000000..cc7994cbf60 --- /dev/null +++ b/packages/storage/compat/tasksnapshot.ts @@ -0,0 +1,43 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import * as types from '@firebase/storage-types'; +import { ReferenceCompat } from './reference'; +import { UploadTaskCompat } from './task'; +import { UploadTaskSnapshot } from '../src/tasksnapshot'; +import { Metadata } from '../src/metadata'; + +export class UploadTaskSnapshotCompat implements types.UploadTaskSnapshot { + constructor( + readonly _delegate: UploadTaskSnapshot, + readonly task: UploadTaskCompat, + readonly ref: ReferenceCompat + ) {} + + get bytesTransferred(): number { + return this._delegate.bytesTransferred; + } + get metadata(): Metadata { + return this._delegate.metadata; + } + get state(): string { + return this._delegate.state; + } + get totalBytes(): number { + return this._delegate.totalBytes; + } +} diff --git a/packages/storage/exp/index.ts b/packages/storage/exp/index.ts new file mode 100644 index 00000000000..de835358f8f --- /dev/null +++ b/packages/storage/exp/index.ts @@ -0,0 +1,78 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { _registerComponent, registerVersion } from '@firebase/app-exp'; + +import { XhrIoPool } from '../src/implementation/xhriopool'; +import { StorageService } from '../src/service'; +import { + Component, + ComponentType, + ComponentContainer +} from '@firebase/component'; + +import { name, version } from '../package.json'; + +export { ref } from '../src/service'; +export { + uploadBytesResumable, + uploadString, + getMetadata, + updateMetadata, + list, + listAll, + getDownloadURL, + deleteObject +} from '../src/reference'; + +/** + * Type constant for Firebase Storage. + */ +const STORAGE_TYPE = 'storage-exp'; + +function factory(container: ComponentContainer, url?: string): StorageService { + // Dependencies + const app = container.getProvider('app-exp').getImmediate(); + const authProvider = container.getProvider('auth-internal'); + + return (new StorageService( + app, + authProvider, + new XhrIoPool(), + url + ) as unknown) as StorageService; +} + +function registerStorage(): void { + _registerComponent( + new Component( + STORAGE_TYPE, + factory, + ComponentType.PUBLIC + ).setMultipleInstances(true) + ); + + registerVersion(name, version); +} + +registerStorage(); + +declare module '@firebase/component' { + interface NameServiceMapping { + 'storage-exp': StorageService; + } +} diff --git a/packages/storage/exp/package.json b/packages/storage/exp/package.json new file mode 100644 index 00000000000..0fcd9c9253a --- /dev/null +++ b/packages/storage/exp/package.json @@ -0,0 +1,12 @@ +{ + "name": "@firebase/storage/exp", + "description": "A tree-shakeable version of the Storage SDK", + "main": "./dist/index.browser.cjs.js", + "module": "./dist/index.browser.esm2017.js", + "browser": "./dist/index.browser.esm2017.js", + "typings": "./dist/index.d.ts", + "private": true, + "dependencies": { + "@firebase/app-exp": "0.0.800" + } +} diff --git a/packages/storage/karma.conf.js b/packages/storage/karma.conf.js index efc709ca8c0..09efdae7148 100644 --- a/packages/storage/karma.conf.js +++ b/packages/storage/karma.conf.js @@ -15,8 +15,6 @@ * limitations under the License. */ -const karma = require('karma'); -const path = require('path'); const karmaBase = require('../../config/karma.base'); const { argv } = require('yargs'); diff --git a/packages/storage/package.json b/packages/storage/package.json index 2b8066df170..b618fc744b8 100644 --- a/packages/storage/package.json +++ b/packages/storage/package.json @@ -6,11 +6,15 @@ "main": "dist/index.cjs.js", "module": "dist/index.esm.js", "esm2017": "dist/index.esm2017.js", - "files": ["dist"], + "files": [ + "dist", + "exp/dist" + ], "scripts": { "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'", "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'", - "build": "rollup -c", + "build": "rollup -c rollup.config.compat.js", + "build:exp": "rollup -c rollup.config.exp.js", "build:deps": "lerna run --scope @firebase/storage --include-dependencies build", "dev": "rollup -c -w", "test": "run-p test:browser lint", @@ -19,7 +23,8 @@ "test:browser:integration": "karma start --single-run --integration", "test:browser": "karma start --single-run", "prepare": "yarn build", - "prettier": "prettier --write 'src/**/*.ts' 'test/**/*.ts'" + "prettier": "prettier --write 'src/**/*.ts' 'test/**/*.ts'", + "api-report": "api-extractor run --local --verbose" }, "license": "Apache-2.0", "dependencies": { @@ -36,6 +41,7 @@ "@firebase/app": "0.6.13", "@firebase/auth": "0.15.1", "rollup": "2.33.1", + "@rollup/plugin-json": "4.1.0", "rollup-plugin-typescript2": "0.29.0", "typescript": "4.0.5" }, @@ -48,4 +54,4 @@ "url": "https://github.com/firebase/firebase-js-sdk/issues" }, "typings": "dist/index.d.ts" -} +} \ No newline at end of file diff --git a/packages/storage/rollup.config.compat.js b/packages/storage/rollup.config.compat.js new file mode 100644 index 00000000000..3b2bb2102b8 --- /dev/null +++ b/packages/storage/rollup.config.compat.js @@ -0,0 +1,77 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import json from '@rollup/plugin-json'; +import typescriptPlugin from 'rollup-plugin-typescript2'; +import typescript from 'typescript'; +import pkg from './package.json'; + +const deps = Object.keys( + Object.assign({}, pkg.peerDependencies, pkg.dependencies) +); +/** + * ES5 Builds + */ +const es5BuildPlugins = [ + typescriptPlugin({ + typescript + }), + json() +]; + +const es5Builds = [ + { + input: './compat/index.ts', + output: [ + { file: pkg.main, format: 'cjs', sourcemap: true }, + { file: pkg.module, format: 'es', sourcemap: true } + ], + plugins: es5BuildPlugins, + external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)) + } +]; + +/** + * ES2017 Builds + */ +const es2017BuildPlugins = [ + typescriptPlugin({ + typescript, + tsconfigOverride: { + compilerOptions: { + target: 'es2017' + } + } + }), + json({ preferConst: true }) +]; + +const es2017Builds = [ + { + input: './compat/index.ts', + output: { + file: pkg.esm2017, + format: 'es', + sourcemap: true + }, + plugins: es2017BuildPlugins, + external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)) + } +]; + +// eslint-disable-next-line import/no-default-export +export default [...es5Builds, ...es2017Builds]; diff --git a/packages/storage/rollup.config.exp.js b/packages/storage/rollup.config.exp.js new file mode 100644 index 00000000000..8c56778129c --- /dev/null +++ b/packages/storage/rollup.config.exp.js @@ -0,0 +1,68 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import json from '@rollup/plugin-json'; +import typescriptPlugin from 'rollup-plugin-typescript2'; +import typescript from 'typescript'; +import pkgExp from './exp/package.json'; +import pkg from './package.json'; +import path from 'path'; +import { importPathTransformer } from '../../scripts/exp/ts-transform-import-path'; + +const deps = Object.keys( + Object.assign({}, pkg.peerDependencies, pkg.dependencies) +).concat('@firebase/app-exp'); + +const plugins = [ + typescriptPlugin({ + typescript, + tsconfigOverride: { + compilerOptions: { + target: 'es2017' + } + }, + abortOnError: false, + transformers: [importPathTransformer] + }), + json({ preferConst: true }) +]; + +const browserBuilds = [ + { + input: './exp/index.ts', + output: [ + { + file: path.resolve('./exp', pkgExp.main), + format: 'cjs', + sourcemap: true + }, + { + file: path.resolve('./exp', pkgExp.browser), + format: 'es', + sourcemap: true + } + ], + plugins, + external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)), + treeshake: { + moduleSideEffects: false + } + } +]; + +// eslint-disable-next-line import/no-default-export +export default browserBuilds; diff --git a/packages/storage/src/implementation/backoff.ts b/packages/storage/src/implementation/backoff.ts index e7e49b1156f..7262a7f4da8 100644 --- a/packages/storage/src/implementation/backoff.ts +++ b/packages/storage/src/implementation/backoff.ts @@ -50,9 +50,6 @@ export function start( } let triggeredCallback = false; - // TODO: This disable can be removed and the 'ignoreRestArgs' option added to - // the no-explicit-any rule when ESlint releases it. - // eslint-disable-next-line @typescript-eslint/no-explicit-any function triggerCallback(...args: any[]): void { if (!triggeredCallback) { triggeredCallback = true; @@ -67,9 +64,6 @@ export function start( }, millis); } - // TODO: This disable can be removed and the 'ignoreRestArgs' option added to - // the no-explicit-any rule when ESlint releases it. - // eslint-disable-next-line @typescript-eslint/no-explicit-any function handler(success: boolean, ...args: any[]): void { if (triggeredCallback) { return; diff --git a/packages/storage/src/implementation/blob.ts b/packages/storage/src/implementation/blob.ts index a82a71dc6f7..e9cde8878da 100644 --- a/packages/storage/src/implementation/blob.ts +++ b/packages/storage/src/implementation/blob.ts @@ -25,7 +25,7 @@ import { StringFormat, dataFromString } from './string'; import * as type from './type'; /** - * @param opt_elideCopy If true, doesn't copy mutable input data + * @param opt_elideCopy - If true, doesn't copy mutable input data * (e.g. Uint8Arrays). Pass true only if you know the objects will not be * modified after this blob's construction. */ diff --git a/packages/storage/src/implementation/error.ts b/packages/storage/src/implementation/error.ts index 47780c177af..9889e9e559d 100644 --- a/packages/storage/src/implementation/error.ts +++ b/packages/storage/src/implementation/error.ts @@ -21,7 +21,10 @@ export class FirebaseStorageError extends FirebaseError { customData: { serverResponse: string | null } = { serverResponse: null }; constructor(code: Code, message: string) { - super(prependCode(code), 'Firebase Storage: ' + message); + super( + prependCode(code), + `Firebase Storage: ${message} (${prependCode(code)})` + ); // Without this, `instanceof FirebaseStorageError`, in tests for example, // returns false. Object.setPrototypeOf(this, FirebaseStorageError.prototype); @@ -33,7 +36,7 @@ export class FirebaseStorageError extends FirebaseError { get message(): string { if (this.customData.serverResponse) { - return this.message + '\n' + this.customData.serverResponse; + return `${this.message}\n${this.customData.serverResponse}`; } else { return this.message; } @@ -50,9 +53,6 @@ export class FirebaseStorageError extends FirebaseError { export const errors = {}; -/** - * @enum {string} - */ export type Code = string; export const Code = { // Shared between all platforms @@ -79,7 +79,8 @@ export const Code = { APP_DELETED: 'app-deleted', INVALID_ROOT_OPERATION: 'invalid-root-operation', INVALID_FORMAT: 'invalid-format', - INTERNAL_ERROR: 'internal-error' + INTERNAL_ERROR: 'internal-error', + UNSUPPORTED_ENVIRONMENT: 'unsupported-environment' }; export function prependCode(code: Code): string { @@ -221,15 +222,8 @@ export function noDownloadURL(): FirebaseStorageError { ); } -export function invalidArgument( - index: number, - fnName: string, - message: string -): FirebaseStorageError { - return new FirebaseStorageError( - Code.INVALID_ARGUMENT, - 'Invalid argument in `' + fnName + '` at index ' + index + ': ' + message - ); +export function invalidArgument(message: string): FirebaseStorageError { + return new FirebaseStorageError(Code.INVALID_ARGUMENT, message); } export function invalidArgumentCount( @@ -269,7 +263,7 @@ export function appDeleted(): FirebaseStorageError { } /** - * @param name The name of the operation that was invalid. + * @param name - The name of the operation that was invalid. */ export function invalidRootOperation(name: string): FirebaseStorageError { return new FirebaseStorageError( @@ -282,8 +276,8 @@ export function invalidRootOperation(name: string): FirebaseStorageError { } /** - * @param format The format that was not valid. - * @param message A message describing the format violation. + * @param format - The format that was not valid. + * @param message - A message describing the format violation. */ export function invalidFormat( format: string, @@ -296,7 +290,7 @@ export function invalidFormat( } /** - * @param message A message describing the internal error. + * @param message - A message describing the internal error. */ export function internalError(message: string): FirebaseStorageError { throw new FirebaseStorageError( diff --git a/packages/storage/src/implementation/failrequest.ts b/packages/storage/src/implementation/failrequest.ts index 3cdc22730d5..afd4cd12ec4 100644 --- a/packages/storage/src/implementation/failrequest.ts +++ b/packages/storage/src/implementation/failrequest.ts @@ -19,8 +19,6 @@ import { Request } from './request'; /** * A request whose promise always fails. - * @struct - * @template T */ export class FailRequest implements Request { promise_: Promise; diff --git a/packages/storage/src/implementation/fs.ts b/packages/storage/src/implementation/fs.ts index 1e4d7dc2cab..795a47970fa 100644 --- a/packages/storage/src/implementation/fs.ts +++ b/packages/storage/src/implementation/fs.ts @@ -20,6 +20,7 @@ * bloats the size of the released binary. */ import * as type from './type'; +import { Code, FirebaseStorageError } from './error'; function getBlobBuilder(): typeof IBlobBuilder | undefined { if (typeof BlobBuilder !== 'undefined') { @@ -49,7 +50,10 @@ export function getBlob(...args: Array): Blob { if (type.isNativeBlobDefined()) { return new Blob(args); } else { - throw Error("This browser doesn't seem to support creating Blobs"); + throw new FirebaseStorageError( + Code.UNSUPPORTED_ENVIRONMENT, + "This browser doesn't seem to support creating Blobs" + ); } } } diff --git a/packages/storage/src/implementation/location.ts b/packages/storage/src/implementation/location.ts index 1b911f29da9..2cf23d43493 100644 --- a/packages/storage/src/implementation/location.ts +++ b/packages/storage/src/implementation/location.ts @@ -19,12 +19,10 @@ * @fileoverview Functionality related to the parsing/composition of bucket/ * object location. */ -import * as errorsExports from './error'; + +import { invalidDefaultBucket, invalidUrl } from './error'; import { DEFAULT_HOST } from './constants'; -/** - * @struct - */ export class Location { private path_: string; @@ -62,7 +60,7 @@ export class Location { if (bucketLocation.path === '') { return bucketLocation; } else { - throw errorsExports.invalidDefaultBucket(bucketString); + throw invalidDefaultBucket(bucketString); } } @@ -128,7 +126,7 @@ export class Location { } } if (location == null) { - throw errorsExports.invalidUrl(url); + throw invalidUrl(url); } return location; } diff --git a/packages/storage/src/implementation/metadata.ts b/packages/storage/src/implementation/metadata.ts index 2ce6dc35783..22be073f116 100644 --- a/packages/storage/src/implementation/metadata.ts +++ b/packages/storage/src/implementation/metadata.ts @@ -32,9 +32,6 @@ export function noXform_(metadata: Metadata, value: T): T { return value; } -/** - * @struct - */ class Mapping { local: string; writable: boolean; @@ -90,9 +87,9 @@ export function getMappings(): Mappings { */ function xformSize( _metadata: Metadata, - size: number | string | undefined + size?: number | string ): number | undefined { - if (type.isDef(size)) { + if (size !== undefined) { return Number(size); } else { return size; diff --git a/packages/storage/src/implementation/observer.ts b/packages/storage/src/implementation/observer.ts index 0e7967c92ae..d4867d42477 100644 --- a/packages/storage/src/implementation/observer.ts +++ b/packages/storage/src/implementation/observer.ts @@ -18,52 +18,47 @@ import * as type from './type'; import { FirebaseStorageError } from './error'; export type NextFn = (value: T) => void; -export type ErrorFn = (error: Error | FirebaseStorageError) => void; +export type ErrorFn = (error: FirebaseStorageError) => void; export type CompleteFn = () => void; export type Unsubscribe = () => void; export interface StorageObserver { - next?: NextFn | null; - error?: ErrorFn | null; - complete?: CompleteFn | null; + next?: NextFn; + error?: ErrorFn; + complete?: CompleteFn; } export type Subscribe = ( - next?: NextFn | StorageObserver | null, - error?: ErrorFn | null, - complete?: CompleteFn | null + next?: NextFn | StorageObserver, + error?: ErrorFn, + complete?: CompleteFn ) => Unsubscribe; -/** - * @struct - */ export class Observer implements StorageObserver { - next?: NextFn | null; - error?: ErrorFn | null; - complete?: CompleteFn | null; + next?: NextFn; + error?: ErrorFn; + complete?: CompleteFn; constructor( - nextOrObserver?: NextFn | StorageObserver | null, - error?: ErrorFn | null, - complete?: CompleteFn | null + nextOrObserver?: NextFn | StorageObserver, + error?: ErrorFn, + complete?: CompleteFn ) { const asFunctions = - type.isFunction(nextOrObserver) || - type.isDef(error) || - type.isDef(complete); + type.isFunction(nextOrObserver) || error != null || complete != null; if (asFunctions) { - this.next = nextOrObserver as NextFn | null; - this.error = error || null; - this.complete = complete || null; + this.next = nextOrObserver as NextFn; + this.error = error; + this.complete = complete; } else { const observer = nextOrObserver as { - next?: NextFn | null; - error?: ErrorFn | null; - complete?: CompleteFn | null; + next?: NextFn; + error?: ErrorFn; + complete?: CompleteFn; }; - this.next = observer.next || null; - this.error = observer.error || null; - this.complete = observer.complete || null; + this.next = observer.next; + this.error = observer.error; + this.complete = observer.complete; } } } diff --git a/packages/storage/src/implementation/request.ts b/packages/storage/src/implementation/request.ts index 5b553ad3af8..f1119e4c64c 100644 --- a/packages/storage/src/implementation/request.ts +++ b/packages/storage/src/implementation/request.ts @@ -35,9 +35,6 @@ import * as UrlUtils from './url'; import { Headers, XhrIo, ErrorCode } from './xhrio'; import { XhrIoPool } from './xhriopool'; -/** - * @template T - */ export interface Request { getPromise(): Promise; @@ -46,15 +43,11 @@ export interface Request { * appropriate value (if the request is finished before you call this method, * but the promise has not yet been resolved), so don't just assume it will be * rejected if you call this function. - * @param appDelete True if the cancelation came from the app being deleted. + * @param appDelete - True if the cancelation came from the app being deleted. */ cancel(appDelete?: boolean): void; } -/** - * @struct - * @template T - */ class NetworkRequest implements Request { private url_: string; private method_: string; @@ -164,7 +157,7 @@ class NetworkRequest implements Request { } /** - * @param requestWentThrough True if the request eventually went + * @param requestWentThrough - True if the request eventually went * through, false if it hit the retry limit or was canceled. */ function backoffDone( @@ -248,8 +241,7 @@ class NetworkRequest implements Request { /** * A collection of information about the result of a network request. - * @param opt_canceled Defaults to false. - * @struct + * @param opt_canceled - Defaults to false. */ export class RequestEndStatus { /** @@ -287,9 +279,6 @@ export function addGmpidHeader_(headers: Headers, appId: string | null): void { } } -/** - * @template T - */ export function makeRequest( requestInfo: RequestInfo, appId: string | null, diff --git a/packages/storage/src/implementation/requests.ts b/packages/storage/src/implementation/requests.ts index 8b1fe288e25..940026ba0b6 100644 --- a/packages/storage/src/implementation/requests.ts +++ b/packages/storage/src/implementation/requests.ts @@ -342,7 +342,6 @@ export function multipartUpload( * @param opt_finalized True if the server has finished the upload. * @param opt_metadata The upload metadata, should * only be passed if opt_finalized is true. - * @struct */ export class ResumableUploadStatus { finalized: boolean; diff --git a/packages/storage/src/implementation/string.ts b/packages/storage/src/implementation/string.ts index 3018d88c1a4..c24f653dab9 100644 --- a/packages/storage/src/implementation/string.ts +++ b/packages/storage/src/implementation/string.ts @@ -14,10 +14,11 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -import * as errorsExports from './error'; + +import { unknown, invalidFormat } from './error'; /** - * @enum {string} + * An enumeration of the possible string formats for upload. */ export type StringFormat = string; export const StringFormat = { @@ -27,9 +28,6 @@ export const StringFormat = { DATA_URL: 'data_url' }; -/** - * @struct - */ export class StringData { contentType: string | null; @@ -58,7 +56,7 @@ export function dataFromString( } // assert(false); - throw errorsExports.unknown(); + throw unknown(); } export function utf8Bytes_(value: string): Uint8Array { @@ -108,10 +106,7 @@ export function percentEncodedBytes_(value: string): Uint8Array { try { decoded = decodeURIComponent(value); } catch (e) { - throw errorsExports.invalidFormat( - StringFormat.DATA_URL, - 'Malformed data URL.' - ); + throw invalidFormat(StringFormat.DATA_URL, 'Malformed data URL.'); } return utf8Bytes_(decoded); } @@ -123,7 +118,7 @@ export function base64Bytes_(format: StringFormat, value: string): Uint8Array { const hasUnder = value.indexOf('_') !== -1; if (hasMinus || hasUnder) { const invalidChar = hasMinus ? '-' : '_'; - throw errorsExports.invalidFormat( + throw invalidFormat( format, "Invalid character '" + invalidChar + @@ -137,7 +132,7 @@ export function base64Bytes_(format: StringFormat, value: string): Uint8Array { const hasSlash = value.indexOf('/') !== -1; if (hasPlus || hasSlash) { const invalidChar = hasPlus ? '+' : '/'; - throw errorsExports.invalidFormat( + throw invalidFormat( format, "Invalid character '" + invalidChar + "' found: is it base64 encoded?" ); @@ -152,7 +147,7 @@ export function base64Bytes_(format: StringFormat, value: string): Uint8Array { try { bytes = atob(value); } catch (e) { - throw errorsExports.invalidFormat(format, 'Invalid character found'); + throw invalidFormat(format, 'Invalid character found'); } const array = new Uint8Array(bytes.length); for (let i = 0; i < bytes.length; i++) { @@ -161,9 +156,6 @@ export function base64Bytes_(format: StringFormat, value: string): Uint8Array { return array; } -/** - * @struct - */ class DataURLParts { base64: boolean = false; contentType: string | null = null; @@ -172,7 +164,7 @@ class DataURLParts { constructor(dataURL: string) { const matches = dataURL.match(/^data:([^,]+)?,/); if (matches === null) { - throw errorsExports.invalidFormat( + throw invalidFormat( StringFormat.DATA_URL, "Must be formatted 'data:[][;base64]," ); diff --git a/packages/storage/src/implementation/taskenums.ts b/packages/storage/src/implementation/taskenums.ts index a9a63055ae1..5001e413529 100644 --- a/packages/storage/src/implementation/taskenums.ts +++ b/packages/storage/src/implementation/taskenums.ts @@ -21,7 +21,6 @@ /** * Enum for task events. - * @enum {string} */ export type TaskEvent = string; export const TaskEvent = { @@ -31,7 +30,6 @@ export const TaskEvent = { /** * Internal enum for task state. - * @enum {string} */ export type InternalTaskState = string; export const InternalTaskState = { @@ -46,7 +44,6 @@ export const InternalTaskState = { /** * External (API-surfaced) enum for task state. - * @enum {string} */ export type TaskState = string; export const TaskState = { diff --git a/packages/storage/src/implementation/type.ts b/packages/storage/src/implementation/type.ts index f9287b96b7c..1335ee4fab1 100644 --- a/packages/storage/src/implementation/type.ts +++ b/packages/storage/src/implementation/type.ts @@ -17,13 +17,6 @@ import { Code, FirebaseStorageError } from './error'; -/** - * @return False if the object is undefined or null, true otherwise. - */ -export function isDef(p: T | null | undefined): p is T { - return p != null; -} - export function isJustDef(p: T | null | undefined): p is T | null { return p !== void 0; } diff --git a/packages/storage/src/implementation/url.ts b/packages/storage/src/implementation/url.ts index 8c6a4472949..caea91f35b3 100644 --- a/packages/storage/src/implementation/url.ts +++ b/packages/storage/src/implementation/url.ts @@ -30,7 +30,6 @@ export function makeQueryString(params: UrlParams): string { let queryPart = '?'; for (const key in params) { if (params.hasOwnProperty(key)) { - // @ts-ignore TODO: remove once typescript is upgraded to 3.5.x const nextPart = encode(key) + '=' + encode(params[key]); queryPart = queryPart + nextPart + '&'; } diff --git a/packages/storage/src/implementation/xhrio.ts b/packages/storage/src/implementation/xhrio.ts index 0b3ae2c506e..8adc8e86a8b 100644 --- a/packages/storage/src/implementation/xhrio.ts +++ b/packages/storage/src/implementation/xhrio.ts @@ -20,6 +20,9 @@ * goog.net.XhrIo-like interface. */ +/** + * XHR headers + */ export interface Headers { [name: string]: string | number; } @@ -50,9 +53,6 @@ export interface XhrIo { removeUploadProgressListener(listener: (p1: ProgressEvent) => void): void; } -/** - * @enum{number} - */ export enum ErrorCode { NO_ERROR = 0, NETWORK_ERROR = 1, diff --git a/packages/storage/src/implementation/xhrio_network.ts b/packages/storage/src/implementation/xhrio_network.ts index e7f04a8be45..016307be71e 100644 --- a/packages/storage/src/implementation/xhrio_network.ts +++ b/packages/storage/src/implementation/xhrio_network.ts @@ -14,9 +14,8 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -import * as errorsExports from './error'; -import * as type from './type'; import { Headers, XhrIo, ErrorCode } from './xhrio'; +import { internalError } from './error'; /** * We use this instead of goog.net.XhrIo because goog.net.XhrIo is hyuuuuge and @@ -52,22 +51,22 @@ export class NetworkXhrIo implements XhrIo { send( url: string, method: string, - body?: ArrayBufferView | Blob | string | null, + body?: ArrayBufferView | Blob | string, headers?: Headers ): Promise { if (this.sent_) { - throw errorsExports.internalError('cannot .send() more than once'); + throw internalError('cannot .send() more than once'); } this.sent_ = true; this.xhr_.open(method, url, true); - if (type.isDef(headers)) { + if (headers !== undefined) { for (const key in headers) { if (headers.hasOwnProperty(key)) { this.xhr_.setRequestHeader(key, headers[key].toString()); } } } - if (type.isDef(body)) { + if (body !== undefined) { this.xhr_.send(body); } else { this.xhr_.send(); @@ -80,9 +79,7 @@ export class NetworkXhrIo implements XhrIo { */ getErrorCode(): ErrorCode { if (!this.sent_) { - throw errorsExports.internalError( - 'cannot .getErrorCode() before sending' - ); + throw internalError('cannot .getErrorCode() before sending'); } return this.errorCode_; } @@ -92,7 +89,7 @@ export class NetworkXhrIo implements XhrIo { */ getStatus(): number { if (!this.sent_) { - throw errorsExports.internalError('cannot .getStatus() before sending'); + throw internalError('cannot .getStatus() before sending'); } try { return this.xhr_.status; @@ -106,9 +103,7 @@ export class NetworkXhrIo implements XhrIo { */ getResponseText(): string { if (!this.sent_) { - throw errorsExports.internalError( - 'cannot .getResponseText() before sending' - ); + throw internalError('cannot .getResponseText() before sending'); } return this.xhr_.responseText; } @@ -132,7 +127,7 @@ export class NetworkXhrIo implements XhrIo { * @override */ addUploadProgressListener(listener: (p1: ProgressEvent) => void): void { - if (type.isDef(this.xhr_.upload)) { + if (this.xhr_.upload != null) { this.xhr_.upload.addEventListener('progress', listener); } } @@ -141,7 +136,7 @@ export class NetworkXhrIo implements XhrIo { * @override */ removeUploadProgressListener(listener: (p1: ProgressEvent) => void): void { - if (type.isDef(this.xhr_.upload)) { + if (this.xhr_.upload != null) { this.xhr_.upload.removeEventListener('progress', listener); } } diff --git a/packages/storage/src/list.ts b/packages/storage/src/list.ts index 732deac2afa..a2124b88c1e 100644 --- a/packages/storage/src/list.ts +++ b/packages/storage/src/list.ts @@ -14,18 +14,24 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +import * as types from '@firebase/storage-types'; import { Reference } from './reference'; /** * @fileoverview Documentation for ListOptions and ListResult format. */ -export interface ListOptions { - maxResults?: number | null; - pageToken?: string | null; -} +/** + * The options `list()` accepts. + */ +export interface ListOptions extends types.ListOptions {} + +/** + * Result returned by list(). + */ export interface ListResult { prefixes: Reference[]; items: Reference[]; - nextPageToken?: string | null; + nextPageToken?: string; } diff --git a/packages/storage/src/metadata.ts b/packages/storage/src/metadata.ts index 9dfba61cdc8..3f0aa225da6 100644 --- a/packages/storage/src/metadata.ts +++ b/packages/storage/src/metadata.ts @@ -14,21 +14,19 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + +import * as types from '@firebase/storage-types'; import { Reference } from './reference'; /** * @fileoverview Documentation for the metadata format. */ -interface Metadata { - bucket: string | undefined; - generation: string | undefined; - metageneration: string | undefined; - fullPath: string | undefined; - name: string | undefined; - size: number | undefined; + +/** + * The full set of object metadata, including read-only properties. + */ +interface Metadata extends types.FullMetadata { type: string | undefined; - timeCreated: string | undefined; - updated: string | undefined; md5Hash: string | undefined; cacheControl: string | undefined; contentDisposition: string | undefined; diff --git a/packages/storage/src/reference.ts b/packages/storage/src/reference.ts index 2d66d889508..bffadda8afe 100644 --- a/packages/storage/src/reference.ts +++ b/packages/storage/src/reference.ts @@ -18,23 +18,29 @@ /** * @fileoverview Defines the Firebase Storage Reference class. */ + import { FbsBlob } from './implementation/blob'; -import * as errorsExports from './implementation/error'; import { Location } from './implementation/location'; -import * as metadata from './implementation/metadata'; -import * as path from './implementation/path'; -import * as requests from './implementation/requests'; -import { dataFromString, StringFormat } from './implementation/string'; -import * as type from './implementation/type'; -import { validateNumber } from './implementation/type'; +import { getMappings } from './implementation/metadata'; +import { child, parent, lastComponent } from './implementation/path'; +import { + list as requestsList, + getMetadata as requestsGetMetadata, + updateMetadata as requestsUpdateMetadata, + getDownloadUrl as requestsGetDownloadUrl, + deleteObject as requestsDeleteObject +} from './implementation/requests'; +import { StringFormat, dataFromString } from './implementation/string'; import { Metadata } from './metadata'; import { StorageService } from './service'; -import { UploadTask } from './task'; import { ListOptions, ListResult } from './list'; +import { UploadTask } from './task'; +import { invalidRootOperation, noDownloadURL } from './implementation/error'; +import { validateNumber } from './implementation/type'; /** * Provides methods to interact with a bucket in the Firebase Storage service. - * @param location An fbs.location, or the URL at + * @param location - An fbs.location, or the URL at * which to base this object, in one of the following forms: * gs:/// * http[s]://firebasestorage.googleapis.com/ @@ -44,295 +50,309 @@ import { ListOptions, ListResult } from './list'; * the project ID of the base firebase.App instance. */ export class Reference { - protected location: Location; + /** + * @internal + */ + _location: Location; - constructor(protected service: StorageService, location: string | Location) { + constructor(private _service: StorageService, location: string | Location) { if (location instanceof Location) { - this.location = location; + this._location = location; } else { - this.location = Location.makeFromUrl(location); + this._location = Location.makeFromUrl(location); } } /** - * @return The URL for the bucket and path this object references, + * @returns The URL for the bucket and path this object references, * in the form gs:/// * @override */ toString(): string { - return 'gs://' + this.location.bucket + '/' + this.location.path; + return 'gs://' + this._location.bucket + '/' + this._location.path; } protected newRef(service: StorageService, location: Location): Reference { return new Reference(service, location); } - protected mappings(): metadata.Mappings { - return metadata.getMappings(); - } - - /** - * @return A reference to the object obtained by - * appending childPath, removing any duplicate, beginning, or trailing - * slashes. - */ - child(childPath: string): Reference { - const newPath = path.child(this.location.path, childPath); - const location = new Location(this.location.bucket, newPath); - return this.newRef(this.service, location); - } - /** - * @return A reference to the parent of the - * current object, or null if the current object is the root. - */ - get parent(): Reference | null { - const newPath = path.parent(this.location.path); - if (newPath === null) { - return null; - } - const location = new Location(this.location.bucket, newPath); - return this.newRef(this.service, location); - } - - /** - * @return An reference to the root of this + * @returns An reference to the root of this * object's bucket. */ get root(): Reference { - const location = new Location(this.location.bucket, ''); - return this.newRef(this.service, location); + const location = new Location(this._location.bucket, ''); + return this.newRef(this._service, location); } get bucket(): string { - return this.location.bucket; + return this._location.bucket; } get fullPath(): string { - return this.location.path; + return this._location.path; } get name(): string { - return path.lastComponent(this.location.path); + return lastComponent(this._location.path); } get storage(): StorageService { - return this.service; + return this._service; } - /** - * Uploads a blob to this object's location. - * @param data The blob to upload. - * @return An UploadTask that lets you control and - * observe the upload. - */ - put( - data: Blob | Uint8Array | ArrayBuffer, - metadata: Metadata | null = null - ): UploadTask { - this.throwIfRoot_('put'); - return new UploadTask( - this, - this.service, - this.location, - this.mappings(), - new FbsBlob(data), - metadata - ); + get parent(): Reference | null { + const newPath = parent(this._location.path); + if (newPath === null) { + return null; + } + const location = new Location(this._location.bucket, newPath); + return new Reference(this._service, location); } - /** - * Uploads a string to this object's location. - * @param value The string to upload. - * @param format The format of the string to upload. - * @return An UploadTask that lets you control and - * observe the upload. - */ - putString( - value: string, - format: StringFormat = StringFormat.RAW, - metadata?: Metadata - ): UploadTask { - this.throwIfRoot_('putString'); - const data = dataFromString(format, value); - const metadataClone = Object.assign({}, metadata); - if ( - !type.isDef(metadataClone['contentType']) && - type.isDef(data.contentType) - ) { - metadataClone['contentType'] = data.contentType!; + _throwIfRoot(name: string): void { + if (this._location.path === '') { + throw invalidRootOperation(name); } - return new UploadTask( - this, - this.service, - this.location, - this.mappings(), - new FbsBlob(data.data, true), - metadataClone - ); } +} - /** - * Deletes the object at this location. - * @return A promise that resolves if the deletion succeeds. - */ - delete(): Promise { - this.throwIfRoot_('delete'); - return this.service.getAuthToken().then(authToken => { - const requestInfo = requests.deleteObject(this.service, this.location); - return this.service.makeRequest(requestInfo, authToken).getPromise(); - }); - } +/** + * Uploads a blob to this object's location. + * @public + * @param ref - Storage Reference where data should be uploaded. + * @param data - The data to upload. + * @param metadata - Metadata for the newly uploaded string. + * @returns An UploadTask that lets you control and + * observe the upload. + */ +export function uploadBytesResumable( + ref: Reference, + data: Blob | Uint8Array | ArrayBuffer, + metadata: Metadata | null = null +): UploadTask { + ref._throwIfRoot('uploadBytesResumable'); + return new UploadTask(ref, new FbsBlob(data), metadata); +} - /** - * List all items (files) and prefixes (folders) under this storage reference. - * - * This is a helper method for calling list() repeatedly until there are - * no more results. The default pagination size is 1000. - * - * Note: The results may not be consistent if objects are changed while this - * operation is running. - * - * Warning: listAll may potentially consume too many resources if there are - * too many results. - * - * @return A Promise that resolves with all the items and prefixes under - * the current storage reference. `prefixes` contains references to - * sub-directories and `items` contains references to objects in this - * folder. `nextPageToken` is never returned. - */ - listAll(): Promise { - const accumulator = { - prefixes: [], - items: [] - }; - return this.listAllHelper(accumulator).then(() => accumulator); +/** + * Uploads a string to this object's location. + * @public + * @param ref - Storage Reference where string should be uploaded. + * @param value - The string to upload. + * @param format - The format of the string to upload. + * @param metadata - Metadata for the newly uploaded object. + * @returns An UploadTask that lets you control and + * observe the upload. + */ +export function uploadString( + ref: Reference, + value: string, + format: StringFormat = StringFormat.RAW, + metadata?: Metadata +): UploadTask { + ref._throwIfRoot('putString'); + const data = dataFromString(format, value); + const metadataClone = { ...metadata } as Metadata; + if (metadataClone['contentType'] == null && data.contentType != null) { + metadataClone['contentType'] = data.contentType!; } + return new UploadTask(ref, new FbsBlob(data.data, true), metadataClone); +} - private async listAllHelper( - accumulator: ListResult, - pageToken?: string - ): Promise { - const opt: ListOptions = { - // maxResults is 1000 by default. - pageToken - }; - const nextPage = await this.list(opt); - accumulator.prefixes.push(...nextPage.prefixes); - accumulator.items.push(...nextPage.items); - if (nextPage.nextPageToken != null) { - await this.listAllHelper(accumulator, nextPage.nextPageToken); - } +/** + * List all items (files) and prefixes (folders) under this storage reference. + * + * This is a helper method for calling list() repeatedly until there are + * no more results. The default pagination size is 1000. + * + * Note: The results may not be consistent if objects are changed while this + * operation is running. + * + * Warning: listAll may potentially consume too many resources if there are + * too many results. + * @public + * @param ref - Storage Reference to get list from. + * + * @returns A Promise that resolves with all the items and prefixes under + * the current storage reference. `prefixes` contains references to + * sub-directories and `items` contains references to objects in this + * folder. `nextPageToken` is never returned. + */ +export function listAll(ref: Reference): Promise { + const accumulator: ListResult = { + prefixes: [], + items: [] + }; + return listAllHelper(ref, accumulator).then(() => accumulator); +} + +/** + * Separated from listAll because async functions can't use "arguments". + * @internal + * @param ref + * @param accumulator + * @param pageToken + */ +async function listAllHelper( + ref: Reference, + accumulator: ListResult, + pageToken?: string +): Promise { + const opt: ListOptions = { + // maxResults is 1000 by default. + pageToken + }; + const nextPage = await list(ref, opt); + accumulator.prefixes.push(...nextPage.prefixes); + accumulator.items.push(...nextPage.items); + if (nextPage.nextPageToken != null) { + await listAllHelper(ref, accumulator, nextPage.nextPageToken); } +} - /** - * List items (files) and prefixes (folders) under this storage reference. - * - * List API is only available for Firebase Rules Version 2. - * - * GCS is a key-blob store. Firebase Storage imposes the semantic of '/' - * delimited folder structure. - * Refer to GCS's List API if you want to learn more. - * - * To adhere to Firebase Rules's Semantics, Firebase Storage does not - * support objects whose paths end with "/" or contain two consecutive - * "/"s. Firebase Storage List API will filter these unsupported objects. - * list() may fail if there are too many unsupported objects in the bucket. - * - * @param options See ListOptions for details. - * @return A Promise that resolves with the items and prefixes. - * `prefixes` contains references to sub-folders and `items` - * contains references to objects in this folder. `nextPageToken` - * can be used to get the rest of the results. - */ - list(options?: ListOptions | null): Promise { - const op = options || {}; - if (typeof op.maxResults === 'number') { +/** + * List items (files) and prefixes (folders) under this storage reference. + * + * List API is only available for Firebase Rules Version 2. + * + * GCS is a key-blob store. Firebase Storage imposes the semantic of '/' + * delimited folder structure. + * Refer to GCS's List API if you want to learn more. + * + * To adhere to Firebase Rules's Semantics, Firebase Storage does not + * support objects whose paths end with "/" or contain two consecutive + * "/"s. Firebase Storage List API will filter these unsupported objects. + * list() may fail if there are too many unsupported objects in the bucket. + * @public + * + * @param ref - Storage Reference to get list from. + * @param options - See ListOptions for details. + * @returns A Promise that resolves with the items and prefixes. + * `prefixes` contains references to sub-folders and `items` + * contains references to objects in this folder. `nextPageToken` + * can be used to get the rest of the results. + */ +export async function list( + ref: Reference, + options?: ListOptions | null +): Promise { + if (options != null) { + if (typeof options.maxResults === 'number') { validateNumber( 'options.maxResults', /* minValue= */ 1, /* maxValue= */ 1000, - op.maxResults + options.maxResults ); } - return this.service.getAuthToken().then(authToken => { - const requestInfo = requests.list( - this.service, - this.location, - /*delimiter= */ '/', - op.pageToken, - op.maxResults - ); - return this.service.makeRequest(requestInfo, authToken).getPromise(); - }); } + const authToken = await ref.storage.getAuthToken(); + const op = options || {}; + const requestInfo = requestsList( + ref.storage, + ref._location, + /*delimiter= */ '/', + op.pageToken, + op.maxResults + ); + return ref.storage.makeRequest(requestInfo, authToken).getPromise(); +} - /** - * A promise that resolves with the metadata for this object. If this - * object doesn't exist or metadata cannot be retreived, the promise is - * rejected. - */ - getMetadata(): Promise { - this.throwIfRoot_('getMetadata'); - return this.service.getAuthToken().then(authToken => { - const requestInfo = requests.getMetadata( - this.service, - this.location, - this.mappings() - ); - return this.service.makeRequest(requestInfo, authToken).getPromise(); - }); - } +/** + * A promise that resolves with the metadata for this object. If this + * object doesn't exist or metadata cannot be retreived, the promise is + * rejected. + * @public + * @param ref - Storage Reference to get metadata from. + */ +export async function getMetadata(ref: Reference): Promise { + ref._throwIfRoot('getMetadata'); + const authToken = await ref.storage.getAuthToken(); + const requestInfo = requestsGetMetadata( + ref.storage, + ref._location, + getMappings() + ); + return ref.storage.makeRequest(requestInfo, authToken).getPromise(); +} - /** - * Updates the metadata for this object. - * @param metadata The new metadata for the object. - * Only values that have been explicitly set will be changed. Explicitly - * setting a value to null will remove the metadata. - * @return A promise that resolves - * with the new metadata for this object. - * @see firebaseStorage.Reference.prototype.getMetadata - */ - updateMetadata(metadata: Metadata): Promise { - this.throwIfRoot_('updateMetadata'); - return this.service.getAuthToken().then(authToken => { - const requestInfo = requests.updateMetadata( - this.service, - this.location, - metadata, - this.mappings() - ); - return this.service.makeRequest(requestInfo, authToken).getPromise(); - }); - } +/** + * Updates the metadata for this object. + * @public + * @param ref - Storage Reference to update metadata for. + * @param metadata - The new metadata for the object. + * Only values that have been explicitly set will be changed. Explicitly + * setting a value to null will remove the metadata. + * @returns A promise that resolves + * with the new metadata for this object. + * See `firebaseStorage.Reference.prototype.getMetadata` + */ +export async function updateMetadata( + ref: Reference, + metadata: Metadata +): Promise { + ref._throwIfRoot('updateMetadata'); + const authToken = await ref.storage.getAuthToken(); + const requestInfo = requestsUpdateMetadata( + ref.storage, + ref._location, + metadata, + getMappings() + ); + return ref.storage.makeRequest(requestInfo, authToken).getPromise(); +} - /** - * @return A promise that resolves with the download - * URL for this object. - */ - getDownloadURL(): Promise { - this.throwIfRoot_('getDownloadURL'); - return this.service.getAuthToken().then(authToken => { - const requestInfo = requests.getDownloadUrl( - this.service, - this.location, - this.mappings() - ); - return this.service - .makeRequest(requestInfo, authToken) - .getPromise() - .then(url => { - if (url === null) { - throw errorsExports.noDownloadURL(); - } - return url; - }); +/** + * Returns the download URL for the given Reference. + * @public + * @returns A promise that resolves with the download + * URL for this object. + */ +export async function getDownloadURL(ref: Reference): Promise { + ref._throwIfRoot('getDownloadURL'); + const authToken = await ref.storage.getAuthToken(); + const requestInfo = requestsGetDownloadUrl( + ref.storage, + ref._location, + getMappings() + ); + return ref.storage + .makeRequest(requestInfo, authToken) + .getPromise() + .then(url => { + if (url === null) { + throw noDownloadURL(); + } + return url; }); - } +} - private throwIfRoot_(name: string): void { - if (this.location.path === '') { - throw errorsExports.invalidRootOperation(name); - } - } +/** + * Deletes the object at this location. + * @public + * @param ref - Storage Reference for object to delete. + * @returns A promise that resolves if the deletion succeeds. + */ +export async function deleteObject(ref: Reference): Promise { + ref._throwIfRoot('deleteObject'); + const authToken = await ref.storage.getAuthToken(); + const requestInfo = requestsDeleteObject(ref.storage, ref._location); + return ref.storage.makeRequest(requestInfo, authToken).getPromise(); +} + +/** + * Returns reference for object obtained by appending `childPath` to `ref`. + * @internal + * + * @param ref - Storage Reference to get child of. + * @param childPath - Child path from provided ref. + * @returns A reference to the object obtained by + * appending childPath, removing any duplicate, beginning, or trailing + * slashes. + */ +export function getChild(ref: Reference, childPath: string): Reference { + const newPath = child(ref._location.path, childPath); + const location = new Location(ref._location.bucket, newPath); + return new Reference(ref.storage, location); } diff --git a/packages/storage/src/service.ts b/packages/storage/src/service.ts index 54377f7b2fa..d2aba09ba17 100644 --- a/packages/storage/src/service.ts +++ b/packages/storage/src/service.ts @@ -15,220 +15,237 @@ * limitations under the License. */ -import { FirebaseApp } from '@firebase/app-types'; import { Location } from './implementation/location'; import { FailRequest } from './implementation/failrequest'; import { Request, makeRequest } from './implementation/request'; import { RequestInfo } from './implementation/requestinfo'; import { XhrIoPool } from './implementation/xhriopool'; -import { Reference } from './reference'; +import { Reference, getChild } from './reference'; import { Provider } from '@firebase/component'; import { FirebaseAuthInternalName } from '@firebase/auth-interop-types'; -import { FirebaseOptions } from '@firebase/app-types-exp'; +import { + FirebaseApp, + FirebaseOptions, + _FirebaseService +} from '@firebase/app-types-exp'; import * as constants from '../src/implementation/constants'; -import * as errorsExports from './implementation/error'; -import { Code, FirebaseStorageError } from './implementation/error'; +import { + invalidArgument, + appDeleted, + noDefaultBucket +} from './implementation/error'; import { validateNumber } from './implementation/type'; +export function isUrl(path?: string): boolean { + return /^[A-Za-z]+:\/\//.test(path as string); +} + /** - * A service that provides firebaseStorage.Reference instances. - * @param opt_url gs:// url to a custom Storage Bucket - * - * @struct + * Returns a firebaseStorage.Reference for the given url. */ -export class StorageService { - private app_: FirebaseApp | null; - private readonly bucket_: Location | null = null; - private readonly internals_: ServiceInternals; - private readonly authProvider_: Provider; - private readonly appId_: string | null = null; - private readonly pool_: XhrIoPool; - private readonly requests_: Set>; - private deleted_: boolean = false; - private maxOperationRetryTime_: number; - private maxUploadRetryTime_: number; +function refFromURL(service: StorageService, url: string): Reference { + return new Reference(service, url); +} - constructor( - app: FirebaseApp | null, - authProvider: Provider, - pool: XhrIoPool, - url?: string - ) { - this.app_ = app; - this.authProvider_ = authProvider; - this.maxOperationRetryTime_ = constants.DEFAULT_MAX_OPERATION_RETRY_TIME; - this.maxUploadRetryTime_ = constants.DEFAULT_MAX_UPLOAD_RETRY_TIME; - this.requests_ = new Set(); - this.pool_ = pool; - if (url != null) { - this.bucket_ = Location.makeFromBucketSpec(url); - } else { - this.bucket_ = StorageService.extractBucket_(this.app_?.options); +/** + * Returns a firebaseStorage.Reference for the given path in the default + * bucket. + */ +function refFromPath( + ref: StorageService | Reference, + path?: string +): Reference { + if (ref instanceof StorageService) { + const service = ref; + if (service._bucket == null) { + throw noDefaultBucket(); } - this.internals_ = new ServiceInternals(this); - } - - private static extractBucket_(config?: FirebaseOptions): Location | null { - const bucketString = config?.[constants.CONFIG_STORAGE_BUCKET_KEY]; - if (bucketString == null) { - return null; + const reference = new Reference(service, service._bucket!); + if (path != null) { + return refFromPath(reference, path); + } else { + return reference; } - return Location.makeFromBucketSpec(bucketString); - } - - async getAuthToken(): Promise { - const auth = this.authProvider_.getImmediate({ optional: true }); - if (auth) { - const tokenData = await auth.getToken(); - if (tokenData !== null) { - return tokenData.accessToken; + } else { + // ref is a Reference + if (path !== undefined) { + if (path.includes('..')) { + throw invalidArgument('`path` param cannot contain ".."'); } - } - return null; - } - - /** - * Stop running requests and prevent more from being created. - */ - deleteApp(): void { - this.deleted_ = true; - this.app_ = null; - this.requests_.forEach(request => request.cancel()); - this.requests_.clear(); - } - - /** - * Returns a new firebaseStorage.Reference object referencing this StorageService - * at the given Location. - * @param loc The Location. - * @return A firebaseStorage.Reference. - */ - makeStorageReference(loc: Location): Reference { - return new Reference(this, loc); - } - - makeRequest( - requestInfo: RequestInfo, - authToken: string | null - ): Request { - if (!this.deleted_) { - const request = makeRequest( - requestInfo, - this.appId_, - authToken, - this.pool_ - ); - this.requests_.add(request); - // Request removes itself from set when complete. - request.getPromise().then( - () => this.requests_.delete(request), - () => this.requests_.delete(request) - ); - return request; + return getChild(ref, path); } else { - return new FailRequest(errorsExports.appDeleted()); + return ref; } } +} - /** - * Returns a firebaseStorage.Reference for the given path in the default - * bucket. - */ - ref(path?: string): Reference { - if (/^[A-Za-z]+:\/\//.test(path as string)) { - throw new FirebaseStorageError( - Code.INVALID_ARGUMENT, - 'Expected child path but got a URL, use refFromURL instead.' +/** + * Returns a storage Reference for the given url. + * @param storage - `Storage` instance. + * @param url - URL. If empty, returns root reference. + * @public + */ +export function ref(storage: StorageService, url?: string): Reference; +/** + * Returns a storage Reference for the given path in the + * default bucket. + * @param storageOrRef - `Storage` service or storage `Reference`. + * @param pathOrUrlStorage - path. If empty, returns root reference (if Storage + * instance provided) or returns same reference (if Reference provided). + * @public + */ +export function ref( + storageOrRef: StorageService | Reference, + path?: string +): Reference; +export function ref( + serviceOrRef: StorageService | Reference, + pathOrUrl?: string +): Reference | null { + if (pathOrUrl && isUrl(pathOrUrl)) { + if (serviceOrRef instanceof StorageService) { + return refFromURL(serviceOrRef, pathOrUrl); + } else { + throw invalidArgument( + 'To use ref(service, url), the first argument must be a Storage instance.' ); } + } else { + return refFromPath(serviceOrRef, pathOrUrl); + } +} - if (this.bucket_ == null) { - throw new Error('No Storage Bucket defined in Firebase Options.'); - } - - const ref = new Reference(this, this.bucket_); - if (path != null) { - return ref.child(path); - } else { - return ref; - } +function extractBucket(config?: FirebaseOptions): Location | null { + const bucketString = config?.[constants.CONFIG_STORAGE_BUCKET_KEY]; + if (bucketString == null) { + return null; } + return Location.makeFromBucketSpec(bucketString); +} +/** + * A service that provides Firebase Storage Reference instances. + * @param opt_url - gs:// url to a custom Storage Bucket + */ +export class StorageService implements _FirebaseService { /** - * Returns a firebaseStorage.Reference object for the given absolute URL, - * which must be a gs:// or http[s]:// URL. + * @internal */ - refFromURL(url: string): Reference { - if (!/^[A-Za-z]+:\/\//.test(url)) { - throw new FirebaseStorageError( - Code.INVALID_ARGUMENT, - 'Expected full URL but got a child path, use ref instead.' - ); - } - try { - Location.makeFromUrl(url); - } catch (e) { - throw new FirebaseStorageError( - Code.INVALID_ARGUMENT, - 'Expected valid full URL but got an invalid one.' - ); - } + readonly _bucket: Location | null = null; + protected readonly _appId: string | null = null; + private readonly _requests: Set>; + private _deleted: boolean = false; + private _maxOperationRetryTime: number; + private _maxUploadRetryTime: number; - return new Reference(this, url); + constructor( + readonly app: FirebaseApp, + /** + * @internal + */ + readonly _authProvider: Provider, + /** + * @internal + */ + readonly _pool: XhrIoPool, + /** + * @internal + */ + readonly _url?: string + ) { + this._maxOperationRetryTime = constants.DEFAULT_MAX_OPERATION_RETRY_TIME; + this._maxUploadRetryTime = constants.DEFAULT_MAX_UPLOAD_RETRY_TIME; + this._requests = new Set(); + if (_url != null) { + this._bucket = Location.makeFromBucketSpec(_url); + } else { + this._bucket = extractBucket(this.app.options); + } } get maxUploadRetryTime(): number { - return this.maxUploadRetryTime_; + return this._maxUploadRetryTime; } - setMaxUploadRetryTime(time: number): void { + set maxUploadRetryTime(time: number) { validateNumber( 'time', /* minValue=*/ 0, /* maxValue= */ Number.POSITIVE_INFINITY, time ); - this.maxUploadRetryTime_ = time; + this._maxUploadRetryTime = time; } get maxOperationRetryTime(): number { - return this.maxOperationRetryTime_; + return this._maxOperationRetryTime; } - setMaxOperationRetryTime(time: number): void { + set maxOperationRetryTime(time: number) { validateNumber( 'time', /* minValue=*/ 0, /* maxValue= */ Number.POSITIVE_INFINITY, time ); - this.maxOperationRetryTime_ = time; + this._maxOperationRetryTime = time; } - get app(): FirebaseApp | null { - return this.app_; + async getAuthToken(): Promise { + const auth = this._authProvider.getImmediate({ optional: true }); + if (auth) { + const tokenData = await auth.getToken(); + if (tokenData !== null) { + return tokenData.accessToken; + } + } + return null; } - get INTERNAL(): ServiceInternals { - return this.internals_; + /** + * Stop running requests and prevent more from being created. + * @internal + */ + _delete(): Promise { + this._deleted = true; + this._requests.forEach(request => request.cancel()); + this._requests.clear(); + return Promise.resolve(); } -} - -/** - * @struct - */ -export class ServiceInternals { - service_: StorageService; - constructor(service: StorageService) { - this.service_ = service; + /** + * Returns a new firebaseStorage.Reference object referencing this StorageService + * at the given Location. + */ + makeStorageReference(loc: Location): Reference { + return new Reference(this, loc); } /** - * Called when the associated app is deleted. + * @internal + * @param requestInfo - HTTP RequestInfo object + * @param authToken - Firebase auth token */ - delete(): Promise { - this.service_.deleteApp(); - return Promise.resolve(); + makeRequest( + requestInfo: RequestInfo, + authToken: string | null + ): Request { + if (!this._deleted) { + const request = makeRequest( + requestInfo, + this._appId, + authToken, + this._pool + ); + this._requests.add(request); + // Request removes itself from set when complete. + request.getPromise().then( + () => this._requests.delete(request), + () => this._requests.delete(request) + ); + return request; + } else { + return new FailRequest(appDeleted()); + } } } diff --git a/packages/storage/src/task.ts b/packages/storage/src/task.ts index 0d330d9a5db..9d9242444c7 100644 --- a/packages/storage/src/task.ts +++ b/packages/storage/src/task.ts @@ -30,7 +30,6 @@ import { Metadata } from './metadata'; import { CompleteFn, ErrorFn, - NextFn, Observer, StorageObserver, Subscribe, @@ -39,140 +38,140 @@ import { import { Request } from './implementation/request'; import { UploadTaskSnapshot } from './tasksnapshot'; import { async as fbsAsync } from './implementation/async'; -import { Location } from './implementation/location'; import * as fbsMetadata from './implementation/metadata'; import * as fbsRequests from './implementation/requests'; import { Reference } from './reference'; -import { StorageService } from './service'; +import { getMappings } from './implementation/metadata'; /** * Represents a blob being uploaded. Can be used to pause/resume/cancel the * upload and manage callbacks for various events. */ export class UploadTask { - private ref_: Reference; - private service_: StorageService; - private location_: Location; - private blob_: FbsBlob; - private metadata_: Metadata | null; - private mappings_: fbsMetadata.Mappings; - private transferred_: number = 0; - private needToFetchStatus_: boolean = false; - private needToFetchMetadata_: boolean = false; - private observers_: Array> = []; - private resumable_: boolean; - private state_: InternalTaskState; - private error_: Error | null = null; - private uploadUrl_: string | null = null; - private request_: Request | null = null; - private chunkMultiplier_: number = 1; - private errorHandler_: (p1: FirebaseStorageError) => void; - private metadataErrorHandler_: (p1: FirebaseStorageError) => void; - private resolve_: ((p1: UploadTaskSnapshot) => void) | null = null; - private reject_: ((p1: Error) => void) | null = null; - private promise_: Promise; + private _ref: Reference; + /** + * @internal + */ + _blob: FbsBlob; + /** + * @internal + */ + _metadata: Metadata | null; + private _mappings: fbsMetadata.Mappings; + /** + * @internal + */ + _transferred: number = 0; + private _needToFetchStatus: boolean = false; + private _needToFetchMetadata: boolean = false; + private _observers: Array> = []; + private _resumable: boolean; + /** + * @internal + */ + _state: InternalTaskState; + private _error?: FirebaseStorageError = undefined; + private _uploadUrl?: string = undefined; + private _request?: Request = undefined; + private _chunkMultiplier: number = 1; + private _errorHandler: (p1: FirebaseStorageError) => void; + private _metadataErrorHandler: (p1: FirebaseStorageError) => void; + private _resolve?: (p1: UploadTaskSnapshot) => void = undefined; + private _reject?: (p1: FirebaseStorageError) => void = undefined; + private _promise: Promise; /** - * @param ref The firebaseStorage.Reference object this task came + * @param ref - The firebaseStorage.Reference object this task came * from, untyped to avoid cyclic dependencies. - * @param blob The blob to upload. + * @param blob - The blob to upload. */ - constructor( - ref: Reference, - service: StorageService, - location: Location, - mappings: fbsMetadata.Mappings, - blob: FbsBlob, - metadata: Metadata | null = null - ) { - this.ref_ = ref; - this.service_ = service; - this.location_ = location; - this.blob_ = blob; - this.metadata_ = metadata; - this.mappings_ = mappings; - this.resumable_ = this.shouldDoResumable_(this.blob_); - this.state_ = InternalTaskState.RUNNING; - this.errorHandler_ = error => { - this.request_ = null; - this.chunkMultiplier_ = 1; + constructor(ref: Reference, blob: FbsBlob, metadata: Metadata | null = null) { + this._ref = ref; + this._blob = blob; + this._metadata = metadata; + this._mappings = getMappings(); + this._resumable = this._shouldDoResumable(this._blob); + this._state = InternalTaskState.RUNNING; + this._errorHandler = error => { + this._request = undefined; + this._chunkMultiplier = 1; if (error.codeEquals(Code.CANCELED)) { - this.needToFetchStatus_ = true; + this._needToFetchStatus = true; this.completeTransitions_(); } else { - this.error_ = error; - this.transition_(InternalTaskState.ERROR); + this._error = error; + this._transition(InternalTaskState.ERROR); } }; - this.metadataErrorHandler_ = error => { - this.request_ = null; + this._metadataErrorHandler = error => { + this._request = undefined; if (error.codeEquals(Code.CANCELED)) { this.completeTransitions_(); } else { - this.error_ = error; - this.transition_(InternalTaskState.ERROR); + this._error = error; + this._transition(InternalTaskState.ERROR); } }; - this.promise_ = new Promise((resolve, reject) => { - this.resolve_ = resolve; - this.reject_ = reject; - this.start_(); + this._promise = new Promise((resolve, reject) => { + this._resolve = resolve; + this._reject = reject; + this._start(); }); // Prevent uncaught rejections on the internal promise from bubbling out // to the top level with a dummy handler. - this.promise_.then(null, () => {}); + this._promise.then(null, () => {}); } - private makeProgressCallback_(): (p1: number, p2: number) => void { - const sizeBefore = this.transferred_; - return loaded => this.updateProgress_(sizeBefore + loaded); + private _makeProgressCallback(): (p1: number, p2: number) => void { + const sizeBefore = this._transferred; + return loaded => this._updateProgress(sizeBefore + loaded); } - private shouldDoResumable_(blob: FbsBlob): boolean { + private _shouldDoResumable(blob: FbsBlob): boolean { return blob.size() > 256 * 1024; } - private start_(): void { - if (this.state_ !== InternalTaskState.RUNNING) { + private _start(): void { + if (this._state !== InternalTaskState.RUNNING) { // This can happen if someone pauses us in a resume callback, for example. return; } - if (this.request_ !== null) { + if (this._request !== undefined) { return; } - if (this.resumable_) { - if (this.uploadUrl_ === null) { - this.createResumable_(); + if (this._resumable) { + if (this._uploadUrl === undefined) { + this._createResumable(); } else { - if (this.needToFetchStatus_) { - this.fetchStatus_(); + if (this._needToFetchStatus) { + this._fetchStatus(); } else { - if (this.needToFetchMetadata_) { + if (this._needToFetchMetadata) { // Happens if we miss the metadata on upload completion. - this.fetchMetadata_(); + this._fetchMetadata(); } else { - this.continueUpload_(); + this._continueUpload(); } } } } else { - this.oneShotUpload_(); + this._oneShotUpload(); } } - private resolveToken_(callback: (p1: string | null) => void): void { + private _resolveToken(callback: (p1: string | null) => void): void { // eslint-disable-next-line @typescript-eslint/no-floating-promises - this.service_.getAuthToken().then(authToken => { - switch (this.state_) { + this._ref.storage.getAuthToken().then(authToken => { + switch (this._state) { case InternalTaskState.RUNNING: callback(authToken); break; case InternalTaskState.CANCELING: - this.transition_(InternalTaskState.CANCELED); + this._transition(InternalTaskState.CANCELED); break; case InternalTaskState.PAUSING: - this.transition_(InternalTaskState.PAUSED); + this._transition(InternalTaskState.PAUSED); break; default: } @@ -181,161 +180,173 @@ export class UploadTask { // TODO(andysoto): assert false - private createResumable_(): void { - this.resolveToken_(authToken => { + private _createResumable(): void { + this._resolveToken(authToken => { const requestInfo = fbsRequests.createResumableUpload( - this.service_, - this.location_, - this.mappings_, - this.blob_, - this.metadata_ + this._ref.storage, + this._ref._location, + this._mappings, + this._blob, + this._metadata + ); + const createRequest = this._ref.storage.makeRequest( + requestInfo, + authToken ); - const createRequest = this.service_.makeRequest(requestInfo, authToken); - this.request_ = createRequest; + this._request = createRequest; createRequest.getPromise().then((url: string) => { - this.request_ = null; - this.uploadUrl_ = url; - this.needToFetchStatus_ = false; + this._request = undefined; + this._uploadUrl = url; + this._needToFetchStatus = false; this.completeTransitions_(); - }, this.errorHandler_); + }, this._errorHandler); }); } - private fetchStatus_(): void { + private _fetchStatus(): void { // TODO(andysoto): assert(this.uploadUrl_ !== null); - const url = this.uploadUrl_ as string; - this.resolveToken_(authToken => { + const url = this._uploadUrl as string; + this._resolveToken(authToken => { const requestInfo = fbsRequests.getResumableUploadStatus( - this.service_, - this.location_, + this._ref.storage, + this._ref._location, url, - this.blob_ + this._blob ); - const statusRequest = this.service_.makeRequest(requestInfo, authToken); - this.request_ = statusRequest; + const statusRequest = this._ref.storage.makeRequest( + requestInfo, + authToken + ); + this._request = statusRequest; statusRequest.getPromise().then(status => { status = status as fbsRequests.ResumableUploadStatus; - this.request_ = null; - this.updateProgress_(status.current); - this.needToFetchStatus_ = false; + this._request = undefined; + this._updateProgress(status.current); + this._needToFetchStatus = false; if (status.finalized) { - this.needToFetchMetadata_ = true; + this._needToFetchMetadata = true; } this.completeTransitions_(); - }, this.errorHandler_); + }, this._errorHandler); }); } - private continueUpload_(): void { + private _continueUpload(): void { const chunkSize = - fbsRequests.resumableUploadChunkSize * this.chunkMultiplier_; + fbsRequests.resumableUploadChunkSize * this._chunkMultiplier; const status = new fbsRequests.ResumableUploadStatus( - this.transferred_, - this.blob_.size() + this._transferred, + this._blob.size() ); // TODO(andysoto): assert(this.uploadUrl_ !== null); - const url = this.uploadUrl_ as string; - this.resolveToken_(authToken => { + const url = this._uploadUrl as string; + this._resolveToken(authToken => { let requestInfo; try { requestInfo = fbsRequests.continueResumableUpload( - this.location_, - this.service_, + this._ref._location, + this._ref.storage, url, - this.blob_, + this._blob, chunkSize, - this.mappings_, + this._mappings, status, - this.makeProgressCallback_() + this._makeProgressCallback() ); } catch (e) { - this.error_ = e; - this.transition_(InternalTaskState.ERROR); + this._error = e; + this._transition(InternalTaskState.ERROR); return; } - const uploadRequest = this.service_.makeRequest(requestInfo, authToken); - this.request_ = uploadRequest; + const uploadRequest = this._ref.storage.makeRequest( + requestInfo, + authToken + ); + this._request = uploadRequest; uploadRequest .getPromise() .then((newStatus: fbsRequests.ResumableUploadStatus) => { - this.increaseMultiplier_(); - this.request_ = null; - this.updateProgress_(newStatus.current); + this._increaseMultiplier(); + this._request = undefined; + this._updateProgress(newStatus.current); if (newStatus.finalized) { - this.metadata_ = newStatus.metadata; - this.transition_(InternalTaskState.SUCCESS); + this._metadata = newStatus.metadata; + this._transition(InternalTaskState.SUCCESS); } else { this.completeTransitions_(); } - }, this.errorHandler_); + }, this._errorHandler); }); } - private increaseMultiplier_(): void { + private _increaseMultiplier(): void { const currentSize = - fbsRequests.resumableUploadChunkSize * this.chunkMultiplier_; + fbsRequests.resumableUploadChunkSize * this._chunkMultiplier; // Max chunk size is 32M. if (currentSize < 32 * 1024 * 1024) { - this.chunkMultiplier_ *= 2; + this._chunkMultiplier *= 2; } } - private fetchMetadata_(): void { - this.resolveToken_(authToken => { + private _fetchMetadata(): void { + this._resolveToken(authToken => { const requestInfo = fbsRequests.getMetadata( - this.service_, - this.location_, - this.mappings_ + this._ref.storage, + this._ref._location, + this._mappings + ); + const metadataRequest = this._ref.storage.makeRequest( + requestInfo, + authToken ); - const metadataRequest = this.service_.makeRequest(requestInfo, authToken); - this.request_ = metadataRequest; + this._request = metadataRequest; metadataRequest.getPromise().then(metadata => { - this.request_ = null; - this.metadata_ = metadata; - this.transition_(InternalTaskState.SUCCESS); - }, this.metadataErrorHandler_); + this._request = undefined; + this._metadata = metadata; + this._transition(InternalTaskState.SUCCESS); + }, this._metadataErrorHandler); }); } - private oneShotUpload_(): void { - this.resolveToken_(authToken => { + private _oneShotUpload(): void { + this._resolveToken(authToken => { const requestInfo = fbsRequests.multipartUpload( - this.service_, - this.location_, - this.mappings_, - this.blob_, - this.metadata_ + this._ref.storage, + this._ref._location, + this._mappings, + this._blob, + this._metadata ); - const multipartRequest = this.service_.makeRequest( + const multipartRequest = this._ref.storage.makeRequest( requestInfo, authToken ); - this.request_ = multipartRequest; + this._request = multipartRequest; multipartRequest.getPromise().then(metadata => { - this.request_ = null; - this.metadata_ = metadata; - this.updateProgress_(this.blob_.size()); - this.transition_(InternalTaskState.SUCCESS); - }, this.errorHandler_); + this._request = undefined; + this._metadata = metadata; + this._updateProgress(this._blob.size()); + this._transition(InternalTaskState.SUCCESS); + }, this._errorHandler); }); } - private updateProgress_(transferred: number): void { - const old = this.transferred_; - this.transferred_ = transferred; + private _updateProgress(transferred: number): void { + const old = this._transferred; + this._transferred = transferred; // A progress update can make the "transferred" value smaller (e.g. a // partial upload not completed by server, after which the "transferred" // value may reset to the value at the beginning of the request). - if (this.transferred_ !== old) { - this.notifyObservers_(); + if (this._transferred !== old) { + this._notifyObservers(); } } - private transition_(state: InternalTaskState): void { - if (this.state_ === state) { + private _transition(state: InternalTaskState): void { + if (this._state === state) { return; } switch (state) { @@ -343,74 +354,74 @@ export class UploadTask { // TODO(andysoto): // assert(this.state_ === InternalTaskState.RUNNING || // this.state_ === InternalTaskState.PAUSING); - this.state_ = state; - if (this.request_ !== null) { - this.request_.cancel(); + this._state = state; + if (this._request !== undefined) { + this._request.cancel(); } break; case InternalTaskState.PAUSING: // TODO(andysoto): // assert(this.state_ === InternalTaskState.RUNNING); - this.state_ = state; - if (this.request_ !== null) { - this.request_.cancel(); + this._state = state; + if (this._request !== undefined) { + this._request.cancel(); } break; case InternalTaskState.RUNNING: // TODO(andysoto): // assert(this.state_ === InternalTaskState.PAUSED || // this.state_ === InternalTaskState.PAUSING); - const wasPaused = this.state_ === InternalTaskState.PAUSED; - this.state_ = state; + const wasPaused = this._state === InternalTaskState.PAUSED; + this._state = state; if (wasPaused) { - this.notifyObservers_(); - this.start_(); + this._notifyObservers(); + this._start(); } break; case InternalTaskState.PAUSED: // TODO(andysoto): // assert(this.state_ === InternalTaskState.PAUSING); - this.state_ = state; - this.notifyObservers_(); + this._state = state; + this._notifyObservers(); break; case InternalTaskState.CANCELED: // TODO(andysoto): // assert(this.state_ === InternalTaskState.PAUSED || // this.state_ === InternalTaskState.CANCELING); - this.error_ = canceled(); - this.state_ = state; - this.notifyObservers_(); + this._error = canceled(); + this._state = state; + this._notifyObservers(); break; case InternalTaskState.ERROR: // TODO(andysoto): // assert(this.state_ === InternalTaskState.RUNNING || // this.state_ === InternalTaskState.PAUSING || // this.state_ === InternalTaskState.CANCELING); - this.state_ = state; - this.notifyObservers_(); + this._state = state; + this._notifyObservers(); break; case InternalTaskState.SUCCESS: // TODO(andysoto): // assert(this.state_ === InternalTaskState.RUNNING || // this.state_ === InternalTaskState.PAUSING || // this.state_ === InternalTaskState.CANCELING); - this.state_ = state; - this.notifyObservers_(); + this._state = state; + this._notifyObservers(); break; default: // Ignore } } private completeTransitions_(): void { - switch (this.state_) { + switch (this._state) { case InternalTaskState.PAUSING: - this.transition_(InternalTaskState.PAUSED); + this._transition(InternalTaskState.PAUSED); break; case InternalTaskState.CANCELING: - this.transition_(InternalTaskState.CANCELED); + this._transition(InternalTaskState.CANCELED); break; case InternalTaskState.RUNNING: - this.start_(); + this._start(); break; default: // TODO(andysoto): assert(false); @@ -419,50 +430,49 @@ export class UploadTask { } get snapshot(): UploadTaskSnapshot { - const externalState = taskStateFromInternalTaskState(this.state_); + const externalState = taskStateFromInternalTaskState(this._state); return new UploadTaskSnapshot( - this.transferred_, - this.blob_.size(), + this._transferred, + this._blob.size(), externalState, - this.metadata_, + this._metadata!, this, - this.ref_ + this._ref ); } /** * Adds a callback for an event. - * @param type The type of event to listen for. + * @param type - The type of event to listen for. */ on( type: TaskEvent, nextOrObserver?: - | NextFn | StorageObserver - | null, - error?: ErrorFn | null, - completed?: CompleteFn | null + | ((a: UploadTaskSnapshot) => unknown), + error?: ErrorFn, + completed?: CompleteFn ): Unsubscribe | Subscribe { const observer = new Observer(nextOrObserver, error, completed); - this.addObserver_(observer); + this._addObserver(observer); return () => { - this.removeObserver_(observer); + this._removeObserver(observer); }; } /** * This object behaves like a Promise, and resolves with its snapshot data * when the upload completes. - * @param onFulfilled The fulfillment callback. Promise chaining works as normal. - * @param onRejected The rejection callback. + * @param onFulfilled - The fulfillment callback. Promise chaining works as normal. + * @param onRejected - The rejection callback. */ then( onFulfilled?: ((value: UploadTaskSnapshot) => U | Promise) | null, - onRejected?: ((error: Error) => U | Promise) | null + onRejected?: ((error: FirebaseStorageError) => U | Promise) | null ): Promise { // These casts are needed so that TypeScript can infer the types of the // resulting Promise. - return this.promise_.then( + return this._promise.then( onFulfilled as (value: UploadTaskSnapshot) => U | Promise, onRejected as ((error: unknown) => Promise) | null ); @@ -471,61 +481,63 @@ export class UploadTask { /** * Equivalent to calling `then(null, onRejected)`. */ - catch(onRejected: (p1: Error) => T | Promise): Promise { + catch( + onRejected: (p1: FirebaseStorageError) => T | Promise + ): Promise { return this.then(null, onRejected); } /** * Adds the given observer. */ - private addObserver_(observer: Observer): void { - this.observers_.push(observer); - this.notifyObserver_(observer); + private _addObserver(observer: Observer): void { + this._observers.push(observer); + this._notifyObserver(observer); } /** * Removes the given observer. */ - private removeObserver_(observer: Observer): void { - const i = this.observers_.indexOf(observer); + private _removeObserver(observer: Observer): void { + const i = this._observers.indexOf(observer); if (i !== -1) { - this.observers_.splice(i, 1); + this._observers.splice(i, 1); } } - private notifyObservers_(): void { - this.finishPromise_(); - const observers = this.observers_.slice(); + private _notifyObservers(): void { + this._finishPromise(); + const observers = this._observers.slice(); observers.forEach(observer => { - this.notifyObserver_(observer); + this._notifyObserver(observer); }); } - private finishPromise_(): void { - if (this.resolve_ !== null) { + private _finishPromise(): void { + if (this._resolve !== undefined) { let triggered = true; - switch (taskStateFromInternalTaskState(this.state_)) { + switch (taskStateFromInternalTaskState(this._state)) { case TaskState.SUCCESS: - fbsAsync(this.resolve_.bind(null, this.snapshot))(); + fbsAsync(this._resolve.bind(null, this.snapshot))(); break; case TaskState.CANCELED: case TaskState.ERROR: - const toCall = this.reject_ as (p1: Error) => void; - fbsAsync(toCall.bind(null, this.error_ as Error))(); + const toCall = this._reject as (p1: FirebaseStorageError) => void; + fbsAsync(toCall.bind(null, this._error as FirebaseStorageError))(); break; default: triggered = false; break; } if (triggered) { - this.resolve_ = null; - this.reject_ = null; + this._resolve = undefined; + this._reject = undefined; } } } - private notifyObserver_(observer: Observer): void { - const externalState = taskStateFromInternalTaskState(this.state_); + private _notifyObserver(observer: Observer): void { + const externalState = taskStateFromInternalTaskState(this._state); switch (externalState) { case TaskState.RUNNING: case TaskState.PAUSED: @@ -541,39 +553,43 @@ export class UploadTask { case TaskState.CANCELED: case TaskState.ERROR: if (observer.error) { - fbsAsync(observer.error.bind(observer, this.error_ as Error))(); + fbsAsync( + observer.error.bind(observer, this._error as FirebaseStorageError) + )(); } break; default: // TODO(andysoto): assert(false); if (observer.error) { - fbsAsync(observer.error.bind(observer, this.error_ as Error))(); + fbsAsync( + observer.error.bind(observer, this._error as FirebaseStorageError) + )(); } } } /** * Resumes a paused task. Has no effect on a currently running or failed task. - * @return True if the operation took effect, false if ignored. + * @returns True if the operation took effect, false if ignored. */ resume(): boolean { const valid = - this.state_ === InternalTaskState.PAUSED || - this.state_ === InternalTaskState.PAUSING; + this._state === InternalTaskState.PAUSED || + this._state === InternalTaskState.PAUSING; if (valid) { - this.transition_(InternalTaskState.RUNNING); + this._transition(InternalTaskState.RUNNING); } return valid; } /** * Pauses a currently running task. Has no effect on a paused or failed task. - * @return True if the operation took effect, false if ignored. + * @returns True if the operation took effect, false if ignored. */ pause(): boolean { - const valid = this.state_ === InternalTaskState.RUNNING; + const valid = this._state === InternalTaskState.RUNNING; if (valid) { - this.transition_(InternalTaskState.PAUSING); + this._transition(InternalTaskState.PAUSING); } return valid; } @@ -581,14 +597,14 @@ export class UploadTask { /** * Cancels a currently running or paused task. Has no effect on a complete or * failed task. - * @return True if the operation took effect, false if ignored. + * @returns True if the operation took effect, false if ignored. */ cancel(): boolean { const valid = - this.state_ === InternalTaskState.RUNNING || - this.state_ === InternalTaskState.PAUSING; + this._state === InternalTaskState.RUNNING || + this._state === InternalTaskState.PAUSING; if (valid) { - this.transition_(InternalTaskState.CANCELING); + this._transition(InternalTaskState.CANCELING); } return valid; } diff --git a/packages/storage/src/tasksnapshot.ts b/packages/storage/src/tasksnapshot.ts index 7524ee4bbc4..6f3395fd567 100644 --- a/packages/storage/src/tasksnapshot.ts +++ b/packages/storage/src/tasksnapshot.ts @@ -24,7 +24,7 @@ export class UploadTaskSnapshot { readonly bytesTransferred: number, readonly totalBytes: number, readonly state: TaskState, - readonly metadata: Metadata | null, + readonly metadata: Metadata, readonly task: UploadTask, readonly ref: Reference ) {} diff --git a/packages/storage/test/integration/integration.test.ts b/packages/storage/test/integration/integration.test.ts index 931ee648fa8..ba4a0cf07db 100644 --- a/packages/storage/test/integration/integration.test.ts +++ b/packages/storage/test/integration/integration.test.ts @@ -23,7 +23,7 @@ import '@firebase/auth'; import * as storage from '@firebase/storage-types'; import { expect } from 'chai'; -import '../../index'; +import '../../compat/index'; // eslint-disable-next-line @typescript-eslint/no-require-imports const PROJECT_CONFIG = require('../../../../config/project.json'); diff --git a/packages/storage/test/unit/reference.test.ts b/packages/storage/test/unit/reference.compat.test.ts similarity index 56% rename from packages/storage/test/unit/reference.test.ts rename to packages/storage/test/unit/reference.compat.test.ts index d1955500a2a..46e07c2544f 100644 --- a/packages/storage/test/unit/reference.test.ts +++ b/packages/storage/test/unit/reference.compat.test.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2017 Google LLC + * Copyright 2020 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -14,35 +14,45 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -import { assert } from 'chai'; +import { expect } from 'chai'; import { FirebaseApp } from '@firebase/app-types'; import { StringFormat } from '../../src/implementation/string'; import { Headers } from '../../src/implementation/xhrio'; import { Metadata } from '../../src/metadata'; -import { Reference } from '../../src/reference'; -import { StorageService } from '../../src/service'; +import { ReferenceCompat } from '../../compat/reference'; +import { StorageServiceCompat } from '../../compat/service'; import * as testShared from './testshared'; import { SendHook, TestingXhrIo } from './xhrio'; import { DEFAULT_HOST } from '../../src/implementation/constants'; import { FirebaseAuthInternalName } from '@firebase/auth-interop-types'; import { Provider } from '@firebase/component'; +import { StorageService } from '../../src/service'; +import { Reference } from '../../src/reference'; /* eslint-disable @typescript-eslint/no-floating-promises */ function makeFakeService( app: FirebaseApp, authProvider: Provider, sendHook: SendHook -): StorageService { - return new StorageService(app, authProvider, testShared.makePool(sendHook)); +): StorageServiceCompat { + const storageServiceCompat: StorageServiceCompat = new StorageServiceCompat( + app, + new StorageService(app, authProvider, testShared.makePool(sendHook)) + ); + return storageServiceCompat; } -function makeStorage(url: string): Reference { +function makeStorage(url: string): ReferenceCompat { const service = new StorageService( - null, + {} as FirebaseApp, testShared.emptyAuthProvider, testShared.makePool(null) ); - return new Reference(service, url); + const storageServiceCompat: StorageServiceCompat = new StorageServiceCompat( + {} as FirebaseApp, + service + ); + return new ReferenceCompat(new Reference(service, url), storageServiceCompat); } describe('Firebase Storage > Reference', () => { @@ -50,28 +60,28 @@ describe('Firebase Storage > Reference', () => { const child = makeStorage('gs://test-bucket/hello'); describe('Path constructor', () => { it('root', () => { - assert.equal(root.toString(), 'gs://test-bucket/'); + expect(root.toString()).to.equal('gs://test-bucket/'); }); it('keeps characters after ? on a gs:// string', () => { const s = makeStorage('gs://test-bucket/this/ismyobject?hello'); - assert.equal(s.toString(), 'gs://test-bucket/this/ismyobject?hello'); + expect(s.toString()).to.equal('gs://test-bucket/this/ismyobject?hello'); }); it("doesn't URL-decode on a gs:// string", () => { const s = makeStorage('gs://test-bucket/%3F'); - assert.equal(s.toString(), 'gs://test-bucket/%3F'); + expect(s.toString()).to.equal('gs://test-bucket/%3F'); }); it('ignores URL params and fragments on an http URL', () => { const s = makeStorage( `http://${DEFAULT_HOST}/v0/b/test-bucket/o/my/object.txt` + '?ignoreme#please' ); - assert.equal(s.toString(), 'gs://test-bucket/my/object.txt'); + expect(s.toString()).to.equal('gs://test-bucket/my/object.txt'); }); it('URL-decodes and ignores fragment on an http URL', () => { const s = makeStorage( `http://${DEFAULT_HOST}/v0/b/test-bucket/o/%3F?ignore` ); - assert.equal(s.toString(), 'gs://test-bucket/?'); + expect(s.toString()).to.equal('gs://test-bucket/?'); }); it('ignores URL params and fragments on an https URL', () => { @@ -79,95 +89,93 @@ describe('Firebase Storage > Reference', () => { `https://${DEFAULT_HOST}/v0/b/test-bucket/o/my/object.txt` + '?ignoreme#please' ); - assert.equal(s.toString(), 'gs://test-bucket/my/object.txt'); + expect(s.toString()).to.equal('gs://test-bucket/my/object.txt'); }); it('URL-decodes and ignores fragment on an https URL', () => { const s = makeStorage( `https://${DEFAULT_HOST}/v0/b/test-bucket/o/%3F?ignore` ); - assert.equal(s.toString(), 'gs://test-bucket/?'); + expect(s.toString()).to.equal('gs://test-bucket/?'); }); }); describe('toString', () => { it("Doesn't add trailing slash", () => { const s = makeStorage('gs://test-bucket/foo'); - assert.equal(s.toString(), 'gs://test-bucket/foo'); + expect(s.toString()).to.equal('gs://test-bucket/foo'); }); it('Strips trailing slash', () => { const s = makeStorage('gs://test-bucket/foo/'); - assert.equal(s.toString(), 'gs://test-bucket/foo'); + expect(s.toString()).to.equal('gs://test-bucket/foo'); }); }); describe('parent', () => { it('Returns null at root', () => { - assert.isNull(root.parent); + expect(root.parent).to.be.null; }); it('Returns root one level down', () => { - assert.equal(child.parent!.toString(), 'gs://test-bucket/'); + expect(child.parent!.toString()).to.equal('gs://test-bucket/'); }); it('Works correctly with empty levels', () => { const s = makeStorage('gs://test-bucket/a///'); - assert.equal(s.parent!.toString(), 'gs://test-bucket/a/'); + expect(s.parent!.toString()).to.equal('gs://test-bucket/a/'); }); }); describe('root', () => { it('Returns self at root', () => { - assert.equal(root.root.toString(), 'gs://test-bucket/'); + expect(root.root.toString()).to.equal('gs://test-bucket/'); }); it('Returns root multiple levels down', () => { const s = makeStorage('gs://test-bucket/a/b/c/d'); - assert.equal(s.root.toString(), 'gs://test-bucket/'); + expect(s.root.toString()).to.equal('gs://test-bucket/'); }); }); describe('bucket', () => { it('Returns bucket name', () => { - assert.equal(root.bucket, 'test-bucket'); + expect(root.bucket).to.equal('test-bucket'); }); }); describe('fullPath', () => { it('Returns full path without leading slash', () => { const s = makeStorage('gs://test-bucket/full/path'); - assert.equal(s.fullPath, 'full/path'); + expect(s.fullPath).to.equal('full/path'); }); }); describe('name', () => { it('Works at top level', () => { const s = makeStorage('gs://test-bucket/toplevel.txt'); - assert.equal(s.name, 'toplevel.txt'); + expect(s.name).to.equal('toplevel.txt'); }); it('Works at not the top level', () => { const s = makeStorage('gs://test-bucket/not/toplevel.txt'); - assert.equal('toplevel.txt', s.name); + expect('toplevel.txt').to.equal(s.name); }); }); describe('child', () => { it('works with a simple string', () => { - assert.equal(root.child('a').toString(), 'gs://test-bucket/a'); + expect(root.child('a').toString()).to.equal('gs://test-bucket/a'); }); it('drops a trailing slash', () => { - assert.equal(root.child('ab/').toString(), 'gs://test-bucket/ab'); + expect(root.child('ab/').toString()).to.equal('gs://test-bucket/ab'); }); it('compresses repeated slashes', () => { - assert.equal( - root.child('//a///b/////').toString(), + expect(root.child('//a///b/////').toString()).to.equal( 'gs://test-bucket/a/b' ); }); it('works chained multiple times with leading slashes', () => { - assert.equal( - root.child('a').child('/b').child('c').child('d/e').toString(), - 'gs://test-bucket/a/b/c/d/e' - ); + expect( + root.child('a').child('/b').child('c').child('d/e').toString() + ).to.equal('gs://test-bucket/a/b/c/d/e'); }); }); @@ -179,8 +187,8 @@ describe('Firebase Storage > Reference', () => { body?: ArrayBufferView | Blob | string | null, headers?: Headers ): void { - assert.isDefined(headers); - assert.isUndefined(headers!['Authorization']); + expect(headers).to.not.be.undefined; + expect(headers!['Authorization']).to.be.undefined; done(); } @@ -202,9 +210,8 @@ describe('Firebase Storage > Reference', () => { body?: ArrayBufferView | Blob | string | null, headers?: Headers ): void { - assert.isDefined(headers); - assert.equal( - headers!['Authorization'], + expect(headers).to.not.be.undefined; + expect(headers!['Authorization']).to.equal( 'Firebase ' + testShared.authToken ); done(); @@ -225,7 +232,7 @@ describe('Firebase Storage > Reference', () => { const task = child.putString('hello', StringFormat.RAW, { contentType: 'lol/wut' } as Metadata); - assert.equal(task.snapshot.metadata!.contentType, 'lol/wut'); + expect(task.snapshot.metadata!.contentType).to.equal('lol/wut'); task.cancel(); }); it('Uses embedded content type in DATA_URL format', () => { @@ -233,7 +240,7 @@ describe('Firebase Storage > Reference', () => { 'data:lol/wat;base64,aaaa', StringFormat.DATA_URL ); - assert.equal(task.snapshot.metadata!.contentType, 'lol/wat'); + expect(task.snapshot.metadata!.contentType).to.equal('lol/wat'); task.cancel(); }); it('Lets metadata.contentType override embedded content type in DATA_URL format', () => { @@ -242,7 +249,7 @@ describe('Firebase Storage > Reference', () => { StringFormat.DATA_URL, { contentType: 'tomato/soup' } as Metadata ); - assert.equal(task.snapshot.metadata!.contentType, 'tomato/soup'); + expect(task.snapshot.metadata!.contentType).to.equal('tomato/soup'); task.cancel(); }); }); @@ -250,133 +257,47 @@ describe('Firebase Storage > Reference', () => { describe('Argument verification', () => { describe('list', () => { it('throws on invalid maxResults', () => { - testShared.assertThrows( - testShared.bind(child.list, child, { maxResults: 0 }), - 'storage/invalid-argument' - ); - testShared.assertThrows( - testShared.bind(child.list, child, { maxResults: -4 }), - 'storage/invalid-argument' - ); - testShared.assertThrows( - testShared.bind(child.list, child, { maxResults: 1001 }), - 'storage/invalid-argument' - ); - }); - }); - }); - - describe('non-root operations', () => { - it("put doesn't throw", () => { - assert.doesNotThrow(() => { - child.put(new Blob(['a'])); - child.put(new Uint8Array(10)); - child.put(new ArrayBuffer(10)); - }); - }); - it("putString doesn't throw", () => { - assert.doesNotThrow(() => { - child.putString('raw', StringFormat.RAW); - child.putString('aaaa', StringFormat.BASE64); - child.putString('aaaa', StringFormat.BASE64URL); - child.putString( - 'data:application/octet-stream;base64,aaaa', - StringFormat.DATA_URL - ); - }); - }); - it("delete doesn't throw", () => { - assert.doesNotThrow(() => { - child.delete(); - }); - }); - it("getMetadata doesn't throw", () => { - assert.doesNotThrow(() => { - child.getMetadata(); - }); - }); - it("listAll doesn't throw", () => { - assert.doesNotThrow(() => { - child.listAll(); - }); - }); - it("list doesn't throw", () => { - assert.doesNotThrow(() => { - child.list(); - }); - assert.doesNotThrow(() => { - child.list({ pageToken: 'xxx', maxResults: 4 }); - }); - assert.doesNotThrow(() => { - child.list({ pageToken: 'xxx' }); - }); - assert.doesNotThrow(() => { - child.list({ maxResults: 4 }); - }); - assert.doesNotThrow(() => { - child.list({ maxResults: 4, pageToken: null }); - }); - }); - it("updateMetadata doesn't throw", () => { - assert.doesNotThrow(() => { - child.updateMetadata({} as Metadata); - }); - }); - it("getDownloadURL doesn't throw", () => { - assert.doesNotThrow(() => { - child.getDownloadURL(); + it('throws on invalid maxResults', async () => { + await expect(child.list({ maxResults: 0 })).to.be.rejectedWith( + 'storage/invalid-argument' + ); + await expect(child.list({ maxResults: -4 })).to.be.rejectedWith( + 'storage/invalid-argument' + ); + await expect(child.list({ maxResults: 1001 })).to.be.rejectedWith( + 'storage/invalid-argument' + ); + }); }); }); }); describe('root operations', () => { it('put throws', () => { - testShared.assertThrows( - root.put.bind(root, new Blob(['a'])), + expect(() => root.put(new Blob(['a']))).to.throw( 'storage/invalid-root-operation' ); }); it('putString throws', () => { - testShared.assertThrows( - root.putString.bind(root, 'raw', StringFormat.RAW), + expect(() => root.putString('raw', StringFormat.RAW)).to.throw( 'storage/invalid-root-operation' ); }); it('delete throws', () => { - testShared.assertThrows( - root.delete.bind(root), - 'storage/invalid-root-operation' - ); + expect(() => root.delete()).to.throw('storage/invalid-root-operation'); }); - it('getMetadata throws', () => { - testShared.assertThrows( - root.getMetadata.bind(root), + it('getMetadata throws', async () => { + await expect(root.getMetadata()).to.be.rejectedWith( 'storage/invalid-root-operation' ); }); - it("listAll doesn't throw", () => { - assert.doesNotThrow(() => { - root.listAll(); - }); - }); - it("list doesn't throw", () => { - assert.doesNotThrow(() => { - root.list(); - }); - assert.doesNotThrow(() => { - root.list({ pageToken: 'xxx', maxResults: 4 }); - }); - }); - it('updateMetadata throws', () => { - testShared.assertThrows( - // eslint-disable-next-line @typescript-eslint/no-explicit-any - (root as any).updateMetadata.bind(root, {}), + it('updateMetadata throws', async () => { + await expect(root.updateMetadata({} as Metadata)).to.be.rejectedWith( 'storage/invalid-root-operation' ); }); - it('getDownloadURL throws', () => { - testShared.assertThrows( - root.getDownloadURL.bind(root), + it('getDownloadURL throws', async () => { + await expect(root.getDownloadURL()).to.be.rejectedWith( 'storage/invalid-root-operation' ); }); diff --git a/packages/storage/test/unit/reference.exp.test.ts b/packages/storage/test/unit/reference.exp.test.ts new file mode 100644 index 00000000000..0ee0cfb6b9f --- /dev/null +++ b/packages/storage/test/unit/reference.exp.test.ts @@ -0,0 +1,306 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +import { expect } from 'chai'; +import { FirebaseApp } from '@firebase/app-types'; +import { StringFormat } from '../../src/implementation/string'; +import { Headers } from '../../src/implementation/xhrio'; +import { Metadata } from '../../src/metadata'; +import { + Reference, + uploadString, + uploadBytesResumable, + deleteObject, + list, + getMetadata, + updateMetadata, + getDownloadURL +} from '../../src/reference'; +import { StorageService, ref } from '../../src/service'; +import * as testShared from './testshared'; +import { SendHook, TestingXhrIo } from './xhrio'; +import { DEFAULT_HOST } from '../../src/implementation/constants'; +import { FirebaseAuthInternalName } from '@firebase/auth-interop-types'; +import { Provider } from '@firebase/component'; + +/* eslint-disable @typescript-eslint/no-floating-promises */ +function makeFakeService( + app: FirebaseApp, + authProvider: Provider, + sendHook: SendHook +): StorageService { + return new StorageService(app, authProvider, testShared.makePool(sendHook)); +} + +function makeStorage(url: string): Reference { + const service = new StorageService( + {} as FirebaseApp, + testShared.emptyAuthProvider, + testShared.makePool(null) + ); + return new Reference(service, url); +} + +describe('Firebase Storage > Reference', () => { + const root = makeStorage('gs://test-bucket/'); + const child = makeStorage('gs://test-bucket/hello'); + describe('Path constructor', () => { + it('root', () => { + expect(root.toString()).to.equal('gs://test-bucket/'); + }); + it('keeps characters after ? on a gs:// string', () => { + const s = makeStorage('gs://test-bucket/this/ismyobject?hello'); + expect(s.toString()).to.equal('gs://test-bucket/this/ismyobject?hello'); + }); + it("doesn't URL-decode on a gs:// string", () => { + const s = makeStorage('gs://test-bucket/%3F'); + expect(s.toString()).to.equal('gs://test-bucket/%3F'); + }); + it('ignores URL params and fragments on an http URL', () => { + const s = makeStorage( + `http://${DEFAULT_HOST}/v0/b/test-bucket/o/my/object.txt` + + '?ignoreme#please' + ); + expect(s.toString()).to.equal('gs://test-bucket/my/object.txt'); + }); + it('URL-decodes and ignores fragment on an http URL', () => { + const s = makeStorage( + `http://${DEFAULT_HOST}/v0/b/test-bucket/o/%3F?ignore` + ); + expect(s.toString()).to.equal('gs://test-bucket/?'); + }); + + it('ignores URL params and fragments on an https URL', () => { + const s = makeStorage( + `https://${DEFAULT_HOST}/v0/b/test-bucket/o/my/object.txt` + + '?ignoreme#please' + ); + expect(s.toString()).to.equal('gs://test-bucket/my/object.txt'); + }); + + it('URL-decodes and ignores fragment on an https URL', () => { + const s = makeStorage( + `https://${DEFAULT_HOST}/v0/b/test-bucket/o/%3F?ignore` + ); + expect(s.toString()).to.equal('gs://test-bucket/?'); + }); + }); + + describe('toString', () => { + it("Doesn't add trailing slash", () => { + const s = makeStorage('gs://test-bucket/foo'); + expect(s.toString()).to.equal('gs://test-bucket/foo'); + }); + it('Strips trailing slash', () => { + const s = makeStorage('gs://test-bucket/foo/'); + expect(s.toString()).to.equal('gs://test-bucket/foo'); + }); + }); + + describe('parentReference', () => { + it('Returns null at root', () => { + expect(root.parent).to.be.null; + }); + it('Returns root one level down', () => { + expect(child.parent!.toString()).to.equal('gs://test-bucket/'); + }); + it('Works correctly with empty levels', () => { + const s = makeStorage('gs://test-bucket/a///'); + expect(s.parent!.toString()).to.equal('gs://test-bucket/a/'); + }); + }); + + describe('root', () => { + it('Returns self at root', () => { + expect(root.root.toString()).to.equal('gs://test-bucket/'); + }); + + it('Returns root multiple levels down', () => { + const s = makeStorage('gs://test-bucket/a/b/c/d'); + expect(s.root.toString()).to.equal('gs://test-bucket/'); + }); + }); + + describe('bucket', () => { + it('Returns bucket name', () => { + expect(root.bucket).to.equal('test-bucket'); + }); + }); + + describe('fullPath', () => { + it('Returns full path without leading slash', () => { + const s = makeStorage('gs://test-bucket/full/path'); + expect(s.fullPath).to.equal('full/path'); + }); + }); + + describe('name', () => { + it('Works at top level', () => { + const s = makeStorage('gs://test-bucket/toplevel.txt'); + expect(s.name).to.equal('toplevel.txt'); + }); + + it('Works at not the top level', () => { + const s = makeStorage('gs://test-bucket/not/toplevel.txt'); + expect(s.name).to.equal('toplevel.txt'); + }); + }); + + describe('get child with ref()', () => { + it('works with a simple string', () => { + expect(ref(root, 'a').toString()).to.equal('gs://test-bucket/a'); + }); + it('drops a trailing slash', () => { + expect(ref(root, 'ab/').toString()).to.equal('gs://test-bucket/ab'); + }); + it('compresses repeated slashes', () => { + expect(ref(root, '//a///b/////').toString()).to.equal( + 'gs://test-bucket/a/b' + ); + }); + it('works chained multiple times with leading slashes', () => { + expect( + ref(ref(ref(ref(root, 'a'), '/b'), 'c'), 'd/e').toString() + ).to.equal('gs://test-bucket/a/b/c/d/e'); + }); + }); + + it("Doesn't send Authorization on null auth token", done => { + function newSend( + xhrio: TestingXhrIo, + url: string, + method: string, + body?: ArrayBufferView | Blob | string | null, + headers?: Headers + ): void { + expect(headers).to.not.be.undefined; + expect(headers!['Authorization']).to.be.undefined; + done(); + } + + const service = makeFakeService( + testShared.fakeApp, + testShared.emptyAuthProvider, + newSend + ); + const reference = ref(service, 'gs://test-bucket'); + getMetadata(ref(reference, 'foo')); + }); + + it('Works if the user logs in before creating the storage reference', done => { + // Regression test for b/27227221 + function newSend( + xhrio: TestingXhrIo, + url: string, + method: string, + body?: ArrayBufferView | Blob | string | null, + headers?: Headers + ): void { + expect(headers).to.not.be.undefined; + expect(headers!['Authorization']).to.equal( + 'Firebase ' + testShared.authToken + ); + done(); + } + + const service = makeFakeService( + testShared.fakeApp, + testShared.fakeAuthProvider, + newSend + ); + const reference = ref(service, 'gs://test-bucket'); + getMetadata(ref(reference, 'foo')); + }); + + describe('uploadString', () => { + it('Uses metadata.contentType for RAW format', () => { + // Regression test for b/30989476 + const task = uploadString(child, 'hello', StringFormat.RAW, { + contentType: 'lol/wut' + } as Metadata); + expect(task.snapshot.metadata!.contentType).to.equal('lol/wut'); + task.cancel(); + }); + it('Uses embedded content type in DATA_URL format', () => { + const task = uploadString( + child, + 'data:lol/wat;base64,aaaa', + StringFormat.DATA_URL + ); + expect(task.snapshot.metadata!.contentType).to.equal('lol/wat'); + task.cancel(); + }); + it('Lets metadata.contentType override embedded content type in DATA_URL format', () => { + const task = uploadString( + child, + 'data:ignore/me;base64,aaaa', + StringFormat.DATA_URL, + { contentType: 'tomato/soup' } as Metadata + ); + expect(task.snapshot.metadata!.contentType).to.equal('tomato/soup'); + task.cancel(); + }); + }); + + describe('Argument verification', () => { + describe('list', () => { + it('throws on invalid maxResults', async () => { + await expect(list(child, { maxResults: 0 })).to.be.rejectedWith( + 'storage/invalid-argument' + ); + await expect(list(child, { maxResults: -4 })).to.be.rejectedWith( + 'storage/invalid-argument' + ); + await expect(list(child, { maxResults: 1001 })).to.be.rejectedWith( + 'storage/invalid-argument' + ); + }); + }); + }); + + describe('root operations', () => { + it('uploadBytesResumable throws', () => { + expect(() => uploadBytesResumable(root, new Blob(['a']))).to.throw( + 'storage/invalid-root-operation' + ); + }); + it('uploadString throws', () => { + expect(() => uploadString(root, 'raw', StringFormat.RAW)).to.throw( + 'storage/invalid-root-operation' + ); + }); + it('deleteObject throws', async () => { + await expect(deleteObject(root)).to.be.rejectedWith( + 'storage/invalid-root-operation' + ); + }); + it('getMetadata throws', async () => { + await expect(getMetadata(root)).to.be.rejectedWith( + 'storage/invalid-root-operation' + ); + }); + it('updateMetadata throws', async () => { + await expect(updateMetadata(root, {} as Metadata)).to.be.rejectedWith( + 'storage/invalid-root-operation' + ); + }); + it('getDownloadURL throws', async () => { + await expect(getDownloadURL(root)).to.be.rejectedWith( + 'storage/invalid-root-operation' + ); + }); + }); +}); diff --git a/packages/storage/test/unit/service.test.ts b/packages/storage/test/unit/service.compat.test.ts similarity index 72% rename from packages/storage/test/unit/service.test.ts rename to packages/storage/test/unit/service.compat.test.ts index 595add06579..a7502f531ca 100644 --- a/packages/storage/test/unit/service.test.ts +++ b/packages/storage/test/unit/service.compat.test.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2017 Google LLC + * Copyright 2020 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -14,13 +14,17 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -import { assert } from 'chai'; +import { expect } from 'chai'; import { TaskEvent } from '../../src/implementation/taskenums'; import { XhrIoPool } from '../../src/implementation/xhriopool'; -import { StorageService } from '../../src/service'; +import { StorageServiceCompat } from '../../compat/service'; import * as testShared from './testshared'; import { DEFAULT_HOST } from '../../src/implementation/constants'; import { FirebaseStorageError } from '../../src/implementation/error'; +import { StorageService } from '../../src/service'; +import { FirebaseApp } from '@firebase/app-types'; +import { Provider } from '@firebase/component'; +import { FirebaseAuthInternalName } from '@firebase/auth-interop-types'; const fakeAppGs = testShared.makeFakeApp('gs://mybucket'); const fakeAppGsEndingSlash = testShared.makeFakeApp('gs://mybucket/'); @@ -31,192 +35,200 @@ function makeGsUrl(child: string = ''): string { return 'gs://' + testShared.bucket + '/' + child; } +function makeService( + app: FirebaseApp, + authProvider: Provider, + pool: XhrIoPool, + url?: string +): StorageServiceCompat { + const storageServiceCompat: StorageServiceCompat = new StorageServiceCompat( + app, + new StorageService(app, authProvider, pool, url) + ); + return storageServiceCompat; +} + describe('Firebase Storage > Service', () => { describe('simple constructor', () => { - const service = new StorageService( + const service = makeService( testShared.fakeApp, testShared.fakeAuthProvider, xhrIoPool ); it('Root refs point to the right place', () => { const ref = service.ref(); - assert.equal(ref.toString(), makeGsUrl()); + expect(ref.toString()).to.equal(makeGsUrl()); }); it('Child refs point to the right place', () => { const ref = service.ref('path/to/child'); - assert.equal(ref.toString(), makeGsUrl('path/to/child')); + expect(ref.toString()).to.equal(makeGsUrl('path/to/child')); }); it('Throws calling ref with a gs:// URL', () => { const error = testShared.assertThrows(() => { service.ref('gs://bucket/object'); }, 'storage/invalid-argument'); - assert.match(error.message, /refFromURL/); + expect(error.message).to.match(/refFromURL/); }); it('Throws calling ref with an http:// URL', () => { const error = testShared.assertThrows(() => { service.ref(`http://${DEFAULT_HOST}/etc`); }, 'storage/invalid-argument'); - assert.match(error.message, /refFromURL/); + expect(error.message).to.match(/refFromURL/); }); it('Throws calling ref with an https:// URL', () => { const error = testShared.assertThrows(() => { service.ref(`https://${DEFAULT_HOST}/etc`); }, 'storage/invalid-argument'); - assert.match(error.message, /refFromURL/); + expect(error.message).to.match(/refFromURL/); }); }); describe('custom bucket constructor', () => { it('gs:// custom bucket constructor refs point to the right place', () => { - const service = new StorageService( + const service = makeService( testShared.fakeApp, testShared.fakeAuthProvider, xhrIoPool, 'gs://foo-bar.appspot.com' ); const ref = service.ref(); - assert.equal(ref.toString(), 'gs://foo-bar.appspot.com/'); + expect(ref.toString()).to.equal('gs://foo-bar.appspot.com/'); }); it('http:// custom bucket constructor refs point to the right place', () => { - const service = new StorageService( + const service = makeService( testShared.fakeApp, testShared.fakeAuthProvider, xhrIoPool, `http://${DEFAULT_HOST}/v1/b/foo-bar.appspot.com/o` ); const ref = service.ref(); - assert.equal(ref.toString(), 'gs://foo-bar.appspot.com/'); + expect(ref.toString()).to.equal('gs://foo-bar.appspot.com/'); }); it('https:// custom bucket constructor refs point to the right place', () => { - const service = new StorageService( + const service = makeService( testShared.fakeApp, testShared.fakeAuthProvider, xhrIoPool, `https://${DEFAULT_HOST}/v1/b/foo-bar.appspot.com/o` ); const ref = service.ref(); - assert.equal(ref.toString(), 'gs://foo-bar.appspot.com/'); + expect(ref.toString()).to.equal('gs://foo-bar.appspot.com/'); }); it('Bare bucket name constructor refs point to the right place', () => { - const service = new StorageService( + const service = makeService( testShared.fakeApp, testShared.fakeAuthProvider, xhrIoPool, 'foo-bar.appspot.com' ); const ref = service.ref(); - assert.equal(ref.toString(), 'gs://foo-bar.appspot.com/'); + expect(ref.toString()).to.equal('gs://foo-bar.appspot.com/'); }); it('Child refs point to the right place', () => { - const service = new StorageService( + const service = makeService( testShared.fakeApp, testShared.fakeAuthProvider, xhrIoPool, 'foo-bar.appspot.com' ); const ref = service.ref('path/to/child'); - assert.equal(ref.toString(), 'gs://foo-bar.appspot.com/path/to/child'); + expect(ref.toString()).to.equal('gs://foo-bar.appspot.com/path/to/child'); }); it('Throws trying to construct with a gs:// URL containing an object path', () => { const error = testShared.assertThrows(() => { - new StorageService( + makeService( testShared.fakeApp, testShared.fakeAuthProvider, xhrIoPool, 'gs://bucket/object/' ); }, 'storage/invalid-default-bucket'); - assert.match(error.message, /Invalid default bucket/); + expect(error.message).to.match(/Invalid default bucket/); }); }); describe('default bucket config', () => { it('gs:// works without ending slash', () => { - const service = new StorageService( + const service = makeService( fakeAppGs, testShared.fakeAuthProvider, xhrIoPool ); - assert.equal(service.ref().toString(), 'gs://mybucket/'); + expect(service.ref().toString()).to.equal('gs://mybucket/'); }); it('gs:// works with ending slash', () => { - const service = new StorageService( + const service = makeService( fakeAppGsEndingSlash, testShared.fakeAuthProvider, xhrIoPool ); - assert.equal(service.ref().toString(), 'gs://mybucket/'); + expect(service.ref().toString()).to.equal('gs://mybucket/'); }); it('Throws when config bucket is gs:// with an object path', () => { testShared.assertThrows(() => { - new StorageService( - fakeAppInvalidGs, - testShared.fakeAuthProvider, - xhrIoPool - ); + makeService(fakeAppInvalidGs, testShared.fakeAuthProvider, xhrIoPool); }, 'storage/invalid-default-bucket'); }); }); describe('refFromURL', () => { - const service = new StorageService( + const service = makeService( testShared.fakeApp, testShared.fakeAuthProvider, xhrIoPool ); - it('Throws on non-URL arg', () => { - const error = testShared.assertThrows(() => { - service.refFromURL('path/to/child'); - }, 'storage/invalid-argument'); - assert.match( - error.message, - /Expected full URL but got a child path, use ref instead/i - ); - }); it('Works with gs:// URLs', () => { const ref = service.refFromURL('gs://mybucket/child/path/image.png'); - assert.equal(ref.toString(), 'gs://mybucket/child/path/image.png'); + expect(ref.toString()).to.equal('gs://mybucket/child/path/image.png'); }); it('Works with http:// URLs', () => { const ref = service.refFromURL( `http://${DEFAULT_HOST}/v0/b/` + 'mybucket/o/child%2Fpath%2Fimage.png?downloadToken=hello' ); - assert.equal(ref.toString(), 'gs://mybucket/child/path/image.png'); + expect(ref.toString()).to.equal('gs://mybucket/child/path/image.png'); }); it('Works with https:// URLs', () => { const ref = service.refFromURL( `https://${DEFAULT_HOST}/v0/b/` + 'mybucket/o/child%2Fpath%2Fimage.png?downloadToken=hello' ); - assert.equal(ref.toString(), 'gs://mybucket/child/path/image.png'); + expect(ref.toString()).to.equal('gs://mybucket/child/path/image.png'); }); it('Works with storage.googleapis.com URLs', () => { const ref = service.refFromURL( `https://storage.googleapis.com/mybucket/path%20with%20space/image.png` ); - assert.equal(ref.toString(), 'gs://mybucket/path with space/image.png'); + expect(ref.toString()).to.equal( + 'gs://mybucket/path with space/image.png' + ); }); it('Works with storage.googleapis.com URLs with query params', () => { const ref = service.refFromURL( `https://storage.googleapis.com/mybucket/path%20with%20space/image.png?X-Goog-Algorithm= GOOG4-RSA-SHA256` ); - assert.equal(ref.toString(), 'gs://mybucket/path with space/image.png'); + expect(ref.toString()).to.equal( + 'gs://mybucket/path with space/image.png' + ); }); it('Works with storage.cloud.google.com URLs', () => { const ref = service.refFromURL( `https://storage.cloud.google.com/mybucket/path%20with%20space/image.png` ); - assert.equal(ref.toString(), 'gs://mybucket/path with space/image.png'); + expect(ref.toString()).to.equal( + 'gs://mybucket/path with space/image.png' + ); }); it('Works with storage.cloud.google.com URLs and escaped slash', () => { const ref = service.refFromURL( `https://storage.cloud.google.com/mybucket/path%20with%20space%2Fimage.png` ); - assert.equal(ref.toString(), 'gs://mybucket/path with space/image.png'); + expect(ref.toString()).to.equal( + 'gs://mybucket/path with space/image.png' + ); }); }); describe('Argument verification', () => { - const service = new StorageService( + const service = makeService( testShared.fakeApp, testShared.fakeAuthProvider, xhrIoPool @@ -230,6 +242,15 @@ GOOG4-RSA-SHA256` }); }); describe('refFromURL', () => { + it('Throws with a non-URL string arg', () => { + const error = testShared.assertThrows( + testShared.bind(service.refFromURL, service, 'child'), + 'storage/invalid-argument' + ); + expect(error.message).to.match( + /expected a full URL but got a child path/i + ); + }); it('Throws with an invalid URL arg', () => { testShared.assertThrows( testShared.bind(service.refFromURL, service, 'notlegit://url'), @@ -256,38 +277,24 @@ GOOG4-RSA-SHA256` }); describe('Deletion', () => { - const service = new StorageService( + const service = makeService( testShared.fakeApp, testShared.fakeAuthProvider, xhrIoPool ); - it('In-flight requests are canceled when the service is deleted', () => { + it('In-flight requests are canceled when the service is deleted', async () => { const ref = service.refFromURL('gs://mybucket/image.jpg'); - const toReturn = ref.getMetadata().then( - () => { - assert.fail('Promise succeeded, should have been canceled'); - }, - err => { - assert.equal(err.code, 'storage/app-deleted'); - } - ); + const metadataPromise = ref.getMetadata(); // eslint-disable-next-line @typescript-eslint/no-floating-promises service.INTERNAL.delete(); - return toReturn; + await expect(metadataPromise).to.be.rejectedWith('storage/app-deleted'); }); - it('Requests fail when started after the service is deleted', () => { + it('Requests fail when started after the service is deleted', async () => { const ref = service.refFromURL('gs://mybucket/image.jpg'); // eslint-disable-next-line @typescript-eslint/no-floating-promises service.INTERNAL.delete(); - const toReturn = ref.getMetadata().then( - () => { - assert.fail('Promise succeeded, should have been canceled'); - }, - err => { - assert.equal(err.code, 'storage/app-deleted'); - } - ); - return toReturn; + + await expect(ref.getMetadata()).to.be.rejectedWith('storage/app-deleted'); }); it('Running uploads fail when the service is deleted', () => { const ref = service.refFromURL('gs://mybucket/image.jpg'); @@ -296,14 +303,13 @@ GOOG4-RSA-SHA256` TaskEvent.STATE_CHANGED, null, (err: FirebaseStorageError | Error) => { - assert.equal( - (err as FirebaseStorageError).code, + expect((err as FirebaseStorageError).code).to.equal( 'storage/app-deleted' ); resolve(); }, () => { - assert.fail('Upload completed, should have been canceled'); + reject('Upload completed, should have been canceled'); } ); // eslint-disable-next-line @typescript-eslint/no-floating-promises diff --git a/packages/storage/test/unit/service.exp.test.ts b/packages/storage/test/unit/service.exp.test.ts new file mode 100644 index 00000000000..941c0507cb1 --- /dev/null +++ b/packages/storage/test/unit/service.exp.test.ts @@ -0,0 +1,321 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +import { expect } from 'chai'; +import { TaskEvent } from '../../src/implementation/taskenums'; +import { XhrIoPool } from '../../src/implementation/xhriopool'; +import { StorageService, ref } from '../../src/service'; +import * as testShared from './testshared'; +import { DEFAULT_HOST } from '../../src/implementation/constants'; +import { FirebaseStorageError } from '../../src/implementation/error'; +import { + Reference, + getMetadata, + uploadBytesResumable +} from '../../src/reference'; +import { Location } from '../../src/implementation/location'; + +const fakeAppGs = testShared.makeFakeApp('gs://mybucket'); +const fakeAppGsEndingSlash = testShared.makeFakeApp('gs://mybucket/'); +const fakeAppInvalidGs = testShared.makeFakeApp('gs://mybucket/hello'); +const xhrIoPool = new XhrIoPool(); +const testLocation = new Location('bucket', 'object'); + +function makeGsUrl(child: string = ''): string { + return 'gs://' + testShared.bucket + '/' + child; +} + +describe('Firebase Storage > Service', () => { + describe('simple constructor', () => { + const service = new StorageService( + testShared.fakeApp, + testShared.fakeAuthProvider, + xhrIoPool + ); + it('Root refs point to the right place', () => { + const reference = ref(service); + expect(reference.toString()).to.equal(makeGsUrl()); + }); + it('Child refs point to the right place', () => { + const reference = ref(service, 'path/to/child'); + expect(reference.toString()).to.equal(makeGsUrl('path/to/child')); + }); + }); + describe('custom bucket constructor', () => { + it('gs:// custom bucket constructor refs point to the right place', () => { + const service = new StorageService( + testShared.fakeApp, + testShared.fakeAuthProvider, + xhrIoPool, + 'gs://foo-bar.appspot.com' + ); + const reference = ref(service); + expect(reference.toString()).to.equal('gs://foo-bar.appspot.com/'); + }); + it('http:// custom bucket constructor refs point to the right place', () => { + const service = new StorageService( + testShared.fakeApp, + testShared.fakeAuthProvider, + xhrIoPool, + `http://${DEFAULT_HOST}/v1/b/foo-bar.appspot.com/o` + ); + const reference = ref(service); + expect(reference.toString()).to.equal('gs://foo-bar.appspot.com/'); + }); + it('https:// custom bucket constructor refs point to the right place', () => { + const service = new StorageService( + testShared.fakeApp, + testShared.fakeAuthProvider, + xhrIoPool, + `https://${DEFAULT_HOST}/v1/b/foo-bar.appspot.com/o` + ); + const reference = ref(service); + expect(reference.toString()).to.equal('gs://foo-bar.appspot.com/'); + }); + + it('Bare bucket name constructor refs point to the right place', () => { + const service = new StorageService( + testShared.fakeApp, + testShared.fakeAuthProvider, + xhrIoPool, + 'foo-bar.appspot.com' + ); + const reference = ref(service); + expect(reference.toString()).to.equal('gs://foo-bar.appspot.com/'); + }); + it('Child refs point to the right place', () => { + const service = new StorageService( + testShared.fakeApp, + testShared.fakeAuthProvider, + xhrIoPool, + 'foo-bar.appspot.com' + ); + const reference = ref(service, 'path/to/child'); + expect(reference.toString()).to.equal( + 'gs://foo-bar.appspot.com/path/to/child' + ); + }); + it('Throws trying to construct with a gs:// URL containing an object path', () => { + const error = testShared.assertThrows(() => { + new StorageService( + testShared.fakeApp, + testShared.fakeAuthProvider, + xhrIoPool, + 'gs://bucket/object/' + ); + }, 'storage/invalid-default-bucket'); + expect(error.message).to.match(/Invalid default bucket/); + }); + }); + describe('default bucket config', () => { + it('gs:// works without ending slash', () => { + const service = new StorageService( + fakeAppGs, + testShared.fakeAuthProvider, + xhrIoPool + ); + expect(ref(service)?.toString()).to.equal('gs://mybucket/'); + }); + it('gs:// works with ending slash', () => { + const service = new StorageService( + fakeAppGsEndingSlash, + testShared.fakeAuthProvider, + xhrIoPool + ); + expect(ref(service)?.toString()).to.equal('gs://mybucket/'); + }); + it('Throws when config bucket is gs:// with an object path', () => { + testShared.assertThrows(() => { + new StorageService( + fakeAppInvalidGs, + testShared.fakeAuthProvider, + xhrIoPool + ); + }, 'storage/invalid-default-bucket'); + }); + }); + describe('ref(service, url)', () => { + const service = new StorageService( + testShared.fakeApp, + testShared.fakeAuthProvider, + xhrIoPool + ); + it('Works with gs:// URLs', () => { + const reference = ref(service, 'gs://mybucket/child/path/image.png'); + expect(reference.toString()).to.equal( + 'gs://mybucket/child/path/image.png' + ); + }); + it('Works with http:// URLs', () => { + const reference = ref( + service, + `http://${DEFAULT_HOST}/v0/b/` + + 'mybucket/o/child%2Fpath%2Fimage.png?downloadToken=hello' + ); + expect(reference.toString()).to.equal( + 'gs://mybucket/child/path/image.png' + ); + }); + it('Works with https:// URLs', () => { + const reference = ref( + service, + `https://${DEFAULT_HOST}/v0/b/` + + 'mybucket/o/child%2Fpath%2Fimage.png?downloadToken=hello' + ); + expect(reference.toString()).to.equal( + 'gs://mybucket/child/path/image.png' + ); + }); + it('Works with storage.googleapis.com URLs', () => { + const reference = ref( + service, + `https://storage.googleapis.com/mybucket/path%20with%20space/image.png` + ); + expect(reference.toString()).to.equal( + 'gs://mybucket/path with space/image.png' + ); + }); + it('Works with storage.googleapis.com URLs with query params', () => { + const reference = ref( + service, + `https://storage.googleapis.com/mybucket/path%20with%20space/image.png?X-Goog-Algorithm= +GOOG4-RSA-SHA256` + ); + expect(reference.toString()).to.equal( + 'gs://mybucket/path with space/image.png' + ); + }); + it('Works with storage.cloud.google.com URLs', () => { + const reference = ref( + service, + `https://storage.cloud.google.com/mybucket/path%20with%20space/image.png` + ); + expect(reference.toString()).to.equal( + 'gs://mybucket/path with space/image.png' + ); + }); + it('Works with storage.cloud.google.com URLs and escaped slash', () => { + const reference = ref( + service, + `https://storage.cloud.google.com/mybucket/path%20with%20space%2Fimage.png` + ); + expect(reference.toString()).to.equal( + 'gs://mybucket/path with space/image.png' + ); + }); + }); + describe('ref(service, path)', () => { + const service = new StorageService( + testShared.fakeApp, + testShared.fakeAuthProvider, + xhrIoPool + ); + it('Works with non URL paths', () => { + const newRef = ref(service, 'child/path/image.png'); + expect(newRef.toString()).to.equal('gs://mybucket/child/path/image.png'); + }); + it('Works with no path', () => { + const newRef = ref(service); + expect(newRef.toString()).to.equal('gs://mybucket/'); + }); + }); + describe('ref(reference, path)', () => { + const service = new StorageService( + testShared.fakeApp, + testShared.fakeAuthProvider, + xhrIoPool + ); + const reference = new Reference(service, testLocation); + it('Throws calling ref(reference, path) with a gs:// URL', () => { + const error = testShared.assertThrows(() => { + ref(reference, 'gs://bucket/object'); + }, 'storage/invalid-argument'); + expect(error.message).to.match(/url/); + }); + it('Throws calling ref(reference, path) with an http:// URL', () => { + const error = testShared.assertThrows(() => { + ref(reference, `http://${DEFAULT_HOST}/etc`); + }, 'storage/invalid-argument'); + expect(error.message).to.match(/url/); + }); + it('Throws calling ref(reference, path) with an https:// URL', () => { + const error = testShared.assertThrows(() => { + ref(reference, `https://${DEFAULT_HOST}/etc`); + }, 'storage/invalid-argument'); + expect(error.message).to.match(/url/); + }); + it('Works with non URL paths', () => { + const newRef = ref(reference, 'child/path/image.png'); + expect(newRef.toString()).to.equal( + 'gs://bucket/object/child/path/image.png' + ); + }); + it('Works with no path', () => { + const newRef = ref(reference); + expect(newRef.toString()).to.equal('gs://bucket/object'); + }); + it('Throws calling ref(reference, path) if path contains ".."', () => { + const error = testShared.assertThrows(() => { + ref(reference, `../child/path`); + }, 'storage/invalid-argument'); + expect(error.message).to.match(/"\.\."/); + }); + }); + + describe('Deletion', () => { + const service = new StorageService( + testShared.fakeApp, + testShared.fakeAuthProvider, + xhrIoPool + ); + it('In-flight requests are canceled when the service is deleted', async () => { + const reference = ref(service, 'gs://mybucket/image.jpg'); + const metadataPromise = getMetadata(reference); + // eslint-disable-next-line @typescript-eslint/no-floating-promises + service._delete(); + await expect(metadataPromise).to.be.rejectedWith('storage/app-deleted'); + }); + it('Requests fail when started after the service is deleted', async () => { + const reference = ref(service, 'gs://mybucket/image.jpg'); + // eslint-disable-next-line @typescript-eslint/no-floating-promises + service._delete(); + await expect(getMetadata(reference)).to.be.rejectedWith( + 'storage/app-deleted' + ); + }); + it('Running uploads fail when the service is deleted', () => { + const reference = ref(service, 'gs://mybucket/image.jpg'); + const toReturn = new Promise((resolve, reject) => { + uploadBytesResumable(reference, new Blob(['a'])).on( + TaskEvent.STATE_CHANGED, + undefined, + (err: FirebaseStorageError | Error) => { + expect((err as FirebaseStorageError).code).to.equal( + 'storage/app-deleted' + ); + resolve(); + }, + () => { + reject('Upload completed, should have been canceled'); + } + ); + // eslint-disable-next-line @typescript-eslint/no-floating-promises + service._delete(); + }); + return toReturn; + }); + }); +}); diff --git a/packages/storage/test/unit/task.test.ts b/packages/storage/test/unit/task.test.ts index d4cd24f8a6d..61a81fff13f 100644 --- a/packages/storage/test/unit/task.test.ts +++ b/packages/storage/test/unit/task.test.ts @@ -17,7 +17,6 @@ import { assert } from 'chai'; import { FbsBlob } from '../../src/implementation/blob'; import { Location } from '../../src/implementation/location'; -import { getMappings } from '../../src/implementation/metadata'; import { Unsubscribe } from '../../src/implementation/observer'; import { TaskEvent, TaskState } from '../../src/implementation/taskenums'; import { Headers } from '../../src/implementation/xhrio'; @@ -26,13 +25,12 @@ import { StorageService } from '../../src/service'; import { UploadTask } from '../../src/task'; import { makePool, emptyAuthProvider } from './testshared'; import { StringHeaders, TestingXhrIo } from './xhrio'; +import { FirebaseApp } from '@firebase/app-types'; const testLocation = new Location('bucket', 'object'); const smallBlob = new FbsBlob(new Blob(['a'])); const bigBlob = new FbsBlob(new Blob([new ArrayBuffer(1024 * 1024)])); -const mappings = getMappings(); - const fakeMetadata = '{ "downloadTokens": "a,b" }'; interface Response { @@ -59,7 +57,11 @@ function storageServiceWithHandler(handler: RequestHandler): StorageService { xhrio.simulateResponse(response.status, response.body, response.headers); } - return new StorageService(null, emptyAuthProvider, makePool(newSend)); + return new StorageService( + {} as FirebaseApp, + emptyAuthProvider, + makePool(newSend) + ); } function fakeServerHandler(): RequestHandler { @@ -191,15 +193,12 @@ describe('Firebase Storage > Upload Task', () => { it('Works for a small upload w/ an observer', done => { const storageService = storageServiceWithHandler(fakeServerHandler()); const task = new UploadTask( - {} as Reference, - storageService, - testLocation, - mappings, + new Reference(storageService, testLocation), smallBlob ); task.on( TaskEvent.STATE_CHANGED, - null, + undefined, () => assert.fail('Unexpected upload failure'), () => done() ); @@ -207,10 +206,7 @@ describe('Firebase Storage > Upload Task', () => { it('Works for a small upload w/ a promise', () => { const storageService = storageServiceWithHandler(fakeServerHandler()); const task = new UploadTask( - {} as Reference, - storageService, - testLocation, - mappings, + new Reference(storageService, testLocation), smallBlob ); return task.then(snapshot => { @@ -220,10 +216,7 @@ describe('Firebase Storage > Upload Task', () => { it('Works for a small upload canceled w/ a promise', () => { const storageService = storageServiceWithHandler(fakeServerHandler()); const task = new UploadTask( - {} as Reference, - storageService, - testLocation, - mappings, + new Reference(storageService, testLocation), smallBlob ); const promise: Promise = task.then( @@ -239,20 +232,27 @@ describe('Firebase Storage > Upload Task', () => { it('Works properly with multiple observers', () => { const storageService = storageServiceWithHandler(fakeServerHandler()); const task = new UploadTask( - {} as Reference, - storageService, - testLocation, - mappings, + new Reference(storageService, testLocation), smallBlob ); let badComplete = false; - const h1: Unsubscribe = task.on(TaskEvent.STATE_CHANGED, null, null, () => { - badComplete = true; - }) as Unsubscribe; - const h2: Unsubscribe = task.on(TaskEvent.STATE_CHANGED, null, null, () => { - badComplete = true; - }) as Unsubscribe; + const h1: Unsubscribe = task.on( + TaskEvent.STATE_CHANGED, + undefined, + undefined, + () => { + badComplete = true; + } + ) as Unsubscribe; + const h2: Unsubscribe = task.on( + TaskEvent.STATE_CHANGED, + undefined, + undefined, + () => { + badComplete = true; + } + ) as Unsubscribe; let resumed = 0; @@ -270,8 +270,8 @@ describe('Firebase Storage > Upload Task', () => { } lastState = snapshot.state; }, - null, - null + undefined, + undefined ); })(); h1(); @@ -280,7 +280,7 @@ describe('Firebase Storage > Upload Task', () => { return new Promise(resolve => { task.on( TaskEvent.STATE_CHANGED, - null, + undefined, () => { assert.fail('Upload failed'); }, @@ -295,10 +295,7 @@ describe('Firebase Storage > Upload Task', () => { it("Works properly with an observer missing the 'next' method", () => { const storageService = storageServiceWithHandler(fakeServerHandler()); const task = new UploadTask( - {} as Reference, - storageService, - testLocation, - mappings, + new Reference(storageService, testLocation), smallBlob ); return new Promise(resolve => { @@ -316,10 +313,7 @@ describe('Firebase Storage > Upload Task', () => { function runNormalUploadTest(blob: FbsBlob): Promise { const storageService = storageServiceWithHandler(fakeServerHandler()); const task = new UploadTask( - {} as Reference, - storageService, - testLocation, - mappings, + new Reference(storageService, testLocation), blob ); @@ -404,7 +398,7 @@ describe('Firebase Storage > Upload Task', () => { let completeTriggered = false; - task.on(TaskEvent.STATE_CHANGED, null, null, () => { + task.on(TaskEvent.STATE_CHANGED, undefined, undefined, () => { fixedAssertFalse(completeTriggered); completeTriggered = true; @@ -438,10 +432,7 @@ describe('Firebase Storage > Upload Task', () => { fixedAssertTrue(lastIsAll); const task2 = new UploadTask( - {} as Reference, - storageService, - testLocation, - mappings, + new Reference(storageService, testLocation), blob ); const events2: string[] = []; diff --git a/packages/storage/test/unit/testshared.ts b/packages/storage/test/unit/testshared.ts index 0737d8916d0..8a3d4c8b7a4 100644 --- a/packages/storage/test/unit/testshared.ts +++ b/packages/storage/test/unit/testshared.ts @@ -14,11 +14,14 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -import { expect } from 'chai'; +import { expect, use } from 'chai'; +import * as chaiAsPromised from 'chai-as-promised'; + +use(chaiAsPromised); + import { FirebaseApp } from '@firebase/app-types'; import * as constants from '../../src/implementation/constants'; import { Code, FirebaseStorageError } from '../../src/implementation/error'; -import * as type from '../../src/implementation/type'; import { Headers, XhrIo } from '../../src/implementation/xhrio'; import { XhrIoPool } from '../../src/implementation/xhriopool'; import { SendHook, StringHeaders, TestingXhrIo } from './xhrio'; @@ -44,7 +47,7 @@ export const emptyAuthProvider = new Provider( export function makeFakeApp(bucketArg?: string): FirebaseApp { const app: any = {}; app.options = {}; - if (type.isDef(bucketArg)) { + if (bucketArg != null) { app.options[constants.CONFIG_STORAGE_BUCKET_KEY] = bucketArg; } else { app.options[constants.CONFIG_STORAGE_BUCKET_KEY] = bucket; diff --git a/packages/storage/test/unit/xhrio.ts b/packages/storage/test/unit/xhrio.ts index 187d87cf0e4..ff558ab01d0 100644 --- a/packages/storage/test/unit/xhrio.ts +++ b/packages/storage/test/unit/xhrio.ts @@ -14,8 +14,8 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -import * as type from '../../src/implementation/type'; import { ErrorCode, Headers, XhrIo } from '../../src/implementation/xhrio'; +import { FirebaseStorageError, Code } from '../../src/implementation/error'; export type SendHook = ( xhrio: TestingXhrIo, @@ -64,7 +64,7 @@ export class TestingXhrIo implements XhrIo { headers?: Headers ): Promise { if (this.state !== State.START) { - throw new Error("Can't send again"); + throw new FirebaseStorageError(Code.UNKNOWN, "Can't send again"); } this.state = State.SENT; @@ -81,7 +81,10 @@ export class TestingXhrIo implements XhrIo { headers: { [key: string]: string } ): void { if (this.state !== State.SENT) { - throw new Error("Can't simulate response before send/more than once"); + throw new FirebaseStorageError( + Code.UNKNOWN, + "Can't simulate response before send/more than once" + ); } this.status = status; @@ -116,7 +119,7 @@ export class TestingXhrIo implements XhrIo { getResponseHeader(header: string): string | null { const headerValue = this.headers[header.toLowerCase()]; - if (type.isDef(headerValue)) { + if (headerValue != null) { return headerValue; } else { return null; From 2d325e77efbc9b35c549295eca09ddcda6ce39e4 Mon Sep 17 00:00:00 2001 From: Alex Volkovitsky Date: Fri, 6 Nov 2020 14:38:23 -0800 Subject: [PATCH 071/624] Add retry logic around logic IndexedDB connections. (#4047) * Add retry logic around logic IndexedDB connections. Similar to https://github.com/firebase/firebase-js-sdk/blob/a10c18f8996fc35942779f5fea5690ae5d102bb0/packages/firestore/src/local/simple_db.ts * PR Feedback --- .../persistence/indexed_db.test.ts | 25 +++++++++++ .../persistence/indexed_db.ts | 45 +++++++++++++------ 2 files changed, 57 insertions(+), 13 deletions(-) diff --git a/packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.test.ts b/packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.test.ts index 0decef78da5..a400dc22048 100644 --- a/packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.test.ts +++ b/packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.test.ts @@ -324,4 +324,29 @@ describe('platform_browser/persistence/indexed_db', () => { }); }); }); + + describe('closed IndexedDB connection', () => { + it('should retry by reopening the connection', async () => { + const closeDb = async (): Promise => { + const db = await ((persistence as unknown) as { + _openDb(): Promise; + })._openDb(); + db.close(); + }; + const key = 'my-super-special-persistence-type'; + const value = PersistenceType.LOCAL; + + expect(await persistence._get(key)).to.be.null; + + await closeDb(); + await persistence._set(key, value); + + await closeDb(); + expect(await persistence._get(key)).to.be.eq(value); + + await closeDb(); + await persistence._remove(key); + expect(await persistence._get(key)).to.be.null; + }); + }); }); diff --git a/packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.ts b/packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.ts index dee7448a602..845275a5922 100644 --- a/packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.ts +++ b/packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.ts @@ -164,6 +164,8 @@ function deleteObject(db: IDBDatabase, key: string): Promise { /** @internal */ export const _POLLING_INTERVAL_MS = 800; +/** @internal */ +export const _TRANSACTION_RETRY_COUNT = 3; class IndexedDBLocalPersistence implements Persistence { static type: 'LOCAL' = 'LOCAL'; @@ -193,7 +195,7 @@ class IndexedDBLocalPersistence implements Persistence { ); } - private async initialize(): Promise { + async _openDb(): Promise { if (this.db) { return this.db; } @@ -201,6 +203,26 @@ class IndexedDBLocalPersistence implements Persistence { return this.db; } + async _withRetries(op: (db: IDBDatabase) => Promise): Promise { + let numAttempts = 0; + + while (true) { + try { + const db = await this._openDb(); + return await op(db); + } catch (e) { + if (numAttempts++ > _TRANSACTION_RETRY_COUNT) { + throw e; + } + if (this.db) { + this.db.close(); + this.db = undefined; + } + // TODO: consider adding exponential backoff + } + } + } + /** * IndexedDB events do not propagate from the main window to the worker context. We rely on a * postMessage interface to send these events to the worker ourselves. @@ -318,38 +340,35 @@ class IndexedDBLocalPersistence implements Persistence { } async _set(key: string, value: PersistenceValue): Promise { - const db = await this.initialize(); return this._withPendingWrite(async () => { - await _putObject(db, key, value); + await this._withRetries((db: IDBDatabase) => _putObject(db, key, value)); this.localCache[key] = value; return this.notifyServiceWorker(key); }); } async _get(key: string): Promise { - const db = await this.initialize(); - const obj = (await getObject(db, key)) as T; + const obj = (await this._withRetries((db: IDBDatabase) => + getObject(db, key) + )) as T; this.localCache[key] = obj; return obj; } async _remove(key: string): Promise { - const db = await this.initialize(); return this._withPendingWrite(async () => { - await deleteObject(db, key); + await this._withRetries((db: IDBDatabase) => deleteObject(db, key)); delete this.localCache[key]; return this.notifyServiceWorker(key); }); } private async _poll(): Promise { - const db = await _openDatabase(); - // TODO: check if we need to fallback if getAll is not supported - const getAllRequest = getObjectStore(db, false).getAll(); - const result = await new DBPromise( - getAllRequest - ).toPromise(); + const result = await this._withRetries((db: IDBDatabase) => { + const getAllRequest = getObjectStore(db, false).getAll(); + return new DBPromise(getAllRequest).toPromise(); + }); if (!result) { return []; From 6be9225fc3fb99fd7aec53954a476909607d3cd8 Mon Sep 17 00:00:00 2001 From: Sebastian Schmidt Date: Mon, 9 Nov 2020 09:49:11 -0800 Subject: [PATCH 072/624] FieldPath Compat class (#4038) --- packages/firestore/lite/src/api/field_path.ts | 28 +++-- packages/firestore/src/api/database.ts | 77 +++++++------ packages/firestore/src/api/field_path.ts | 67 ++---------- .../firestore/src/api/user_data_reader.ts | 101 ++++++++++-------- .../test/integration/util/firebase_export.ts | 4 +- packages/firestore/test/util/helpers.ts | 3 +- 6 files changed, 122 insertions(+), 158 deletions(-) diff --git a/packages/firestore/lite/src/api/field_path.ts b/packages/firestore/lite/src/api/field_path.ts index 64e435dec95..021ed57f36a 100644 --- a/packages/firestore/lite/src/api/field_path.ts +++ b/packages/firestore/lite/src/api/field_path.ts @@ -15,8 +15,11 @@ * limitations under the License. */ -import { _BaseFieldPath } from '../../../src/api/field_path'; -import { DOCUMENT_KEY_NAME } from '../../../src/model/path'; +import { + DOCUMENT_KEY_NAME, + FieldPath as InternalFieldPath +} from '../../../src/model/path'; +import { Code, FirestoreError } from '../../../src/util/error'; /** * A `FieldPath` refers to a field in a document. The path may consist of a @@ -26,12 +29,9 @@ import { DOCUMENT_KEY_NAME } from '../../../src/model/path'; * Create a `FieldPath` by providing field names. If more than one field * name is provided, the path will point to a nested field in a document. */ -export class FieldPath extends _BaseFieldPath { - // Note: This class is stripped down a copy of the FieldPath class in the - // legacy SDK. The changes are: - // - The `documentId()` static method has been removed - // - Input validation is limited to errors that cannot be caught by the - // TypeScript transpiler. +export class FieldPath { + /** Internal representation of a Firestore field path. */ + readonly _internalPath: InternalFieldPath; /** * Creates a FieldPath from the provided field names. If more than one field @@ -40,7 +40,17 @@ export class FieldPath extends _BaseFieldPath { * @param fieldNames A list of field names. */ constructor(...fieldNames: string[]) { - super(fieldNames); + for (let i = 0; i < fieldNames.length; ++i) { + if (fieldNames[i].length === 0) { + throw new FirestoreError( + Code.INVALID_ARGUMENT, + `Invalid field name at argument $(i + 1). ` + + 'Field names must not be empty.' + ); + } + } + + this._internalPath = new InternalFieldPath(fieldNames); } /** diff --git a/packages/firestore/src/api/database.ts b/packages/firestore/src/api/database.ts index 834388c17d5..73905859ada 100644 --- a/packages/firestore/src/api/database.ts +++ b/packages/firestore/src/api/database.ts @@ -77,7 +77,7 @@ import { } from '../util/input_validation'; import { logWarn, setLogLevel as setClientLogLevel } from '../util/log'; import { AutoId } from '../util/misc'; -import { _BaseFieldPath, FieldPath as ExternalFieldPath } from './field_path'; +import { FieldPath as ExpFieldPath } from '../../lite/src/api/field_path'; import { CompleteFn, ErrorFn, @@ -119,6 +119,7 @@ import { DocumentData as PublicDocumentData, DocumentReference as PublicDocumentReference, DocumentSnapshot as PublicDocumentSnapshot, + FieldPath as PublicFieldPath, FirebaseFirestore as PublicFirestore, FirestoreDataConverter as PublicFirestoreDataConverter, GetOptions as PublicGetOptions, @@ -518,28 +519,33 @@ export class Transaction implements PublicTransaction { ): Transaction; update( documentRef: PublicDocumentReference, - field: string | ExternalFieldPath, + field: string | PublicFieldPath, value: unknown, ...moreFieldsAndValues: unknown[] ): Transaction; update( documentRef: PublicDocumentReference, - fieldOrUpdateData: string | ExternalFieldPath | PublicUpdateData, + fieldOrUpdateData: string | PublicFieldPath | PublicUpdateData, value?: unknown, ...moreFieldsAndValues: unknown[] ): Transaction { - let ref; - let parsed; + const ref = validateReference( + 'Transaction.update', + documentRef, + this._firestore + ); + // For Compat types, we have to "extract" the underlying types before + // performing validation. + if (fieldOrUpdateData instanceof Compat) { + fieldOrUpdateData = (fieldOrUpdateData as Compat)._delegate; + } + + let parsed; if ( typeof fieldOrUpdateData === 'string' || - fieldOrUpdateData instanceof ExternalFieldPath + fieldOrUpdateData instanceof ExpFieldPath ) { - ref = validateReference( - 'Transaction.update', - documentRef, - this._firestore - ); parsed = parseUpdateVarargs( this._dataReader, 'Transaction.update', @@ -549,11 +555,6 @@ export class Transaction implements PublicTransaction { moreFieldsAndValues ); } else { - ref = validateReference( - 'Transaction.update', - documentRef, - this._firestore - ); parsed = parseUpdateData( this._dataReader, 'Transaction.update', @@ -629,30 +630,34 @@ export class WriteBatch implements PublicWriteBatch { ): WriteBatch; update( documentRef: PublicDocumentReference, - field: string | ExternalFieldPath, + field: string | PublicFieldPath, value: unknown, ...moreFieldsAndValues: unknown[] ): WriteBatch; update( documentRef: PublicDocumentReference, - fieldOrUpdateData: string | ExternalFieldPath | PublicUpdateData, + fieldOrUpdateData: string | PublicFieldPath | PublicUpdateData, value?: unknown, ...moreFieldsAndValues: unknown[] ): WriteBatch { this.verifyNotCommitted(); + const ref = validateReference( + 'WriteBatch.update', + documentRef, + this._firestore + ); - let ref; - let parsed; + // For Compat types, we have to "extract" the underlying types before + // performing validation. + if (fieldOrUpdateData instanceof Compat) { + fieldOrUpdateData = (fieldOrUpdateData as Compat)._delegate; + } + let parsed; if ( typeof fieldOrUpdateData === 'string' || - fieldOrUpdateData instanceof ExternalFieldPath + fieldOrUpdateData instanceof ExpFieldPath ) { - ref = validateReference( - 'WriteBatch.update', - documentRef, - this._firestore - ); parsed = parseUpdateVarargs( this._dataReader, 'WriteBatch.update', @@ -662,11 +667,6 @@ export class WriteBatch implements PublicWriteBatch { moreFieldsAndValues ); } else { - ref = validateReference( - 'WriteBatch.update', - documentRef, - this._firestore - ); parsed = parseUpdateData( this._dataReader, 'WriteBatch.update', @@ -825,26 +825,25 @@ export class DocumentReference update(value: PublicUpdateData): Promise; update( - field: string | ExternalFieldPath, + field: string | PublicFieldPath, value: unknown, ...moreFieldsAndValues: unknown[] ): Promise; update( - fieldOrUpdateData: string | ExternalFieldPath | PublicUpdateData, + fieldOrUpdateData: string | PublicFieldPath | PublicUpdateData, value?: unknown, ...moreFieldsAndValues: unknown[] ): Promise { // For Compat types, we have to "extract" the underlying types before // performing validation. if (fieldOrUpdateData instanceof Compat) { - fieldOrUpdateData = (fieldOrUpdateData as Compat<_BaseFieldPath>) - ._delegate; + fieldOrUpdateData = (fieldOrUpdateData as Compat)._delegate; } let parsed; if ( typeof fieldOrUpdateData === 'string' || - fieldOrUpdateData instanceof _BaseFieldPath + fieldOrUpdateData instanceof ExpFieldPath ) { parsed = parseUpdateVarargs( this._dataReader, @@ -1080,7 +1079,7 @@ export class DocumentSnapshot } get( - fieldPath: string | ExternalFieldPath, + fieldPath: string | PublicFieldPath, options: PublicSnapshotOptions = {} ): unknown { if (this._document) { @@ -1556,7 +1555,7 @@ export class Query implements PublicQuery { } where( - field: string | ExternalFieldPath, + field: string | PublicFieldPath, opStr: PublicWhereFilterOp, value: unknown ): PublicQuery { @@ -1578,7 +1577,7 @@ export class Query implements PublicQuery { } orderBy( - field: string | ExternalFieldPath, + field: string | PublicFieldPath, directionStr?: PublicOrderByDirection ): PublicQuery { let direction: Direction; diff --git a/packages/firestore/src/api/field_path.ts b/packages/firestore/src/api/field_path.ts index 4008a9936c1..bf4e24491d2 100644 --- a/packages/firestore/src/api/field_path.ts +++ b/packages/firestore/src/api/field_path.ts @@ -17,44 +17,20 @@ import { FieldPath as PublicFieldPath } from '@firebase/firestore-types'; +import { FieldPath as ExpFieldPath } from '../../lite/src/api/field_path'; import { FieldPath as InternalFieldPath } from '../model/path'; -import { Code, FirestoreError } from '../util/error'; +import { Compat } from '../compat/compat'; // The objects that are a part of this API are exposed to third-parties as // compiled javascript so we want to flag our private members with a leading // underscore to discourage their use. -/** - * A field class base class that is shared by the lite, full and legacy SDK, - * which supports shared code that deals with FieldPaths. - */ -// Use underscore prefix to hide this class from our Public API. -// eslint-disable-next-line @typescript-eslint/naming-convention -export abstract class _BaseFieldPath { - /** Internal representation of a Firestore field path. */ - readonly _internalPath: InternalFieldPath; - - constructor(fieldNames: string[]) { - for (let i = 0; i < fieldNames.length; ++i) { - if (fieldNames[i].length === 0) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - `Invalid field name at argument $(i + 1). ` + - 'Field names must not be empty.' - ); - } - } - - this._internalPath = new InternalFieldPath(fieldNames); - } -} - /** * A `FieldPath` refers to a field in a document. The path may consist of a * single field name (referring to a top-level field in the document), or a list * of field names (referring to a nested field in the document). */ -export class FieldPath extends _BaseFieldPath implements PublicFieldPath { +export class FieldPath extends Compat implements PublicFieldPath { /** * Creates a FieldPath from the provided field names. If more than one field * name is provided, the path will point to a nested field in a document. @@ -62,7 +38,7 @@ export class FieldPath extends _BaseFieldPath implements PublicFieldPath { * @param fieldNames A list of field names. */ constructor(...fieldNames: string[]) { - super(fieldNames); + super(new ExpFieldPath(...fieldNames)); } static documentId(): FieldPath { @@ -76,37 +52,12 @@ export class FieldPath extends _BaseFieldPath implements PublicFieldPath { } isEqual(other: PublicFieldPath): boolean { - if (!(other instanceof FieldPath)) { + if (other instanceof Compat) { + other = other._delegate; + } + if (!(other instanceof ExpFieldPath)) { return false; } - return this._internalPath.isEqual(other._internalPath); - } -} - -/** - * Matches any characters in a field path string that are reserved. - */ -const RESERVED = new RegExp('[~\\*/\\[\\]]'); - -/** - * Parses a field path string into a FieldPath, treating dots as separators. - */ -export function fromDotSeparatedString(path: string): FieldPath { - const found = path.search(RESERVED); - if (found >= 0) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - `Invalid field path (${path}). Paths must not contain ` + - `'~', '*', '/', '[', or ']'` - ); - } - try { - return new FieldPath(...path.split('.')); - } catch (e) { - throw new FirestoreError( - Code.INVALID_ARGUMENT, - `Invalid field path (${path}). Paths must not be empty, ` + - `begin with '.', end with '.', or contain '..'` - ); + return this._delegate._internalPath.isEqual(other._internalPath); } } diff --git a/packages/firestore/src/api/user_data_reader.ts b/packages/firestore/src/api/user_data_reader.ts index a574191d365..bf63ab6cfa9 100644 --- a/packages/firestore/src/api/user_data_reader.ts +++ b/packages/firestore/src/api/user_data_reader.ts @@ -15,7 +15,11 @@ * limitations under the License. */ -import { DocumentData, SetOptions } from '@firebase/firestore-types'; +import { + DocumentData, + SetOptions, + FieldPath as PublicFieldPath +} from '@firebase/firestore-types'; import { Value as ProtoValue, @@ -33,7 +37,7 @@ import { SetMutation, TransformMutation } from '../model/mutation'; -import { FieldPath } from '../model/path'; +import { FieldPath as InternalFieldPath } from '../model/path'; import { debugAssert, fail } from '../util/assert'; import { Code, FirestoreError } from '../util/error'; import { isPlainObject, valueDescription } from '../util/input_validation'; @@ -46,13 +50,13 @@ import { toResourceName, toTimestamp } from '../remote/serializer'; -import { _BaseFieldPath, fromDotSeparatedString } from './field_path'; import { DeleteFieldValueImpl } from './field_value'; import { GeoPoint } from './geo_point'; import { newSerializer } from '../platform/serializer'; import { Bytes } from '../../lite/src/api/bytes'; import { Compat } from '../compat/compat'; import { FieldValue } from '../../lite/src/api/field_value'; +import { FieldPath } from '../../lite/src/api/field_path'; const RESERVED_FIELD_REGEX = /^__.*__$/; @@ -174,7 +178,7 @@ interface ContextSettings { * nonempty path (indicating the context represents a nested location within * the data). */ - readonly path?: FieldPath; + readonly path?: InternalFieldPath; /** * Whether or not this context corresponds to an element of an array. * If not set, elements are treated as if they were outside of arrays. @@ -190,7 +194,7 @@ interface ContextSettings { /** A "context" object passed around while parsing user data. */ export class ParseContext { readonly fieldTransforms: FieldTransform[]; - readonly fieldMask: FieldPath[]; + readonly fieldMask: InternalFieldPath[]; /** * Initializes a ParseContext with the given source and path. * @@ -215,7 +219,7 @@ export class ParseContext { readonly serializer: JsonProtoSerializer, readonly ignoreUndefinedProperties: boolean, fieldTransforms?: FieldTransform[], - fieldMask?: FieldPath[] + fieldMask?: InternalFieldPath[] ) { // Minor hack: If fieldTransforms is undefined, we assume this is an // external call and we need to validate the entire path. @@ -226,7 +230,7 @@ export class ParseContext { this.fieldMask = fieldMask || []; } - get path(): FieldPath | undefined { + get path(): InternalFieldPath | undefined { return this.settings.path; } @@ -253,7 +257,7 @@ export class ParseContext { return context; } - childContextForFieldPath(field: FieldPath): ParseContext { + childContextForFieldPath(field: InternalFieldPath): ParseContext { const childPath = this.path?.child(field); const context = this.contextWith({ path: childPath, arrayElement: false }); context.validatePath(); @@ -277,7 +281,7 @@ export class ParseContext { } /** Returns 'true' if 'fieldPath' was traversed when creating this context. */ - contains(fieldPath: FieldPath): boolean { + contains(fieldPath: InternalFieldPath): boolean { return ( this.fieldMask.find(field => fieldPath.isPrefixOf(field)) !== undefined || this.fieldTransforms.find(transform => @@ -334,7 +338,7 @@ export class UserDataReader { dataSource, methodName, targetDoc, - path: FieldPath.emptyPath(), + path: InternalFieldPath.emptyPath(), arrayElement: false, hasConverter }, @@ -372,23 +376,14 @@ export function parseSetData( fieldMask = new FieldMask(context.fieldMask); fieldTransforms = context.fieldTransforms; } else if (options.mergeFields) { - const validatedFieldPaths: FieldPath[] = []; + const validatedFieldPaths: InternalFieldPath[] = []; for (const stringOrFieldPath of options.mergeFields) { - let fieldPath: FieldPath; - - if (stringOrFieldPath instanceof _BaseFieldPath) { - fieldPath = stringOrFieldPath._internalPath; - } else if (typeof stringOrFieldPath === 'string') { - fieldPath = fieldPathFromDotSeparatedString( - methodName, - stringOrFieldPath, - targetDoc - ); - } else { - throw fail('Expected stringOrFieldPath to be a string or a FieldPath'); - } - + const fieldPath = fieldPathFromArgument( + methodName, + stringOrFieldPath, + targetDoc + ); if (!context.contains(fieldPath)) { throw new FirestoreError( Code.INVALID_ARGUMENT, @@ -431,7 +426,7 @@ export function parseUpdateData( ); validatePlainObject('Data must be an object, but it was:', context, input); - const fieldMaskPaths: FieldPath[] = []; + const fieldMaskPaths: InternalFieldPath[] = []; const updateData = new ObjectValueBuilder(); forEach(input as Dict, (key, value) => { const path = fieldPathFromDotSeparatedString(methodName, key, targetDoc); @@ -468,7 +463,7 @@ export function parseUpdateVarargs( userDataReader: UserDataReader, methodName: string, targetDoc: DocumentKey, - field: string | _BaseFieldPath, + field: string | PublicFieldPath | Compat, value: unknown, moreFieldsAndValues: unknown[] ): ParsedUpdateData { @@ -492,13 +487,13 @@ export function parseUpdateVarargs( keys.push( fieldPathFromArgument( methodName, - moreFieldsAndValues[i] as string | _BaseFieldPath + moreFieldsAndValues[i] as string | PublicFieldPath ) ); values.push(moreFieldsAndValues[i + 1]); } - const fieldMaskPaths: FieldPath[] = []; + const fieldMaskPaths: InternalFieldPath[] = []; const updateData = new ObjectValueBuilder(); // We iterate in reverse order to pick the last value for a field if the @@ -797,16 +792,16 @@ function validatePlainObject( */ export function fieldPathFromArgument( methodName: string, - path: string | _BaseFieldPath | Compat<_BaseFieldPath>, + path: string | PublicFieldPath | Compat, targetDoc?: DocumentKey -): FieldPath { +): InternalFieldPath { // If required, replace the FieldPath Compat class with with the firestore-exp // FieldPath. if (path instanceof Compat) { - path = (path as Compat<_BaseFieldPath>)._delegate; + path = (path as Compat)._delegate; } - if (path instanceof _BaseFieldPath) { + if (path instanceof FieldPath) { return path._internalPath; } else if (typeof path === 'string') { return fieldPathFromDotSeparatedString(methodName, path); @@ -822,6 +817,11 @@ export function fieldPathFromArgument( } } +/** + * Matches any characters in a field path string that are reserved. + */ +const FIELD_PATH_RESERVED = new RegExp('[~\\*/\\[\\]]'); + /** * Wraps fromDotSeparatedString with an error message about the method that * was thrown. @@ -834,13 +834,25 @@ export function fieldPathFromDotSeparatedString( methodName: string, path: string, targetDoc?: DocumentKey -): FieldPath { +): InternalFieldPath { + const found = path.search(FIELD_PATH_RESERVED); + if (found >= 0) { + throw createError( + `Invalid field path (${path}). Paths must not contain ` + + `'~', '*', '/', '[', or ']'`, + methodName, + /* hasConverter= */ false, + /* path= */ undefined, + targetDoc + ); + } + try { - return fromDotSeparatedString(path)._internalPath; + return new FieldPath(...path.split('.'))._internalPath; } catch (e) { - const message = errorMessage(e); throw createError( - message, + `Invalid field path (${path}). Paths must not be empty, ` + + `begin with '.', end with '.', or contain '..'`, methodName, /* hasConverter= */ false, /* path= */ undefined, @@ -853,7 +865,7 @@ function createError( reason: string, methodName: string, hasConverter: boolean, - path?: FieldPath, + path?: InternalFieldPath, targetDoc?: DocumentKey ): FirestoreError { const hasPath = path && !path.isEmpty(); @@ -883,15 +895,10 @@ function createError( ); } -/** - * Extracts the message from a caught exception, which should be an Error object - * though JS doesn't guarantee that. - */ -function errorMessage(error: Error | object): string { - return error instanceof Error ? error.message : error.toString(); -} - /** Checks `haystack` if FieldPath `needle` is present. Runs in O(n). */ -function fieldMaskContains(haystack: FieldPath[], needle: FieldPath): boolean { +function fieldMaskContains( + haystack: InternalFieldPath[], + needle: InternalFieldPath +): boolean { return haystack.some(v => v.isEqual(needle)); } diff --git a/packages/firestore/test/integration/util/firebase_export.ts b/packages/firestore/test/integration/util/firebase_export.ts index 3dfd156c8eb..6024db21309 100644 --- a/packages/firestore/test/integration/util/firebase_export.ts +++ b/packages/firestore/test/integration/util/firebase_export.ts @@ -34,6 +34,7 @@ import firebaseAppCompat from '@firebase/app-compat'; import * as exp from '../../../exp/test/shim'; import { FieldValue } from '../../../src/compat/field_value'; +import { FieldPath } from '../../../src/api/field_path'; import { FirebaseApp } from '@firebase/app-types'; import { Firestore, @@ -115,9 +116,6 @@ export function newTestFirestore( // eslint-disable-next-line @typescript-eslint/no-explicit-any const legacyNamespace = (firebase as any).firestore; -const FieldPath = usesFunctionalApi() - ? exp.FieldPath - : legacyNamespace.FieldPath; const Timestamp = usesFunctionalApi() ? exp.Timestamp : legacyNamespace.Timestamp; diff --git a/packages/firestore/test/util/helpers.ts b/packages/firestore/test/util/helpers.ts index 67c63479b9d..855fe5afb76 100644 --- a/packages/firestore/test/util/helpers.ts +++ b/packages/firestore/test/util/helpers.ts @@ -22,7 +22,6 @@ import * as api from '../../src/protos/firestore_proto_api'; import { expect } from 'chai'; import { Blob } from '../../src/api/blob'; -import { fromDotSeparatedString } from '../../src/api/field_path'; import { UserDataWriter } from '../../src/api/user_data_writer'; import { parseQueryValue, @@ -203,7 +202,7 @@ export function path(path: string, offset?: number): ResourcePath { } export function field(path: string): FieldPath { - return fromDotSeparatedString(path)._internalPath; + return new FieldPath(path.split('.')); } export function mask(...paths: string[]): FieldMask { From 484e90a1d8f63e04268ff5bce4e3e0873c56c8e1 Mon Sep 17 00:00:00 2001 From: Sebastian Schmidt Date: Mon, 9 Nov 2020 14:35:40 -0800 Subject: [PATCH 073/624] Compat class for DocumentReference (#4043) --- .changeset/short-mangos-beg.md | 5 + packages/firestore/exp/src/api/reference.ts | 10 +- packages/firestore/exp/src/api/snapshot.ts | 9 +- packages/firestore/exp/test/shim.ts | 197 +-------- packages/firestore/lite/src/api/reference.ts | 30 +- packages/firestore/lite/src/api/snapshot.ts | 11 +- packages/firestore/src/api/database.ts | 375 ++++++++++-------- packages/firestore/src/api/observer.ts | 2 +- .../firestore/src/api/user_data_reader.ts | 31 +- .../firestore/src/api/user_data_writer.ts | 7 +- .../firestore/src/util/input_validation.ts | 5 + packages/firestore/test/util/api_helpers.ts | 2 +- packages/firestore/test/util/helpers.ts | 6 +- 13 files changed, 266 insertions(+), 424 deletions(-) create mode 100644 .changeset/short-mangos-beg.md diff --git a/.changeset/short-mangos-beg.md b/.changeset/short-mangos-beg.md new file mode 100644 index 00000000000..2b140b68814 --- /dev/null +++ b/.changeset/short-mangos-beg.md @@ -0,0 +1,5 @@ +--- +"@firebase/firestore": patch +--- + +Internal changes to support upcoming modular API. diff --git a/packages/firestore/exp/src/api/reference.ts b/packages/firestore/exp/src/api/reference.ts index 06cc7a5094c..906b860fd91 100644 --- a/packages/firestore/exp/src/api/reference.ts +++ b/packages/firestore/exp/src/api/reference.ts @@ -17,7 +17,6 @@ import { FirebaseFirestore } from './database'; import { - _DocumentKeyReference, ParsedUpdateData, parseSetData, parseUpdateData, @@ -80,6 +79,7 @@ import { removeSnapshotsInSyncListener } from '../../../src/core/event_manager'; import { FirestoreError } from '../../../src/util/error'; +import { Compat } from '../../../src/compat/compat'; /** * An options object that can be passed to {@link onSnapshot()} and {@link @@ -374,6 +374,12 @@ export function updateDoc( const dataReader = newUserDataReader(firestore); + // For Compat types, we have to "extract" the underlying types before + // performing validation. + if (fieldOrUpdateData instanceof Compat) { + fieldOrUpdateData = fieldOrUpdateData._delegate; + } + let parsed: ParsedUpdateData; if ( typeof fieldOrUpdateData === 'string' || @@ -821,7 +827,7 @@ export function executeWrite( */ function convertToDocSnapshot( firestore: FirebaseFirestore, - ref: _DocumentKeyReference, + ref: DocumentReference, snapshot: ViewSnapshot ): DocumentSnapshot { debugAssert( diff --git a/packages/firestore/exp/src/api/snapshot.ts b/packages/firestore/exp/src/api/snapshot.ts index 7002d725b39..cd064784b6a 100644 --- a/packages/firestore/exp/src/api/snapshot.ts +++ b/packages/firestore/exp/src/api/snapshot.ts @@ -238,11 +238,7 @@ export class DocumentSnapshot extends LiteDocumentSnapshot< this._firestoreImpl._databaseId, options?.serverTimestamps || DEFAULT_SERVER_TIMESTAMP_BEHAVIOR, key => - new DocumentReference( - this._firestore, - /* converter= */ null, - key.path - ), + new DocumentReference(this._firestore, /* converter= */ null, key), bytes => new Bytes(bytes) ); return userDataWriter.convertValue(this._document.toProto()) as T; @@ -276,8 +272,7 @@ export class DocumentSnapshot extends LiteDocumentSnapshot< const userDataWriter = new UserDataWriter( this._firestoreImpl._databaseId, options.serverTimestamps || DEFAULT_SERVER_TIMESTAMP_BEHAVIOR, - key => - new DocumentReference(this._firestore, this._converter, key.path), + key => new DocumentReference(this._firestore, this._converter, key), bytes => new Bytes(bytes) ); return userDataWriter.convertValue(value); diff --git a/packages/firestore/exp/test/shim.ts b/packages/firestore/exp/test/shim.ts index e7d4bb2491c..5c18197d47e 100644 --- a/packages/firestore/exp/test/shim.ts +++ b/packages/firestore/exp/test/shim.ts @@ -20,14 +20,8 @@ import * as exp from '../index'; import { addDoc, - collection, - deleteDoc, doc, - DocumentReference as DocumentReferenceExp, FieldPath as FieldPathExp, - getDoc, - getDocFromCache, - getDocFromServer, getDocs, getDocsFromCache, getDocsFromServer, @@ -35,9 +29,7 @@ import { query, queryEqual, refEqual, - setDoc, snapshotEqual, - updateDoc, endAt, endBefore, startAfter, @@ -49,13 +41,17 @@ import { Bytes as BytesExp } from '../../exp/index'; import { UntypedFirestoreDataConverter } from '../../src/api/user_data_reader'; -import { isPartialObserver, PartialObserver } from '../../src/api/observer'; import { isPlainObject, validateSetOptions } from '../../src/util/input_validation'; import { Compat } from '../../src/compat/compat'; -import { Firestore } from '../../src/api/database'; +import { + Firestore, + DocumentReference, + wrapObserver, + extractSnapshotOptions +} from '../../src/api/database'; export { GeoPoint, Timestamp } from '../index'; @@ -188,129 +184,6 @@ export class WriteBatch } } -export class DocumentReference - extends Compat> - implements legacy.DocumentReference { - constructor( - readonly firestore: Firestore, - delegate: exp.DocumentReference - ) { - super(delegate); - } - - readonly id = this._delegate.id; - readonly path = this._delegate.path; - - get parent(): legacy.CollectionReference { - return new CollectionReference(this.firestore, this._delegate.parent); - } - - collection( - collectionPath: string - ): legacy.CollectionReference { - return new CollectionReference( - this.firestore, - collection(this._delegate, collectionPath) - ); - } - - isEqual(other: DocumentReference): boolean { - return refEqual(this._delegate, other._delegate); - } - - set(data: Partial, options?: legacy.SetOptions): Promise { - if (options) { - validateSetOptions('DocumentReference.set', options); - return setDoc(this._delegate, unwrap(data), options); - } else { - return setDoc(this._delegate, unwrap(data)); - } - } - - update(data: legacy.UpdateData): Promise; - update( - field: string | FieldPath, - value: any, - ...moreFieldsAndValues: any[] - ): Promise; - update( - dataOrField: any, - value?: any, - ...moreFieldsAndValues: any[] - ): Promise { - if (arguments.length === 1) { - return updateDoc(this._delegate, unwrap(dataOrField)); - } else { - return updateDoc( - this._delegate, - unwrap(dataOrField), - unwrap(value), - ...unwrap(moreFieldsAndValues) - ); - } - } - - delete(): Promise { - return deleteDoc(this._delegate); - } - - get(options?: legacy.GetOptions): Promise> { - let snap: Promise>; - if (options?.source === 'cache') { - snap = getDocFromCache(this._delegate); - } else if (options?.source === 'server') { - snap = getDocFromServer(this._delegate); - } else { - snap = getDoc(this._delegate); - } - return snap.then(result => new DocumentSnapshot(this.firestore, result)); - } - - onSnapshot(observer: { - next?: (snapshot: DocumentSnapshot) => void; - error?: (error: legacy.FirestoreError) => void; - complete?: () => void; - }): () => void; - onSnapshot( - options: legacy.SnapshotListenOptions, - observer: { - next?: (snapshot: DocumentSnapshot) => void; - error?: (error: legacy.FirestoreError) => void; - complete?: () => void; - } - ): () => void; - onSnapshot( - onNext: (snapshot: DocumentSnapshot) => void, - onError?: (error: legacy.FirestoreError) => void, - onCompletion?: () => void - ): () => void; - onSnapshot( - options: legacy.SnapshotListenOptions, - onNext: (snapshot: DocumentSnapshot) => void, - onError?: (error: legacy.FirestoreError) => void, - onCompletion?: () => void - ): () => void; - onSnapshot(...args: any): () => void { - const options = extractSnapshotOptions(args); - const observer = wrapObserver, exp.DocumentSnapshot>( - args, - snap => new DocumentSnapshot(this.firestore, snap) - ); - return onSnapshot(this._delegate, options, observer); - } - - withConverter( - converter: legacy.FirestoreDataConverter - ): DocumentReference { - return new DocumentReference( - this.firestore, - this._delegate.withConverter( - converter as UntypedFirestoreDataConverter - ) - ); - } -} - export class DocumentSnapshot extends Compat> implements legacy.DocumentSnapshot { @@ -634,8 +507,6 @@ function wrap(firestore: Firestore, value: any): any { return new FieldPath(...value._internalPath.toArray()); } else if (value instanceof BytesExp) { return new Blob(value); - } else if (value instanceof DocumentReferenceExp) { - return new DocumentReference(firestore, value); } else if (isPlainObject(value)) { const obj: any = {}; for (const key in value) { @@ -672,59 +543,3 @@ function unwrap(value: any): any { return value; } } - -/** - * Creates an observer that can be passed to the firestore-exp SDK. The - * observer converts all observed values into the format expected by the shim. - * - * @param args The list of arguments from an `onSnapshot` call. - * @param wrapper The function that converts the firestore-exp type into the - * type used by this shim. - */ -function wrapObserver( - args: any, - wrapper: (val: ExpType) => ShimType -): PartialObserver { - let userObserver: PartialObserver; - if (isPartialObserver(args[0])) { - userObserver = args[0] as PartialObserver; - } else if (isPartialObserver(args[1])) { - userObserver = args[1]; - } else if (typeof args[0] === 'function') { - userObserver = { - next: args[0], - error: args[1], - complete: args[2] - }; - } else { - userObserver = { - next: args[1], - error: args[2], - complete: args[3] - }; - } - - return { - next: val => { - if (userObserver!.next) { - userObserver!.next(wrapper(val)); - } - }, - error: userObserver.error?.bind(userObserver), - complete: userObserver.complete?.bind(userObserver) - }; -} - -/** - * Iterates the list of arguments from an `onSnapshot` call and returns the - * first argument that may be an `SnapshotListenOptions` object. Returns an - * empty object if none is found. - */ -function extractSnapshotOptions(args: any): exp.SnapshotListenOptions { - for (const arg of args) { - if (typeof arg === 'object' && !isPartialObserver(arg)) { - return arg as exp.SnapshotListenOptions; - } - } - return {}; -} diff --git a/packages/firestore/lite/src/api/reference.ts b/packages/firestore/lite/src/api/reference.ts index bd899a4edb7..df2a62db817 100644 --- a/packages/firestore/lite/src/api/reference.ts +++ b/packages/firestore/lite/src/api/reference.ts @@ -19,7 +19,6 @@ import { Document } from '../../../src/model/document'; import { DocumentKey } from '../../../src/model/document_key'; import { FirebaseFirestore } from './database'; import { - _DocumentKeyReference, ParsedUpdateData, parseSetData, parseUpdateData, @@ -125,9 +124,7 @@ export type SetOptions = * and can be used to write, read, or listen to the location. The document at * the referenced location may or may not exist. */ -export class DocumentReference extends _DocumentKeyReference< - T -> { +export class DocumentReference { /** The type of this Firestore reference. */ readonly type = 'document'; @@ -139,18 +136,21 @@ export class DocumentReference extends _DocumentKeyReference< constructor( firestore: FirebaseFirestore, - _converter: FirestoreDataConverter | null, - readonly _path: ResourcePath + readonly _converter: FirestoreDataConverter | null, + readonly _key: DocumentKey ) { - super(firestore._databaseId, new DocumentKey(_path), _converter); this.firestore = firestore; } + get _path(): ResourcePath { + return this._key.path; + } + /** * The document's identifier within its collection. */ get id(): string { - return this._path.lastSegment(); + return this._key.path.lastSegment(); } /** @@ -158,7 +158,7 @@ export class DocumentReference extends _DocumentKeyReference< * to the root of the database). */ get path(): string { - return this._path.canonicalString(); + return this._key.path.canonicalString(); } /** @@ -183,7 +183,7 @@ export class DocumentReference extends _DocumentKeyReference< * @return A `DocumentReference` that uses the provided converter. */ withConverter(converter: FirestoreDataConverter): DocumentReference { - return new DocumentReference(this.firestore, converter, this._path); + return new DocumentReference(this.firestore, converter, this._key); } } @@ -653,7 +653,7 @@ export class CollectionReference extends Query { return new DocumentReference( this.firestore, /* converter= */ null, - parentPath + new DocumentKey(parentPath) ); } } @@ -868,7 +868,11 @@ export function doc( if (parent instanceof FirebaseFirestore) { const absolutePath = ResourcePath.fromString(path, ...pathSegments); validateDocumentPath(absolutePath); - return new DocumentReference(parent, /* converter= */ null, absolutePath); + return new DocumentReference( + parent, + /* converter= */ null, + new DocumentKey(absolutePath) + ); } else { if ( !(parent instanceof DocumentReference) && @@ -887,7 +891,7 @@ export function doc( return new DocumentReference( parent.firestore, parent instanceof CollectionReference ? parent._converter : null, - absolutePath + new DocumentKey(absolutePath) ); } } diff --git a/packages/firestore/lite/src/api/snapshot.ts b/packages/firestore/lite/src/api/snapshot.ts index cff40b44c0b..d4c01415075 100644 --- a/packages/firestore/lite/src/api/snapshot.ts +++ b/packages/firestore/lite/src/api/snapshot.ts @@ -135,7 +135,7 @@ export class DocumentSnapshot { return new DocumentReference( this._firestore, this._converter, - this._key.path + this._key ); } @@ -173,11 +173,7 @@ export class DocumentSnapshot { this._firestore._databaseId, /* serverTimestampBehavior=*/ 'none', key => - new DocumentReference( - this._firestore, - /* converter= */ null, - key.path - ), + new DocumentReference(this._firestore, /* converter= */ null, key), bytes => new Bytes(bytes) ); return userDataWriter.convertValue(this._document.toProto()) as T; @@ -204,8 +200,7 @@ export class DocumentSnapshot { const userDataWriter = new UserDataWriter( this._firestore._databaseId, /* serverTimestampBehavior=*/ 'none', - key => - new DocumentReference(this._firestore, this._converter, key.path), + key => new DocumentReference(this._firestore, this._converter, key), bytes => new Bytes(bytes) ); return userDataWriter.convertValue(value); diff --git a/packages/firestore/src/api/database.ts b/packages/firestore/src/api/database.ts index 73905859ada..02161b9f87d 100644 --- a/packages/firestore/src/api/database.ts +++ b/packages/firestore/src/api/database.ts @@ -24,10 +24,8 @@ import { DatabaseId } from '../core/database_info'; import { ListenOptions } from '../core/event_manager'; import { FirestoreClient, - firestoreClientGetDocumentFromLocalCache, firestoreClientGetDocumentsFromLocalCache, firestoreClientGetDocumentsViaSnapshotListener, - firestoreClientGetDocumentViaSnapshotListener, firestoreClientListen, firestoreClientTransaction, firestoreClientWrite @@ -87,7 +85,6 @@ import { Unsubscribe } from './observer'; import { - _DocumentKeyReference, fieldPathFromArgument, parseQueryValue, parseSetData, @@ -108,7 +105,22 @@ import { waitForPendingWrites, FirebaseFirestore as ExpFirebaseFirestore } from '../../exp/src/api/database'; -import { onSnapshotsInSync } from '../../exp/src/api/reference'; +import { + DocumentReference as ExpDocumentReference, + refEqual, + newUserDataReader +} from '../../lite/src/api/reference'; +import { + onSnapshotsInSync, + setDoc, + updateDoc, + deleteDoc, + getDocFromCache, + getDocFromServer, + getDoc, + onSnapshot +} from '../../exp/src/api/reference'; +import { DocumentSnapshot as ExpDocumentSnapshot } from '../../exp/src/api/snapshot'; import { LRU_COLLECTION_DISABLED } from '../local/lru_garbage_collector'; import { Compat } from '../compat/compat'; @@ -139,7 +151,7 @@ import { WhereFilterOp as PublicWhereFilterOp, WriteBatch as PublicWriteBatch } from '@firebase/firestore-types'; -import { newUserDataReader } from '../../lite/src/api/reference'; + import { makeDatabaseInfo } from '../../lite/src/api/database'; import { DEFAULT_HOST } from '../../lite/src/api/components'; @@ -720,25 +732,19 @@ export class WriteBatch implements PublicWriteBatch { * A reference to a particular document in a collection in the database. */ export class DocumentReference - extends _DocumentKeyReference + extends Compat> implements PublicDocumentReference { - private _firestoreClient: FirestoreClient; - private _dataReader: UserDataReader; - constructor( - public _key: DocumentKey, readonly firestore: Firestore, - readonly _converter: PublicFirestoreDataConverter | null + delegate: ExpDocumentReference ) { - super(firestore._databaseId, _key, _converter); - this._firestoreClient = ensureFirestoreConfigured(firestore._delegate); - this._dataReader = newUserDataReader(firestore._delegate); + super(delegate); } static forPath( path: ResourcePath, firestore: Firestore, - converter: PublicFirestoreDataConverter | null + converter: UntypedFirestoreDataConverter | null ): DocumentReference { if (path.length % 2 !== 0) { throw new FirestoreError( @@ -748,23 +754,41 @@ export class DocumentReference `${path.canonicalString()} has ${path.length}` ); } - return new DocumentReference(new DocumentKey(path), firestore, converter); + return new DocumentReference( + firestore, + new ExpDocumentReference( + firestore._delegate, + converter, + new DocumentKey(path) + ) + ); + } + + static forKey( + key: DocumentKey, + firestore: Firestore, + converter: UntypedFirestoreDataConverter | null + ): DocumentReference { + return new DocumentReference( + firestore, + new ExpDocumentReference(firestore._delegate, converter, key) + ); } get id(): string { - return this._key.path.lastSegment(); + return this._delegate.id; } get parent(): PublicCollectionReference { return new CollectionReference( - this._key.path.popLast(), + this._delegate._path.popLast(), this.firestore, - this._converter + this._delegate._converter ); } get path(): string { - return this._key.path.canonicalString(); + return this._delegate.path; } collection( @@ -783,44 +807,31 @@ export class DocumentReference } const path = ResourcePath.fromString(pathString); return new CollectionReference( - this._key.path.child(path), + this._delegate._path.child(path), this.firestore, /* converter= */ null ); } isEqual(other: PublicDocumentReference): boolean { - if (!(other instanceof DocumentReference)) { + if (other instanceof Compat) { + other = other._delegate; + } + if (!(other instanceof ExpDocumentReference)) { return false; } - return ( - this.firestore === other.firestore && - this._key.isEqual(other._key) && - this._converter === other._converter - ); + return refEqual(this._delegate, other); } set(value: Partial, options: PublicSetOptions): Promise; set(value: T): Promise; set(value: T | Partial, options?: PublicSetOptions): Promise { options = validateSetOptions('DocumentReference.set', options); - const convertedValue = applyFirestoreDataConverter( - this._converter, - value, - options - ); - const parsed = parseSetData( - this._dataReader, - 'DocumentReference.set', - this._key, - convertedValue, - this._converter !== null, - options - ); - return firestoreClientWrite( - this._firestoreClient, - parsed.toMutations(this._key, Precondition.none()) - ); + try { + return setDoc(this._delegate, value, options); + } catch (e) { + throw replaceFunctionName(e, 'setDoc', 'DocumentReference.set'); + } } update(value: PublicUpdateData): Promise; @@ -834,44 +845,24 @@ export class DocumentReference value?: unknown, ...moreFieldsAndValues: unknown[] ): Promise { - // For Compat types, we have to "extract" the underlying types before - // performing validation. - if (fieldOrUpdateData instanceof Compat) { - fieldOrUpdateData = (fieldOrUpdateData as Compat)._delegate; - } - - let parsed; - if ( - typeof fieldOrUpdateData === 'string' || - fieldOrUpdateData instanceof ExpFieldPath - ) { - parsed = parseUpdateVarargs( - this._dataReader, - 'DocumentReference.update', - this._key, - fieldOrUpdateData, - value, - moreFieldsAndValues - ); - } else { - parsed = parseUpdateData( - this._dataReader, - 'DocumentReference.update', - this._key, - fieldOrUpdateData - ); + try { + if (arguments.length === 1) { + return updateDoc(this._delegate, fieldOrUpdateData as PublicUpdateData); + } else { + return updateDoc( + this._delegate, + fieldOrUpdateData as string | ExpFieldPath, + value, + ...moreFieldsAndValues + ); + } + } catch (e) { + throw replaceFunctionName(e, 'updateDoc', 'DocumentReference.update'); } - - return firestoreClientWrite( - this._firestoreClient, - parsed.toMutations(this._key, Precondition.exists(true)) - ); } delete(): Promise { - return firestoreClientWrite(this._firestoreClient, [ - new DeleteMutation(this._key, Precondition.none()) - ]); + return deleteDoc(this._delegate); } onSnapshot(observer: PartialObserver>): Unsubscribe; @@ -892,102 +883,130 @@ export class DocumentReference ): Unsubscribe; onSnapshot(...args: unknown[]): Unsubscribe { - let options: ListenOptions = { - includeMetadataChanges: false - }; - let currArg = 0; - if ( - typeof args[currArg] === 'object' && - !isPartialObserver(args[currArg]) - ) { - options = args[currArg] as PublicSnapshotListenOptions; - currArg++; - } - - const internalOptions = { - includeMetadataChanges: options.includeMetadataChanges - }; - - if (isPartialObserver(args[currArg])) { - const userObserver = args[currArg] as PartialObserver< - PublicDocumentSnapshot - >; - args[currArg] = userObserver.next?.bind(userObserver); - args[currArg + 1] = userObserver.error?.bind(userObserver); - args[currArg + 2] = userObserver.complete?.bind(userObserver); - } - - const observer: PartialObserver = { - next: snapshot => { - if (args[currArg]) { - (args[currArg] as NextFn>)( - this._convertToDocSnapshot(snapshot) - ); - } - }, - error: args[currArg + 1] as ErrorFn, - complete: args[currArg + 2] as CompleteFn - }; - - return firestoreClientListen( - this._firestoreClient, - newQueryForPath(this._key.path), - internalOptions, - observer + const options = extractSnapshotOptions(args); + const observer = wrapObserver, ExpDocumentSnapshot>( + args, + result => + new DocumentSnapshot( + this.firestore, + result._key, + result._document, + result.metadata.fromCache, + result.metadata.hasPendingWrites, + this._delegate._converter as UntypedFirestoreDataConverter + ) ); + return onSnapshot(this._delegate, options, observer); } get(options?: PublicGetOptions): Promise> { - if (options && options.source === 'cache') { - return firestoreClientGetDocumentFromLocalCache( - this._firestoreClient, - this._key - ).then( - doc => - new DocumentSnapshot( - this.firestore, - this._key, - doc, - /*fromCache=*/ true, - doc instanceof Document ? doc.hasLocalMutations : false, - this._converter - ) - ); + let snap: Promise>; + if (options?.source === 'cache') { + snap = getDocFromCache(this._delegate); + } else if (options?.source === 'server') { + snap = getDocFromServer(this._delegate); } else { - return firestoreClientGetDocumentViaSnapshotListener( - this._firestoreClient, - this._key, - options - ).then(snapshot => this._convertToDocSnapshot(snapshot)); + snap = getDoc(this._delegate); } + + return snap.then( + result => + new DocumentSnapshot( + this.firestore, + result._key, + result._document, + result.metadata.fromCache, + result.metadata.hasPendingWrites, + this._delegate._converter as UntypedFirestoreDataConverter + ) + ); } withConverter( converter: PublicFirestoreDataConverter ): PublicDocumentReference { - return new DocumentReference(this._key, this.firestore, converter); + return new DocumentReference( + this.firestore, + this._delegate.withConverter( + converter as UntypedFirestoreDataConverter + ) + ); } +} - /** - * Converts a ViewSnapshot that contains the current document to a - * DocumentSnapshot. - */ - private _convertToDocSnapshot(snapshot: ViewSnapshot): DocumentSnapshot { - debugAssert( - snapshot.docs.size <= 1, - 'Too many documents returned on a document query' - ); - const doc = snapshot.docs.get(this._key); +/** + * Replaces the function name in an error thrown by the firestore-exp API + * with the function names used in the classic API. + */ +function replaceFunctionName( + e: Error, + originalFunctionName: string, + updatedFunctionName: string +): Error { + e.message = e.message.replace( + `${originalFunctionName}()`, + `${updatedFunctionName}()` + ); + return e; +} - return new DocumentSnapshot( - this.firestore, - this._key, - doc, - snapshot.fromCache, - snapshot.hasPendingWrites, - this._converter - ); +/** + * Iterates the list of arguments from an `onSnapshot` call and returns the + * first argument that may be an `SnapshotListenOptions` object. Returns an + * empty object if none is found. + */ +export function extractSnapshotOptions( + args: unknown[] +): PublicSnapshotListenOptions { + for (const arg of args) { + if (typeof arg === 'object' && !isPartialObserver(arg)) { + return arg as PublicSnapshotListenOptions; + } + } + return {}; +} + +/** + * Creates an observer that can be passed to the firestore-exp SDK. The + * observer converts all observed values into the format expected by the classic + * SDK. + * + * @param args The list of arguments from an `onSnapshot` call. + * @param wrapper The function that converts the firestore-exp type into the + * type used by this shim. + */ +export function wrapObserver( + args: unknown[], + wrapper: (val: ExpType) => CompatType +): PartialObserver { + let userObserver: PartialObserver; + if (isPartialObserver(args[0])) { + userObserver = args[0] as PartialObserver; + } else if (isPartialObserver(args[1])) { + userObserver = args[1]; + } else if (typeof args[0] === 'function') { + userObserver = { + next: args[0] as NextFn | undefined, + error: args[1] as ErrorFn | undefined, + complete: args[2] as CompleteFn | undefined + }; + } else { + userObserver = { + next: args[1] as NextFn | undefined, + error: args[2] as ErrorFn | undefined, + complete: args[3] as CompleteFn | undefined + }; } + + return { + next: val => { + if (userObserver!.next) { + userObserver!.next(wrapper(val)); + } + }, + error: userObserver.error?.bind(userObserver), + complete: userObserver.complete?.bind(userObserver) + }; } /** @@ -1046,7 +1065,7 @@ export class DocumentSnapshot public _document: Document | null, private _fromCache: boolean, private _hasPendingWrites: boolean, - private readonly _converter: PublicFirestoreDataConverter | null + private readonly _converter: UntypedFirestoreDataConverter | null ) {} data(options: PublicSnapshotOptions = {}): T | undefined { @@ -1070,7 +1089,11 @@ export class DocumentSnapshot this._firestore._databaseId, options.serverTimestamps || 'none', key => - new DocumentReference(key, this._firestore, /* converter= */ null), + DocumentReference.forKey( + key, + this._firestore, + /* converter= */ null + ), bytes => new Blob(bytes) ); return userDataWriter.convertValue(this._document.toProto()) as T; @@ -1092,7 +1115,8 @@ export class DocumentSnapshot const userDataWriter = new UserDataWriter( this._firestore._databaseId, options.serverTimestamps || 'none', - key => new DocumentReference(key, this._firestore, this._converter), + key => + DocumentReference.forKey(key, this._firestore, this._converter), bytes => new Blob(bytes) ); return userDataWriter.convertValue(value); @@ -1106,7 +1130,7 @@ export class DocumentSnapshot } get ref(): PublicDocumentReference { - return new DocumentReference( + return DocumentReference.forKey( this._key, this._firestore, this._converter @@ -1359,6 +1383,10 @@ function parseDocumentIdValue( query: InternalQuery, documentIdValue: unknown ): ProtoValue { + if (documentIdValue instanceof Compat) { + documentIdValue = documentIdValue._delegate; + } + if (typeof documentIdValue === 'string') { if (documentIdValue === '') { throw new FirestoreError( @@ -1385,7 +1413,7 @@ function parseDocumentIdValue( ); } return refValue(databaseId, new DocumentKey(path)); - } else if (documentIdValue instanceof _DocumentKeyReference) { + } else if (documentIdValue instanceof ExpDocumentReference) { return refValue(databaseId, documentIdValue._key); } else { throw new FirestoreError( @@ -1930,7 +1958,7 @@ export class CollectionReference constructor( readonly _path: ResourcePath, firestore: Firestore, - _converter: PublicFirestoreDataConverter | null + _converter: UntypedFirestoreDataConverter | null ) { super(newQueryForPath(_path), firestore, _converter); if (_path.length % 2 !== 1) { @@ -1952,8 +1980,8 @@ export class CollectionReference if (parentPath.isEmpty()) { return null; } else { - return new DocumentReference( - new DocumentKey(parentPath), + return DocumentReference.forPath( + parentPath, this.firestore, /* converter= */ null ); @@ -1986,8 +2014,8 @@ export class CollectionReference const docRef = this.doc(); // Call set() with the converted value directly to avoid calling toFirestore() a second time. - return new DocumentReference( - (docRef as DocumentReference)._key, + return DocumentReference.forKey( + (docRef as DocumentReference)._delegate._key, this.firestore, null ) @@ -2006,9 +2034,12 @@ function validateReference( methodName: string, documentRef: PublicDocumentReference, firestore: Firestore -): _DocumentKeyReference { - const reference = cast>(documentRef, DocumentReference); - if (reference.firestore !== firestore) { +): ExpDocumentReference { + const reference = cast>( + documentRef, + ExpDocumentReference + ); + if (reference.firestore !== firestore._delegate) { throw new FirestoreError( Code.INVALID_ARGUMENT, 'Provided document reference is from a different Firestore instance.' diff --git a/packages/firestore/src/api/observer.ts b/packages/firestore/src/api/observer.ts index 69264fd20f0..a724f1e96e1 100644 --- a/packages/firestore/src/api/observer.ts +++ b/packages/firestore/src/api/observer.ts @@ -36,7 +36,7 @@ export interface Unsubscribe { (): void; } -export function isPartialObserver(obj: unknown): boolean { +export function isPartialObserver(obj: unknown): obj is PartialObserver { return implementsAnyMethods(obj, ['next', 'error', 'complete']); } diff --git a/packages/firestore/src/api/user_data_reader.ts b/packages/firestore/src/api/user_data_reader.ts index bf63ab6cfa9..d799222c344 100644 --- a/packages/firestore/src/api/user_data_reader.ts +++ b/packages/firestore/src/api/user_data_reader.ts @@ -56,13 +56,14 @@ import { newSerializer } from '../platform/serializer'; import { Bytes } from '../../lite/src/api/bytes'; import { Compat } from '../compat/compat'; import { FieldValue } from '../../lite/src/api/field_value'; +import { DocumentReference } from '../../lite/src/api/reference'; import { FieldPath } from '../../lite/src/api/field_path'; const RESERVED_FIELD_REGEX = /^__.*__$/; /** * An untyped Firestore Data Converter interface that is shared between the - * lite, full and legacy SDK. + * lite, firestore-exp and classic SDK. */ export interface UntypedFirestoreDataConverter { toFirestore(modelObject: T): DocumentData; @@ -70,22 +71,6 @@ export interface UntypedFirestoreDataConverter { fromFirestore(snapshot: unknown, options?: unknown): T; } -/** - * A reference to a document in a Firebase project. - * - * This class serves as a common base class for the public DocumentReferences - * exposed in the lite, full and legacy SDK. - */ -// Use underscore prefix to hide this class from our Public API. -// eslint-disable-next-line @typescript-eslint/naming-convention -export class _DocumentKeyReference { - constructor( - readonly _databaseId: DatabaseId, - readonly _key: DocumentKey, - readonly _converter: UntypedFirestoreDataConverter | null - ) {} -} - /** The result of parsing document data (e.g. for a setData call). */ export class ParsedSetData { constructor( @@ -692,6 +677,10 @@ function parseScalarValue( value: unknown, context: ParseContext ): ProtoValue | null { + if (value instanceof Compat) { + value = value._delegate; + } + if (value === null) { return { nullValue: 'NULL_VALUE' }; } else if (typeof value === 'number') { @@ -725,9 +714,9 @@ function parseScalarValue( }; } else if (value instanceof Bytes) { return { bytesValue: toBytes(context.serializer, value._byteString) }; - } else if (value instanceof _DocumentKeyReference) { + } else if (value instanceof DocumentReference) { const thisDb = context.databaseId; - const otherDb = value._databaseId; + const otherDb = value.firestore._databaseId; if (!otherDb.isEqual(thisDb)) { throw context.createError( 'Document reference is for database ' + @@ -737,7 +726,7 @@ function parseScalarValue( } return { referenceValue: toResourceName( - value._databaseId || context.databaseId, + value.firestore._databaseId || context.databaseId, value._key.path ) }; @@ -766,7 +755,7 @@ function looksLikeJsonObject(input: unknown): boolean { !(input instanceof Timestamp) && !(input instanceof GeoPoint) && !(input instanceof Bytes) && - !(input instanceof _DocumentKeyReference) && + !(input instanceof DocumentReference) && !(input instanceof FieldValue) ); } diff --git a/packages/firestore/src/api/user_data_writer.ts b/packages/firestore/src/api/user_data_writer.ts index 84888fe6fd2..183bcf8baea 100644 --- a/packages/firestore/src/api/user_data_writer.ts +++ b/packages/firestore/src/api/user_data_writer.ts @@ -24,7 +24,6 @@ import { Timestamp as ProtoTimestamp, Value as ProtoValue } from '../protos/firestore_proto_api'; -import { _DocumentKeyReference } from './user_data_reader'; import { GeoPoint } from './geo_point'; import { Timestamp } from './timestamp'; import { DatabaseId } from '../core/database_info'; @@ -58,9 +57,7 @@ export class UserDataWriter { constructor( private readonly databaseId: DatabaseId, private readonly serverTimestampBehavior: ServerTimestampBehavior, - private readonly referenceFactory: ( - key: DocumentKey - ) => _DocumentKeyReference, + private readonly referenceFactory: (key: DocumentKey) => unknown, private readonly bytesFactory: (bytes: ByteString) => Bytes ) {} @@ -132,7 +129,7 @@ export class UserDataWriter { return new Timestamp(normalizedValue.seconds, normalizedValue.nanos); } - private convertReference(name: string): _DocumentKeyReference { + private convertReference(name: string): unknown { const resourcePath = ResourcePath.fromString(name); hardAssert( isValidResourceName(resourcePath), diff --git a/packages/firestore/src/util/input_validation.ts b/packages/firestore/src/util/input_validation.ts index 4d3402904d9..443fd411d93 100644 --- a/packages/firestore/src/util/input_validation.ts +++ b/packages/firestore/src/util/input_validation.ts @@ -20,6 +20,7 @@ import { fail } from './assert'; import { Code, FirestoreError } from './error'; import { DocumentKey } from '../model/document_key'; import { ResourcePath } from '../model/path'; +import { Compat } from '../compat/compat'; /** Types accepted by validateType() and related methods for validation. */ export type ValidationType = @@ -175,6 +176,10 @@ export function cast( // eslint-disable-next-line @typescript-eslint/no-explicit-any constructor: { new (...args: any[]): T } ): T | never { + if (obj instanceof Compat) { + obj = obj._delegate; + } + if (!(obj instanceof constructor)) { if (constructor.name === obj.constructor.name) { throw new FirestoreError( diff --git a/packages/firestore/test/util/api_helpers.ts b/packages/firestore/test/util/api_helpers.ts index b55113849a7..48cf0488aa8 100644 --- a/packages/firestore/test/util/api_helpers.ts +++ b/packages/firestore/test/util/api_helpers.ts @@ -73,7 +73,7 @@ export function collectionReference(path: string): CollectionReference { export function documentReference(path: string): DocumentReference { const db = firestore(); ensureFirestoreConfigured(db._delegate); - return new DocumentReference(key(path), db, /* converter= */ null); + return DocumentReference.forKey(key(path), db, /* converter= */ null); } export function documentSnapshot( diff --git a/packages/firestore/test/util/helpers.ts b/packages/firestore/test/util/helpers.ts index 855fe5afb76..3f294ef9eee 100644 --- a/packages/firestore/test/util/helpers.ts +++ b/packages/firestore/test/util/helpers.ts @@ -111,7 +111,7 @@ export function testUserDataWriter(): UserDataWriter { return new UserDataWriter( TEST_DATABASE_ID, 'none', - key => new DocumentReference(key, FIRESTORE, /* converter= */ null), + key => DocumentReference.forKey(key, FIRESTORE, /* converter= */ null), bytes => new Blob(bytes) ); } @@ -133,8 +133,8 @@ export function version(v: TestSnapshotVersion): SnapshotVersion { } export function ref(key: string, offset?: number): DocumentReference { - return new DocumentReference( - new DocumentKey(path(key, offset)), + return DocumentReference.forPath( + path(key, offset), FIRESTORE, /* converter= */ null ); From f676f67905335053e70aa32c2da098ad41878ccb Mon Sep 17 00:00:00 2001 From: Feiyang Date: Tue, 10 Nov 2020 11:28:55 -0800 Subject: [PATCH 074/624] use firebaes-exp version (#4027) --- packages-exp/app-exp/src/api.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages-exp/app-exp/src/api.ts b/packages-exp/app-exp/src/api.ts index 77589ae5560..064babe8c4e 100644 --- a/packages-exp/app-exp/src/api.ts +++ b/packages-exp/app-exp/src/api.ts @@ -29,7 +29,7 @@ import { Name, ComponentType } from '@firebase/component'; -import { version } from '../../../packages/firebase/package.json'; +import { version } from '../../firebase-exp/package.json'; import { FirebaseAppImpl } from './firebaseApp'; import { _apps, _components, _registerComponent } from './internal'; import { logger } from './logger'; From 82ef45bfc685ff3118ad88c581f88b027ce16f09 Mon Sep 17 00:00:00 2001 From: Feiyang Date: Tue, 10 Nov 2020 14:27:03 -0800 Subject: [PATCH 075/624] Add documentation for Remote config exp (#4026) * add documentation to rc exp * generate reference docs for remote config exp --- common/api-review/remote-config-exp.api.md | 20 ++-- .../api-review/remote-config-types-exp.api.md | 48 ++++++++ docs-exp/auth.autherrorcode.md | 112 ------------------ docs-exp/auth.md | 6 - docs-exp/auth.reauthenticatewithcredential.md | 2 +- docs-exp/index.md | 2 + docs-exp/remote-config-types.fetchstatus.md | 15 +++ docs-exp/remote-config-types.loglevel.md | 13 ++ docs-exp/remote-config-types.md | 22 ++++ ...config-types.remoteconfig.defaultconfig.md | 13 ++ ...nfig-types.remoteconfig.fetchtimemillis.md | 13 ++ ...nfig-types.remoteconfig.lastfetchstatus.md | 13 ++ docs-exp/remote-config-types.remoteconfig.md | 23 ++++ ...mote-config-types.remoteconfig.settings.md | 13 ++ ...onfig-types.settings.fetchtimeoutmillis.md | 13 ++ docs-exp/remote-config-types.settings.md | 21 ++++ ...pes.settings.minimumfetchintervalmillis.md | 13 ++ .../remote-config-types.value.asboolean.md | 19 +++ .../remote-config-types.value.asnumber.md | 17 +++ .../remote-config-types.value.asstring.md | 17 +++ .../remote-config-types.value.getsource.md | 17 +++ docs-exp/remote-config-types.value.md | 23 ++++ docs-exp/remote-config-types.valuesource.md | 15 +++ docs-exp/remote-config.activate.md | 26 ++++ docs-exp/remote-config.ensureinitialized.md | 26 ++++ docs-exp/remote-config.fetchandactivate.md | 26 ++++ docs-exp/remote-config.fetchconfig.md | 24 ++++ docs-exp/remote-config.getall.md | 26 ++++ docs-exp/remote-config.getboolean.md | 29 +++++ docs-exp/remote-config.getnumber.md | 29 +++++ docs-exp/remote-config.getremoteconfig.md | 24 ++++ docs-exp/remote-config.getstring.md | 27 +++++ docs-exp/remote-config.getvalue.md | 27 +++++ docs-exp/remote-config.md | 22 ++++ docs-exp/remote-config.setloglevel.md | 25 ++++ packages-exp/remote-config-exp/src/api.ts | 87 ++++++++++++++ packages-exp/remote-config-exp/src/api2.ts | 11 ++ .../remote-config-types-exp/index.d.ts | 15 +++ 38 files changed, 765 insertions(+), 129 deletions(-) create mode 100644 common/api-review/remote-config-types-exp.api.md delete mode 100644 docs-exp/auth.autherrorcode.md create mode 100644 docs-exp/remote-config-types.fetchstatus.md create mode 100644 docs-exp/remote-config-types.loglevel.md create mode 100644 docs-exp/remote-config-types.md create mode 100644 docs-exp/remote-config-types.remoteconfig.defaultconfig.md create mode 100644 docs-exp/remote-config-types.remoteconfig.fetchtimemillis.md create mode 100644 docs-exp/remote-config-types.remoteconfig.lastfetchstatus.md create mode 100644 docs-exp/remote-config-types.remoteconfig.md create mode 100644 docs-exp/remote-config-types.remoteconfig.settings.md create mode 100644 docs-exp/remote-config-types.settings.fetchtimeoutmillis.md create mode 100644 docs-exp/remote-config-types.settings.md create mode 100644 docs-exp/remote-config-types.settings.minimumfetchintervalmillis.md create mode 100644 docs-exp/remote-config-types.value.asboolean.md create mode 100644 docs-exp/remote-config-types.value.asnumber.md create mode 100644 docs-exp/remote-config-types.value.asstring.md create mode 100644 docs-exp/remote-config-types.value.getsource.md create mode 100644 docs-exp/remote-config-types.value.md create mode 100644 docs-exp/remote-config-types.valuesource.md create mode 100644 docs-exp/remote-config.activate.md create mode 100644 docs-exp/remote-config.ensureinitialized.md create mode 100644 docs-exp/remote-config.fetchandactivate.md create mode 100644 docs-exp/remote-config.fetchconfig.md create mode 100644 docs-exp/remote-config.getall.md create mode 100644 docs-exp/remote-config.getboolean.md create mode 100644 docs-exp/remote-config.getnumber.md create mode 100644 docs-exp/remote-config.getremoteconfig.md create mode 100644 docs-exp/remote-config.getstring.md create mode 100644 docs-exp/remote-config.getvalue.md create mode 100644 docs-exp/remote-config.md create mode 100644 docs-exp/remote-config.setloglevel.md diff --git a/common/api-review/remote-config-exp.api.md b/common/api-review/remote-config-exp.api.md index a51619116ca..870c1003724 100644 --- a/common/api-review/remote-config-exp.api.md +++ b/common/api-review/remote-config-exp.api.md @@ -9,37 +9,37 @@ import { LogLevel } from '@firebase/remote-config-types-exp'; import { RemoteConfig } from '@firebase/remote-config-types-exp'; import { Value } from '@firebase/remote-config-types-exp'; -// @public (undocumented) +// @public export function activate(remoteConfig: RemoteConfig): Promise; -// @public (undocumented) +// @public export function ensureInitialized(remoteConfig: RemoteConfig): Promise; -// @public (undocumented) +// @public export function fetchAndActivate(remoteConfig: RemoteConfig): Promise; -// @public (undocumented) +// @public export function fetchConfig(remoteConfig: RemoteConfig): Promise; -// @public (undocumented) +// @public export function getAll(remoteConfig: RemoteConfig): Record; -// @public (undocumented) +// @public export function getBoolean(remoteConfig: RemoteConfig, key: string): boolean; -// @public (undocumented) +// @public export function getNumber(remoteConfig: RemoteConfig, key: string): number; // @public (undocumented) export function getRemoteConfig(app: FirebaseApp): RemoteConfig; -// @public (undocumented) +// @public export function getString(remoteConfig: RemoteConfig, key: string): string; -// @public (undocumented) +// @public export function getValue(remoteConfig: RemoteConfig, key: string): Value; -// @public (undocumented) +// @public export function setLogLevel(remoteConfig: RemoteConfig, logLevel: LogLevel): void; diff --git a/common/api-review/remote-config-types-exp.api.md b/common/api-review/remote-config-types-exp.api.md new file mode 100644 index 00000000000..0b388ecbf15 --- /dev/null +++ b/common/api-review/remote-config-types-exp.api.md @@ -0,0 +1,48 @@ +## API Report File for "@firebase/remote-config-types-exp" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +// @public +export type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle'; + +// @public +export type LogLevel = 'debug' | 'error' | 'silent'; + +// @public +export interface RemoteConfig { + defaultConfig: { [key: string]: string | number | boolean }; + + fetchTimeMillis: number; + + lastFetchStatus: FetchStatus; + + settings: Settings; +} + +// @public +export interface Settings { + fetchTimeoutMillis: number; + + minimumFetchIntervalMillis: number; +} + +// @public +export interface Value { + asBoolean(): boolean; + + asNumber(): number; + + asString(): string; + + getSource(): ValueSource; +} + +// @public +export type ValueSource = 'static' | 'default' | 'remote'; + + +// (No @packageDocumentation comment for this package) + +``` diff --git a/docs-exp/auth.autherrorcode.md b/docs-exp/auth.autherrorcode.md deleted file mode 100644 index 450c821170f..00000000000 --- a/docs-exp/auth.autherrorcode.md +++ /dev/null @@ -1,112 +0,0 @@ - - -[Home](./index.md) > [@firebase/auth](./auth.md) > [AuthErrorCode](./auth.autherrorcode.md) - -## AuthErrorCode enum - -Enumeration of Firebase Auth error codes. - -Signature: - -```typescript -export declare const enum AuthErrorCode -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| ADMIN\_ONLY\_OPERATION | "admin-restricted-operation" | | -| APP\_NOT\_AUTHORIZED | "app-not-authorized" | | -| APP\_NOT\_INSTALLED | "app-not-installed" | | -| ARGUMENT\_ERROR | "argument-error" | | -| CAPTCHA\_CHECK\_FAILED | "captcha-check-failed" | | -| CODE\_EXPIRED | "codeired" | | -| CORDOVA\_NOT\_READY | "cordova-not-ready" | | -| CORS\_UNSUPPORTED | "cors-unsupported" | | -| CREDENTIAL\_ALREADY\_IN\_USE | "credential-already-in-use" | | -| CREDENTIAL\_MISMATCH | "custom-token-mismatch" | | -| CREDENTIAL\_TOO\_OLD\_LOGIN\_AGAIN | "requires-recent-login" | | -| DYNAMIC\_LINK\_NOT\_ACTIVATED | "dynamic-link-not-activated" | | -| EMAIL\_CHANGE\_NEEDS\_VERIFICATION | "email-change-needs-verification" | | -| EMAIL\_EXISTS | "email-already-in-use" | | -| EMULATOR\_CONFIG\_FAILED | "emulator-config-failed" | | -| EXPIRED\_OOB\_CODE | "expired-action-code" | | -| EXPIRED\_POPUP\_REQUEST | "cancelled-popup-request" | | -| INTERNAL\_ERROR | "internal-error" | | -| INVALID\_API\_KEY | "invalid-api-key" | | -| INVALID\_APP\_CREDENTIAL | "invalid-app-credential" | | -| INVALID\_APP\_ID | "invalid-app-id" | | -| INVALID\_AUTH | "invalid-user-token" | | -| INVALID\_AUTH\_EVENT | "invalid-auth-event" | | -| INVALID\_CERT\_HASH | "invalid-cert-hash" | | -| INVALID\_CODE | "invalid-verification-code" | | -| INVALID\_CONTINUE\_URI | "invalid-continue-uri" | | -| INVALID\_CORDOVA\_CONFIGURATION | "invalid-cordova-configuration" | | -| INVALID\_CUSTOM\_TOKEN | "invalid-custom-token" | | -| INVALID\_DYNAMIC\_LINK\_DOMAIN | "invalid-dynamic-link-domain" | | -| INVALID\_EMAIL | "invalid-email" | | -| INVALID\_EMULATOR\_SCHEME | "invalid-emulator-scheme" | | -| INVALID\_IDP\_RESPONSE | "invalid-credential" | | -| INVALID\_MESSAGE\_PAYLOAD | "invalid-message-payload" | | -| INVALID\_MFA\_SESSION | "invalid-multi-factor-session" | | -| INVALID\_OAUTH\_CLIENT\_ID | "invalid-oauth-client-id" | | -| INVALID\_OAUTH\_PROVIDER | "invalid-oauth-provider" | | -| INVALID\_OOB\_CODE | "invalid-action-code" | | -| INVALID\_ORIGIN | "unauthorized-domain" | | -| INVALID\_PASSWORD | "wrong-password" | | -| INVALID\_PERSISTENCE | "invalid-persistence-type" | | -| INVALID\_PHONE\_NUMBER | "invalid-phone-number" | | -| INVALID\_PROVIDER\_ID | "invalid-provider-id" | | -| INVALID\_RECIPIENT\_EMAIL | "invalid-recipient-email" | | -| INVALID\_SENDER | "invalid-sender" | | -| INVALID\_SESSION\_INFO | "invalid-verification-id" | | -| INVALID\_TENANT\_ID | "invalid-tenant-id" | | -| MFA\_INFO\_NOT\_FOUND | "multi-factor-info-not-found" | | -| MFA\_REQUIRED | "multi-factor-auth-required" | | -| MISSING\_ANDROID\_PACKAGE\_NAME | "missing-android-pkg-name" | | -| MISSING\_APP\_CREDENTIAL | "missing-app-credential" | | -| MISSING\_AUTH\_DOMAIN | "auth-domain-config-required" | | -| MISSING\_CODE | "missing-verification-code" | | -| MISSING\_CONTINUE\_URI | "missing-continue-uri" | | -| MISSING\_IFRAME\_START | "missing-iframe-start" | | -| MISSING\_IOS\_BUNDLE\_ID | "missing-ios-bundle-id" | | -| MISSING\_MFA\_INFO | "missing-multi-factor-info" | | -| MISSING\_MFA\_SESSION | "missing-multi-factor-session" | | -| MISSING\_OR\_INVALID\_NONCE | "missing-or-invalid-nonce" | | -| MISSING\_PHONE\_NUMBER | "missing-phone-number" | | -| MISSING\_SESSION\_INFO | "missing-verification-id" | | -| MODULE\_DESTROYED | "app-deleted" | | -| NEED\_CONFIRMATION | "account-exists-with-different-credential" | | -| NETWORK\_REQUEST\_FAILED | "network-request-failed" | | -| NO\_AUTH\_EVENT | "no-auth-event" | | -| NO\_SUCH\_PROVIDER | "no-such-provider" | | -| NULL\_USER | "null-user" | | -| OPERATION\_NOT\_ALLOWED | "operation-not-allowed" | | -| OPERATION\_NOT\_SUPPORTED | "operation-not-supported-in-this-environment" | | -| POPUP\_BLOCKED | "popup-blocked" | | -| POPUP\_CLOSED\_BY\_USER | "popup-closed-by-user" | | -| PROVIDER\_ALREADY\_LINKED | "provider-already-linked" | | -| QUOTA\_EXCEEDED | "quota-exceeded" | | -| REDIRECT\_CANCELLED\_BY\_USER | "redirect-cancelled-by-user" | | -| REDIRECT\_OPERATION\_PENDING | "redirect-operation-pending" | | -| REJECTED\_CREDENTIAL | "rejected-credential" | | -| SECOND\_FACTOR\_ALREADY\_ENROLLED | "second-factor-already-in-use" | | -| SECOND\_FACTOR\_LIMIT\_EXCEEDED | "maximum-second-factor-count-exceeded" | | -| TENANT\_ID\_MISMATCH | "tenant-id-mismatch" | | -| TIMEOUT | "timeout" | | -| TOKEN\_EXPIRED | "user-tokenired" | | -| TOO\_MANY\_ATTEMPTS\_TRY\_LATER | "too-many-requests" | | -| UNAUTHORIZED\_DOMAIN | "unauthorized-continue-uri" | | -| UNSUPPORTED\_FIRST\_FACTOR | "unsupported-first-factor" | | -| UNSUPPORTED\_PERSISTENCE | "unsupported-persistence-type" | | -| UNSUPPORTED\_TENANT\_OPERATION | "unsupported-tenant-operation" | | -| UNVERIFIED\_EMAIL | "unverified-email" | | -| USER\_CANCELLED | "user-cancelled" | | -| USER\_DELETED | "user-not-found" | | -| USER\_DISABLED | "user-disabled" | | -| USER\_MISMATCH | "user-mismatch" | | -| USER\_SIGNED\_OUT | "user-signed-out" | | -| WEAK\_PASSWORD | "weak-password" | | -| WEB\_STORAGE\_UNSUPPORTED | "web-storage-unsupported" | | - diff --git a/docs-exp/auth.md b/docs-exp/auth.md index 12f1d9bc52b..99db5d961c5 100644 --- a/docs-exp/auth.md +++ b/docs-exp/auth.md @@ -23,12 +23,6 @@ | [RecaptchaVerifier](./auth.recaptchaverifier.md) | An [reCAPTCHA](https://www.google.com/recaptcha/)-based application verifier. | | [TwitterAuthProvider](./auth.twitterauthprovider.md) | Provider for generating an [OAuthCredential](./auth.oauthcredential.md) for [ProviderId.TWITTER](./auth-types.providerid.twitter.md). | -## Enumerations - -| Enumeration | Description | -| --- | --- | -| [AuthErrorCode](./auth.autherrorcode.md) | Enumeration of Firebase Auth error codes. | - ## Functions | Function | Description | diff --git a/docs-exp/auth.reauthenticatewithcredential.md b/docs-exp/auth.reauthenticatewithcredential.md index 6de1ca307ae..be263242af2 100644 --- a/docs-exp/auth.reauthenticatewithcredential.md +++ b/docs-exp/auth.reauthenticatewithcredential.md @@ -25,5 +25,5 @@ Promise<externs.[UserCredential](./auth-types.usercredential.md)> ## Remarks -Use before operations such as [updatePassword()](./auth.updatepassword.md) that require tokens from recent sign-in attempts. This method can be used to recover from a [AuthErrorCode.CREDENTIAL\_TOO\_OLD\_LOGIN\_AGAIN](./auth.autherrorcode.credential_too_old_login_again.md) error. +Use before operations such as [updatePassword()](./auth.updatepassword.md) that require tokens from recent sign-in attempts. This method can be used to recover from a error. diff --git a/docs-exp/index.md b/docs-exp/index.md index 10679e82cf2..d74b7a1c149 100644 --- a/docs-exp/index.md +++ b/docs-exp/index.md @@ -19,4 +19,6 @@ | [@firebase/installations-types](./installations-types.md) | | | [@firebase/performance](./performance.md) | | | [@firebase/performance-types](./performance-types.md) | | +| [@firebase/remote-config](./remote-config.md) | | +| [@firebase/remote-config-types](./remote-config-types.md) | | diff --git a/docs-exp/remote-config-types.fetchstatus.md b/docs-exp/remote-config-types.fetchstatus.md new file mode 100644 index 00000000000..6ed61d1b661 --- /dev/null +++ b/docs-exp/remote-config-types.fetchstatus.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [FetchStatus](./remote-config-types.fetchstatus.md) + +## FetchStatus type + +Summarizes the outcome of the last attempt to fetch config from the Firebase Remote Config server. + +
  • "no-fetch-yet" indicates the [RemoteConfig](./remote-config-types.remoteconfig.md) instance has not yet attempted to fetch config, or that SDK initialization is incomplete.
  • "success" indicates the last attempt succeeded.
  • "failure" indicates the last attempt failed.
  • "throttle" indicates the last attempt was rate-limited.
+ +Signature: + +```typescript +export type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle'; +``` diff --git a/docs-exp/remote-config-types.loglevel.md b/docs-exp/remote-config-types.loglevel.md new file mode 100644 index 00000000000..60cec26a76a --- /dev/null +++ b/docs-exp/remote-config-types.loglevel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [LogLevel](./remote-config-types.loglevel.md) + +## LogLevel type + +Defines levels of Remote Config logging. + +Signature: + +```typescript +export type LogLevel = 'debug' | 'error' | 'silent'; +``` diff --git a/docs-exp/remote-config-types.md b/docs-exp/remote-config-types.md new file mode 100644 index 00000000000..5ebb2cd3480 --- /dev/null +++ b/docs-exp/remote-config-types.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) + +## remote-config-types package + +## Interfaces + +| Interface | Description | +| --- | --- | +| [RemoteConfig](./remote-config-types.remoteconfig.md) | The Firebase Remote Config service interface. | +| [Settings](./remote-config-types.settings.md) | Defines configuration options for the Remote Config SDK. | +| [Value](./remote-config-types.value.md) | Wraps a value with metadata and type-safe getters. | + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [FetchStatus](./remote-config-types.fetchstatus.md) | Summarizes the outcome of the last attempt to fetch config from the Firebase Remote Config server.
  • "no-fetch-yet" indicates the [RemoteConfig](./remote-config-types.remoteconfig.md) instance has not yet attempted to fetch config, or that SDK initialization is incomplete.
  • "success" indicates the last attempt succeeded.
  • "failure" indicates the last attempt failed.
  • "throttle" indicates the last attempt was rate-limited.
| +| [LogLevel](./remote-config-types.loglevel.md) | Defines levels of Remote Config logging. | +| [ValueSource](./remote-config-types.valuesource.md) | Indicates the source of a value.
  • "static" indicates the value was defined by a static constant.
  • "default" indicates the value was defined by default config.
  • "remote" indicates the value was defined by fetched config.
| + diff --git a/docs-exp/remote-config-types.remoteconfig.defaultconfig.md b/docs-exp/remote-config-types.remoteconfig.defaultconfig.md new file mode 100644 index 00000000000..3d4beb37995 --- /dev/null +++ b/docs-exp/remote-config-types.remoteconfig.defaultconfig.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [RemoteConfig](./remote-config-types.remoteconfig.md) > [defaultConfig](./remote-config-types.remoteconfig.defaultconfig.md) + +## RemoteConfig.defaultConfig property + +Object containing default values for conigs. + +Signature: + +```typescript +defaultConfig: { [key: string]: string | number | boolean }; +``` diff --git a/docs-exp/remote-config-types.remoteconfig.fetchtimemillis.md b/docs-exp/remote-config-types.remoteconfig.fetchtimemillis.md new file mode 100644 index 00000000000..c1290ee7142 --- /dev/null +++ b/docs-exp/remote-config-types.remoteconfig.fetchtimemillis.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [RemoteConfig](./remote-config-types.remoteconfig.md) > [fetchTimeMillis](./remote-config-types.remoteconfig.fetchtimemillis.md) + +## RemoteConfig.fetchTimeMillis property + +The Unix timestamp in milliseconds of the last successful fetch, or negative one if the [RemoteConfig](./remote-config-types.remoteconfig.md) instance either hasn't fetched or initialization is incomplete. + +Signature: + +```typescript +fetchTimeMillis: number; +``` diff --git a/docs-exp/remote-config-types.remoteconfig.lastfetchstatus.md b/docs-exp/remote-config-types.remoteconfig.lastfetchstatus.md new file mode 100644 index 00000000000..6a2e7e48087 --- /dev/null +++ b/docs-exp/remote-config-types.remoteconfig.lastfetchstatus.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [RemoteConfig](./remote-config-types.remoteconfig.md) > [lastFetchStatus](./remote-config-types.remoteconfig.lastfetchstatus.md) + +## RemoteConfig.lastFetchStatus property + +The status of the last fetch attempt. + +Signature: + +```typescript +lastFetchStatus: FetchStatus; +``` diff --git a/docs-exp/remote-config-types.remoteconfig.md b/docs-exp/remote-config-types.remoteconfig.md new file mode 100644 index 00000000000..e73d6446dfb --- /dev/null +++ b/docs-exp/remote-config-types.remoteconfig.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [RemoteConfig](./remote-config-types.remoteconfig.md) + +## RemoteConfig interface + +The Firebase Remote Config service interface. + +Signature: + +```typescript +export interface RemoteConfig +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [defaultConfig](./remote-config-types.remoteconfig.defaultconfig.md) | { \[key: string\]: string \| number \| boolean } | Object containing default values for conigs. | +| [fetchTimeMillis](./remote-config-types.remoteconfig.fetchtimemillis.md) | number | The Unix timestamp in milliseconds of the last successful fetch, or negative one if the [RemoteConfig](./remote-config-types.remoteconfig.md) instance either hasn't fetched or initialization is incomplete. | +| [lastFetchStatus](./remote-config-types.remoteconfig.lastfetchstatus.md) | [FetchStatus](./remote-config-types.fetchstatus.md) | The status of the last fetch attempt. | +| [settings](./remote-config-types.remoteconfig.settings.md) | [Settings](./remote-config-types.settings.md) | Defines configuration for the Remote Config SDK. | + diff --git a/docs-exp/remote-config-types.remoteconfig.settings.md b/docs-exp/remote-config-types.remoteconfig.settings.md new file mode 100644 index 00000000000..b16b127dd47 --- /dev/null +++ b/docs-exp/remote-config-types.remoteconfig.settings.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [RemoteConfig](./remote-config-types.remoteconfig.md) > [settings](./remote-config-types.remoteconfig.settings.md) + +## RemoteConfig.settings property + +Defines configuration for the Remote Config SDK. + +Signature: + +```typescript +settings: Settings; +``` diff --git a/docs-exp/remote-config-types.settings.fetchtimeoutmillis.md b/docs-exp/remote-config-types.settings.fetchtimeoutmillis.md new file mode 100644 index 00000000000..d504bfd9ca2 --- /dev/null +++ b/docs-exp/remote-config-types.settings.fetchtimeoutmillis.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [Settings](./remote-config-types.settings.md) > [fetchTimeoutMillis](./remote-config-types.settings.fetchtimeoutmillis.md) + +## Settings.fetchTimeoutMillis property + +Defines the maximum amount of milliseconds to wait for a response when fetching configuration from the Remote Config server. Defaults to 60000 (One minute). + +Signature: + +```typescript +fetchTimeoutMillis: number; +``` diff --git a/docs-exp/remote-config-types.settings.md b/docs-exp/remote-config-types.settings.md new file mode 100644 index 00000000000..d75b0587519 --- /dev/null +++ b/docs-exp/remote-config-types.settings.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [Settings](./remote-config-types.settings.md) + +## Settings interface + +Defines configuration options for the Remote Config SDK. + +Signature: + +```typescript +export interface Settings +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fetchTimeoutMillis](./remote-config-types.settings.fetchtimeoutmillis.md) | number | Defines the maximum amount of milliseconds to wait for a response when fetching configuration from the Remote Config server. Defaults to 60000 (One minute). | +| [minimumFetchIntervalMillis](./remote-config-types.settings.minimumfetchintervalmillis.md) | number | Defines the maximum age in milliseconds of an entry in the config cache before it is considered stale. Defaults to 43200000 (Twelve hours). | + diff --git a/docs-exp/remote-config-types.settings.minimumfetchintervalmillis.md b/docs-exp/remote-config-types.settings.minimumfetchintervalmillis.md new file mode 100644 index 00000000000..8036e67e19c --- /dev/null +++ b/docs-exp/remote-config-types.settings.minimumfetchintervalmillis.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [Settings](./remote-config-types.settings.md) > [minimumFetchIntervalMillis](./remote-config-types.settings.minimumfetchintervalmillis.md) + +## Settings.minimumFetchIntervalMillis property + +Defines the maximum age in milliseconds of an entry in the config cache before it is considered stale. Defaults to 43200000 (Twelve hours). + +Signature: + +```typescript +minimumFetchIntervalMillis: number; +``` diff --git a/docs-exp/remote-config-types.value.asboolean.md b/docs-exp/remote-config-types.value.asboolean.md new file mode 100644 index 00000000000..9018551584f --- /dev/null +++ b/docs-exp/remote-config-types.value.asboolean.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [Value](./remote-config-types.value.md) > [asBoolean](./remote-config-types.value.asboolean.md) + +## Value.asBoolean() method + +Gets the value as a boolean. + +The following values (case insensitive) are interpreted as true: "1", "true", "t", "yes", "y", "on". Other values are interpreted as false. + +Signature: + +```typescript +asBoolean(): boolean; +``` +Returns: + +boolean + diff --git a/docs-exp/remote-config-types.value.asnumber.md b/docs-exp/remote-config-types.value.asnumber.md new file mode 100644 index 00000000000..6d79f1b9235 --- /dev/null +++ b/docs-exp/remote-config-types.value.asnumber.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [Value](./remote-config-types.value.md) > [asNumber](./remote-config-types.value.asnumber.md) + +## Value.asNumber() method + +Gets the value as a number. Comparable to calling Number(value) \|\| 0. + +Signature: + +```typescript +asNumber(): number; +``` +Returns: + +number + diff --git a/docs-exp/remote-config-types.value.asstring.md b/docs-exp/remote-config-types.value.asstring.md new file mode 100644 index 00000000000..2d4a68670cc --- /dev/null +++ b/docs-exp/remote-config-types.value.asstring.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [Value](./remote-config-types.value.md) > [asString](./remote-config-types.value.asstring.md) + +## Value.asString() method + +Gets the value as a string. + +Signature: + +```typescript +asString(): string; +``` +Returns: + +string + diff --git a/docs-exp/remote-config-types.value.getsource.md b/docs-exp/remote-config-types.value.getsource.md new file mode 100644 index 00000000000..29009c0c723 --- /dev/null +++ b/docs-exp/remote-config-types.value.getsource.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [Value](./remote-config-types.value.md) > [getSource](./remote-config-types.value.getsource.md) + +## Value.getSource() method + +Gets the [ValueSource](./remote-config-types.valuesource.md) for the given key. + +Signature: + +```typescript +getSource(): ValueSource; +``` +Returns: + +[ValueSource](./remote-config-types.valuesource.md) + diff --git a/docs-exp/remote-config-types.value.md b/docs-exp/remote-config-types.value.md new file mode 100644 index 00000000000..da56fac4c97 --- /dev/null +++ b/docs-exp/remote-config-types.value.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [Value](./remote-config-types.value.md) + +## Value interface + +Wraps a value with metadata and type-safe getters. + +Signature: + +```typescript +export interface Value +``` + +## Methods + +| Method | Description | +| --- | --- | +| [asBoolean()](./remote-config-types.value.asboolean.md) | Gets the value as a boolean.The following values (case insensitive) are interpreted as true: "1", "true", "t", "yes", "y", "on". Other values are interpreted as false. | +| [asNumber()](./remote-config-types.value.asnumber.md) | Gets the value as a number. Comparable to calling Number(value) \|\| 0. | +| [asString()](./remote-config-types.value.asstring.md) | Gets the value as a string. | +| [getSource()](./remote-config-types.value.getsource.md) | Gets the [ValueSource](./remote-config-types.valuesource.md) for the given key. | + diff --git a/docs-exp/remote-config-types.valuesource.md b/docs-exp/remote-config-types.valuesource.md new file mode 100644 index 00000000000..7ea1942be7d --- /dev/null +++ b/docs-exp/remote-config-types.valuesource.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@firebase/remote-config-types](./remote-config-types.md) > [ValueSource](./remote-config-types.valuesource.md) + +## ValueSource type + +Indicates the source of a value. + +
  • "static" indicates the value was defined by a static constant.
  • "default" indicates the value was defined by default config.
  • "remote" indicates the value was defined by fetched config.
+ +Signature: + +```typescript +export type ValueSource = 'static' | 'default' | 'remote'; +``` diff --git a/docs-exp/remote-config.activate.md b/docs-exp/remote-config.activate.md new file mode 100644 index 00000000000..caa6155cb17 --- /dev/null +++ b/docs-exp/remote-config.activate.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@firebase/remote-config](./remote-config.md) > [activate](./remote-config.activate.md) + +## activate() function + +Makes the last fetched config available to the getters. + +Signature: + +```typescript +export declare function activate(remoteConfig: RemoteConfig): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| remoteConfig | [RemoteConfig](./remote-config-types.remoteconfig.md) | the remote config instance | + +Returns: + +Promise<boolean> + +A promise which resolves to true if the current call activated the fetched configs. If the fetched configs were already activated, the promise will resolve to false. + diff --git a/docs-exp/remote-config.ensureinitialized.md b/docs-exp/remote-config.ensureinitialized.md new file mode 100644 index 00000000000..bcaa6293382 --- /dev/null +++ b/docs-exp/remote-config.ensureinitialized.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@firebase/remote-config](./remote-config.md) > [ensureInitialized](./remote-config.ensureinitialized.md) + +## ensureInitialized() function + +Ensures the last activated config are available to the getters. + +Signature: + +```typescript +export declare function ensureInitialized(remoteConfig: RemoteConfig): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| remoteConfig | [RemoteConfig](./remote-config-types.remoteconfig.md) | the remote config instance | + +Returns: + +Promise<void> + +A promise that resolves when the last activated config is available to the getters + diff --git a/docs-exp/remote-config.fetchandactivate.md b/docs-exp/remote-config.fetchandactivate.md new file mode 100644 index 00000000000..1fa111b2f45 --- /dev/null +++ b/docs-exp/remote-config.fetchandactivate.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@firebase/remote-config](./remote-config.md) > [fetchAndActivate](./remote-config.fetchandactivate.md) + +## fetchAndActivate() function + +Performs fetch and activate operations, as a convenience. + +Signature: + +```typescript +export declare function fetchAndActivate(remoteConfig: RemoteConfig): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| remoteConfig | [RemoteConfig](./remote-config-types.remoteconfig.md) | the remote config instance | + +Returns: + +Promise<boolean> + +A promise which resolves to true if the current call activated the fetched configs. If the fetched configs were already activated, the promise will resolve to false. + diff --git a/docs-exp/remote-config.fetchconfig.md b/docs-exp/remote-config.fetchconfig.md new file mode 100644 index 00000000000..81faa206f97 --- /dev/null +++ b/docs-exp/remote-config.fetchconfig.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/remote-config](./remote-config.md) > [fetchConfig](./remote-config.fetchconfig.md) + +## fetchConfig() function + +Fetches and caches configuration from the Remote Config service. + +Signature: + +```typescript +export declare function fetchConfig(remoteConfig: RemoteConfig): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| remoteConfig | [RemoteConfig](./remote-config-types.remoteconfig.md) | the remote config instance | + +Returns: + +Promise<void> + diff --git a/docs-exp/remote-config.getall.md b/docs-exp/remote-config.getall.md new file mode 100644 index 00000000000..3fb23bbad26 --- /dev/null +++ b/docs-exp/remote-config.getall.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@firebase/remote-config](./remote-config.md) > [getAll](./remote-config.getall.md) + +## getAll() function + +Gets all config. + +Signature: + +```typescript +export declare function getAll(remoteConfig: RemoteConfig): Record; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| remoteConfig | [RemoteConfig](./remote-config-types.remoteconfig.md) | the remote config instance | + +Returns: + +Record<string, [ValueType](./remote-config-types.value.md)> + +all config + diff --git a/docs-exp/remote-config.getboolean.md b/docs-exp/remote-config.getboolean.md new file mode 100644 index 00000000000..ccad8397b9e --- /dev/null +++ b/docs-exp/remote-config.getboolean.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [@firebase/remote-config](./remote-config.md) > [getBoolean](./remote-config.getboolean.md) + +## getBoolean() function + +Gets the value for the given key as a boolean. + +Convenience method for calling remoteConfig.getValue(key).asBoolean(). + +Signature: + +```typescript +export declare function getBoolean(remoteConfig: RemoteConfig, key: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| remoteConfig | [RemoteConfig](./remote-config-types.remoteconfig.md) | the remote config instance | +| key | string | the name of the parameter | + +Returns: + +boolean + +the value for the given key as a boolean + diff --git a/docs-exp/remote-config.getnumber.md b/docs-exp/remote-config.getnumber.md new file mode 100644 index 00000000000..1b73ce97a4a --- /dev/null +++ b/docs-exp/remote-config.getnumber.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [@firebase/remote-config](./remote-config.md) > [getNumber](./remote-config.getnumber.md) + +## getNumber() function + +Gets the value for the given key as a number. + +Convenience method for calling remoteConfig.getValue(key).asNumber(). + +Signature: + +```typescript +export declare function getNumber(remoteConfig: RemoteConfig, key: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| remoteConfig | [RemoteConfig](./remote-config-types.remoteconfig.md) | the remote config instance | +| key | string | the name of the parameter | + +Returns: + +number + +the value for the given key as a number + diff --git a/docs-exp/remote-config.getremoteconfig.md b/docs-exp/remote-config.getremoteconfig.md new file mode 100644 index 00000000000..4eb11b68027 --- /dev/null +++ b/docs-exp/remote-config.getremoteconfig.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@firebase/remote-config](./remote-config.md) > [getRemoteConfig](./remote-config.getremoteconfig.md) + +## getRemoteConfig() function + +Signature: + +```typescript +export declare function getRemoteConfig(app: FirebaseApp): RemoteConfig; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| app | [FirebaseApp](./app-types.firebaseapp.md) | the firebase app instance | + +Returns: + +[RemoteConfig](./remote-config-types.remoteconfig.md) + +a remote config instance + diff --git a/docs-exp/remote-config.getstring.md b/docs-exp/remote-config.getstring.md new file mode 100644 index 00000000000..1b6b6e5ff69 --- /dev/null +++ b/docs-exp/remote-config.getstring.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [@firebase/remote-config](./remote-config.md) > [getString](./remote-config.getstring.md) + +## getString() function + +Gets the value for the given key as a String. Convenience method for calling remoteConfig.getValue(key).asString(). + +Signature: + +```typescript +export declare function getString(remoteConfig: RemoteConfig, key: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| remoteConfig | [RemoteConfig](./remote-config-types.remoteconfig.md) | the remote config instance | +| key | string | the name of the parameter | + +Returns: + +string + +the value for the given key as a String + diff --git a/docs-exp/remote-config.getvalue.md b/docs-exp/remote-config.getvalue.md new file mode 100644 index 00000000000..3b62891a43d --- /dev/null +++ b/docs-exp/remote-config.getvalue.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [@firebase/remote-config](./remote-config.md) > [getValue](./remote-config.getvalue.md) + +## getValue() function + +Gets the [Value](./remote-config-types.value.md) for the given key. + +Signature: + +```typescript +export declare function getValue(remoteConfig: RemoteConfig, key: string): ValueType; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| remoteConfig | [RemoteConfig](./remote-config-types.remoteconfig.md) | the remote config instance | +| key | string | the name of the parameter | + +Returns: + +[ValueType](./remote-config-types.value.md) + +the value for the given key + diff --git a/docs-exp/remote-config.md b/docs-exp/remote-config.md new file mode 100644 index 00000000000..1af7a66975b --- /dev/null +++ b/docs-exp/remote-config.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@firebase/remote-config](./remote-config.md) + +## remote-config package + +## Functions + +| Function | Description | +| --- | --- | +| [activate(remoteConfig)](./remote-config.activate.md) | Makes the last fetched config available to the getters. | +| [ensureInitialized(remoteConfig)](./remote-config.ensureinitialized.md) | Ensures the last activated config are available to the getters. | +| [fetchAndActivate(remoteConfig)](./remote-config.fetchandactivate.md) | Performs fetch and activate operations, as a convenience. | +| [fetchConfig(remoteConfig)](./remote-config.fetchconfig.md) | Fetches and caches configuration from the Remote Config service. | +| [getAll(remoteConfig)](./remote-config.getall.md) | Gets all config. | +| [getBoolean(remoteConfig, key)](./remote-config.getboolean.md) | Gets the value for the given key as a boolean.Convenience method for calling remoteConfig.getValue(key).asBoolean(). | +| [getNumber(remoteConfig, key)](./remote-config.getnumber.md) | Gets the value for the given key as a number.Convenience method for calling remoteConfig.getValue(key).asNumber(). | +| [getRemoteConfig(app)](./remote-config.getremoteconfig.md) | | +| [getString(remoteConfig, key)](./remote-config.getstring.md) | Gets the value for the given key as a String. Convenience method for calling remoteConfig.getValue(key).asString(). | +| [getValue(remoteConfig, key)](./remote-config.getvalue.md) | Gets the [Value](./remote-config-types.value.md) for the given key. | +| [setLogLevel(remoteConfig, logLevel)](./remote-config.setloglevel.md) | Defines the log level to use. | + diff --git a/docs-exp/remote-config.setloglevel.md b/docs-exp/remote-config.setloglevel.md new file mode 100644 index 00000000000..59eb74f96ef --- /dev/null +++ b/docs-exp/remote-config.setloglevel.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@firebase/remote-config](./remote-config.md) > [setLogLevel](./remote-config.setloglevel.md) + +## setLogLevel() function + +Defines the log level to use. + +Signature: + +```typescript +export declare function setLogLevel(remoteConfig: RemoteConfig, logLevel: RemoteConfigLogLevel): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| remoteConfig | [RemoteConfig](./remote-config-types.remoteconfig.md) | the remote config instance | +| logLevel | [RemoteConfigLogLevel](./remote-config-types.loglevel.md) | the log level to set | + +Returns: + +void + diff --git a/packages-exp/remote-config-exp/src/api.ts b/packages-exp/remote-config-exp/src/api.ts index 0b48299c2f4..466cd9e2d9b 100644 --- a/packages-exp/remote-config-exp/src/api.ts +++ b/packages-exp/remote-config-exp/src/api.ts @@ -29,11 +29,26 @@ import { RemoteConfig as RemoteConfigImpl } from './remote_config'; import { Value } from './value'; import { LogLevel as FirebaseLogLevel } from '@firebase/logger'; +/** + * + * @param app - the firebase app instance + * @returns a remote config instance + * + * @public + */ export function getRemoteConfig(app: FirebaseApp): RemoteConfig { const rcProvider = _getProvider(app, RC_COMPONENT_NAME); return rcProvider.getImmediate(); } +/** + * Makes the last fetched config available to the getters. + * @param remoteConfig - the remote config instance + * @returns A promise which resolves to true if the current call activated the fetched configs. + * If the fetched configs were already activated, the promise will resolve to false. + * + * @public + */ export async function activate(remoteConfig: RemoteConfig): Promise { const rc = remoteConfig as RemoteConfigImpl; const [lastSuccessfulFetchResponse, activeConfigEtag] = await Promise.all([ @@ -57,6 +72,13 @@ export async function activate(remoteConfig: RemoteConfig): Promise { return true; } +/** + * Ensures the last activated config are available to the getters. + * @param remoteConfig - the remote config instance + * + * @returns A promise that resolves when the last activated config is available to the getters + * @public + */ export function ensureInitialized(remoteConfig: RemoteConfig): Promise { const rc = remoteConfig as RemoteConfigImpl; if (!rc._initializePromise) { @@ -67,6 +89,11 @@ export function ensureInitialized(remoteConfig: RemoteConfig): Promise { return rc._initializePromise; } +/** + * Fetches and caches configuration from the Remote Config service. + * @param remoteConfig - the remote config instance + * @public + */ export async function fetchConfig(remoteConfig: RemoteConfig): Promise { const rc = remoteConfig as RemoteConfigImpl; // Aborts the request after the given timeout, causing the fetch call to @@ -103,6 +130,14 @@ export async function fetchConfig(remoteConfig: RemoteConfig): Promise { } } +/** + * Gets all config. + * + * @param remoteConfig - the remote config instance + * @returns all config + * + * @public + */ export function getAll(remoteConfig: RemoteConfig): Record { const rc = remoteConfig as RemoteConfigImpl; return getAllKeys( @@ -114,18 +149,62 @@ export function getAll(remoteConfig: RemoteConfig): Record { }, {} as Record); } +/** + * Gets the value for the given key as a boolean. + * + * Convenience method for calling remoteConfig.getValue(key).asBoolean(). + * + * @param remoteConfig - the remote config instance + * @param key - the name of the parameter + * + * @returns the value for the given key as a boolean + * @public + */ export function getBoolean(remoteConfig: RemoteConfig, key: string): boolean { return getValue(remoteConfig, key).asBoolean(); } +/** + * Gets the value for the given key as a number. + * + * Convenience method for calling remoteConfig.getValue(key).asNumber(). + * + * @param remoteConfig - the remote config instance + * @param key - the name of the parameter + * + * @returns the value for the given key as a number + * + * @public + */ export function getNumber(remoteConfig: RemoteConfig, key: string): number { return getValue(remoteConfig, key).asNumber(); } +/** + * Gets the value for the given key as a String. + * Convenience method for calling remoteConfig.getValue(key).asString(). + * + * @param remoteConfig - the remote config instance + * @param key - the name of the parameter + * + * @returns the value for the given key as a String + * + * @public + */ export function getString(remoteConfig: RemoteConfig, key: string): string { return getValue(remoteConfig, key).asString(); } +/** + * Gets the {@link @firebase/remote-config-types#Value} for the given key. + * + * @param remoteConfig - the remote config instance + * @param key - the name of the parameter + * + * @returns the value for the given key + * + * @public + */ export function getValue(remoteConfig: RemoteConfig, key: string): ValueType { const rc = remoteConfig as RemoteConfigImpl; if (!rc._isInitializationComplete) { @@ -147,6 +226,14 @@ export function getValue(remoteConfig: RemoteConfig, key: string): ValueType { return new Value('static'); } +/** + * Defines the log level to use. + * + * @param remoteConfig - the remote config instance + * @param logLevel - the log level to set + * + * @public + */ export function setLogLevel( remoteConfig: RemoteConfig, logLevel: RemoteConfigLogLevel diff --git a/packages-exp/remote-config-exp/src/api2.ts b/packages-exp/remote-config-exp/src/api2.ts index ee1df4b1c06..8a532613186 100644 --- a/packages-exp/remote-config-exp/src/api2.ts +++ b/packages-exp/remote-config-exp/src/api2.ts @@ -20,6 +20,17 @@ import { activate, fetchConfig } from './api'; // This API is put in a separate file, so we can stub fetchConfig and activate in tests. // It's not possible to stub standalone functions from the same module. +/** + * + * Performs fetch and activate operations, as a convenience. + * + * @param remoteConfig - the remote config instance + * + * @returns A promise which resolves to true if the current call activated the fetched configs. + * If the fetched configs were already activated, the promise will resolve to false. + * + * @public + */ export async function fetchAndActivate( remoteConfig: RemoteConfig ): Promise { diff --git a/packages-exp/remote-config-types-exp/index.d.ts b/packages-exp/remote-config-types-exp/index.d.ts index d0271d3e781..bd40447e08b 100644 --- a/packages-exp/remote-config-types-exp/index.d.ts +++ b/packages-exp/remote-config-types-exp/index.d.ts @@ -15,6 +15,11 @@ * limitations under the License. */ +/** + * The Firebase Remote Config service interface. + * + * @public + */ export interface RemoteConfig { /** * Defines configuration for the Remote Config SDK. @@ -47,11 +52,15 @@ export interface RemoteConfig { *
  • "default" indicates the value was defined by default config.
    • *
  • "remote" indicates the value was defined by fetched config.
    • * + * + * @public */ export type ValueSource = 'static' | 'default' | 'remote'; /** * Wraps a value with metadata and type-safe getters. + * + * @public */ export interface Value { /** @@ -80,6 +89,8 @@ export interface Value { /** * Defines configuration options for the Remote Config SDK. + * + * @public */ export interface Settings { /** @@ -105,11 +116,15 @@ export interface Settings { *
  • "failure" indicates the last attempt failed.
    • *
  • "throttle" indicates the last attempt was rate-limited.
    • * + * + * @public */ export type FetchStatus = 'no-fetch-yet' | 'success' | 'failure' | 'throttle'; /** * Defines levels of Remote Config logging. + * + * @public */ export type LogLevel = 'debug' | 'error' | 'silent'; From 47b182b91879d6e4bcce07609c517938d9354c9f Mon Sep 17 00:00:00 2001 From: Feiyang Date: Tue, 10 Nov 2020 15:19:52 -0800 Subject: [PATCH 076/624] Add remote-config-exp to firebaes-exp (#4025) * add rc to firebase-exp, and make test app work * rename the RC instance to rcInstance * add rc dependency to firebase-exp --- packages-exp/firebase-exp/package.json | 6 ++- .../firebase-exp/remote-config/index.ts | 17 +++++++++ .../firebase-exp/remote-config/package.json | 7 ++++ packages-exp/firebase-exp/rollup.config.js | 12 +++++- .../remote-config-exp/test_app/index.html | 4 +- .../remote-config-exp/test_app/index.js | 38 +++++++++---------- 6 files changed, 60 insertions(+), 24 deletions(-) create mode 100644 packages-exp/firebase-exp/remote-config/index.ts create mode 100644 packages-exp/firebase-exp/remote-config/package.json diff --git a/packages-exp/firebase-exp/package.json b/packages-exp/firebase-exp/package.json index f76217a3806..5a220d7f4ac 100644 --- a/packages-exp/firebase-exp/package.json +++ b/packages-exp/firebase-exp/package.json @@ -42,7 +42,8 @@ "@firebase/auth-exp": "0.0.800", "@firebase/functions-exp": "0.0.800", "@firebase/firestore": "2.0.1", - "@firebase/performance-exp": "0.0.800" + "@firebase/performance-exp": "0.0.800", + "@firebase/remote-config-exp": "0.0.800" }, "devDependencies": { "rollup": "2.33.1", @@ -64,6 +65,7 @@ "functions", "firestore", "firestore/lite", - "performance" + "performance", + "remote-config" ] } diff --git a/packages-exp/firebase-exp/remote-config/index.ts b/packages-exp/firebase-exp/remote-config/index.ts new file mode 100644 index 00000000000..73b26c811e9 --- /dev/null +++ b/packages-exp/firebase-exp/remote-config/index.ts @@ -0,0 +1,17 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +export * from '@firebase/remote-config-exp'; diff --git a/packages-exp/firebase-exp/remote-config/package.json b/packages-exp/firebase-exp/remote-config/package.json new file mode 100644 index 00000000000..86878ce0089 --- /dev/null +++ b/packages-exp/firebase-exp/remote-config/package.json @@ -0,0 +1,7 @@ +{ + "name": "firebase-exp/remote-config", + "main": "dist/index.cjs.js", + "browser": "dist/index.esm.js", + "module": "dist/index.esm.js", + "typings": "dist/remote-config/index.d.ts" +} diff --git a/packages-exp/firebase-exp/rollup.config.js b/packages-exp/firebase-exp/rollup.config.js index d6b7aa10ee9..27b15a7cddd 100644 --- a/packages-exp/firebase-exp/rollup.config.js +++ b/packages-exp/firebase-exp/rollup.config.js @@ -39,7 +39,7 @@ function createUmdOutputConfig(output, componentName) { format: 'umd', sourcemap: true, extend: true, - name: `${GLOBAL_NAME}.${componentName}`, + name: `${GLOBAL_NAME}.${camelize(componentName)}`, globals: { '@firebase/app-exp': `${GLOBAL_NAME}.app` }, @@ -65,6 +65,16 @@ function createUmdOutputConfig(output, componentName) { }; } +function camelize(str) { + const arr = str.split('-'); + const capital = arr.map((item, index) => + index > 0 + ? item.charAt(0).toUpperCase() + item.slice(1).toLowerCase() + : item.toLowerCase() + ); + return capital.join(''); +} + const plugins = [sourcemaps(), resolveModule(), json(), commonjs()]; const typescriptPlugin = rollupTypescriptPlugin({ diff --git a/packages-exp/remote-config-exp/test_app/index.html b/packages-exp/remote-config-exp/test_app/index.html index 8bf6a0c888c..effc7bd1492 100644 --- a/packages-exp/remote-config-exp/test_app/index.html +++ b/packages-exp/remote-config-exp/test_app/index.html @@ -3,8 +3,8 @@ Test App - - + +