Skip to content

fix: Check inputs type before doing truncation #1299

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

Merged
merged 1 commit into from
Apr 12, 2018
Merged

fix: Check inputs type before doing truncation #1299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 9 additions & 4 deletions src/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,13 @@ function objectFrozen(obj) {
}

function truncate(str, max) {
return !max || str.length <= max ? str : str.substr(0, max) + '\u2026';
if (typeof max !== 'number') {
throw new Error('2nd argument to `truncate` function should be a number');
}
if (typeof str !== 'string' || max === 0) {
return str;
}
return str.length <= max ? str : str.substr(0, max) + '\u2026';
}

/**
Expand Down Expand Up @@ -459,10 +465,9 @@ function jsonSize(value) {
}

function serializeValue(value) {
var maxLength = 40;

if (typeof value === 'string') {
return value.length <= maxLength ? value : value.substr(0, maxLength - 1) + '\u2026';
var maxLength = 40;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

was this change just tangential, or is it part of the fix?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(thinking it was just a tangential fix)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was :)

return truncate(value, maxLength);
} else if (
typeof value === 'number' ||
typeof value === 'boolean' ||
Expand Down
97 changes: 41 additions & 56 deletions test/raven.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -828,10 +828,10 @@ describe('globals', function() {
});

Raven._globalProject = '2';
Raven._globalOptions = {
Object.assign(Raven._globalOptions, {
logger: 'javascript',
maxMessageLength: 100
};
});
Raven._breadcrumbs = [
{
type: 'request',
Expand Down Expand Up @@ -875,13 +875,13 @@ describe('globals', function() {
});

Raven._globalProject = '2';
Raven._globalOptions = {
Object.assign(Raven._globalOptions, {
logger: 'javascript',
maxMessageLength: 100,
autoBreadcrumbs: {
sentry: true
}
};
});
Raven._breadcrumbs = [
{
type: 'http',
Expand Down Expand Up @@ -979,11 +979,11 @@ describe('globals', function() {
});

Raven._globalProject = '2';
Raven._globalOptions = {
Object.assign(Raven._globalOptions, {
logger: 'javascript',
maxMessageLength: 100,
autoBreadcrumbs: false
};
});

Raven._send({message: 'bar'});

Expand Down Expand Up @@ -1014,10 +1014,10 @@ describe('globals', function() {
});

Raven._globalProject = '2';
Raven._globalOptions = {
Object.assign(Raven._globalOptions, {
logger: 'javascript',
maxMessageLength: 100
};
});
Raven._globalContext = {user: {name: 'Matt'}};

Raven._send({message: 'bar'});
Expand Down Expand Up @@ -1049,10 +1049,6 @@ describe('globals', function() {
});

Raven._globalProject = '2';
Raven._globalOptions = {
logger: 'javascript',
maxMessageLength: 100
};
Raven._globalContext = {tags: {tag1: 'value1'}};

Raven._send({message: 'bar', tags: {tag2: 'value2'}});
Expand All @@ -1072,10 +1068,6 @@ describe('globals', function() {
extra: {'session:duration': 100}
});

assert.deepEqual(Raven._globalOptions, {
logger: 'javascript',
maxMessageLength: 100
});
assert.deepEqual(Raven._globalContext, {
tags: {tag1: 'value1'}
});
Expand All @@ -1090,10 +1082,6 @@ describe('globals', function() {
});

Raven._globalProject = '2';
Raven._globalOptions = {
logger: 'javascript',
maxMessageLength: 100
};
Raven._globalContext = {extra: {key1: 'value1'}};

Raven._send({message: 'bar', extra: {key2: 'value2'}});
Expand All @@ -1113,10 +1101,6 @@ describe('globals', function() {
extra: {key1: 'value1', key2: 'value2', 'session:duration': 100}
});

assert.deepEqual(Raven._globalOptions, {
logger: 'javascript',
maxMessageLength: 100
});
assert.deepEqual(Raven._globalContext, {
extra: {key1: 'value1'}
});
Expand All @@ -1126,14 +1110,14 @@ describe('globals', function() {
this.sinon.stub(Raven, 'isSetup').returns(true);
this.sinon.stub(Raven, '_makeRequest');

Raven._globalOptions = {
Object.assign(Raven._globalOptions, {
projectId: 2,
logger: 'javascript',
maxMessageLength: 100,
dataCallback: function() {
return {message: 'ibrokeit'};
}
};
});
Raven._globalContext = {user: {name: 'Matt'}};

Raven._send({message: 'bar'});
Expand All @@ -1152,13 +1136,13 @@ describe('globals', function() {
});

Raven._globalProject = '2';
Raven._globalOptions = {
Object.assign(Raven._globalOptions, {
logger: 'javascript',
maxMessageLength: 100,
dataCallback: function() {
return;
}
};
});

Raven._send({message: 'bar'});
assert.deepEqual(Raven._makeRequest.lastCall.args[0].data, {
Expand Down Expand Up @@ -1207,13 +1191,13 @@ describe('globals', function() {
headers: {'User-Agent': 'lolbrowser'}
});

Raven._globalOptions = {
Object.assign(Raven._globalOptions, {
projectId: 2,
logger: 'javascript',
maxMessageLength: 100,
tags: {},
extra: {}
};
});

Raven._send({
message: 'bar',
Expand Down Expand Up @@ -1247,12 +1231,12 @@ describe('globals', function() {
headers: {'User-Agent': 'lolbrowser'}
});

Raven._globalOptions = {
Object.assign(Raven._globalOptions, {
projectId: 2,
logger: 'javascript',
maxMessageLength: 100,
environment: 'abc123'
};
});

Raven._send({message: 'bar'});
assert.deepEqual(Raven._makeRequest.lastCall.args[0].data, {
Expand Down Expand Up @@ -1280,12 +1264,12 @@ describe('globals', function() {
headers: {'User-Agent': 'lolbrowser'}
});

Raven._globalOptions = {
Object.assign(Raven._globalOptions, {
projectId: 2,
logger: 'javascript',
maxMessageLength: 100,
release: 'abc123'
};
});

Raven._send({message: 'bar'});
assert.deepEqual(Raven._makeRequest.lastCall.args[0].data, {
Expand Down Expand Up @@ -1313,12 +1297,12 @@ describe('globals', function() {
headers: {'User-Agent': 'lolbrowser'}
});

Raven._globalOptions = {
Object.assign(Raven._globalOptions, {
projectId: 2,
logger: 'javascript',
maxMessageLength: 100,
serverName: 'abc123'
};
});

Raven._send({message: 'bar'});
assert.deepEqual(Raven._makeRequest.lastCall.args[0].data, {
Expand Down Expand Up @@ -1346,14 +1330,15 @@ describe('globals', function() {
headers: {'User-Agent': 'lolbrowser'}
});

var globalOptions = {
var globalOptions = Object.assign({}, Raven._globalOptions, {
projectId: 2,
logger: 'javascript',
maxMessageLength: 100,
release: 'abc123'
};
Raven._globalEndpoint = 'http://localhost/store/';
});

Raven._globalOptions = globalOptions;
Raven._globalEndpoint = 'http://localhost/store/';

Raven._send({message: 'bar'});
var args = Raven._makeRequest.lastCall.args;
Expand Down Expand Up @@ -1394,12 +1379,12 @@ describe('globals', function() {
});

Raven._globalEndpoint = 'http://localhost/store/';
Raven._globalOptions = {
Object.assign(Raven._globalOptions, {
projectId: 2,
logger: 'javascript',
maxMessageLength: 100,
release: 'abc123'
};
});
Raven._globalSecret = 'def'; // <-- secret

Raven._send({message: 'bar'});
Expand Down Expand Up @@ -1437,14 +1422,14 @@ describe('globals', function() {
headers: {'User-Agent': 'lolbrowser'}
});

var globalOptions = {
var globalOptions = Object.assign({}, Raven._globalOptions, {
logger: 'javascript',
maxMessageLength: 100,
transport: sinon.stub()
};
});

Raven._globalProject = '2';
Raven._globalOptions = globalOptions;
Raven._globalProject = '2';

Raven._send({message: 'bar'});
assert.deepEqual(globalOptions.transport.lastCall.args[0].data, {
Expand All @@ -1468,13 +1453,13 @@ describe('globals', function() {
this.sinon.stub(window, 'fetch').resolves(true);

Raven._globalProject = '2';
Raven._globalOptions = {
Object.assign(Raven._globalOptions, {
logger: 'javascript',
maxMessageLength: 100,
headers: {
'custom-header': 'value'
}
};
});

Raven._send({message: 'bar'});

Expand All @@ -1487,15 +1472,15 @@ describe('globals', function() {
this.sinon.stub(window, 'fetch').resolves(true);

Raven._globalProject = '2';
Raven._globalOptions = {
Object.assign(Raven._globalOptions, {
logger: 'javascript',
maxMessageLength: 100,
headers: {
'custom-header': function() {
return 'computed-header-value';
}
}
};
});

Raven._send({message: 'bar'});

Expand All @@ -1516,14 +1501,14 @@ describe('globals', function() {
requests.push(xhr);
};

Raven._globalOptions = {
Object.assign(Raven._globalOptions, {
headers: {
'custom-string-header': 'pickle-rick',
'custom-function-header': function() {
return 'morty';
}
}
};
});

Raven._send({message: 'bar'});

Expand Down Expand Up @@ -1713,10 +1698,10 @@ describe('globals', function() {
});

Raven._globalProject = '2';
Raven._globalOptions = {
Object.assign(Raven._globalOptions, {
logger: 'javascript',
maxMessageLength: 100
};
});
Raven._globalOptions.maxUrlLength = 30;

var longUrl = new Array(50).join('a');
Expand Down Expand Up @@ -1758,10 +1743,10 @@ describe('globals', function() {
});

Raven._globalProject = '2';
Raven._globalOptions = {
Object.assign(Raven._globalOptions, {
logger: 'javascript',
maxMessageLength: 100
};
});
Raven._globalOptions.maxUrlLength = 35;

var longUrl = new Array(50).join('a');
Expand Down Expand Up @@ -1809,10 +1794,10 @@ describe('globals', function() {
});

Raven._globalProject = '2';
Raven._globalOptions = {
Object.assign(Raven._globalOptions, {
logger: 'javascript',
maxMessageLength: 100
};
});
Raven._globalOptions.maxUrlLength = 35;

var obj = {method: 'POST', url: undefined};
Expand Down
Loading