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.

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

fix: unknown errors should not be retried #1388

Merged
merged 1 commit into from
Jun 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/transaction-runner.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import {Database} from './database';
const jsonProtos = require('../protos/protos.json');
const RETRY_INFO = 'google.rpc.retryinfo-bin';

const RETRYABLE: grpc.status[] = [grpc.status.ABORTED, grpc.status.UNKNOWN];
const RETRYABLE: grpc.status[] = [grpc.status.ABORTED];

// tslint:disable-next-line variable-name
const RetryInfo = Root.fromJSON(jsonProtos).lookup('google.rpc.RetryInfo');
Expand Down
78 changes: 3 additions & 75 deletions test/transaction-runner.ts
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ describe('TransactionRunner', () => {

it('should reject for non-retryable errors', done => {
const fakeError = new Error('err') as grpc.ServiceError;
fakeError.code = grpc.status.DEADLINE_EXCEEDED;
fakeError.code = grpc.status.UNKNOWN;

runFn.rejects(fakeError);

Expand Down Expand Up @@ -273,26 +273,6 @@ describe('TransactionRunner', () => {
assert.strictEqual(delayStub.callCount, 1);
});

it('should retry on UNKNOWN errors', async () => {
const fakeReturnValue = 12;
const fakeError = new Error('err') as grpc.ServiceError;
fakeError.code = grpc.status.UNKNOWN;

runFn.onCall(0).rejects(fakeError);
runFn.onCall(1).resolves(fakeReturnValue);

const delayStub = sandbox
.stub(runner, 'getNextDelay')
.withArgs(fakeError)
.returns(0);

const returnValue = await runner.run();

assert.strictEqual(returnValue, fakeReturnValue);
assert.strictEqual(runner.attempts, 1);
assert.strictEqual(delayStub.callCount, 1);
});

it('should throw a DeadlineError if the timeout is exceeded', done => {
const fakeError = new Error('err') as grpc.ServiceError;
fakeError.code = grpc.status.ABORTED;
Expand Down Expand Up @@ -394,7 +374,7 @@ describe('TransactionRunner', () => {

it('should return non-retryable request errors', async () => {
const fakeError = new Error('err') as grpc.ServiceError;
fakeError.code = grpc.status.DEADLINE_EXCEEDED;
fakeError.code = grpc.status.UNKNOWN;

fakeTransaction.request.withArgs(CONFIG).callsFake((_, callback) => {
callback(fakeError);
Expand Down Expand Up @@ -428,25 +408,6 @@ describe('TransactionRunner', () => {
assert.strictEqual(callbackStub.callCount, 1);
assert.strictEqual(runFn.callCount, 2);
});

it('should intercept UNKNOWN request errors', async () => {
const fakeError = new Error('err') as grpc.ServiceError;
fakeError.code = grpc.status.UNKNOWN;

fakeTransaction.request
.onCall(0)
.callsFake((_, callback) => callback(fakeError));

fakeTransaction.request.onCall(1).callsFake((_, callback) => {
callback(null);
setImmediate(() => fakeTransaction.emit('end'));
});

await runner.run();

assert.strictEqual(callbackStub.callCount, 1);
assert.strictEqual(runFn.callCount, 2);
});
});

describe('transaction streams', () => {
Expand Down Expand Up @@ -479,7 +440,7 @@ describe('TransactionRunner', () => {
fakeTransaction.requestStream.withArgs(CONFIG).returns(fakeStream);

const fakeError = new Error('err') as grpc.ServiceError;
fakeError.code = grpc.status.DEADLINE_EXCEEDED;
fakeError.code = grpc.status.UNKNOWN;

runFn.callsFake((err, transaction) => {
assert.ifError(err);
Expand Down Expand Up @@ -526,39 +487,6 @@ describe('TransactionRunner', () => {
runner.run().catch(done);
setImmediate(() => badStream.destroy(fakeError));
});

it('should intercept UNKNOWN streaming errors', done => {
const badStream = through.obj();
const goodStream = through.obj();

const fakeError = new Error('err') as grpc.ServiceError;
fakeError.code = grpc.status.UNKNOWN;

const fakeData = [{a: 'b'}, {c: 'd'}, {e: 'f'}];
fakeData.forEach(data => goodStream.push(data));
goodStream.push(null);

fakeTransaction.requestStream.onCall(0).returns(badStream);
fakeTransaction.requestStream.onCall(1).returns(goodStream);

runFn.callsFake((err, transaction) => {
assert.ifError(err);

transaction
.requestStream(CONFIG)
.on('error', done)
.pipe(
concat(data => {
assert.deepStrictEqual(data, fakeData);
assert.strictEqual(runFn.callCount, 2);
done();
})
);
});

runner.run().catch(done);
setImmediate(() => badStream.destroy(fakeError));
});
});
});
});
Expand Down