mirror of https://github.com/grpc/grpc-node.git
Switched to using static functions for accessing Client properties
This commit is contained in:
parent
f02ed6d312
commit
d76b6a0c4f
10
index.js
10
index.js
|
@ -164,3 +164,13 @@ exports.ServerCredentials = grpc.ServerCredentials;
|
|||
* @see module:src/client.makeClientConstructor
|
||||
*/
|
||||
exports.makeGenericClientConstructor = client.makeClientConstructor;
|
||||
|
||||
/**
|
||||
* @see module:src/client.getClientChannel
|
||||
*/
|
||||
exports.getClientChannel = client.getClientChannel;
|
||||
|
||||
/**
|
||||
* @see module:src/client.waitForClientReady
|
||||
*/
|
||||
exports.waitForClientReady = client.waitForClientReady;
|
||||
|
|
|
@ -285,7 +285,7 @@ function authTest(expected_user, scope, client, done) {
|
|||
if (credential.createScopedRequired() && scope) {
|
||||
credential = credential.createScoped(scope);
|
||||
}
|
||||
client.$_updateMetadata = grpc.getGoogleAuthDelegate(credential);
|
||||
client.$updateMetadata = grpc.getGoogleAuthDelegate(credential);
|
||||
var arg = {
|
||||
response_type: 'COMPRESSABLE',
|
||||
response_size: 314159,
|
||||
|
@ -338,7 +338,7 @@ function oauth2Test(expected_user, scope, per_rpc, client, done) {
|
|||
if (per_rpc) {
|
||||
updateMetadata('', {}, makeTestCall);
|
||||
} else {
|
||||
client.$_updateMetadata = updateMetadata;
|
||||
client.$updateMetadata = updateMetadata;
|
||||
makeTestCall(null, {});
|
||||
}
|
||||
});
|
||||
|
|
|
@ -275,7 +275,7 @@ function makeUnaryRequestFunction(method, serialize, deserialize) {
|
|||
emitter.getPeer = function getPeer() {
|
||||
return call.getPeer();
|
||||
};
|
||||
this.$_updateMetadata(this.$_auth_uri, metadata, function(error, metadata) {
|
||||
this.$updateMetadata(this.$auth_uri, metadata, function(error, metadata) {
|
||||
if (error) {
|
||||
call.cancel();
|
||||
callback(error);
|
||||
|
@ -349,7 +349,7 @@ function makeClientStreamRequestFunction(method, serialize, deserialize) {
|
|||
metadata = metadata.clone();
|
||||
}
|
||||
var stream = new ClientWritableStream(call, serialize);
|
||||
this.$_updateMetadata(this.$_auth_uri, metadata, function(error, metadata) {
|
||||
this.$updateMetadata(this.$auth_uri, metadata, function(error, metadata) {
|
||||
if (error) {
|
||||
call.cancel();
|
||||
callback(error);
|
||||
|
@ -425,7 +425,7 @@ function makeServerStreamRequestFunction(method, serialize, deserialize) {
|
|||
metadata = metadata.clone();
|
||||
}
|
||||
var stream = new ClientReadableStream(call, deserialize);
|
||||
this.$_updateMetadata(this.$_auth_uri, metadata, function(error, metadata) {
|
||||
this.$updateMetadata(this.$auth_uri, metadata, function(error, metadata) {
|
||||
if (error) {
|
||||
call.cancel();
|
||||
stream.emit('error', error);
|
||||
|
@ -503,7 +503,7 @@ function makeBidiStreamRequestFunction(method, serialize, deserialize) {
|
|||
metadata = metadata.clone();
|
||||
}
|
||||
var stream = new ClientDuplexStream(call, serialize, deserialize);
|
||||
this.$_updateMetadata(this.$_auth_uri, metadata, function(error, metadata) {
|
||||
this.$updateMetadata(this.$auth_uri, metadata, function(error, metadata) {
|
||||
if (error) {
|
||||
call.cancel();
|
||||
stream.emit('error', error);
|
||||
|
@ -594,43 +594,16 @@ exports.makeClientConstructor = function(methods, serviceName) {
|
|||
options = {};
|
||||
}
|
||||
options['grpc.primary_user_agent'] = 'grpc-node/' + version;
|
||||
/* Private fields use $ as a prefix instead of _ because it is an invalid
|
||||
* prefix of a method name */
|
||||
this.$channel = new grpc.Channel(address, credentials, options);
|
||||
// Remove the optional DNS scheme, trailing port, and trailing backslash
|
||||
address = address.replace(/^(dns:\/{3})?([^:\/]+)(:\d+)?\/?$/, '$2');
|
||||
this.$_server_address = address;
|
||||
this.$_auth_uri = 'https://' + this.server_address + '/' + serviceName;
|
||||
this.$_updateMetadata = updateMetadata;
|
||||
this.$server_address = address;
|
||||
this.$auth_uri = 'https://' + this.server_address + '/' + serviceName;
|
||||
this.$updateMetadata = updateMetadata;
|
||||
}
|
||||
|
||||
/**
|
||||
* Wait for the client to be ready. The callback will be called when the
|
||||
* client has successfully connected to the server, and it will be called
|
||||
* with an error if the attempt to connect to the server has unrecoverablly
|
||||
* failed or if the deadline expires. This function will make the channel
|
||||
* start connecting if it has not already done so.
|
||||
* @param {(Date|Number)} deadline When to stop waiting for a connection. Pass
|
||||
* Infinity to wait forever.
|
||||
* @param {function(Error)} callback The callback to call when done attempting
|
||||
* to connect.
|
||||
*/
|
||||
Client.prototype.$waitForReady = function(deadline, callback) {
|
||||
var self = this;
|
||||
var checkState = function(err) {
|
||||
if (err) {
|
||||
callback(new Error('Failed to connect before the deadline'));
|
||||
}
|
||||
var new_state = self.$channel.getConnectivityState(true);
|
||||
if (new_state === grpc.connectivityState.READY) {
|
||||
callback();
|
||||
} else if (new_state === grpc.connectivityState.FATAL_FAILURE) {
|
||||
callback(new Error('Failed to connect to server'));
|
||||
} else {
|
||||
self.$channel.watchConnectivityState(new_state, deadline, checkState);
|
||||
}
|
||||
};
|
||||
checkState();
|
||||
};
|
||||
|
||||
_.each(methods, function(attrs, name) {
|
||||
var method_type;
|
||||
if (_.startsWith(name, '$')) {
|
||||
|
@ -660,6 +633,44 @@ exports.makeClientConstructor = function(methods, serviceName) {
|
|||
return Client;
|
||||
};
|
||||
|
||||
/**
|
||||
* Return the underlying channel object for the specified client
|
||||
* @param {Client} client
|
||||
* @return {Channel} The channel
|
||||
*/
|
||||
exports.getClientChannel = function(client) {
|
||||
return client.$channel;
|
||||
};
|
||||
|
||||
/**
|
||||
* Wait for the client to be ready. The callback will be called when the
|
||||
* client has successfully connected to the server, and it will be called
|
||||
* with an error if the attempt to connect to the server has unrecoverablly
|
||||
* failed or if the deadline expires. This function will make the channel
|
||||
* start connecting if it has not already done so.
|
||||
* @param {Client} client The client to wait on
|
||||
* @param {(Date|Number)} deadline When to stop waiting for a connection. Pass
|
||||
* Infinity to wait forever.
|
||||
* @param {function(Error)} callback The callback to call when done attempting
|
||||
* to connect.
|
||||
*/
|
||||
exports.waitForClientReady = function(client, deadline, callback) {
|
||||
var checkState = function(err) {
|
||||
if (err) {
|
||||
callback(new Error('Failed to connect before the deadline'));
|
||||
}
|
||||
var new_state = client.$channel.getConnectivityState(true);
|
||||
if (new_state === grpc.connectivityState.READY) {
|
||||
callback();
|
||||
} else if (new_state === grpc.connectivityState.FATAL_FAILURE) {
|
||||
callback(new Error('Failed to connect to server'));
|
||||
} else {
|
||||
client.$channel.watchConnectivityState(new_state, deadline, checkState);
|
||||
}
|
||||
};
|
||||
checkState();
|
||||
};
|
||||
|
||||
/**
|
||||
* Creates a constructor for clients for the given service
|
||||
* @param {ProtoBuf.Reflect.Service} service The service to generate a client
|
||||
|
|
|
@ -151,7 +151,7 @@ describe('Client constructor building', function() {
|
|||
}, /\$/);
|
||||
});
|
||||
});
|
||||
describe('Client#$waitForReady', function() {
|
||||
describe('waitForClientReady', function() {
|
||||
var server;
|
||||
var port;
|
||||
var Client;
|
||||
|
@ -169,13 +169,13 @@ describe('Client#$waitForReady', function() {
|
|||
server.forceShutdown();
|
||||
});
|
||||
it('should complete when called alone', function(done) {
|
||||
client.$waitForReady(Infinity, function(error) {
|
||||
grpc.waitForClientReady(client, Infinity, function(error) {
|
||||
assert.ifError(error);
|
||||
done();
|
||||
});
|
||||
});
|
||||
it('should complete when a call is initiated', function(done) {
|
||||
client.$waitForReady(Infinity, function(error) {
|
||||
grpc.waitForClientReady(client, Infinity, function(error) {
|
||||
assert.ifError(error);
|
||||
done();
|
||||
});
|
||||
|
@ -184,19 +184,19 @@ describe('Client#$waitForReady', function() {
|
|||
});
|
||||
it('should complete if called more than once', function(done) {
|
||||
done = multiDone(done, 2);
|
||||
client.$waitForReady(Infinity, function(error) {
|
||||
grpc.waitForClientReady(client, Infinity, function(error) {
|
||||
assert.ifError(error);
|
||||
done();
|
||||
});
|
||||
client.$waitForReady(Infinity, function(error) {
|
||||
grpc.waitForClientReady(client, Infinity, function(error) {
|
||||
assert.ifError(error);
|
||||
done();
|
||||
});
|
||||
});
|
||||
it('should complete if called when already ready', function(done) {
|
||||
client.$waitForReady(Infinity, function(error) {
|
||||
grpc.waitForClientReady(client, Infinity, function(error) {
|
||||
assert.ifError(error);
|
||||
client.$waitForReady(Infinity, function(error) {
|
||||
grpc.waitForClientReady(client, Infinity, function(error) {
|
||||
assert.ifError(error);
|
||||
done();
|
||||
});
|
||||
|
@ -444,7 +444,8 @@ describe('Other conditions', function() {
|
|||
server.forceShutdown();
|
||||
});
|
||||
it('channel.getTarget should be available', function() {
|
||||
assert.strictEqual(typeof client.$channel.getTarget(), 'string');
|
||||
assert.strictEqual(typeof grpc.getClientChannel(client).getTarget(),
|
||||
'string');
|
||||
});
|
||||
describe('Server recieving bad input', function() {
|
||||
var misbehavingClient;
|
||||
|
|
Loading…
Reference in New Issue