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.

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

Allow early termination to limit execution time with degenerate cases #365

Merged
merged 2 commits into from
May 6, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
7 changes: 3 additions & 4 deletions src/diff/base.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Diff.prototype = {

let newLen = newString.length, oldLen = oldString.length;
let editLength = 1;
let maxEditLength = newLen + oldLen;
let maxEditLength = options.maxEditLength || newLen + oldLen;
Copy link
Owner

Choose a reason for hiding this comment

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

Can we cap this parameter at newLen+oldLen?

let bestPath = [{ newPos: -1, components: [] }];

// Seed editLength = 0, i.e. the content starts with the same values
Expand Down Expand Up @@ -87,12 +87,11 @@ Diff.prototype = {

// Performs the length of edit iteration. Is a bit fugly as this has to support the
// sync and async mode which is never fun. Loops over execEditLength until a value
// is produced.
// is produced, or until the edit length exceeds options.maxEditLength (if given),
// in which case it will return undefined.
if (callback) {
(function exec() {
setTimeout(function() {
// This should not happen, but we want to be safe.
/* istanbul ignore next */
if (editLength > maxEditLength) {
return callback();
}
Expand Down
4 changes: 4 additions & 0 deletions src/patch/create.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ export function structuredPatch(oldFileName, newFileName, oldStr, newStr, oldHea
}

const diff = diffLines(oldStr, newStr, options);
if(!diff) {
return;
}

diff.push({value: '', lines: []}); // Append an empty value to make cleanup easier

function contextLines(lines) {
Expand Down
18 changes: 18 additions & 0 deletions test/diff/line.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,24 @@ describe('diff/line', function() {
'');
expect(convertChangesToXML(diffResult)).to.equal('<del>line\n\nold value \n\nline</del>');
});

describe('given options.maxEditLength', function() {
it('terminates early', function() {
const diffResult = diffLines(
'line\nold value\nline',
'line\nnew value\nline', { maxEditLength: 1 });
expect(diffResult).to.be.undefined;
});
it('terminates early - async', function(done) {
function callback(diffResult) {
expect(diffResult).to.be.undefined;
done();
}
diffLines(
'line\nold value\nline',
'line\nnew value\nline', { callback, maxEditLength: 1 });
});
});
});

// Trimmed Line Diff
Expand Down
13 changes: 13 additions & 0 deletions test/patch/create.js
Original file line number Diff line number Diff line change
Expand Up @@ -649,6 +649,19 @@ describe('patch/create', function() {
}]
});
});

describe('given options.maxEditLength', function() {
const options = { maxEditLength: 1 };

it('terminates early', function() {
const res = structuredPatch(
'oldfile', 'newfile',
'line2\nline3\nline4\n', 'line2\nline3\nline5',
'header1', 'header2', options
);
expect(res).to.be.undefined;
});
});
});

describe('#formatPatch', function() {
Expand Down