Add Env Override Global Variable `forceEnvironment` #6901

dwyfrequency · 2022-12-19T19:13:36Z

To adapt to the changing javascript landscape, we will allow users to specify their environment as Node or Browser to override Firebase's runtime environment detection and force the SDK to act as if it were in the respective environment.

changeset-bot · 2022-12-19T19:13:40Z

🦋 Changeset detected

Latest commit: 409f9c5

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

This PR includes changesets to release 28 packages

Name	Type
@firebase/util	Minor
firebase	Minor
@firebase/analytics-compat	Patch
@firebase/analytics	Patch
@firebase/app-check-compat	Patch
@firebase/app-check	Patch
@firebase/app-compat	Patch
@firebase/app	Patch
@firebase/auth-compat	Patch
@firebase/auth	Patch
@firebase/component	Patch
@firebase/database-compat	Patch
@firebase/database-types	Patch
@firebase/database	Patch
@firebase/firestore-compat	Patch
@firebase/firestore	Patch
@firebase/functions-compat	Patch
@firebase/functions	Patch
@firebase/installations-compat	Patch
@firebase/installations	Patch
@firebase/messaging-compat	Patch
@firebase/messaging	Patch
@firebase/performance-compat	Patch
@firebase/performance	Patch
@firebase/remote-config-compat	Patch
@firebase/remote-config	Patch
@firebase/storage-compat	Patch
@firebase/storage	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 · 2022-12-19T19:41:33Z

Size Report ¹

Affected Products

@firebase/firestore
Type Base (d8af08f) Merge (35a3764) Diff
browser 272 kB 273 kB +52 B (+0.0%)
esm5 339 kB 339 kB +69 B (+0.0%)
main 545 kB 545 kB +120 B (+0.0%)
module 272 kB 273 kB +52 B (+0.0%)
react-native 273 kB 273 kB +52 B (+0.0%)
@firebase/util
Type Base (d8af08f) Merge (35a3764) Diff
browser 22.7 kB 22.9 kB +201 B (+0.9%)
esm5 24.2 kB 24.4 kB +199 B (+0.8%)
main 29.7 kB 30.0 kB +273 B (+0.9%)
module 22.7 kB 22.9 kB +201 B (+0.9%)

`bundle`

Type	Base (`d8af08f`)	Merge (`35a3764`)	Diff
firestore (Persistence)	281 kB	281 kB	+182 B (+0.1%)
firestore (Query Cursors)	220 kB	220 kB	+52 B (+0.0%)
firestore (Query)	217 kB	217 kB	+52 B (+0.0%)
firestore (Read data once)	205 kB	205 kB	+52 B (+0.0%)
firestore (Realtime updates)	207 kB	207 kB	+52 B (+0.0%)
firestore (Transaction)	188 kB	188 kB	+52 B (+0.0%)
firestore (Write data)	188 kB	188 kB	+52 B (+0.0%)
storage (uploadBytes)	46.8 kB	46.9 kB	+130 B (+0.3%)
storage (uploadBytesResumable)	56.8 kB	56.9 kB	+130 B (+0.2%)
storage (uploadString)	47.0 kB	47.2 kB	+130 B (+0.3%)

`firebase`

Type	Base (`d8af08f`)	Merge (`35a3764`)	Diff
firebase-app.js	92.0 kB	92.8 kB	+831 B (+0.9%)
firebase-auth-compat.js	126 kB	126 kB	+113 B (+0.1%)
firebase-auth-react-native.js	150 kB	150 kB	+130 B (+0.1%)
firebase-compat.js	745 kB	746 kB	+157 B (+0.0%)
firebase-firestore-compat.js	320 kB	320 kB	+917 B (+0.3%)
firebase-firestore.js	321 kB	321 kB	+168 B (+0.1%)
firebase-performance-standalone-compat.es2017.js	89.9 kB	89.9 kB	+1 B (+0.0%)
firebase-storage-compat.js	39.4 kB	40.3 kB	+878 B (+2.2%)
firebase-storage.js	39.0 kB	39.1 kB	+116 B (+0.3%)

Test Logs

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

google-oss-bot · 2022-12-19T19:59:50Z

Size Analysis Report ¹

Affected Products

@firebase/firestore
- addDoc
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 118 kB 118 kB +52 B (+0.0%)
  size-with-ext-deps 178 kB 178 kB +52 B (+0.0%)
- deleteDoc
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 109 kB 109 kB +52 B (+0.0%)
  size-with-ext-deps 169 kB 169 kB +52 B (+0.0%)
- disableNetwork
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 97.5 kB 97.6 kB +52 B (+0.1%)
  size-with-ext-deps 157 kB 157 kB +52 B (+0.0%)
- enableIndexedDbPersistence
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 179 kB 179 kB +52 B (+0.0%)
  size-with-ext-deps 239 kB 240 kB +1.01 kB (+0.4%)
- enableMultiTabIndexedDbPersistence
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 211 kB 211 kB +52 B (+0.0%)
  size-with-ext-deps 271 kB 272 kB +1.01 kB (+0.4%)
- enableNetwork
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 97.5 kB 97.6 kB +52 B (+0.1%)
  size-with-ext-deps 157 kB 157 kB +52 B (+0.0%)
- executeWrite
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 108 kB 108 kB +52 B (+0.0%)
  size-with-ext-deps 168 kB 168 kB +52 B (+0.0%)
- getCountFromServer
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 104 kB 104 kB +52 B (+0.0%)
  size-with-ext-deps 164 kB 164 kB +52 B (+0.0%)
- getDoc
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 135 kB 135 kB +52 B (+0.0%)
  size-with-ext-deps 194 kB 194 kB +52 B (+0.0%)
- getDocFromCache
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 90.6 kB 90.7 kB +52 B (+0.1%)
  size-with-ext-deps 150 kB 150 kB +52 B (+0.0%)
- getDocFromServer
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 135 kB 135 kB +52 B (+0.0%)
  size-with-ext-deps 194 kB 194 kB +52 B (+0.0%)
- getDocs
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 136 kB 136 kB +52 B (+0.0%)
  size-with-ext-deps 196 kB 196 kB +52 B (+0.0%)
- getDocsFromCache
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 98.3 kB 98.3 kB +52 B (+0.1%)
  size-with-ext-deps 157 kB 157 kB +52 B (+0.0%)
- getDocsFromServer
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 136 kB 136 kB +52 B (+0.0%)
  size-with-ext-deps 196 kB 196 kB +52 B (+0.0%)
- loadBundle
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 107 kB 107 kB +52 B (+0.0%)
  size-with-ext-deps 166 kB 166 kB +52 B (+0.0%)
- namedQuery
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 84.1 kB 84.1 kB +52 B (+0.1%)
  size-with-ext-deps 143 kB 143 kB +52 B (+0.0%)
- onSnapshot
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 137 kB 137 kB +52 B (+0.0%)
  size-with-ext-deps 196 kB 197 kB +52 B (+0.0%)
- onSnapshotsInSync
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 127 kB 127 kB +52 B (+0.0%)
  size-with-ext-deps 186 kB 186 kB +52 B (+0.0%)
- runTransaction
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 118 kB 118 kB +52 B (+0.0%)
  size-with-ext-deps 178 kB 178 kB +52 B (+0.0%)
- setDoc
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 117 kB 117 kB +52 B (+0.0%)
  size-with-ext-deps 177 kB 177 kB +52 B (+0.0%)
- setIndexConfiguration
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 86.7 kB 86.7 kB +52 B (+0.1%)
  size-with-ext-deps 146 kB 146 kB +52 B (+0.0%)
- updateDoc
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 118 kB 118 kB +52 B (+0.0%)
  size-with-ext-deps 177 kB 177 kB +52 B (+0.0%)
- waitForPendingWrites
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 97.9 kB 98.0 kB +52 B (+0.1%)
  size-with-ext-deps 157 kB 157 kB +52 B (+0.0%)
- writeBatch
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size 120 kB 120 kB +52 B (+0.0%)
  size-with-ext-deps 179 kB 179 kB +52 B (+0.0%)
@firebase/storage
- _FbsBlob
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size-with-ext-deps 31.4 kB 32.4 kB +955 B (+3.0%)
- _UploadTask
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size-with-ext-deps 47.0 kB 47.9 kB +955 B (+2.0%)
- uploadBytes
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size-with-ext-deps 37.2 kB 38.2 kB +961 B (+2.6%)
- uploadBytesResumable
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size-with-ext-deps 47.2 kB 48.2 kB +961 B (+2.0%)
- uploadString
  Size
  Type Base (d8af08f) Merge (35a3764) Diff
  size-with-ext-deps 37.5 kB 38.4 kB +961 B (+2.6%)

`@firebase/util`

`getDefaults`

Size

Type	Base (`d8af08f`)	Merge (`35a3764`)	Diff
size	?	3.83 kB	? (?)
size-with-ext-deps	?	3.83 kB	? (?)

Dependency

Type	Base (`d8af08f`)	Merge (`35a3764`)	Diff
functions	?	getGlobal	?
classes	?		?
variables	?	base64 base64Decode byteArrayToString getDefaults getDefaultsFromCookie getDefaultsFromEnvVariable getDefaultsFromGlobal stringToByteArray$1	?
enums	?		?

`isNode`

Size

Type	Base (`d8af08f`)	Merge (`35a3764`)	Diff
size	135 B	4.07 kB	+3.94 kB (+2917.8%)
size-with-ext-deps	135 B	4.07 kB	+3.94 kB (+2917.8%)

Dependency

Type Base (d8af08f) Merge (35a3764) Diff

functions

isNode

getGlobal
isNode

+ getGlobal

variables

base64
base64Decode
byteArrayToString
getDefaults
getDefaultsFromCookie
getDefaultsFromEnvVariable
getDefaultsFromGlobal
stringToByteArray$1

+ base64
+ base64Decode
+ byteArrayToString
+ getDefaults
+ getDefaultsFromCookie
+ getDefaultsFromEnvVariable
+ getDefaultsFromGlobal
+ stringToByteArray$1

`isSafari`

Size

Type	Base (`d8af08f`)	Merge (`35a3764`)	Diff
size	242 B	4.18 kB	+3.94 kB (+1627.7%)
size-with-ext-deps	242 B	4.18 kB	+3.94 kB (+1627.7%)

Dependency

Type Base (d8af08f) Merge (35a3764) Diff

functions

isNode
isSafari

getGlobal
isNode
isSafari

+ getGlobal

variables

base64
base64Decode
byteArrayToString
getDefaults
getDefaultsFromCookie
getDefaultsFromEnvVariable
getDefaultsFromGlobal
stringToByteArray$1

+ base64
+ base64Decode
+ byteArrayToString
+ getDefaults
+ getDefaultsFromCookie
+ getDefaultsFromEnvVariable
+ getDefaultsFromGlobal
+ stringToByteArray$1

Test Logs

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

github-actions · 2022-12-20T19:37:24Z

Changeset File Check ✅

No modified packages are missing from the changeset file.
No changeset formatting errors detected.

hsubox76

Looks good! Just a few nits about documentation and such. When we do this release we'll have to remember to generate new reference docs.

common/api-review/util.api.md

packages/util/src/defaults.ts

common/api-review/util.api.md

packages/util/src/defaults.ts

.changeset/silly-suns-drop.md

packages/util/src/environment.ts

.changeset/silly-suns-drop.md

hsubox76

Looks good! Thanks for getting this done!

Add forceEnvironment and check value in isNode

85e8dc4

Update API reports

22cafa1

github-actions bot added the doc-changes PRs that affect docs label Dec 19, 2022

dwyfrequency added 3 commits December 19, 2022 20:40

Add tests for environment package

6f8c557

Update docs

97607ca

Update tests and remove console.log

e825176

dwyfrequency marked this pull request as ready for review December 20, 2022 19:33

dwyfrequency requested a review from hsubox76 as a code owner December 20, 2022 19:33

Add changeset

6ea2769

dwyfrequency requested a review from egilmorez as a code owner December 20, 2022 19:34

hsubox76 reviewed Dec 21, 2022

View reviewed changes

.changeset/silly-suns-drop.md Outdated Show resolved Hide resolved

dwyfrequency added 3 commits December 21, 2022 18:29

Remove old changeset and update it with a new one

5172aca

Update jsdoc

9e4dfaf

Move getGlobal into separate file to remove circular dep

409f9c5

hsubox76 approved these changes Dec 22, 2022

View reviewed changes

dwyfrequency merged commit 06dc136 into master Dec 22, 2022

dwyfrequency deleted the jd-env-default-override branch December 22, 2022 21:27

google-oss-bot mentioned this pull request Jan 17, 2023

Version Packages #6953

Merged

firebase locked and limited conversation to collaborators Jan 22, 2023

Add Env Override Global Variable forceEnvironment #6901

Add Env Override Global Variable forceEnvironment #6901

Conversation

dwyfrequency commented Dec 19, 2022

changeset-bot bot commented Dec 19, 2022 • edited Loading

🦋 Changeset detected

google-oss-bot commented Dec 19, 2022 • edited Loading

Size Report 1

Affected Products

@firebase/firestore

@firebase/util

bundle

firebase

Test Logs

google-oss-bot commented Dec 19, 2022 • edited Loading

Size Analysis Report 1

Affected Products

@firebase/firestore

addDoc

deleteDoc

disableNetwork

enableIndexedDbPersistence

enableMultiTabIndexedDbPersistence

enableNetwork

executeWrite

getCountFromServer

getDoc

getDocFromCache

getDocFromServer

getDocs

getDocsFromCache

getDocsFromServer

loadBundle

namedQuery

onSnapshot

onSnapshotsInSync

runTransaction

setDoc

setIndexConfiguration

updateDoc

waitForPendingWrites

writeBatch

@firebase/storage

_FbsBlob

_UploadTask

uploadBytes

uploadBytesResumable

uploadString

@firebase/util

getDefaults

isNode

isSafari

Test Logs

github-actions bot commented Dec 20, 2022 • edited Loading

Changeset File Check ✅

hsubox76 left a comment

Choose a reason for hiding this comment

hsubox76 left a comment

Choose a reason for hiding this comment

Add Env Override Global Variable `forceEnvironment` #6901

Add Env Override Global Variable `forceEnvironment` #6901

changeset-bot bot commented Dec 19, 2022 •

edited

Loading

google-oss-bot commented Dec 19, 2022 •

edited

Loading

Size Report ¹

`@firebase/firestore`

`@firebase/util`

`bundle`

`firebase`

google-oss-bot commented Dec 19, 2022 •

edited

Loading

Size Analysis Report ¹

`@firebase/firestore`

`addDoc`

`deleteDoc`

`disableNetwork`

`enableIndexedDbPersistence`

`enableMultiTabIndexedDbPersistence`

`enableNetwork`

`executeWrite`

`getCountFromServer`

`getDoc`

`getDocFromCache`

`getDocFromServer`

`getDocs`

`getDocsFromCache`

`getDocsFromServer`

`loadBundle`

`namedQuery`

`onSnapshot`

`onSnapshotsInSync`

`runTransaction`

`setDoc`

`setIndexConfiguration`

`updateDoc`

`waitForPendingWrites`

`writeBatch`

`@firebase/storage`

`_FbsBlob`

`_UploadTask`

`uploadBytes`

`uploadBytesResumable`

`uploadString`

`@firebase/util`

`getDefaults`

`isNode`

`isSafari`

github-actions bot commented Dec 20, 2022 •

edited

Loading