Feature: Task Killer

Purpose

Provide a way to kill tasks in Cockpit, to test garbage collection and allow a person using Cockpit to manually free up resources on the client machine (the computer running the browser) as well as the server (in tasks that require heavy IO, etc.).

This feature is meant primarily as a debugging tool.

Audience

Developers

TBD

Proposed implementation(s)

It's a common pattern to provide extended information on applications in the about box. Sometimes, this may include resources used. Andreas and I (Garrett) are looking to implement a task list where tasks can be killed inside the Cockpit about dialog.

An alternate approach would be to have a hidden keystroke to enable the ability to close running tasks from the navigation. This approach is not mutually exclusive with the about box method. However, Andreas and I (Garrett) think it's best to make an advanced feature like this a bit more hidden.

After (or while) this feature is implemented, it may be a good idea for tasks running inside of Cockpit to provide hints on whether they should persist or could be transient (recreated at each request). Lighter weight frames may then be cleaned up a bit more aggressively in the background according to some heuristic (with something like time since last used, # of tasks since last use, # of active tasks, the persistence hint, and so on).

Mockups

TBD

Resources

It would be nice to have some sort of stats for resource usage for each iframe. A lot of metrics we'd want to use are probably only available at a browser-level, instead of within the page. However, there should be some JS APIs we can use to display performance.

• Navigation Timing / Performance API
  • Very broad browser support: http://caniuse.com/#feat=nav-timing
  • Docs: https://developer.mozilla.org/en-US/docs/Web/API/Navigation_timing_API
  • Quick overview: https://www.html5rocks.com/en/tutorials/webperformance/basics/
  • Using Navigation Timing on iframes: http://stackoverflow.com/questions/9944170/using-the-new-javascript-performance-timing-api-on-iframes
  • performance.getEntries() to get a list of various loaded resources and the stats (modify for iframe usage, of course)
  • Chrome has performance.memory (Firefox does not) — the about might need to be different between browsers, as it would be great to have actual memory values instead of approximates or (essentially) made-up resource measurements
    • Don't use: It doesn't work in Chrome anyway (just reports heap sizes, unless one runs with an experimental command-line flag) http://docs.webplatform.org/apis/timing/properties/memory/
  • Resource measurement I've figured out based on performance API, for render time (which should roughly indicate complexity of page) and resource usage (on load, not additional usage while manipulating the page):

    • Snippet showing the DOM render time for each iframe (run in dev console):

      $('iframe').each(function(i, iframe){ console.log(iframe.name,  iframe.contentWindow.performance.timing.domComplete - iframe.contentWindow.performance.timing.domLoading); })

    • Snippet to display the decoded (uncompressed in RAM) file sizes (which should be roughly equivalent with memory size) — note that this doesn't take into account actual RAM usage of the page in use, only the RAM used for resources (scripts, images, etc.):

      $('iframe').each(function(i, iframe){ console.log(iframe.name, iframe.contentWindow.performance.getEntries({entryType: "resource"}).reduce(function(prev, el){ return (prev.decodedBodySize || 0) + (el.decodedBodySize || 0) })); });

• querySelector
  • document.querySelectorAll('*').length can be a very crude indicator on elements in the DOM; this could be used per iframe
  • it's generally not a great metric, as it doesn't count interactivity, memory usage, or other things (as it does take some elements longer to render than others)