ZoneTracker: Tracking JavaScript Performance with Zone.js

Daniel James

Reading time: about 5 min

Topics:

Web Development

Lucidchart is a highly performant web application. When editing a Lucidchart document, users expect a high frame rate and a responsive UI. To ensure a great experience, we track frame rate and UI stalls. This article describes how we leverage an existing library, Zone.js, to accomplish this. Prereq: The JavaScript event loop For this discussion, it’s necessary to have a basic understanding of JavaScript tasks. A task in Javascript represents the synchronous execution of code from start to finish. (There’s no preemption in JavaScript.) Tasks may be queued from setTimeout’s, XHR callbacks, keyboard or mouse events, etc… Here is my favorite in-depth explanation of JavaScript tasks. Blocking tasks Since code execution in JavaScript does not preempt, if a JavaScript task (such as an event handler for clicking) takes too long to complete, the browser cannot repaint the screen or handle additional input. To keep the experience smooth, we try to maintain sixty frames per second (FPS). This objective means individual tasks cannot take longer than 16.6 milliseconds (1 second / 60 frames per second = 16.6 milliseconds). Why not just measure frame rate? We could simply measure and report the frame rate directly. This would be easy to do and offer some insight. However, just the frame rate as a single number is not very actionable. What if we released new code and noticed that the average frame rate dropped by 5%? We wouldn’t know what is actually causing the decrease in performance. The next logical step at this point would be to start “tagging” the code. Generally we have a pretty good idea of which parts of the code take up the most time (like saving, rendering, etc.). We could time each of these blocks of code and report them individually. Then we would know if the regression was in these blocks of code. However, we’d never be able to instrument every chunk of code using this approach. We might miss code, and it’s more reactive than we might hope. As a result, we track each and every task that runs. Of course, doing this task doesn’t sound easy. Luckily, we can leverage an existing library to accomplish it. What is Zone.js? Zone.js can be thought of as a wrapper around tasks. It inserts itself into every task creation point. By doing so, Zone can know when a task begins and ends, what the task is, what kind of task it is, etc. Zone is the “magic” behind Angular’s change detection, allowing Angular to ensure the view is updated anytime the application’s state could’ve possibly changed. For most people, this is the only use case for Zone that they’re aware of. In fact, Zone is entirely decoupled from Angular—you do not need to have an Angular application to track performance like this with Zone! Using Zone There is a great write-up of how Zone works internally, which I highly recommend reading. In essence, there can be many nested layers of zones. Each zone can be configured to intercept tasks and/or do whatever they wish with them. Once done, the zone may pass the task to its parent zone, eventually reaching the root zone. The root zone, of course, will just execute the tasks as expected. A zone is configured with a ZoneSpec, and the specific logic for executing tasks in a zone is contained in the ZoneDelegate. We could create an entirely new zone (Like NgZone for Angular). However, we would then have to ensure the entire application runs in this zone. Instead, we opted to hook into the root zone itself. Below is an example implementation of hooking Zone like this:

See the Pen NEqgOr by Daniel James (@danielscottjames) on CodePen.

Analysis Drag the blocks around the screen. You will notice that different blocks stall for different amounts of time while being dragged. We log output every “minute” (for the purposes of this demo, I am redefining a minute to be 10 seconds) that looks like this:

MINUTE_TAG: {
  "blocks_0": 440,
  "time_0": 5475700,
  "blocks_17": 18,
  "time_17": 4890800,
  "blocks_50": 16,
  "time_50": 4821300,
  "blocks_100": 14,
  "time_100": 4666900,
  "blocks_250": 10,
  "time_250": 3947500
}

blocks_X is the number of blocks (we group microtasks with the task they’re attached to and call it a block) executed this minute that took X or less milliseconds. time_X is the cumulative execution time for these blocks in microseconds. There are a number of conclusions we could draw from this data, such as:

The total amount of time we spent executing JavaScript during this 10-second window is ~5.5 seconds (time_0).
The user spent about ~90% of this interactive time getting less than 60 FPS (time_17/time_0).
The user experienced 10 stalls that lasted a quarter second or longer (blocks_250).

For every task that runs, we attempt to automatically tag it based on the function name (in our application, we have a way of manually tagging tasks as well). The ZoneTracker notes how long it takes to execute the task, and to bucket them up based on their tag. (e.g., the tagged task `_drag` took 50ms, so we will add it to the 50ms bucket for its tag.) We also report each tag’s contribution to the aggregated numbers shown above. Note that we aren’t necessarily logging every function that runs. We care about tasks (because tasks are what will block rendering and input.) This example was rather basic, and the ZoneTracker can be extended in many ways. We have caught many performance problems with the data collected through these means! This sample code is plug and play. Drop it into your application and see what it tells you!

About Lucid

Lucid Software is a pioneer and leader in visual collaboration dedicated to helping teams build the future. With its products—Lucidchart, Lucidspark, and Lucidscale—teams are supported from ideation to execution and are empowered to align around a shared vision, clarify complexity, and collaborate visually, no matter where they are. Lucid is proud to serve top businesses around the world, including customers such as Google, GE, and NBC Universal, and 99% of the Fortune 500. Lucid partners with industry leaders, including Google, Atlassian, and Microsoft. Since its founding, Lucid has received numerous awards for its products, business, and workplace culture. For more information, visit lucid.co.