Skip to content

Do not throw from connection.send in Node.js #5578

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.

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

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 6, 2021
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/curvy-peaches-deliver.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@firebase/storage": patch
---

Do not throw from `connection.send` to enable retries in Node.js.
4 changes: 4 additions & 0 deletions packages/storage/src/implementation/connection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ export type Headers = Record<string, string>;
* goog.net.XhrIo-like interface.
*/
export interface Connection {
/**
* This method should never reject. In case of encountering an error, set an error code internally which can be accessed
* by calling getErrorCode() by callers.
*/
send(
url: string,
method: string,
Expand Down
1 change: 1 addition & 0 deletions packages/storage/src/implementation/request.ts
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ class NetworkRequest<T> implements Request<T> {
connection.addUploadProgressListener(progressListener);
}

// connection.send() never rejects, so we don't need to have a error handler or use catch on the returned promise.
// eslint-disable-next-line @typescript-eslint/no-floating-promises
connection
.send(this.url_, this.method_, this.body_, this.headers_)
Expand Down
20 changes: 11 additions & 9 deletions packages/storage/src/platform/node/connection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,7 @@

import { ErrorCode, Connection } from '../../implementation/connection';
import { internalError } from '../../implementation/error';
import nodeFetch from 'node-fetch';

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const fetch: typeof window.fetch = nodeFetch as any;
import nodeFetch, { FetchError } from 'node-fetch';

/**
* Network layer that works in Node.
Expand All @@ -34,6 +31,8 @@ export class FetchConnection implements Connection {
private body_: string | undefined;
private headers_: Headers | undefined;
private sent_: boolean = false;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
private fetch_: typeof window.fetch = nodeFetch as any;

constructor() {
this.errorCode_ = ErrorCode.NO_ERROR;
Expand All @@ -50,18 +49,21 @@ export class FetchConnection implements Connection {
}
this.sent_ = true;

return fetch(url, {
return this.fetch_(url, {
method,
headers: headers || {},
body
})
.then(resp => {
this.headers_ = resp.headers;
this.statusCode_ = resp.status;
return resp.text();
})
.then(body => {
this.body_ = body;
return resp.text().then(body => {
this.body_ = body;
});
}, (_err: FetchError) => {
this.errorCode_ = ErrorCode.NETWORK_ERROR;
// emulate XHR which sets status to 0 when encountering a network error
this.statusCode_ = 0;
});
}

Expand Down
17 changes: 17 additions & 0 deletions packages/storage/test/browser/connection.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import { expect } from "chai";
import { SinonFakeXMLHttpRequest, useFakeXMLHttpRequest } from "sinon";
import { ErrorCode } from "../../src/implementation/connection";
import { XhrConnection } from "../../src/platform/browser/connection";

describe('Connections', () => {
it('XhrConnection.send() should not reject on network errors', async () => {
const fakeXHR = useFakeXMLHttpRequest();
const connection = new XhrConnection();
const sendPromise = connection.send('testurl', 'GET');
// simulate an network error
((connection as any).xhr_ as SinonFakeXMLHttpRequest).error();
await sendPromise;
expect(connection.getErrorCode()).to.equal(ErrorCode.NETWORK_ERROR);
fakeXHR.restore();
});
});
15 changes: 15 additions & 0 deletions packages/storage/test/unit/connection.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { stub } from 'sinon';
import { expect } from 'chai';
import { ErrorCode } from '../../src/implementation/connection';
import { FetchConnection } from '../../src/platform/node/connection';

describe('Connections', () => {
it('FetchConnection.send() should not reject on network errors', async () => {
const connection = new FetchConnection();

// need the casting here because fetch_ is a private member
stub(connection as any, 'fetch_').rejects();
await connection.send('testurl', 'GET');
expect(connection.getErrorCode()).to.equal(ErrorCode.NETWORK_ERROR);
});
});