mirror of https://github.com/grpc/grpc-node.git
620 lines
16 KiB
TypeScript
620 lines
16 KiB
TypeScript
/*
|
|
* Copyright 2019 gRPC authors.
|
|
*
|
|
* 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.
|
|
*
|
|
*/
|
|
|
|
// Allow `any` data type for testing runtime type checking.
|
|
// tslint:disable no-any
|
|
import * as assert from 'assert';
|
|
import {join} from 'path';
|
|
|
|
import * as grpc from '../src';
|
|
import {ServiceError} from '../src/call';
|
|
import {ServiceClient, ServiceClientConstructor} from '../src/make-client';
|
|
import {Server} from '../src/server';
|
|
import {sendUnaryData, ServerDuplexStream, ServerReadableStream, ServerUnaryCall, ServerWritableStream} from '../src/server-call';
|
|
|
|
import {loadProtoFile} from './common';
|
|
|
|
const protoFile = join(__dirname, 'fixtures', 'test_service.proto');
|
|
const testServiceDef = loadProtoFile(protoFile);
|
|
const testServiceClient =
|
|
testServiceDef.TestService as ServiceClientConstructor;
|
|
const clientInsecureCreds = grpc.credentials.createInsecure();
|
|
const serverInsecureCreds = grpc.ServerCredentials.createInsecure();
|
|
|
|
|
|
describe('Client malformed response handling', () => {
|
|
let server: Server;
|
|
let client: ServiceClient;
|
|
const badArg = Buffer.from([0xFF]);
|
|
|
|
before((done) => {
|
|
const malformedTestService = {
|
|
unary: {
|
|
path: '/TestService/Unary',
|
|
requestStream: false,
|
|
responseStream: false,
|
|
requestDeserialize: identity,
|
|
responseSerialize: identity
|
|
},
|
|
clientStream: {
|
|
path: '/TestService/ClientStream',
|
|
requestStream: true,
|
|
responseStream: false,
|
|
requestDeserialize: identity,
|
|
responseSerialize: identity
|
|
},
|
|
serverStream: {
|
|
path: '/TestService/ServerStream',
|
|
requestStream: false,
|
|
responseStream: true,
|
|
requestDeserialize: identity,
|
|
responseSerialize: identity
|
|
},
|
|
bidiStream: {
|
|
path: '/TestService/BidiStream',
|
|
requestStream: true,
|
|
responseStream: true,
|
|
requestDeserialize: identity,
|
|
responseSerialize: identity
|
|
}
|
|
} as any;
|
|
|
|
server = new Server();
|
|
|
|
server.addService(malformedTestService, {
|
|
unary(call: ServerUnaryCall<any, any>, cb: sendUnaryData<any>) {
|
|
cb(null, badArg);
|
|
},
|
|
|
|
clientStream(
|
|
stream: ServerReadableStream<any, any>, cb: sendUnaryData<any>) {
|
|
stream.on('data', noop);
|
|
stream.on('end', () => {
|
|
cb(null, badArg);
|
|
});
|
|
},
|
|
|
|
serverStream(stream: ServerWritableStream<any, any>) {
|
|
stream.write(badArg);
|
|
stream.end();
|
|
},
|
|
|
|
bidiStream(stream: ServerDuplexStream<any, any>) {
|
|
stream.on('data', () => {
|
|
// Ignore requests
|
|
stream.write(badArg);
|
|
});
|
|
|
|
stream.on('end', () => {
|
|
stream.end();
|
|
});
|
|
}
|
|
});
|
|
|
|
server.bindAsync('localhost:0', serverInsecureCreds, (err, port) => {
|
|
assert.ifError(err);
|
|
client = new testServiceClient(`localhost:${port}`, clientInsecureCreds);
|
|
server.start();
|
|
done();
|
|
});
|
|
});
|
|
|
|
after((done) => {
|
|
client.close();
|
|
server.tryShutdown(done);
|
|
});
|
|
|
|
it('should get an INTERNAL status with a unary call', (done) => {
|
|
client.unary({}, (err: ServiceError, data: any) => {
|
|
assert(err);
|
|
assert.strictEqual(err.code, grpc.status.INTERNAL);
|
|
done();
|
|
});
|
|
});
|
|
|
|
it('should get an INTERNAL status with a client stream call', (done) => {
|
|
const call = client.clientStream((err: ServiceError, data: any) => {
|
|
assert(err);
|
|
assert.strictEqual(err.code, grpc.status.INTERNAL);
|
|
done();
|
|
});
|
|
|
|
call.write({});
|
|
call.end();
|
|
});
|
|
|
|
it('should get an INTERNAL status with a server stream call', (done) => {
|
|
const call = client.serverStream({});
|
|
|
|
call.on('data', noop);
|
|
call.on('error', (err: ServiceError) => {
|
|
assert(err);
|
|
assert.strictEqual(err.code, grpc.status.INTERNAL);
|
|
done();
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('Server serialization failure handling', () => {
|
|
let client: ServiceClient;
|
|
let server: Server;
|
|
|
|
before((done) => {
|
|
function serializeFail(obj: any) {
|
|
throw new Error('Serialization failed');
|
|
}
|
|
|
|
const malformedTestService = {
|
|
unary: {
|
|
path: '/TestService/Unary',
|
|
requestStream: false,
|
|
responseStream: false,
|
|
requestDeserialize: identity,
|
|
responseSerialize: serializeFail
|
|
},
|
|
clientStream: {
|
|
path: '/TestService/ClientStream',
|
|
requestStream: true,
|
|
responseStream: false,
|
|
requestDeserialize: identity,
|
|
responseSerialize: serializeFail
|
|
},
|
|
serverStream: {
|
|
path: '/TestService/ServerStream',
|
|
requestStream: false,
|
|
responseStream: true,
|
|
requestDeserialize: identity,
|
|
responseSerialize: serializeFail
|
|
},
|
|
bidiStream: {
|
|
path: '/TestService/BidiStream',
|
|
requestStream: true,
|
|
responseStream: true,
|
|
requestDeserialize: identity,
|
|
responseSerialize: serializeFail
|
|
}
|
|
};
|
|
|
|
server = new Server();
|
|
server.addService(malformedTestService as any, {
|
|
unary(call: ServerUnaryCall<any, any>, cb: sendUnaryData<any>) {
|
|
cb(null, {});
|
|
},
|
|
|
|
clientStream(
|
|
stream: ServerReadableStream<any, any>, cb: sendUnaryData<any>) {
|
|
stream.on('data', noop);
|
|
stream.on('end', () => {
|
|
cb(null, {});
|
|
});
|
|
},
|
|
|
|
serverStream(stream: ServerWritableStream<any, any>) {
|
|
stream.write({});
|
|
stream.end();
|
|
},
|
|
|
|
bidiStream(stream: ServerDuplexStream<any, any>) {
|
|
stream.on('data', () => {
|
|
// Ignore requests
|
|
stream.write({});
|
|
});
|
|
stream.on('end', () => {
|
|
stream.end();
|
|
});
|
|
}
|
|
});
|
|
|
|
server.bindAsync('localhost:0', serverInsecureCreds, (err, port) => {
|
|
assert.ifError(err);
|
|
client = new testServiceClient(`localhost:${port}`, clientInsecureCreds);
|
|
server.start();
|
|
done();
|
|
});
|
|
});
|
|
|
|
after((done) => {
|
|
client.close();
|
|
server.tryShutdown(done);
|
|
});
|
|
|
|
it('should get an INTERNAL status with a unary call', (done) => {
|
|
client.unary({}, (err: ServiceError, data: any) => {
|
|
assert(err);
|
|
assert.strictEqual(err.code, grpc.status.INTERNAL);
|
|
done();
|
|
});
|
|
});
|
|
|
|
it('should get an INTERNAL status with a client stream call', (done) => {
|
|
const call = client.clientStream((err: ServiceError, data: any) => {
|
|
assert(err);
|
|
assert.strictEqual(err.code, grpc.status.INTERNAL);
|
|
done();
|
|
});
|
|
|
|
call.write({});
|
|
call.end();
|
|
});
|
|
|
|
it('should get an INTERNAL status with a server stream call', (done) => {
|
|
const call = client.serverStream({});
|
|
|
|
call.on('data', noop);
|
|
call.on('error', (err: ServiceError) => {
|
|
assert(err);
|
|
assert.strictEqual(err.code, grpc.status.INTERNAL);
|
|
done();
|
|
});
|
|
});
|
|
});
|
|
|
|
|
|
describe('Other conditions', () => {
|
|
let client: ServiceClient;
|
|
let server: Server;
|
|
let port: number;
|
|
|
|
before((done) => {
|
|
const trailerMetadata = new grpc.Metadata();
|
|
|
|
server = new Server();
|
|
trailerMetadata.add('trailer-present', 'yes');
|
|
|
|
server.addService(testServiceClient.service, {
|
|
unary(call: ServerUnaryCall<any, any>, cb: sendUnaryData<any>) {
|
|
const req = call.request;
|
|
|
|
if (req.error) {
|
|
const details = req.message || 'Requested error';
|
|
|
|
cb({code: grpc.status.UNKNOWN, details} as ServiceError, null,
|
|
trailerMetadata);
|
|
} else {
|
|
cb(null, {count: 1}, trailerMetadata);
|
|
}
|
|
},
|
|
|
|
clientStream(
|
|
stream: ServerReadableStream<any, any>, cb: sendUnaryData<any>) {
|
|
let count = 0;
|
|
let errored = false;
|
|
|
|
stream.on('data', (data: any) => {
|
|
if (data.error) {
|
|
const message = data.message || 'Requested error';
|
|
errored = true;
|
|
cb(new Error(message) as ServiceError, null, trailerMetadata);
|
|
} else {
|
|
count++;
|
|
}
|
|
});
|
|
|
|
stream.on('end', () => {
|
|
if (!errored) {
|
|
cb(null, {count}, trailerMetadata);
|
|
}
|
|
});
|
|
},
|
|
|
|
serverStream(stream: ServerWritableStream<any, any>) {
|
|
const req = stream.request;
|
|
|
|
if (req.error) {
|
|
stream.emit('error', {
|
|
code: grpc.status.UNKNOWN,
|
|
details: req.message || 'Requested error',
|
|
metadata: trailerMetadata
|
|
});
|
|
} else {
|
|
for (let i = 0; i < 5; i++) {
|
|
stream.write({count: i});
|
|
}
|
|
|
|
stream.end(trailerMetadata);
|
|
}
|
|
},
|
|
|
|
bidiStream(stream: ServerDuplexStream<any, any>) {
|
|
let count = 0;
|
|
stream.on('data', (data: any) => {
|
|
if (data.error) {
|
|
const message = data.message || 'Requested error';
|
|
const err = new Error(message) as ServiceError;
|
|
|
|
err.metadata = trailerMetadata.clone();
|
|
err.metadata.add('count', '' + count);
|
|
stream.emit('error', err);
|
|
} else {
|
|
stream.write({count});
|
|
count++;
|
|
}
|
|
});
|
|
|
|
stream.on('end', () => {
|
|
stream.end(trailerMetadata);
|
|
});
|
|
}
|
|
});
|
|
|
|
server.bindAsync('localhost:0', serverInsecureCreds, (err, _port) => {
|
|
assert.ifError(err);
|
|
port = _port;
|
|
client = new testServiceClient(`localhost:${port}`, clientInsecureCreds);
|
|
server.start();
|
|
done();
|
|
});
|
|
});
|
|
|
|
after((done) => {
|
|
client.close();
|
|
server.tryShutdown(done);
|
|
});
|
|
|
|
describe('Server receiving bad input', () => {
|
|
let misbehavingClient: ServiceClient;
|
|
const badArg = Buffer.from([0xFF]);
|
|
|
|
before(() => {
|
|
const testServiceAttrs = {
|
|
unary: {
|
|
path: '/TestService/Unary',
|
|
requestStream: false,
|
|
responseStream: false,
|
|
requestSerialize: identity,
|
|
responseDeserialize: identity
|
|
},
|
|
clientStream: {
|
|
path: '/TestService/ClientStream',
|
|
requestStream: true,
|
|
responseStream: false,
|
|
requestSerialize: identity,
|
|
responseDeserialize: identity
|
|
},
|
|
serverStream: {
|
|
path: '/TestService/ServerStream',
|
|
requestStream: false,
|
|
responseStream: true,
|
|
requestSerialize: identity,
|
|
responseDeserialize: identity
|
|
},
|
|
bidiStream: {
|
|
path: '/TestService/BidiStream',
|
|
requestStream: true,
|
|
responseStream: true,
|
|
requestSerialize: identity,
|
|
responseDeserialize: identity
|
|
}
|
|
} as any;
|
|
|
|
const client =
|
|
grpc.makeGenericClientConstructor(testServiceAttrs, 'TestService');
|
|
|
|
misbehavingClient = new client(`localhost:${port}`, clientInsecureCreds);
|
|
});
|
|
|
|
after(() => {
|
|
misbehavingClient.close();
|
|
});
|
|
|
|
it('should respond correctly to a unary call', (done) => {
|
|
misbehavingClient.unary(badArg, (err: ServiceError, data: any) => {
|
|
assert(err);
|
|
assert.strictEqual(err.code, grpc.status.INTERNAL);
|
|
done();
|
|
});
|
|
});
|
|
|
|
it('should respond correctly to a client stream', (done) => {
|
|
const call =
|
|
misbehavingClient.clientStream((err: ServiceError, data: any) => {
|
|
assert(err);
|
|
assert.strictEqual(err.code, grpc.status.INTERNAL);
|
|
done();
|
|
});
|
|
|
|
call.write(badArg);
|
|
call.end();
|
|
});
|
|
|
|
it('should respond correctly to a server stream', (done) => {
|
|
const call = misbehavingClient.serverStream(badArg);
|
|
|
|
call.on('data', (data: any) => {
|
|
assert.fail(data);
|
|
});
|
|
|
|
call.on('error', (err: ServiceError) => {
|
|
assert(err);
|
|
assert.strictEqual(err.code, grpc.status.INTERNAL);
|
|
done();
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('Trailing metadata', () => {
|
|
it('should be present when a unary call succeeds', (done) => {
|
|
let count = 0;
|
|
const call =
|
|
client.unary({error: false}, (err: ServiceError, data: any) => {
|
|
assert.ifError(err);
|
|
|
|
count++;
|
|
if (count === 2) {
|
|
done();
|
|
}
|
|
});
|
|
|
|
call.on('status', (status: grpc.StatusObject) => {
|
|
assert.deepStrictEqual(status.metadata.get('trailer-present'), ['yes']);
|
|
|
|
count++;
|
|
if (count === 2) {
|
|
done();
|
|
}
|
|
});
|
|
});
|
|
|
|
it('should be present when a unary call fails', (done) => {
|
|
let count = 0;
|
|
const call =
|
|
client.unary({error: true}, (err: ServiceError, data: any) => {
|
|
assert(err);
|
|
|
|
count++;
|
|
if (count === 2) {
|
|
done();
|
|
}
|
|
});
|
|
|
|
call.on('status', (status: grpc.StatusObject) => {
|
|
assert.deepStrictEqual(status.metadata.get('trailer-present'), ['yes']);
|
|
|
|
count++;
|
|
if (count === 2) {
|
|
done();
|
|
}
|
|
});
|
|
});
|
|
|
|
it('should be present when a client stream call succeeds', (done) => {
|
|
let count = 0;
|
|
const call = client.clientStream((err: ServiceError, data: any) => {
|
|
assert.ifError(err);
|
|
|
|
count++;
|
|
if (count === 2) {
|
|
done();
|
|
}
|
|
});
|
|
|
|
call.write({error: false});
|
|
call.write({error: false});
|
|
call.end();
|
|
|
|
call.on('status', (status: grpc.StatusObject) => {
|
|
assert.deepStrictEqual(status.metadata.get('trailer-present'), ['yes']);
|
|
|
|
count++;
|
|
if (count === 2) {
|
|
done();
|
|
}
|
|
});
|
|
});
|
|
|
|
it('should be present when a client stream call fails', (done) => {
|
|
let count = 0;
|
|
const call = client.clientStream((err: ServiceError, data: any) => {
|
|
assert(err);
|
|
|
|
count++;
|
|
if (count === 2) {
|
|
done();
|
|
}
|
|
});
|
|
|
|
call.write({error: false});
|
|
call.write({error: true});
|
|
call.end();
|
|
|
|
call.on('status', (status: grpc.StatusObject) => {
|
|
assert.deepStrictEqual(status.metadata.get('trailer-present'), ['yes']);
|
|
|
|
count++;
|
|
if (count === 2) {
|
|
done();
|
|
}
|
|
});
|
|
});
|
|
|
|
it('should be present when a server stream call succeeds', (done) => {
|
|
const call = client.serverStream({error: false});
|
|
|
|
call.on('data', noop);
|
|
call.on('status', (status: grpc.StatusObject) => {
|
|
assert.strictEqual(status.code, grpc.status.OK);
|
|
assert.deepStrictEqual(status.metadata.get('trailer-present'), ['yes']);
|
|
done();
|
|
});
|
|
});
|
|
|
|
it('should be present when a server stream call fails', (done) => {
|
|
const call = client.serverStream({error: true});
|
|
|
|
call.on('data', noop);
|
|
call.on('error', (error: ServiceError) => {
|
|
assert.deepStrictEqual(error.metadata.get('trailer-present'), ['yes']);
|
|
done();
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('Error object should contain the status', () => {
|
|
it('for a unary call', (done) => {
|
|
client.unary({error: true}, (err: ServiceError, data: any) => {
|
|
assert(err);
|
|
assert.strictEqual(err.code, grpc.status.UNKNOWN);
|
|
assert.strictEqual(err.details, 'Requested error');
|
|
done();
|
|
});
|
|
});
|
|
|
|
it('for a client stream call', (done) => {
|
|
const call = client.clientStream((err: ServiceError, data: any) => {
|
|
assert(err);
|
|
assert.strictEqual(err.code, grpc.status.UNKNOWN);
|
|
assert.strictEqual(err.details, 'Requested error');
|
|
done();
|
|
});
|
|
|
|
call.write({error: false});
|
|
call.write({error: true});
|
|
call.end();
|
|
});
|
|
|
|
it('for a server stream call', (done) => {
|
|
const call = client.serverStream({error: true});
|
|
|
|
call.on('data', noop);
|
|
call.on('error', (error: ServiceError) => {
|
|
assert.strictEqual(error.code, grpc.status.UNKNOWN);
|
|
assert.strictEqual(error.details, 'Requested error');
|
|
done();
|
|
});
|
|
});
|
|
|
|
it('for a UTF-8 error message', (done) => {
|
|
client.unary(
|
|
{error: true, message: '測試字符串'},
|
|
(err: ServiceError, data: any) => {
|
|
assert(err);
|
|
assert.strictEqual(err.code, grpc.status.UNKNOWN);
|
|
assert.strictEqual(err.details, '測試字符串');
|
|
done();
|
|
});
|
|
});
|
|
});
|
|
});
|
|
|
|
|
|
function identity(arg: any): any {
|
|
return arg;
|
|
}
|
|
|
|
|
|
function noop(): void {}
|