astoilkov/main-thread-scheduling

main-thread-scheduling

Fast and consistently responsive apps using a single function call

Install

npm install main-thread-scheduling

Overview

The library lets you run computationally heavy tasks on the main thread while ensuring:

• Your app's UI doesn't freeze.
• Your users' computer fans don't spin.
• It can be easily integrated into your existing codebase.

A real-world showcase of searching in 10k files and getting results instantly — https://twitter.com/antoniostoilkov/status/1539576912498118656.

Use Cases

• You want to turn a synchronous function into a non-blocking asynchronous function. Avoids UI freezes.
• You want to render important elements first and less urgent ones second. Improves perceived performance.
• You want to run a long background task that doesn't spin the fans after a while. Avoids bad reputation.
• You want to run multiple backgrounds tasks that don't degrade your app performance with time. Prevents death by a thousand cuts.

How It Works

• Uses MessageChannel.postMessage() and requestIdleCallback() for scheduling.
• Stops task execution when user interacts with the UI (if navigator.scheduling.isInputPending() API is available).
• Global queue. Multiple tasks are executed one by one so increasing the number of tasks doesn't degrade performance linearly.
• Sorts tasks by importance. Sorts by priority and gives priority to tasks requested later.
• Considerate about your existing code. Tasks with background priority are executed last so there isn't some unexpected work that slows down the main thread after the background task is finished.

Why

Why rely on some open-source library to ensure a good performance for my app?

• Not a weekend project. Actively maintained for over a year — see contributors page. I've been using it in my own products for over two years — Nota and iBar. Flux.ai are also using it in their product (software for designing hardware circuits).
• This is the future. Browsers are probably going to support scheduling tasks on the main thread in the future. Here is the spec. This library will still be relevant in the future — explanation.
• Simple. 90% of the time you only need the yieldOrContinue(priority) function. The API has two more functions for more advanced cases.
• High quality. Aiming for high-quality with my open-source principles.

Example

You can see the library in action in this CodeSandbox. Try removing the call to yieldToContinue() and then type in the input to see the difference.

API

yieldOrContinue(priority: 'background' | 'user-visible')

The complexity of the entire library is hidden behind this method. You can have great app performance by calling a single method.

async function findInFiles(query: string) {  
    for (const file of files) {
        await yieldOrContinue('user-visible')
        
        for (const line of file.lines) {
            fuzzySearchLine(line, query)
        }
    }
}

More complex scenarios

The library has two more functions available:

• yieldControl(priority: 'background' | 'user-visible')
• isTimeToYield(priority: 'background' | 'user-visible')

These two functions are used together to handle more advanced use cases.

A simple use case where you will need those two functions is when you want to render your view before yielding back control to the browser to continue its work:

async function doHeavyWork() {
    for (const value of values) {
        if (isTimeToYield('user-visible')) {
            render()
            await yieldControl('user-visible')
        }
        
        computeHeavyWorkOnValue(value)
    }
}

Priorities

There are two priorities available: user-visible and background:

• user-visible – use this for things that need to display to the user as fast as possible. Every user-visible task is run for 83ms – this gives you a nice cycle of doing heavy work and letting the browser render pending changes.
• background – use this for background tasks. Every background task is run for 5ms.

If you have a use case for a third priority, you can write in this issue.

Alternatives

Web Workers are a great fit if you have: 1) heavy algorithm (e.g. image processing), 2) heavy process (runs for a long time, big part of the app lifecycle). However, in reality, it's rare to see people using them. That's because they require significant investment of time due to the complexity that can't be avoided when working with CPU threads regardless of the programming language. This library can be used as a gateway before transitioning to Web Workers. In most cases, you would discover the doing it on the main thread is good enough.

scheduler.yield() will probably land in browsers at some point. However, is scheduler.yield() enough? The spec isn't very clear on how it will work exactly so I'm not sure. My guess is that it would be possible go without this library but you will need extra code to do so. That's because you will need to reimplement the isTimeToYield() method for which I don't see an alternative in the spec.

React scheduler is a similar implementation. They plan to make it more generic (for use outside of React) but there doesn't seem to be a public roadmap for that.