Robust Error Handling in Node v1

Slide 1

Slide 1 text

Robust Error Handling in Node.js

Slide 2

Slide 2 text

Who are you? • I'm Lewis, I like JavaScript, I work for Sentry • Sentry is the open source crash reporting & error tracking service • I maintain raven-node, the Sentry Node.js SDK. • It captures and reports about 100 million errors per week

Slide 3

Slide 3 text

Why should you want robust error handling in Node?

Slide 4

Slide 4 text

This talk is for you if...

Slide 5

Slide 5 text

You've ever written code like this: fs.readFile('myFile.txt', { encoding: 'utf8' }, function (err, data) { console.log(data); });

Slide 6

Slide 6 text

Or this: http.get(myUrl, function (res) { doSomethingWith(res); });

Slide 7

Slide 7 text

Or even this: try { data = JSON.parse(userInput); } catch (e) { // this should never happen } doSomethingWith(data);

Slide 8

Slide 8 text

"this should never happen"

Slide 9

Slide 9 text

Famous last words

Slide 10

Slide 10 text

We can do better!

Slide 11

Slide 11 text

This is a little better: fs.readFile('myFile.txt', { encoding: 'utf8' }, function (err, data) { if (err) return console.error(err); doSomethingWith(data); });

Slide 12

Slide 12 text

But we can do a lot better

Slide 13

Slide 13 text

Overview of topics • Background and how Node is special/different • Handle what you can, avoid what you can't • The robust game plan to follow • Exceptions, Callbacks, Promises, EventEmitters, and more • Catching, reporting, shutting down, restarting gracefully

Slide 14

Slide 14 text

Error Mechanisms in Other Languages • Python: try/except and raise • Ruby: begin/rescue and raise • PHP: try/catch and throw • Lua: pcall() and error()

Slide 15

Slide 15 text

So Node has some similar thing, right?

Slide 16

Slide 16 text

Well, sure, this works: try { throw new Error('boom!'); } catch (e) { console.log('Aha! I caught the error!'); }

Slide 17

Slide 17 text

Well, sure, this works: try { throw new Error('boom!'); } catch (e) { console.log('Aha! I caught the error!'); } $ node try-catch.js

Slide 18

Slide 18 text

Well, sure, this works: try { throw new Error('boom!'); } catch (e) { console.log('Aha! I caught the error!'); } $ node try-catch.js > Aha! I caught the error!

Slide 19

Slide 19 text

But where try-catch comes up short: try { setTimeout(function () { throw new Error('boom!'); }, 0); } catch (e) { console.log('Aha! I caught the error!'); }

Slide 20

Slide 20 text

But where try-catch comes up short: try { setTimeout(function () { throw new Error('boom!'); }, 0); } catch (e) { console.log('Aha! I caught the error!'); } $ node try-settimeout.js

Slide 21

Slide 21 text

But where try-catch comes up short: try { setTimeout(function () { throw new Error('boom!'); }, 0); } catch (e) { console.log('Aha! I caught the error!'); } $ node try-settimeout.js /Users/lewis/dev/node-error-talk/try-settimeout.js:3 throw new Error('boom!'); ^ Error: boom! at Timeout._onTimeout (/Users/lewis/dev/node-error-talk/try-settimeout.js:3:11) at ontimeout (timers.js:365:14) at tryOnTimeout (timers.js:237:5) at Timer.listOnTimeout (timers.js:207:5)

Slide 22

Slide 22 text

Why? • Try-catch is synchronous, setTimeout is asynchronous • Callback is queued and will throw the error later • Catch block is no longer waiting to catch the exception • Run-to-completion semantics & event loop are behind this

Slide 23

Slide 23 text

How Node is Different • Other languages: • Each process handles one request at a time • Everything is synchronous, try/catch works ﬁne • Easy to keep one request from blowing everything up • Node: single process, cooperative concurrency, asynchronous I/O • Handles multiple requests at the same time in the same thread • Try/catch doesn't work well in asynchronous world • Any one request blowing up could mess up the others

Slide 24

Slide 24 text

What this means for us • We need other mechanisms to handle asynchronous errors • We can't try/catch and throw exceptions for everything • An error in one request can take down the entire server • We have to be extra careful to keep things online • Our program can end up in unknown states • Only correct thing to do might be shut down!

Slide 25

Slide 25 text

Errors vs Exceptions What's the difference, anyway?

Slide 26

Slide 26 text

Errors Error is just a special class in JavaScript - You can pass an Error object around like any other value - Runtime errors throw an Error object - Has a message and a stack property - Also RangeError, ReferenceError, SyntaxError, others var myError = new Error('my error message');

Slide 27

Slide 27 text

Exceptions Exception: what happens when you throw something - Usually you throw an Error object - Call stack unwinds looking for a catch block - You can throw anything, not just Error objects...but don't - If an exception is unhandled, Node will shut down throw new Error('something bad happened!'); throw 'something bad happened' // avoid this

Slide 28

Slide 28 text

Stack trace example function a() { // call stack here is [a] b(); } function b(x) { // call stack here is [b, a] try { c() } catch (e) { console.log(e.stack); } } function c() { // call stack here is [c, b, a] throw new Error('boom'); } a();

Slide 29

Slide 29 text

Error: boom at c (/Users/lewis/dev/node-error-talk/try-catch.js:14:9) at b (/Users/lewis/dev/node-error-talk/try-catch.js:7:5) at a (/Users/lewis/dev/node-error-talk/try-catch.js:2:3) at Object. (/Users/lewis/dev/node-error-talk/try-catch.js:17:1) ... This is useful! We want to see it!

Slide 30

Slide 30 text

Errors vs Exceptions in Async Node Land • We're generally not going to throw Exceptions • We're going to pass Error objects around a lot

Slide 31

Slide 31 text

Three core guidelines

Slide 32

Slide 32 text

Always know when your errors happen

Slide 33

Slide 33 text

Avoid patterns like: function (err, result) { if (err) { /* drat, ignore */ } } try { ... } catch (e) { // this should never happen } Promise.catch(function (reason) { // surely this won't happen }); req.on('error', function (err) { // oh well, not gonna do anything });

Slide 34

Slide 34 text

Handle what you can, avoid what you can't

Slide 35

Slide 35 text

Operational Errors vs Programming Errors • Operational error: recoverable - expect and handle these • Typically an Error object being passed around • Programming error: nonrecoverable - try to avoid these • Typically an Exception thrown

Slide 36

Slide 36 text

Operational Errors to Expect • Network timeouts • Database is down • Disk got full • 3rd party API returning errors • us-east-1 S3 • Unexpected or missing user inputs (JSON.parse)

Slide 37

Slide 37 text

Programming Errors to Avoid • Silently ignoring/swallowing errors instead of handling them • Classic JavaScript errors • TypeError: undefined is not a function • TypeError: Cannot read property 'x' of undefined • ReferenceError: x is not defined • Invoking a callback twice • Using the wrong error mechanism in the wrong place

Slide 38

Slide 38 text

What to do with each: • Operational errors • Known; handle manually wherever they may occur • Recoverable if handled correctly • We don't have to shut down everything just because S3 is down • Avoid assuming anything is reliable outside your own process • Programming errors • Unknown; catch with global error handler • Nonrecoverable: we're gonna have to abandon ship • No amount of additional code can ﬁx a typo • Use a linter to help avoid many common problems

Slide 39

Slide 39 text

Don't keep running in an unknown state

Slide 40

Slide 40 text

Don't keep running in an unknown state • State shared across multiple requests: less isolation • Unexpected error in one request can pollute state of others • Polluted state can lead to undeﬁned behavior • Memory leaks, inﬁnite loops, security issues • Only way to get back to a known good state: bail out, restart

Slide 41

Slide 41 text

This leads us to the game plan

Slide 42

Slide 42 text

The game plan 1. Always know when errors happen: don't ignore! 2. Handle what you can, avoid what you can't 3. Know and use different mechanisms for effective handling 4. Have a global catch-all for the errors you couldn't handle 5. Use a process manager so shutting down is no big deal 6. Accept when it's time to pack up shop, clean up, shut down

Slide 43

Slide 43 text

3. Know and use different mechanisms for effective handling

Slide 44

Slide 44 text

Error Mechanisms in Node • Try/Catch - throw and try/catch • Callbacks - err ﬁrst argument and if (err) • Promises - reject(err) and .catch() • EventEmitters - error events and .on('error') • Express - next(err) and error-handling middleware

Slide 45

Slide 45 text

Callbacks & Try-catch function readAndParse(file, callback) { fs.readFile(file, { encoding: 'utf8' }, function (err, data) { if (err) return callback(err); try { callback(null, JSON.parse(data)); } catch (e) { callback(e); } }); }

Slide 46

Slide 46 text

Promises var p = new Promise(function (resolve, reject) { fs.readFile('data.txt', function (err, data) { if (err) return reject(err); resolve(data); }); }); p.then(parseJson) .then(doSomethingElse) .catch(function (reason) { // if readFile or JSON parsing or something else failed, // we can handle it here });

Slide 47

Slide 47 text

EventEmitters • Servers, sockets, requests, streams • Long-lived objects with asynchronous stuff going on • They can emit error events: listen for them! • If an error event is emitted without an error listener... • The Error object will be thrown instead! • How operational errors become programming errors

Slide 48

Slide 48 text

EventEmitter Request Example var req = http.get(url, function (res) { doSomething(res); }); req.on('error', function (err) { // we caught the request error, let's recover }

Slide 49

Slide 49 text

Express Error Middleware app.post('/login', function (req, res, next) { db.query('SELECT ...', function (err, user) { if (err) return next(err); }); }); app.use(function (req, res, next, err) { // spit out your own error page, log the error, etc next(); });

Slide 50

Slide 50 text

4. Have a global catch-all for the errors you couldn't handle

Slide 51

Slide 51 text

Basic Global Error Handler process.on('uncaughtException', function (err) { console.log('Uncaught exception! Oh no!'); console.error(err); process.exit(1); });

Slide 52

Slide 52 text

5. Use a process manager so shutting down is no big deal

Slide 53

Slide 53 text

Process managers and Node • Run multiple server processes • One of them dying won't take us ofﬂine • Node cluster module • Process managers: systemd, pm2, forever, naught • Will automatically restart processes when they die • Some provide further Node-speciﬁc functionality

Slide 54

Slide 54 text

Example with naught var server = http.createServer(...); process.on('uncaughtException', function (err) { console.log('Uncaught exception! Oh no!'); console.error(err); // tell naught to stop sending us connections & start up a replacement process.send('offline'); process.exit(1); }); server.listen(80, function () { // tell naught we're ready for traffic if (process.send) process.send('online'); });

Slide 55

Slide 55 text

6. Accept when it's time to pack up shop, clean up, shut down

Slide 56

Slide 56 text

When we catch a "fatal" error, we want to: • Quit accepting new connections • Start reporting whatever we're gonna report • Tell proc manager we're gonna die so it starts replacement • Wait for any existing requests, sockets, etc to be dealt with • Close any open resources, connections, etc • Shut down

Slide 57

Slide 57 text

We want to report that stack trace! function reportError(err, cb) { // send the stack trace somewhere, then call cb() } process.on('uncaughtException', function (err) { process.send('offline'); reportError(err, function (sendErr) { // once error has been reported, let's shut down process.exit(1); }); });

Slide 58

Slide 58 text

Maybe get a text message: var myPhone = "..." function reportError(err, cb) { console.error(err); twilio.sendTextMessage(myPhone, err.message, cb); }

Slide 59

Slide 59 text

Also useful to report operational errors db.query('SELECT ...', function (err, results) { if (err) { return reportError(err); } doSomething(results); });

Slide 60

Slide 60 text

But then the database goes down...

Slide 61

Slide 61 text

Alternatively, use Sentry The raven npm package is our Node SDK: var Raven = require('raven'); Raven.config(''); function reportError(err, cb) { console.error(err); Raven.captureException(err, cb); }

Slide 62

Slide 62 text

Graceful shutdown server = http.createServer(...); function shutDownGracefully(err, cb) { // quit accepting connection, clean up any other resources server.close(function () { // can also wait for all connections: server._connections reportError(err, cb) }); } process.on('uncaughtException', function (err) { process.send('offline'); shutDownGracefully(function () { process.exit(1); }); }); • Wait for any existing requests, sockets, etc to be dealt with • Close any open resources, connections, etc

Slide 63

Slide 63 text

Big Combined Example server = http.createServer(...); function reportError(err, cb) { console.error(err); Raven.captureException(err, cb); } function shutDownGracefully(err, cb) { // quit accepting connection, clean up any other resources server.close(function () { // can also wait for all connections: server._connections reportError(err, cb) }); } process.on('uncaughtException', function (err) { process.send('offline'); shutDownGracefully(function () { process.exit(1); }); }); server.listen(80, function () { if (process.send) process.send('online'); });

Slide 64

Slide 64 text

What NOT to do with a global catch-all: • Just log the error and carry on • Keep the process running indeﬁnitely • Try to recover in any way: it's too late! • Try to centralize handling of operational errors into one place

Slide 65

Slide 65 text

Other global error mechanisms • process.on('uncaughtException') • process.on('unhandledRejection') • Domains - but application code shouldn't need them

Slide 66

Slide 66 text

Recap: overall gameplan 1. Always know when errors happen: don't ignore! 2. Handle what you can, avoid what you can't 3. Know and use different mechanisms for effective handling 4. Have a global catch-all for the errors you couldn't handle 5. Use a process manager so shutting down is no big deal 6. Accept when it's time to pack up shop, clean up, shut down

Slide 67

Slide 67 text

Related things I didn't go into • Run-to-completion semantics & the event loop • V8 stacktrace API • The "callback contract" • Async/Await • Domains (and async_hooks) • Cluster module & process managers

Slide 68

Slide 68 text

Some related links • https://sentry.io/for/node/ • https://www.joyent.com/node-js/production/design/errors • https://nodejs.org/api/errors.html

Slide 69

Slide 69 text

Where are the slides? • Slides available at GitHub.com/LewisJEllis/node-error-talk • I'm Lewis J Ellis: @lewisjellis on Twitter and GitHub

Slide 70

Slide 70 text

Thank you! May your Node applications run happily ever after