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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

allow setting gRPC metadata #1546

Merged
merged 6 commits into from
Sep 2, 2016
Merged

allow setting gRPC metadata #1546

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6c112bf
allow setting gRPC metadata
stephenplusplus Aug 30, 2016
cbd23f3
set metadata per call
stephenplusplus Aug 31, 2016
eff7266
refactor and test
stephenplusplus Sep 1, 2016
6cc716b
always default to empty metadata
stephenplusplus Sep 2, 2016
9cf0c10
lint issue
stephenplusplus Sep 2, 2016
c68b260
Update grpc-service.js
stephenplusplus Sep 2, 2016
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
25 changes: 19 additions & 6 deletions packages/common/src/grpc-service.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ var GRPC_ERROR_CODE_TO_HTTP = {
*
* @param {object} config - Configuration object.
* @param {string} config.baseUrl - The base URL to make API requests to.
* @param {object} config.grpcMetadata - Metadata to send with every request.
* @param {string[]} config.scopes - The scopes required for the request.
* @param {string} config.service - The name of the service.
* @param {object=} config.protoServices - Directly provide the required proto
Expand All @@ -158,6 +159,16 @@ function GrpcService(config, options) {
this.grpcCredentials = grpc.credentials.createInsecure();
}

this.grpcMetadata = new grpc.Metadata();

if (config.grpcMetadata) {
for (var prop in config.grpcMetadata) {
if (config.grpcMetadata.hasOwnProperty(prop)) {
this.grpcMetadata.add(prop, config.grpcMetadata[prop]);
}
}
}

this.maxRetries = options.maxRetries;

var apiVersion = config.apiVersion;
Expand Down Expand Up @@ -227,8 +238,10 @@ GrpcService.prototype.request = function(protoOpts, reqOpts, callback) {
delete reqOpts.autoPaginateVal;

var service = this.getService_(protoOpts);
var grpcOpts = {};

var metadata = this.grpcMetadata;

var grpcOpts = {};
if (is.number(protoOpts.timeout)) {
grpcOpts.deadline = GrpcService.createDeadline_(protoOpts.timeout);
}
Expand All @@ -248,16 +261,16 @@ GrpcService.prototype.request = function(protoOpts, reqOpts, callback) {
request: function(_, onResponse) {
respError = null;

service[protoOpts.method](reqOpts, grpcOpts, function(err, resp) {
if (err) {
respError = GrpcService.decorateError_(err);
service[protoOpts.method](reqOpts, metadata, grpcOpts, function(e, resp) {
if (e) {
respError = GrpcService.decorateError_(e);

if (respError) {
onResponse(null, respError);
return;
}

onResponse(err, resp);
onResponse(e, resp);
return;
}

Expand Down Expand Up @@ -330,7 +343,7 @@ GrpcService.prototype.requestStream = function(protoOpts, reqOpts) {
shouldRetryFn: GrpcService.shouldRetryRequest_,

request: function() {
return service[protoOpts.method](reqOpts, grpcOpts)
return service[protoOpts.method](reqOpts, self.grpcMetadata, grpcOpts)
.on('metadata', function() {
// retry-request requires a server response before it starts emitting
// data. The closest mechanism grpc provides is a metadata event, but
Expand Down
86 changes: 78 additions & 8 deletions packages/common/test/grpc-service.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,15 @@ function fakeRetryRequest() {
return (retryRequestOverride || retryRequest).apply(null, arguments);
}

var GrpcMetadataOverride;
var grpcLoadOverride;
var fakeGrpc = {
Metadata: function() {
if (GrpcMetadataOverride) {
return new GrpcMetadataOverride();
}
return new grpc.Metadata();
},
load: function() {
return (grpcLoadOverride || grpc.load).apply(null, arguments);
},
Expand Down Expand Up @@ -84,7 +91,10 @@ describe('GrpcService', function() {
var CONFIG = {
proto: {},
service: 'Service',
apiVersion: 'v1'
apiVersion: 'v1',
grpcMetadata: {
property: 'value'
}
};

var OPTIONS = {
Expand All @@ -111,6 +121,7 @@ describe('GrpcService', function() {
});

beforeEach(function() {
GrpcMetadataOverride = null;
retryRequestOverride = null;

googleProtoFilesOverride = function() {
Expand Down Expand Up @@ -232,6 +243,36 @@ describe('GrpcService', function() {
assert.strictEqual(calledWith[1], OPTIONS);
});

it('should default grpcMetadata to empty metadata', function() {
var fakeGrpcMetadata = {};

GrpcMetadataOverride = function() {
return fakeGrpcMetadata;
};

var config = extend({}, CONFIG);
delete config.grpcMetadata;

var grpcService = new GrpcService(config, OPTIONS);
assert.strictEqual(grpcService.grpcMetadata, fakeGrpcMetadata);
});

it('should create and localize grpcMetadata', function() {
var fakeGrpcMetadata = {
add: function(prop, value) {
assert.strictEqual(prop, Object.keys(CONFIG.grpcMetadata)[0]);
assert.strictEqual(value, CONFIG.grpcMetadata[prop]);
}
};

GrpcMetadataOverride = function() {
return fakeGrpcMetadata;
};

var grpcService = new GrpcService(CONFIG, OPTIONS);
assert.strictEqual(grpcService.grpcMetadata, fakeGrpcMetadata);
});

it('should localize maxRetries', function() {
assert.strictEqual(grpcService.maxRetries, OPTIONS.maxRetries);
});
Expand Down Expand Up @@ -738,7 +779,7 @@ describe('GrpcService', function() {
grpcService.protos.Service = {
service: function() {
return {
method: function(reqOpts, grpcOpts, callback) {
method: function(reqOpts, metadata, grpcOpts, callback) {
callback(grpcError500);
}
};
Expand All @@ -763,7 +804,7 @@ describe('GrpcService', function() {
grpcService.protos.Service = {
service: function() {
return {
method: function(reqOpts, grpcOpts, callback) {
method: function(reqOpts, metadata, grpcOpts, callback) {
callback(grpcError500);
}
};
Expand All @@ -787,7 +828,7 @@ describe('GrpcService', function() {
grpcService.protos.Service = {
service: function() {
return {
method: function(reqOpts, grpcOpts, callback) {
method: function(reqOpts, metadata, grpcOpts, callback) {
callback(unknownError, null);
}
};
Expand Down Expand Up @@ -821,6 +862,21 @@ describe('GrpcService', function() {
grpcService.request(PROTO_OPTS, REQ_OPTS, assert.ifError);
});

it('should pass the grpc metadata with the request', function(done) {
grpcService.protos.Service = {
service: function() {
return {
method: function(reqOpts, metadata) {
assert.strictEqual(metadata, grpcService.grpcMetadata);
done();
}
};
}
};

grpcService.request(PROTO_OPTS, REQ_OPTS, assert.ifError);
});

it('should set a deadline if a timeout is provided', function(done) {
var expectedDeadlineRange = [
Date.now() + PROTO_OPTS.timeout - 250,
Expand All @@ -830,7 +886,7 @@ describe('GrpcService', function() {
grpcService.protos.Service = {
service: function() {
return {
method: function(reqOpts, grpcOpts) {
method: function(reqOpts, metadata, grpcOpts) {
assert(is.date(grpcOpts.deadline));

assert(grpcOpts.deadline.getTime() > expectedDeadlineRange[0]);
Expand Down Expand Up @@ -874,7 +930,7 @@ describe('GrpcService', function() {
grpcService.protos.Service = {
service: function() {
return {
method: function(reqOpts, grpcOpts, callback) {
method: function(reqOpts, metadata, grpcOpts, callback) {
callback(grpcError);
}
};
Expand All @@ -896,7 +952,7 @@ describe('GrpcService', function() {
grpcService.protos.Service = {
service: function() {
return {
method: function(reqOpts, grpcOpts, callback) {
method: function(reqOpts, metadata, grpcOpts, callback) {
callback(null, RESPONSE);
}
};
Expand Down Expand Up @@ -976,7 +1032,7 @@ describe('GrpcService', function() {
return fakeDeadline;
};

ProtoService.prototype.method = function(reqOpts, grpcOpts) {
ProtoService.prototype.method = function(reqOpts, metadata, grpcOpts) {
assert.strictEqual(grpcOpts.deadline, fakeDeadline);

GrpcService.createDeadline_ = createDeadline;
Expand All @@ -992,6 +1048,20 @@ describe('GrpcService', function() {
grpcService.requestStream(PROTO_OPTS, REQ_OPTS);
});

it('should pass the grpc metadata with the request', function(done) {
ProtoService.prototype.method = function(reqOpts, metadata) {
assert.strictEqual(metadata, grpcService.grpcMetadata);
setImmediate(done);
return through.obj();
};

retryRequestOverride = function(_, retryOpts) {
return retryOpts.request();
};

grpcService.requestStream(PROTO_OPTS, REQ_OPTS);
});

describe('getting gRPC credentials', function() {
beforeEach(function() {
delete grpcService.grpcCredentials;
Expand Down