(feat) initializeServerApp support for App Hosting auto init by DellaBitta · Pull Request #9151 · firebase/firebase-js-sdk

DellaBitta · 2025-07-07T14:01:18Z

Discussion

Implement Auto Init for initializeServerApp.

Auto init was previously implemented for initializeApp in #8483. This PR adds the same functionality to the initializeServerApp API surface.

Fixes #8863.

Testing

Local testing in Node and a Next.js app.

API Changes

Internal doc: Firebase API - JS SDK initializeServerApp auto init

changeset-bot · 2025-07-07T14:01:22Z

🦋 Changeset detected

Latest commit: 8d93ef2

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@firebase/app	Minor
firebase	Minor
@firebase/app-compat	Patch

Not sure what this means? Click here to learn what changesets are.

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

google-oss-bot · 2025-07-07T14:11:20Z

Size Report ¹

Affected Products

@firebase/app
Type Base (f11b552) Merge (bb0c09f) Diff
browser 19.5 kB 20.0 kB +507 B (+2.6%)
main 20.4 kB 20.9 kB +549 B (+2.7%)
module 19.5 kB 20.0 kB +507 B (+2.6%)
react-native 20.4 kB 20.9 kB +549 B (+2.7%)
@firebase/database-compat/standalone
Type Base (f11b552) Merge (bb0c09f) Diff
main 366 kB 367 kB +549 B (+0.1%)

`firebase`

Type	Base (`f11b552`)	Merge (bb0c09f)	Diff
firebase-app-compat.js	31.8 kB	32.0 kB	+232 B (+0.7%)
firebase-app.js	103 kB	104 kB	+928 B (+0.9%)
firebase-compat.js	806 kB	807 kB	+235 B (+0.0%)
firebase-performance-standalone-compat.js	105 kB	106 kB	+237 B (+0.2%)

Test Logs

Base (f11b552): https://github.com/firebase/firebase-js-sdk/actions/runs/16227224067
Merge (bb0c09f): https://github.com/firebase/firebase-js-sdk/actions/runs/16228602698

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

google-oss-bot · 2025-07-07T14:23:06Z

Size Analysis Report ¹

Affected Products

`@firebase/app`

`_isFirebaseServerAppSettings`

Size

Type	Base (`f11b552`)	Merge (bb0c09f)	Diff
size	?	8.82 kB	? (?)
size-with-ext-deps	?	18.3 kB	? (?)

Dependency

Type	Base (`f11b552`)	Merge (bb0c09f)	Diff
functions	?	15 dependencies _addComponent _isFirebaseApp _isFirebaseServerAppSettings _registerComponent computeKey countBytes extractHeartbeatsForHeader getDbPromise getEarliestHeartbeatIdx getUTCDateString isVersionServiceProvider readHeartbeatsFromIndexedDB registerCoreComponents registerVersion writeHeartbeatsToIndexedDB	?
classes	?	HeartbeatServiceImpl HeartbeatStorageImpl PlatformLoggerServiceImpl	?
variables	?	41 dependencies DB_NAME DB_VERSION ERRORS ERROR_FACTORY MAX_HEADER_BYTES MAX_NUM_STORED_HEARTBEATS PLATFORM_LOG_STRING STORE_NAME _apps _components _serverApps dbPromise logger name name$1 name$2 name$3 name$4 name$5 name$6 name$7 name$8 name$9 name$a name$b name$c name$d name$e name$f name$g name$h name$i name$j name$k name$l name$m name$n name$o name$p name$q version$1	?
enums	?		?

External Dependency

Module	Base (`f11b552`)	Merge (bb0c09f)	Diff
`@firebase/component`	?	Component	?
`@firebase/logger`	?	Logger	?
`@firebase/util`	?	ErrorFactory FirebaseError base64urlEncodeWithoutPadding isIndexedDBAvailable validateIndexedDBOpenable	?
`idb`	?	openDB	?

`initializeServerApp`

Size

Type	Base (`f11b552`)	Merge (bb0c09f)	Diff
size	12.3 kB	12.6 kB	+258 B (+2.1%)
size-with-ext-deps	26.3 kB	27.4 kB	+1.04 kB (+4.0%)

Dependency

Type Base (f11b552) Merge (bb0c09f) Diff

functions

17 dependencies

_addComponent
_isFirebaseApp
_registerComponent
computeKey
countBytes
deleteApp
extractHeartbeatsForHeader
getDbPromise
getEarliestHeartbeatIdx
getUTCDateString
initializeServerApp
isVersionServiceProvider
readHeartbeatsFromIndexedDB
registerCoreComponents
registerVersion
validateTokenTTL
writeHeartbeatsToIndexedDB

18 dependencies

_addComponent
_isFirebaseApp
_isFirebaseServerAppSettings
_registerComponent
computeKey
countBytes
deleteApp
extractHeartbeatsForHeader
getDbPromise
getEarliestHeartbeatIdx
getUTCDateString
initializeServerApp
isVersionServiceProvider
readHeartbeatsFromIndexedDB
registerCoreComponents
registerVersion
validateTokenTTL
writeHeartbeatsToIndexedDB

+ _isFirebaseServerAppSettings

External Dependency

Module Base (f11b552) Merge (bb0c09f) Diff

@firebase/util

ErrorFactory
FirebaseError
base64Decode
base64urlEncodeWithoutPadding
isBrowser
isIndexedDBAvailable
isWebWorker
validateIndexedDBOpenable

ErrorFactory
FirebaseError
base64Decode
base64urlEncodeWithoutPadding
getDefaultAppConfig
isBrowser
isIndexedDBAvailable
isWebWorker
validateIndexedDBOpenable

+ getDefaultAppConfig

Test Logs

Base (f11b552): https://github.com/firebase/firebase-js-sdk/actions/runs/16227224067
Merge (bb0c09f): https://github.com/firebase/firebase-js-sdk/actions/runs/16228602698

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

packages/app/src/api.ts

dlarocque · 2025-07-07T18:54:30Z

packages/app/src/api.ts

+/**
+ * Creates and initializes a {@link @firebase/app#FirebaseServerApp} instance.
+ *
+ * @param config - Optional `FirebaseServerApp` configuration.
+ *
+ * @returns The initialized `FirebaseServerApp`.
+ *
+ * @public
+ */


I think it's useful to add @throws tag on functions that throw, but the other functions in app don't do this, so maybe it'd just make it inconsistent which may be worse- feel free to ignore.

@throws {AppError.INVALID_SERVER_APP_ENVIRONMENT} - ...

hsubox76 · 2025-07-07T22:44:36Z

packages/app/src/api.ts

+
+  if (_options) {
+    if (_isFirebaseApp(_options)) {
+      app = _options;


It looks like this is the only place the app variable is used, probably don't need to initialize it with the let above in line 256.

packages/app/src/api.ts

hsubox76 · 2025-07-07T22:53:22Z

packages/app/src/api.ts

    throw ERROR_FACTORY.create(AppError.INVALID_SERVER_APP_ENVIRONMENT);
  }

-  if (_serverAppConfig.automaticDataCollectionEnabled === undefined) {


Are we getting rid of this? Should this go in the second branch of the if/else? Maybe also the third?

Yes, thank you, nice catch!

egilmorez

LGTM!

Would this have any impact on https://firebase.devsite.corp.google.com/docs/app-hosting/firebase-sdks or other App Hosting pages? Or possibly https://firebase.google.com/docs/web/ssr-apps?

DellaBitta · 2025-07-09T13:52:09Z

Would this have any impact on https://firebase.devsite.corp.google.com/docs/app-hosting/firebase-sdks or other App Hosting pages?

Yes, I think that page should be updated. Both the "Automatically initialize Firebase Admin SDK and web SDKs" and "Use FirebaseServerApp for SSR" sections. Hit up @jamesdaniels and me to get the ball rolling there.

Or possibly https://firebase.google.com/docs/web/ssr-apps?

I don't think this page needs any updates. It doesn't mention auto-initialization at all, and I don't think we want to push for its usage outside of App Hosting context.

DellaBitta added 4 commits June 13, 2025 16:04

Auto it impl and tested

4ee298c

declare zero parameter initializeServerApp function.

ed091d2

parameter consistency. logging cleanup.

4ff465a

configuration -> settings

07b8f26

DellaBitta requested review from a team as code owners July 7, 2025 14:01

DellaBitta added 2 commits July 7, 2025 10:36

Merge branch 'main' into ddb-serverapp-autoinit

238e4f9

changeset

832f81e

DellaBitta requested review from a team as code owners July 7, 2025 15:02

DellaBitta changed the title ~~(feat) initializeServerApp support for App Hosting Auto Init~~ (feat) initializeServerApp support for App Hosting auto init Jul 7, 2025

dlarocque approved these changes Jul 7, 2025

View reviewed changes

hsubox76 reviewed Jul 7, 2025

View reviewed changes

Review updates.

9f67976

DellaBitta requested a review from hsubox76 July 8, 2025 14:31

DellaBitta added 2 commits July 8, 2025 10:34

Merge branch 'main' into ddb-serverapp-autoinit

b999c00

docgen.

b43f513

hsubox76 approved these changes Jul 8, 2025

View reviewed changes

@throws clauses.

1653cfc

egilmorez approved these changes Jul 8, 2025

View reviewed changes

format

7b1a506

dlarocque approved these changes Jul 10, 2025

View reviewed changes

Merge branch 'main' into ddb-serverapp-autoinit

8d93ef2

DellaBitta merged commit d91169f into main Jul 12, 2025
49 checks passed

DellaBitta deleted the ddb-serverapp-autoinit branch July 12, 2025 00:50

google-oss-bot mentioned this pull request Jul 15, 2025

Version Packages #9165

Merged

dconeybe mentioned this pull request Jul 25, 2025

fix(firestore): fix empty message reject inside transaction body #9177

Merged

firebase locked and limited conversation to collaborators Aug 11, 2025

Conversation

DellaBitta commented Jul 7, 2025

Discussion

Testing

API Changes

Uh oh!

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

Uh oh!

🦋 Changeset detected

Uh oh!

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

Uh oh!

Size Report 1

Affected Products

@firebase/app

@firebase/database-compat/standalone

firebase

Test Logs

Uh oh!

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

Uh oh!

Size Analysis Report 1

Affected Products

@firebase/app

_isFirebaseServerAppSettings

initializeServerApp

Test Logs

Uh oh!

Uh oh!

dlarocque Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

hsubox76 Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

DellaBitta Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hsubox76 Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

DellaBitta Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

DellaBitta Jul 8, 2025

Choose a reason for hiding this comment

Uh oh!

egilmorez left a comment

Choose a reason for hiding this comment

Uh oh!

DellaBitta commented Jul 9, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

changeset-bot bot commented Jul 7, 2025 •

edited

Loading

google-oss-bot commented Jul 7, 2025 •

edited

Loading

Size Report ¹

`@firebase/app`

`@firebase/database-compat/standalone`

`firebase`

google-oss-bot commented Jul 7, 2025 •

edited

Loading

Size Analysis Report ¹

`@firebase/app`

`_isFirebaseServerAppSettings`

`initializeServerApp`