An extraction of JS Bin's loop protection functionality.
JavaScript
Latest commit 7eb9db8 Oct 17, 2016 @remy remy committed on GitHub Merge pull request #15 from ltegman/fix/multiline-comment-scenarios
Fix two multiline comment scenarios, jshint errors

README.md

Test status

loop-protect

JS Bin's loop protection implementation as a reusable library.

This code protects most cases where user code includes an infinite loop using a while, for or do loop.

Note that this does not solve the halting problem but simply rewrites JavaScript (without an AST) wrapping loops with a conditional break. This also does not protect against recursive loops.

Example

With loop protection in place, it means that a user can enter the code as follows on JS Bin, and the final console.log will still work.

while (true) {
  doSomething();
}

console.log('All finished');

Usage

The loop protection can be used both on the client side and server side. It supports AMD and CommonJS module loading, or can be included as vanilla JavaScript (as it is in JS Bin).

Public methods

  • loopProtect.hit(number): fired when a potential infinite loop is found. Can be overwritten (see example below).
  • loopProtect.alias(string): used if loopProtect is aliased to a different variable.
  • loopProtect.debug(bool): used for development to trace steps of protection (not included .min file)

Example implementation

// we're going to alias the loopProtect object under a different name
// when it runs inside the iframe, so we need to configure the loopProtect
// *before* we process the JavaScript.
loopProtect.alias = 'protect';

// show the user we found an infinite loop and let the code carry on
loopProtect.hit = function (line) {
  alert('Potential infinite loop found on line ' + line);
};

// rewrite the user's JavaScript to protect loops
var processed = loopProtect(getUserCode());

// run in an iframe, and expose the loopProtect variable under a new name
var iframe = getNewFrame();

// append the iframe to allow our code to run as soon as .close is called
document.body.appendChild(iframe);

// open the iframe and write the code to it
var win = iframe.contentWindow;
var doc = win.document;
doc.open();

// this line is why we use `loopProtect.alias = 'protect'`
win.protect = loopProtect;

doc.write('<script>' + processed + '<' + '/script>');
doc.close();

// code now runs, and if there's a loop, loopProtect.hit is called.

Abstract

The loop protection method takes a string of JavaScript and manually parses the code manually to find while, for and do loops.

Once these loops are found, a marker is inserted before the loop, and a test is called as the first job inside the loop. The first time the test is called, it records the time, and if the loop has taken over 100ms then the loop will break out and the remaining JavaScript is executed.

Why not use an AST?

The parsing would be 100% robust if we did use an AST, but the overhead would be at the cost of around 200-300K for the parser.

For it's purpose, this manual loop protection works pretty well. Most people spot their infinite loops whilst they're typing and will fix the code, but if like JS Bin you're rendering the output and JavaScript in real-time, you'll need to prevent the browser from hanging. This simple loop protection is one defence against loops.

TODO / ideas

  • If the time between tests is 100ms or more, it's likely we're looking at a loop with an alert (or type of blocking call), so perhaps the loop protection can back off?

Contributors

License

MIT / http://jsbin.mit-license.org