feat: initializeApp idempotency #2947
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DellaBitta
changed the title
lahirumaramba
changed the title
lahirumaramba
approved these changes
Jul 15, 2025
| * or `options.credential` are defined. This is due to the function's inability to | ||
| * determine if the existing {@link App}'s `options` compare to the `options` parameter | ||
| * of this function. It's recommended to use {@link getApp} or {@link getApps} if your | ||
| * implementation uses either of these two fields in {@link AppOptions}. |
There was a problem hiding this comment.
Should we extend the JSDoc with an example?
/**...
* For example, to safely initialize an app that may already exist:
*
* ```javascript
* let app;
* try {
* app = getApp("myApp");
* } catch (error) {
* app = initializeApp({ credential: myCredential }, "myApp");
* }
* ```
*/
src/app/lifecycle.ts
Outdated
| } else if (autoInit) { | ||
| // Auto-initialization is triggered when no options were passed to | ||
| // initializeApp. With no options to compare, simply return the App. | ||
| return currentApp; | ||
| } else { |
There was a problem hiding this comment.
Can we simplify this by using early exits/guard clauses (and removing the nested if else statements)?
If it doesn't work in this case feel free to ignore. For example:
if (this.appStore.has(appName)) {
const currentApp = this.appStore.get(appName)!;
if (currentApp.autoInit() !== autoInit) {
throw new FirebaseAppError(
AppErrorCodes.INVALID_APP_OPTIONS,
`Firebase app named "${appName}" attempted mismatch between custom AppOptions` +
' and an App created via Auto Init.'
)
}
if (autoInit) {
return currentApp;
}
if (typeof options.httpAgent !== 'undefined') {
.....
src/app/lifecycle.ts
Outdated
|
|
||
| // `httpAgent` objects cannot be compared with deepEquals impls. | ||
| // Idempotency cannot be supported if one exists. | ||
| if (typeof options.httpAgent !== 'undefined') { |
There was a problem hiding this comment.
nit: Would it make sense to move this (and below) validation to a separate function (out of initializeApp) to clean it up a bit?
src/app/lifecycle.ts
Outdated
| * @internal | ||
| */ | ||
| function validateAppNameFormat(appName: string): void { | ||
| if (typeof appName !== 'string' || appName === '') { |
There was a problem hiding this comment.
Can we use validator.isNonEmptyString() here?
firebase-admin-node/src/utils/validator.ts
Line 104 in 26b884f
src/app/lifecycle.ts
Outdated
| export function initializeApp(options?: AppOptions, appName: string = DEFAULT_APP_NAME): App { | ||
| return defaultAppStore.initializeApp(options, appName); | ||
| } | ||
|
|
||
| /** | ||
| * Returns an existing App instance for the provided name. If no name is provided | ||
| * the the default app name is queried. |
| * A (read-only) array of all initialized apps. | ||
| * | ||
| * @returns An array containing all initialized apps. | ||
| */ |
There was a problem hiding this comment.
Let's get @egilmorez's review on the new doc changes, please. Thanks!
src/app/lifecycle.ts
Outdated
| 'name.', | ||
| ); | ||
| AppErrorCodes.INVALID_APP_OPTIONS, | ||
| `Firebase app named "${appName}" attempted mismatch between custom AppOptions` + |
There was a problem hiding this comment.
Can we simplify this error message? I am not sure Auto Init is a well known term in the Admin SDK world
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Discussion
Update
initializeAppto return an existing app if one exists with the same name and the sameAppOptions. However, due to their inabilty to be compared,initializeAppwill throw if an existing app has a configuredCredentialorhttpAgent.Additionally adds reference docs to
getAppandgetApps.Testing
Updated unit tests.
API Changes
Internal: go/fb-admin-init-idempotency
Fixes: #2111