Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/esprehn/tasklets

Experimenting with making using workers easy.
https://github.com/esprehn/tasklets

Last synced: about 2 months ago
JSON representation

Experimenting with making using workers easy.

Awesome Lists containing this project

README 

        
# Problem

Most modern development platforms favor a multi-threaded approach by default. Typically, the split for work is:



- __Main thread__: UI manipulation, event/input routing

- __Background thread__: All other work



iOS and Android native platforms, for example, restrict (by default) the usage of any APIs not critical to UI manipulation on the main thread.



The web has support for this model via `WebWorkers`, though the `postMessage()` interface is clunky and difficult to use. As a result, worker adoption has been minimal at best and the default model remains to put all work on the main thread. In order to encourage developers to move work off the main thread, we need a more ergonomic solution.



In anticipation of increased usage of threads, we will also need a solution that scales well with regards to resource usage. Workers require ~5MB per thread. This proposal suggests using worklets as the fundamental execution context to better support a world where multiple parties are using threading heavily.



# Tasklet API

__Note__: APIs described below are just strawman proposals. We think they're pretty cool but there's always room for improvement.



Today, many uses of `WebWorker`s follow a structure similar to:



```javascript

const worker = new Worker('worker.js');

worker.postMessage({'cmd':'fetch', 'url':'example.com'});

```



A switch statement in the worker then routes messages to the correct API. The tasklet API exposes this behavior natively, by allowing a class within one context to expose methods to other contexts:



```javascript

// tasklet.js

class Speaker {

  // We have to list what methods are exposed.

  static get exposed() { return ['concat']; }



  concat(message) {

    return `${message} world!`;

  }

}

services.register('speak', Speaker);

```



From the main thread, we can access these exposed methods directly, awaiting them as we would await a normal promise:



```javascript

// main.html

const tasklet = new Tasklet('tasklet.js');

const speaker = await tasklet.connect('speak');



speaker.concat('Hello');

```



This makes it much simpler to dispatch computationally expensive work to a background context.



# Main thread interaction

In addition to dispatching occasional background work, we want sites to architect their entire app in a threaded way. While this is possible with `postMessage` (or the tasklet API), the difficulty in communicating progress and dispatching UI work to the main thread will likely discourage developers from building complex background logic.



A straightforward use case for back and forth communication is progress UI. Imagine a site like Facebook loading its news feed in a background context. Ideally, as posts come in, the site would incrementally update the UI, rather than waiting on all of the background work to finish.



This area is a bit more experimental, but there are a few ideas to make this easier:



## Event based communication

If we allowed classes to extend `EventTarget`, tasklets could communicate with the main thread via messages:



```javascript

// tasklet.js

class NewsFeedTasklet extends EventTarget {

  static get exposed() { return []; }



  loadPosts(numPosts) {

    for(let i = 0; i < numPosts; i++) {

      fetch(`posts/today/${i}`)

      .then(res => res.json())

      .then(data => dispatchEvent('new-post', data));

    }

  }

}

services.register('news-feed', NewsFeedTasklet);

```



```html








  const tasklet = new Tasklet('tasklet.js');

  const newsFeedTasklet = tasklet.connect('news-feed');



  newsFeedTasklet.addEventListener('new-post', addPost);



  function addPost(e) {

    const data = e.detail;

    let post = document.createElement('div');

    let title = document.createElement('h1');

    let summary = document.createElement('p');



    title.textContent = data.title;

    summary.textContent = data.summary;



    post.appendChild(title);

    post.appendChild(summary);

    document.querySelector('#feed').appendChild(post);

  }



```



## Exposing main thread methods to tasklets

Another way to solve this problem is with the tasklet API in reverse: the main thread can expose methods to tasklet contexts:



```javascript

// main.html

const tasklet = new Tasklet('tasklet.js');



tasklet.register('dom', class {

  // We have to list what methods are exposed.

  static get exposed() { return ['appendText', 'appendBox']; }



  appendText(text) {

    let div = document.createElement('div');

    document.body.appendChild(div).textContent = text;

  }



  appendBox(text, style) {

    let div = document.createElement('div');

    if (style) {

      for (let [property, value] of style)

        div.style[property] = value;

    }

    document.body.appendChild(div).textContent = text;

  }

});

```



Those methods are then available within the tasklet's context without needing to break the control flow:



```javascript

// tasklet.js

const dom = await services.connect('dom');



// Kick off some main thread work to update the UI

let text = "hello";

dom.appendText(text);



// And then continue with our work here

let box = " world!"

dom.appendBox(box);

```



# ES language support

While using this API provides numerous improvements, there are still some rough edges. There is a fair amount of boilerplate to register functions. A site's logic is split between multiple files for main and background work. There's no simple way to just run a function in a background context.



A `remote` keyword could be used to signify work that should be placed in a tasklet:



## Remote classes

A remote class would essentially replace all of the boilerplate mentioned above:



```javascript

// tasklet.js

remote class Speaker {

  concat(message) {

    return `${message} world!`;

  }

}

```



```javascript

// main.html

import tasklet.js;



const speaker = new Speaker();

speaker.concat('Hello');

```



## Remote blocks

Alternatively, remote could be used to delineate blocks that should run in a tasklet:



```javascript

// tasklet.js

class Speaker {

  @expose concat(message) {

    return `${message} world!`;

  }

}

```



```javascript

// main.html

const speaker = await remote { import 'tasklet.js'; }

speaker.concat('Hello');



const expensive = await remote {

  function doExpensiveBackgroundThing() {

    // wow so expensive.

  };

}

expensive.doExpensiveBackgroundThing();

```



`remote` could also be used on individual functions:



```javascript

remote function concat(text) {

  console.log(`${text} world!`);

}



await concat('Hello');

}

```



For crazier (and less realistic) ideas around language support for exposing main thread APIs, see [ES support for exposing main thread functions](ES-support-main.md).



# Implications of worklets

As more sites/content use tasklets, we will need some way to mitigate the performance overhead that traditionally comes with multiple threads (~5MB per). Worklets are a natural fit for this problem, as their contexts can be moved between threads as resource constraints demand. Similarly, the contexts from different tasklets could share a thread (even the main thread) in cases where device memory is critically low. This would allow the user agent to transparently optimize the experience for device memory.