Search code examples
javascriptnode.jsasynchronouspromisenonblocking

Why does NodeJS NOT use Promise for the readFile API?


In the book https://pragprog.com/book/tbajs/async-javascript, I found this:

Node’s early iterations used Promises in its nonblocking API. However, in February 2010, Ryan Dahl made the decision to switch to the now-familiar callback(err, results...) format, on the grounds that Promises are a higher-level construct that belongs in “userland.”

It looks quite confusing to me, because as an API to read files, this

fs.readFile('/etc/passwd')
.onSuccess(function(data){console.log(data)})
.onError(function(err){throw err})

looks much better than this:

fs.readFile('/etc/passwd', function (err, data) {
  if (err) throw err;
  console.log(data);
});

Does anyone have ideas about why "Promises are a higher-level construct" will stops itself from being used in NodeJS API?


Solution

  • Node v8 ships with util.promisify that converts callback APIs to promises, Node v10 ships with native promises support (experimental):

    const fs = require('fs').promises;
    
    // in an async function:
    let data = await fs.readFile('/etc/passwd');
    console.log(data);
    

    The future is promises:

    NodeJS will use promises for the new APIs. In fact it is currently discussed how. An earlier attempt in 0.2 to use Promises in node years ago failed because of friction and performance issues.

    What has to happen first:

    Now promises are a native language feature, but the following has to happen before they make it to the core APIs:

    • Promises have to be a native language construct this already happened.
    • The NodeJS and io.js merger that was recently announced has to happen - the time frame is a few short months probably.
    • The v8 (JavaScript engine) team has to finish working on private symbols which will enable fast promise creation. At the moment the promise constructor is the only way to create promises in native promises and it allocates a closure which is relatively expensive. This is currently being done with Domenic working in tight coordination between the io.js and v8 team to ensure this is done properly.
    • The v8 team has to optimize the promise implementation, currently native promises lose consistently to userland implementations like bluebird. This is also happening now.

    Once all these happen the API will be forked and a version containing promises will be integrated into core. Here is a long and uninteresting discussion about it - there is a better one at the io.js/NG repo but neither are really too informative.

    What can be done today

    Libraries like give you tools to instantly convert a callback API to promises in a fast and efficient way. You can use them today and get that functionality.