Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Event Loop Guide grammar fixes #7479

Closed
wants to merge 8 commits into from
Closed

Event Loop Guide grammar fixes #7479

Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
61cb735
grammar revisions in process.nextTick()
ryanmurakami Jun 29, 2016
8a3a5d2
s-s-s-spaces
ryanmurakami Jun 29, 2016
e25d593
Lower-casing Event Loop and un-back-ticking some words
ryanmurakami Jun 29, 2016
4e673cd
eoop => loop
ryanmurakami Jun 29, 2016
9d74fa5
Un-bolding the comma
ryanmurakami Jun 30, 2016
1f3ade9
phases from backtick to bold and grammar
ryanmurakami Jul 1, 2016
bb971d6
Merge remote-tracking branch 'nodejs/master' into event-loop-grammar
ryanmurakami Jul 5, 2016
95da32c
removing useless bold on headers
ryanmurakami Jul 7, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
174 changes: 93 additions & 81 deletions doc/topics/the-event-loop-timers-and-nexttick.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,24 @@

## What is the Event Loop?

The event loop is what allows Node.js to perform non-blocking I/O
The Event Loop is what allows Node.js to perform non-blocking I/O
operations — despite the fact that JavaScript is single-threaded — by
offloading operations to the system kernel whenever possible.
offloading operations to the system kernel whenever possible.

Since most modern kernels are multi-threaded, they can handle multiple
operations executing in the background. When one of these operations
completes, the kernel tells Node.js so that the appropriate callback
may added to the `poll` queue to eventually be executed. We'll explain
this in further detail later in this topic.

## Event Loop Explained
## Event Loop Explained

When Node.js starts, it initializes the event loop, processes the
When Node.js starts, it initializes the Event Loop, processes the
provided input script (or drops into the REPL, which is not covered in
this document) which may make async API calls, schedule timers, or call
`process.nextTick()`, then begins processing the event loop.
`process.nextTick()`, then begins processing the Event Loop.

The following diagram shows a simplified overview of the event loop's
The following diagram shows a simplified overview of the Event Loop's
order of operations.

┌───────────────────────┐
Expand All @@ -41,10 +41,10 @@ order of operations.
└──┤ close callbacks │
└───────────────────────┘

*note: each box will be referred to as a "phase" of the event loop.*
*note: each box will be referred to as a "phase" of the Event Loop.*

Each phase has a FIFO queue of callbacks to execute. While each phase is
special in its own way, generally, when the event loop enters a given
special in its own way, generally, when the Event Loop enters a given
phase, it will perform any operations specific to that phase, then
execute callbacks in that phase's queue until the queue has been
exhausted or the maximum number of callbacks have executed. When the
Expand All @@ -67,43 +67,43 @@ actually uses are those above._

## Phases Overview:

* `timers`: this phase executes callbacks scheduled by `setTimeout()`
* `timers`: this phase executes callbacks scheduled by `setTimeout()`
and `setInterval()`.
* `I/O callbacks`: most types of callback except timers, setImmedate, close
* `idle, prepare`: only used internally
* `poll`: retrieve new I/O events; node will block here when appropriate
* `check`: setImmediate callbacks are invoked here
* `close callbacks`: e.g socket.on('close', ...)

Between each run of the event loop, Node.js checks if it is waiting for
Between each run of the Event Loop, Node.js checks if it is waiting for
any asynchronous I/O or timer and it shuts down cleanly if there are not
any.

## Phases in Detail

### timers
### `timers`:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This probably doesn't need backticks.


A timer specifies the **threshold** _after which_ a provided callback
_may be executed_ rather than the **exact** time a person _wants it to
be executed_. Timers callbacks will run as early as they can be
scheduled after the specified amount of time has passed; however,
Operating System scheduling or the running of other callbacks may delay
them.
them.

_**Note**: Technically, the [`poll` phase](#poll) controls when timers
_**Note**: Technically, the [`poll` phase](#poll) controls when timers
are executed._

For example, say you schedule a timeout to execute after a 100 ms
threshold, then your script starts asynchronously reading a file which
For example, say you schedule a timeout to execute after a 100 ms
threshold, then your script starts asynchronously reading a file which
takes 95 ms:

```js

var fs = require('fs');

function someAsyncOperation (callback) {
// let's assume this takes 95ms to complete

// let's assume this takes 95ms to complete
fs.readFile('/path/to/file', callback);

}
Expand Down Expand Up @@ -131,78 +131,78 @@ someAsyncOperation(function () {
});
```

When the event loop enters the `poll` phase, it has an empty queue
When the Event Loop enters the `poll` phase, it has an empty queue
(`fs.readFile()` has not completed) so it will wait for the number of ms
remaining until the soonest timer's threshold is reached. While it is
waiting 95 ms pass, `fs.readFile()` finishes reading the file and its
callback which takes 10 ms to complete is added to the `poll` queue and
executed. When the callback finishes, there are no more callbacks in the
queue, so the event loop will see that the threshold of the soonest
queue, so the Event Loop will see that the threshold of the soonest
timer has been reached then wrap back to the `timers` phase to execute
the timer's callback. In this example, you will see that the total delay
between the timer being scheduled and its callback being executed will
between the timer being scheduled and its callback being executed will
be 105ms.

Note: To prevent the `poll` phase from starving the event loop, libuv
Note: To prevent the `poll` phase from starving the Event Loop, libuv
also has a hard maximum (system dependent) before it stops `poll`ing for
more events.

### I/O callbacks:
### `I/O callbacks`:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't need backticks.


This phase executes callbacks for some system operations such as types
This phase executes callbacks for some system operations such as types
of TCP errors. For example if a TCP socket receives `ECONNREFUSED` when
attempting to connect, some \*nix systems want to wait to report the
error. This will be queued to execute in the `I/O callbacks` phase.

### poll:
### `poll`:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For these back-ticks, I was copying the pattern in the above "phases overview" section. Also, subsequent phase headers do have back-ticks. I think consistency should be maintained, so do you suggest removing them all, or keeping them?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like they should be removed unless they are referencing something that is code, such as process.nextTick().

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, sounds good.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, one more thing, these event loop phases are back-ticked all over the document. I think it really helps for them to stand out from normal text, but I agree that the reader should probably not think of them as code. What do you think about a different designation for these phases, maybe italics? or just quotes?


The poll phase has two main functions:

1. Executing scripts for timers who's threshold has elapsed, then
2. Processing events in the `poll` queue.


When the event loop enters the `poll` phase _and there are no timers
When the Event Loop enters the `poll` phase _and there are no timers
scheduled_, one of two things will happen:

* _If the `poll` queue **is not empty**_, the event loop will iterate
through its queue of callbacks executing them synchronously until
either the queue has been exhausted, or the system-dependent hard limit
* _If the `poll` queue **is not empty**_, the Event Loop will iterate
through its queue of callbacks executing them synchronously until
either the queue has been exhausted, or the system-dependent hard limit
is reached.

* _If the `poll` queue **is empty**_, one of two more things will
happen:
* If scripts have been scheduled by `setImmediate()`, the event loop
happen:
* If scripts have been scheduled by `setImmediate()`, the Event Loop
will end the `poll` phase and continue to the `check` phase to
execute those scheduled scripts.

* If scripts **have not** been scheduled by `setImmediate()`, the
event loop will wait for callbacks to be added to the queue, then
Event Loop will wait for callbacks to be added to the queue, then
execute it immediately.

Once the `poll` queue is empty the event loop will check for timers
Once the `poll` queue is empty the Event Loop will check for timers
_whose time thresholds have been reached_. If one or more timers are
ready, the event loop will wrap back to the timers phase to execute
ready, the Event Loop will wrap back to the timers phase to execute
those timers' callbacks.

### `check`:

This phase allows a person to execute callbacks immediately after the
`poll` phase has completed. If the `poll` phase becomes idle and
scripts have been queued with `setImmediate()`, the event loop may
This phase allows a person to execute callbacks immediately after the
`poll` phase has completed. If the `poll` phase becomes idle and
scripts have been queued with `setImmediate()`, the Event Loop may
continue to the `check` phase rather than waiting.

`setImmediate()` is actually a special timer that runs in a separate
phase of the event loop. It uses a libuv API that schedules callbacks to
phase of the Event Loop. It uses a libuv API that schedules callbacks to
execute after the `poll` phase has completed.

Generally, as the code is executed, the event loop will eventually hit
Generally, as the code is executed, the Event Loop will eventually hit
the `poll` phase where it will wait for an incoming connection, request,
etc. However, after a callback has been scheduled with `setImmediate()`,
then the `poll` phase becomes idle, it will end and continue to the
`check` phase rather than waiting for `poll` events.
then the `poll` phase becomes idle, it will end and continue to the
`check` phase rather than waiting for `poll` events.

### `close callbacks`:
### `close callbacks`:

If a socket or handle is closed abruptly (e.g. `socket.destroy()`), the
`'close'` event will be emitted in this phase. Otherwise it will be
Expand All @@ -211,15 +211,15 @@ emitted via `process.nextTick()`.
## `setImmediate()` vs `setTimeout()`

`setImmediate` and `setTimeout()` are similar, but behave in different
ways depending on when they are called.
ways depending on when they are called.

* `setImmediate()` is designed to execute a script once the current
`poll` phase completes.
`poll` phase completes.
* `setTimeout()` schedules a script to be run
after a minimum threshold in ms has elapsed.

The order in which the timers are executed will vary depending on the
context in which they are called. If both are called from within the
context in which they are called. If both are called from within the
main module, then timing will be bound by the performance of the process
(which can be impacted by other applications running on the machine).

Expand Down Expand Up @@ -283,16 +283,16 @@ within an I/O cycle, independently of how many timers are present.
### Understanding `process.nextTick()`

You may have noticed that `process.nextTick()` was not displayed in the
diagram, even though its a part of the asynchronous API. This is because
`process.nextTick()` is not technically part of the event loop. Instead,
the nextTickQueue will be processed after the current operation
completes, regardless of the current `phase` of the event loop.
diagram, even though it's a part of the asynchronous API. This is because
`process.nextTick()` is not technically part of the Event Loop. Instead,
the `nextTickQueue` will be processed after the current operation
completes, regardless of the current `phase` of the Event Loop.

Looking back at our diagram, any time you call `process.nextTick()` in a
given phase, all callbacks passed to `process.nextTick()` will be
resolved before the event loop continues. This can create some bad
resolved before the Event Loop continues. This can create some bad
situations because **it allows you to "starve" your I/O by making
recursive `process.nextTick()` calls.** which prevents the event loop
recursive `process.nextTick()` calls,** which prevents the Event Loop
from reaching the `poll` phase.

### Why would that be allowed?
Expand All @@ -318,10 +318,10 @@ the callback so you don't have to nest functions.
What we're doing is passing an error back to the user but only *after*
we have allowed the rest of the user's code to execute. By using
`process.nextTick()` we guarantee that `apiCall()` always runs its
callback *after* the rest of the user's code and *before* the event loop
is allowed to proceed. To acheive this, the JS call stack is allowed to
callback *after* the rest of the user's code and *before* the Event Loop
is allowed to proceed. To achieve this, the JS call stack is allowed to
unwind then immediately execute the provided callback which allows a
person to make recursive calls to nextTick without reaching a
person to make recursive calls to `process.nextTick()` without reaching a
`RangeError: Maximum call stack size exceeded from v8`.

This philosophy can lead to some potentially problematic situations.
Expand All @@ -343,21 +343,33 @@ var bar = 1;
```

The user defines `someAsyncApiCall()` to have an asynchronous signature,
actually operates synchronously. When it is called, the callback
provided to `someAsyncApiCall ()` is called in the same phase of the
event loop because `someAsyncApiCall()` doesn't actually do anything
asynchronously. As a result, the callback tries to reference `bar` but
it may not have that variable in scope yet because the script has not
but it actually operates synchronously. When it is called, the callback
provided to `someAsyncApiCall()` is called in the same phase of the
Event Loop because `someAsyncApiCall()` doesn't actually do anything
asynchronously. As a result, the callback tries to reference `bar` even
though it may not have that variable in scope yet, because the script has not
been able to run to completion.

By placing it in a `process.nextTick()`, the script still has the
By placing the callback in a `process.nextTick()`, the script still has the
ability to run to completion, allowing all the variables, functions,
etc., to be initialized prior to the callback being called. It also has
the advantage of not allowing the event loop to continue. It may be
useful that the user be alerted to an error before the event loop is
allowed to continue.
etc., to be initialized prior to the callback being called. It also has
the advantage of not allowing the Event Loop to continue. It may be
useful for the user to be alerted to an error before the Event Loop is
allowed to continue. Here is the previous example using `process.nextTick()`:

```js
function someAsyncApiCall (callback) {
process.nextTick(callback);
};

someAsyncApiCall(() => {
console.log('bar', bar); // 1
});

var bar = 1;
```

A real world example in node would be:
Here's another real world example:

```js
const server = net.createServer(() => {}).listen(8080);
Expand All @@ -367,10 +379,10 @@ server.on('listening', () => {});

When only a port is passed the port is bound immediately. So the
`'listening'` callback could be called immediately. Problem is that the
`.on('listening')` will not have been set by that time.
`.on('listening')` will not have been set by that time.

To get around this the `'listening'` event is queued in a `nextTick()`
to allow the script to run to completion. Which allows the user to set
to allow the script to run to completion. Which allows the user to set
any event handlers they want.

## `process.nextTick()` vs `setImmediate()`
Expand All @@ -379,8 +391,8 @@ We have two calls that are similar as far as users are concerned, but
their names are confusing.

* `process.nextTick()` fires immediately on the same phase
* `setImmediate()` fires on the following iteration or 'tick' of the
event loop
* `setImmediate()` fires on the following iteration or 'tick' of the
Event Loop

In essence, the names should be swapped. `process.nextTick()` fires more
immediately than `setImmediate()` but this is an artifact of the past
Expand All @@ -389,19 +401,19 @@ percentage of the packages on npm. Every day more new modules are being
added, which mean every day we wait, more potential breakages occur.
While they are confusing, the names themselves won't change.

*We recommend developers use `setImmediate()` in all cases because its
*We recommend developers use `setImmediate()` in all cases because it's
easier to reason about (and it leads to code that's compatible with a
wider variety of environments, like browser JS.)*

## Why use `process.nextTick()`?
## Why use `process.nextTick()`?

There are two main reasons:

1. Allow users to handle errors, cleanup any then unneeded resources, or
perhaps try the request again before the event loop continues.
perhaps try the request again before the Event Loop continues.

2. At times it's necessary to allow a callback to run after the call
stack has unwound but before the event loop continues.
stack has unwound but before the Event Loop continues.

One example is to match the user's expectations. Simple example:

Expand All @@ -413,14 +425,14 @@ server.listen(8080);
server.on('listening', function() { });
```

Say that listen() is run at the beginning of the event loop, but the
Say that listen() is run at the beginning of the Event Loop, but the
listening callback is placed in a `setImmediate()`. Now, unless a
hostname is passed binding to the port will happen immediately. Now for
the event loop to proceed it must hit the `poll` phase, which means
there is a non-zero chance that a connection could have been received
hostname is passed binding to the port will happen immediately. Now for
the Event Loop to proceed it must hit the `poll` phase, which means
there is a non-zero chance that a connection could have been received
allowing the connection event to be fired before the listening event.

Another example is running a function constructor that was to, say,
Another example is running a function constructor that was to, say,
inherit from `EventEmitter` and it wanted to call an event within the
constructor:

Expand All @@ -440,10 +452,10 @@ myEmitter.on('event', function() {
});
```

You can't emit an event from the constructor immediately
because the script will not have processed to the point where the user
assigns a callback to that event. So, within the constructor itself,
you can use `process.nextTick()` to set a callback to emit the event
You can't emit an event from the constructor immediately
because the script will not have processed to the point where the user
assigns a callback to that event. So, within the constructor itself,
you can use `process.nextTick()` to set a callback to emit the event
after the constructor has finished, which provides the expected results:

```js
Expand Down