-
Notifications
You must be signed in to change notification settings - Fork 885
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Env Override Global Variable
forceEnvironment (#6901)
* Add forceEnvironment and check value in isNode * Update API reports * Add tests for environment package * Update tests and remove console.log * Add changeset * Remove old changeset and update it with a new one * Update jsdoc * Move getGlobal into separate file to remove circular dep
- Loading branch information
1 parent
a7622d4
commit 06dc136
Showing
9 changed files
with
127 additions
and
32 deletions.
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| '@firebase/util': minor | ||
| 'firebase': minor | ||
| --- | ||
|
|
||
| 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. |
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| /** | ||
| * @license | ||
| * Copyright 2022 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. | ||
| */ | ||
|
|
||
| /** | ||
| * Polyfill for `globalThis` object. | ||
| * @returns the `globalThis` object for the given environment. | ||
| * @public | ||
| */ | ||
| export function getGlobal(): typeof globalThis { | ||
| if (typeof self !== 'undefined') { | ||
| return self; | ||
| } | ||
| if (typeof window !== 'undefined') { | ||
| return window; | ||
| } | ||
| if (typeof global !== 'undefined') { | ||
| return global; | ||
| } | ||
| throw new Error('Unable to locate global object.'); | ||
| } |
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| /** | ||
| * @license | ||
| * Copyright 2022 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 { isNode } from '../src/environment'; | ||
| import { SinonStub, stub, restore } from 'sinon'; | ||
| import * as defaults from '../src/defaults'; | ||
|
|
||
| const firebaseDefaults: defaults.FirebaseDefaults = { | ||
| _authTokenSyncURL: 'string', | ||
| _authIdTokenMaxAge: 200, | ||
| forceEnvironment: 'node' | ||
| }; | ||
|
|
||
| describe('isNode()', () => { | ||
| let getDefaultsFromGlobalStub: SinonStub; | ||
|
|
||
| beforeEach(async () => { | ||
| getDefaultsFromGlobalStub = stub(defaults, 'getDefaults'); | ||
| }); | ||
|
|
||
| afterEach(async () => { | ||
| restore(); | ||
| }); | ||
|
|
||
| it('returns true if forceEnvironment lists `node`', () => { | ||
| getDefaultsFromGlobalStub.returns(firebaseDefaults); | ||
|
|
||
| expect(isNode()).to.be.true; | ||
| }); | ||
|
|
||
| it('returns false if forceEnvironment lists `browser`', () => { | ||
| getDefaultsFromGlobalStub.returns({ | ||
| ...firebaseDefaults, | ||
| forceEnvironment: 'browser' | ||
| }); | ||
|
|
||
| expect(isNode()).to.be.false; | ||
| }); | ||
| }); |