Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Add support for environment variable FIRESTORE_PREFER_REST #1848

Merged
merged 6 commits into from
May 15, 2023
Merged

feat: Add support for environment variable FIRESTORE_PREFER_REST #1848

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fea271d
Add support for environment variable FIRESTORE_PREFER_REST
MarkDuckworth May 10, 2023
6f91f2d
Testing configuration permutations for preferRest.
MarkDuckworth May 10, 2023
fd2d775
Code improvements.
MarkDuckworth May 11, 2023
8b64ab7
PR feedback.
MarkDuckworth May 12, 2023
b0c00c3
PR feedback.
MarkDuckworth May 15, 2023
cac5c8c
80-column limit
MarkDuckworth May 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions dev/src/util.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,10 +222,10 @@ export function wrapError(err: Error, stack: string): Error {
* Parses the value of the environment variable FIRESTORE_PREFER_REST, and returns
* a value indicating if the environment variable enables or disables preferRest.
*
* This method will warn to the console if the environment variable is set to an unsupported value.
* This function will warn to the console if the environment variable is set to an unsupported value.
MarkDuckworth marked this conversation as resolved.
Show resolved Hide resolved
*
* @return {boolean | undefined} `true` if the environment variable enables `preferRest`,
* `false` if the environment variable disable `preferRest`, or `undefined` if the
* @return `true` if the environment variable enables `preferRest`,
* `false` if the environment variable disables `preferRest`, or `undefined` if the
* environment variable is not set or is set to an unsupported value.
*/
export function tryGetPreferRestEnvironmentVariable(): boolean | undefined {
Expand Down
24 changes: 8 additions & 16 deletions dev/test/util.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,51 +58,43 @@ describe('isPlainObject()', () => {

it('reads true', async () => {
process.env.FIRESTORE_PREFER_REST = 'true';
const prevValue = tryGetPreferRestEnvironmentVariable();
expect(prevValue).to.be.true;
expect(tryGetPreferRestEnvironmentVariable()).to.be.true;
});

it('reads 1', async () => {
process.env.FIRESTORE_PREFER_REST = '1';
const prevValue = tryGetPreferRestEnvironmentVariable();
expect(prevValue).to.be.true;
expect(tryGetPreferRestEnvironmentVariable()).to.be.true;
});

it('reads false', async () => {
process.env.FIRESTORE_PREFER_REST = 'false';
const prevValue = tryGetPreferRestEnvironmentVariable();
expect(prevValue).to.be.false;
expect(tryGetPreferRestEnvironmentVariable()).to.be.false;
});

it('reads 0', async () => {
process.env.FIRESTORE_PREFER_REST = '0';
const prevValue = tryGetPreferRestEnvironmentVariable();
expect(prevValue).to.be.false;
expect(tryGetPreferRestEnvironmentVariable()).to.be.false;
});

it('ignores case', async () => {
dconeybe marked this conversation as resolved.
Show resolved Hide resolved
process.env.FIRESTORE_PREFER_REST = 'True';
const prevValue = tryGetPreferRestEnvironmentVariable();
expect(prevValue).to.be.true;
expect(tryGetPreferRestEnvironmentVariable()).to.be.true;
});

it('trims whitespace', async () => {
process.env.FIRESTORE_PREFER_REST = ' true ';
const prevValue = tryGetPreferRestEnvironmentVariable();
expect(prevValue).to.be.true;
expect(tryGetPreferRestEnvironmentVariable()).to.be.true;
});

it('returns undefined when the environment variable is not set', async () => {
delete process.env.FIRESTORE_PREFER_REST;
const prevValue = tryGetPreferRestEnvironmentVariable();
expect(prevValue).to.be.undefined;
expect(tryGetPreferRestEnvironmentVariable()).to.be.undefined;
expect(warnSpy.calledOnce).to.be.false;
});

it('returns undefined and warns when the environment variable is set to an unsupported value', async () => {
process.env.FIRESTORE_PREFER_REST = 'enable';
const prevValue = tryGetPreferRestEnvironmentVariable();
expect(prevValue).to.be.undefined;
expect(tryGetPreferRestEnvironmentVariable()).to.be.undefined;
expect(warnSpy.calledOnce).to.be.true;
expect(warnSpy.getCall(0).args[0]).to.match(
/unsupported value.*FIRESTORE_PREFER_REST/
Expand Down