Skip to content

work around IPv6 addresses in Trace#fromRequest #35

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
29 changes: 28 additions & 1 deletion lib/trace.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
(function () {
var tracers, formatters, zipkinCore_types;
var Trace, Annotation, Endpoint, Int64;
var forEach, has, getUniqueId, getNowMicros, getHex64;
var forEach, has, getUniqueId, getNowMicros, getHex64, isIPv4;

forEach = function(obj, f){
Array.prototype.forEach.call(obj, f);
Expand Down Expand Up @@ -54,6 +54,28 @@
return Date.now() * 1000;
};

/**
* Returns true if an IP address is v4 dotted decimal
* @param {String} address
* @returns {Boolean}
*/
isIPv4 = function(address) {
var octets = address.split('.');

if (octets.length !== 4) {
return false;
}

forEach(octets, function(octet) {
var n = parseInt(octet)
if (isNaN(n) || n < 0 || n > 255) {
return false;
}
});

return true;
}

/**
* A Trace encapsulates information about the current span of this trace
* and provides a mechanism for creating new child spans and recording
Expand Down Expand Up @@ -237,6 +259,11 @@

var host = (request.socket && request.socket.address ?
request.socket.address() : {address: '127.0.0.1', port: 80});
if (host.address === '::1') {
host.address = '127.0.0.1'
} else if (!isIPv4(host.address)) {
host.address = '0.0.0.0';
}

if (serviceName === undefined || serviceName === null) {
serviceName = 'http';
Expand Down
28 changes: 28 additions & 0 deletions tests/test_trace.js
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,34 @@ module.exports = {
{method: 'GET', headers: {}}, 'this_is_a_service');
test.equal(t.endpoint.serviceName, "this_is_a_service");
test.done();
},
test_fromRequest_endpoint_with_ipv6_localhost: function(test) {
var t = new trace.Trace.fromRequest({
method: 'GET',
headers: {},
socket: {
address: function() {
return {family: 2, port: 8888, address: '::1'};
}
}
});
test.equal(t.endpoint.ipv4, '127.0.0.1');
test.equal(t.endpoint.port, 8888);
test.done();
},
test_fromRequest_endpoint_with_other_ipv6: function(test) {
var t = new trace.Trace.fromRequest({
method: 'GET',
headers: {},
socket: {
address: function() {
return {family: 2, port: 8888, address: '2001:db8::ff00:42:8329'};
}
}
});
test.equal(t.endpoint.ipv4, '0.0.0.0');
test.equal(t.endpoint.port, 8888);
test.done();
}
},
annotationTests: {
Expand Down