Handling unhandled Promise rejections, avoiding application crash

By: (plus.google.com) +David Herron; Date: March 1, 2018

Tags: Node.JS » JavaScript

With Promises and async functions, errors are automatically caught and are turned into a Promise rejection. What happens if nothing inspects the rejected Promise? Turns out that, currently, Node.js detects the unhandled Promise rejection and it prints a warning. In the warning, it says the behavior of catching unhandled Promise rejections is deprecated and will be returned, and instead the application will crash. Therefore it's worth our while to figure out what to do with unhandled Promise rejections.

Let's start with what we mean by this. Suppose buried inside your application lies an async function that sometimes throws an error, but you neglected to catch the error. I don't have an example handy, but can concoct an artificial example.

var NotesModule;
async function model() {
    if (NotesModule) return NotesModule;
    NotesModule = require(`../models/notes-${process.env.NOTES_MODEL}`);
    return undefined; // NotesModule;
}

This function is loading a module that will be used by other code. It doesn't entirely matter what that other code is, just that returning undefined from this function is bad news. That other code will then throw an error because of the undefined value, and that error isn't getting caught in the application.

As a result we get this series of messages:

(node:32263) UnhandledPromiseRejectionWarning: TypeError: Cannot read property 'keylist' of undefined
    at Module.keylist (file:///home/david/nodewebdev/node-web-development-code-4th-edition/chap07/notes/models/notes.mjs:14:58)
    at <anonymous>
(node:32263) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 1)
(node:32263) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

The message Cannot read property 'keylist' of undefined is the other code throwing its error. But the error isn't caught and Node.js instead says - in effect - woah, I detected an unhandled rejected Promise, and in the future you won't be getting this nice message but instead you'll get a crashed process.

The solution is actually fairly simple. The most comprehensive solution is to handle every error path with appropriate code. But of course we're human and we slip up from time to time. I'm sure I've made at least one mistake in my life.

The workaround that prevents a crash is to add this code to your application:

process.on('unhandledRejection', (reason, p) => {
  error(`Unhandled Rejection at: ${util.inspect(p)} reason: ${reason}`);
});

The process object emits several events, and this new one covers unhandled Promise rejection. For documentation see: (nodejs.org) https://nodejs.org/api/process.html#process_event_unhandledrejection

The output looks like so:

  notes:error Unhandled Rejection at: Promise {
  notes:error   <rejected> TypeError: Cannot read property 'keylist' of undefined
  notes:error     at Module.keylist (file:///home/david/nodewebdev/node-web-development-code-4th-edition/chap07/notes/models/notes.mjs:14:58)
  notes:error     at <anonymous> } reason: TypeError: Cannot read property 'keylist' of undefined +6s

Or, in another instance:

  notes:error Unhandled Rejection at: Promise {
  notes:error   <rejected> TypeError: model(...).keylist is not a function
  notes:error     at Module.keylist (file:///home/david/nodewebdev/node-web-development-code-4th-edition/chap07/notes/models/notes.mjs:40:44)
  notes:error     at router.get (file:///home/david/nodewebdev/node-web-development-code-4th-edition/chap07/notes/routes/index.mjs:9:29)
  notes:error     at Layer.handle [as handle_request] (/home/david/nodewebdev/node-web-development-code-4th-edition/chap07/notes/node_modules/express/lib/router/layer.js:95:5)
  notes:error     at next (/home/david/nodewebdev/node-web-development-code-4th-edition/chap07/notes/node_modules/express/lib/router/route.js:137:13)
  notes:error     at Route.dispatch (/home/david/nodewebdev/node-web-development-code-4th-edition/chap07/notes/node_modules/express/lib/router/route.js:112:3)
  notes:error     at Layer.handle [as handle_request] (/home/david/nodewebdev/node-web-development-code-4th-edition/chap07/notes/node_modules/express/lib/router/layer.js:95:5)
  notes:error     at /home/david/nodewebdev/node-web-development-code-4th-edition/chap07/notes/node_modules/express/lib/router/index.js:281:22
  notes:error     at Function.process_params (/home/david/nodewebdev/node-web-development-code-4th-edition/chap07/notes/node_modules/express/lib/router/index.js:335:12)
  notes:error     at next (/home/david/nodewebdev/node-web-development-code-4th-edition/chap07/notes/node_modules/express/lib/router/index.js:275:10)
  notes:error     at Function.handle (/home/david/nodewebdev/node-web-development-code-4th-edition/chap07/notes/node_modules/express/lib/router/index.js:174:3) } reason: TypeError: model(...).keylist is not a function +3s

This is very useful output - since it tells us exactly where the issue occurred, and the precise problem. Plus, the application doesn't crash.

« Dynamic import lands in Node.js, we can import ES6 modules in CommonJS code Hiding data, creating encapsulation, in JavaScript ES-2015 classes »
2016 Election 2018 Elections Acer C720 Ad block Affiliate marketing Air Filters Air Quality Air Quality Monitoring AkashaCMS Amazon Amazon Kindle Amazon Web Services America Amiga and Jon Pertwee Android Anti-Fascism AntiVirus Software Apple Apple Flexgate Apple Hardware History Apple Hardware Mistakes Apple iPhone Apple iPhone Hardware April 1st Arduino ARM Compilation Artificial Intelligence Astronomy Astrophotography Asynchronous Programming Authoritarianism Automated Social Posting AWS DynamoDB AWS Lambda Ayo.JS Bells Law Big Brother Big Data Big Finish Big Science Bitcoin Mining Black Holes Blade Runner Blockchain Blogger Blogging Books Botnets Cassette Tapes Cellphones China China Manufacturing Christopher Eccleston Chrome Chrome Apps Chromebook Chromebox ChromeOS CIA CitiCards Citizen Journalism Civil Liberties Climate Change Clinton Cluster Computing Command Line Tools Comment Systems Computer Accessories Computer Hardware Computer Repair Computers Conservatives Cross Compilation Crouton Cryptocurrency Curiosity Rover Currencies Cyber Security Cybermen Cybersecurity Daleks Darth Vader Data backup Data Formats Data Storage Database Database Backup Databases David Tenant DDoS Botnet Department of Defense Department of Justice Detect Adblocker Developers Editors Digital audio Digital Nomad Digital Photography Direct Attach Storage Diskless Booting Disqus DIY DIY Repair DNP3 Do it yourself Docker Docker MAMP Docker Swarm Doctor Who Doctor Who Paradox Doctor Who Review Drobo Drupal Drupal Themes DuckDuckGo DVD E-Books E-Readers Early Computers eGPU Election Hacks Electric Bicycles Electric Vehicles Electron Eliminating Jobs for Human Emdebian Encabulators Energy Efficiency Enterprise Node EPUB ESP8266 Ethical Curation Eurovision Event Driven Asynchronous Express Face Recognition Facebook Fake Advertising Fake News Fedora VirtualBox Fifth Doctor File transfer without iTunes FireFly Flash Flickr Fraud Freedom of Speech Front-end Development G Suite Gallifrey Gig Economy git Github GitKraken Gitlab GMAIL Google Google Adsense Google Chrome Google Gnome Google+ Government Spying Great Britain Green Transportation Hate Speech Heat Loss Hibernate High Technology Hoax Science Home Automation HTTP Security HTTPS Human ID I2C Protocol Image Analysis Image Conversion Image Processing ImageMagick In-memory Computing Incognito Mode InfluxDB Infrared Thermometers Insulation Internet Internet Advertising Internet Law Internet of Things Internet Policy Internet Privacy iOS iOS Devices iPad iPhone iPhone hacking Iron Man iShowU Audio Capture iTunes Janet Fielding Java JavaFX JavaScript JavaScript Injection JDBC John Simms Journalism Joyent jQuery Kaspersky Labs Kext Kindle Kindle Marketplace Large Hadron Collider Lets Encrypt LibreOffice Linux Linux Hints Linux Single Board Computers Logging Mac Mini Mac OS Mac OS X Mac Pro MacBook Pro Machine Learning Machine Readable ID Macintosh macOS macOS High Sierra macOS Kext MacOS X setup Make Money Online Make Money with Gigs March For Our Lives MariaDB Mars Mass Violence Matt Lucas MEADS Anti-Missile Mercurial MERN Stack Michele Gomez Micro Apartments Microsoft Military AI Military Hardware Minification Minimized CSS Minimized HTML Minimized JavaScript Missy Mobile Applications Mobile Computers MODBUS Mondas Monetary System MongoDB Mongoose Monty Python MQTT Music Player Music Streaming MySQL NanoPi Nardole NASA Net Neutrality Network Attached Storage Node Web Development Node.js Node.js Database Node.js Performance Node.js Testing Node.JS Web Development Node.x North Korea npm NSA NVIDIA NY Times Online advertising Online Community Online Fraud Online Journalism Online News Online Photography Online Video Open Media Vault Open Source Open Source and Patents Open Source Governance Open Source Licenses Open Source Software OpenAPI OpenJDK OpenVPN Palmtop PDA Patrick Troughton PayPal Paywalls Personal Flight Peter Capaldi Peter Davison Phishing Photography PHP Plex Plex Media Server Political Protest Politics Postal Service Power Control President Trump Privacy Private E-mail server Production use Public Violence Raspberry Pi Raspberry Pi 3 Raspberry Pi Zero ReactJS Recaptcha Recycling Refurbished Computers Remote Desktop Removable Storage Renewable Energy Republicans Retro Computing Retro-Technology Reviews RFID Rich Internet Applications Right to Repair River Song Robotics Robots Rocket Ships RSS News Readers rsync Russia Russia Troll Factory Russian Hacking Rust SCADA Scheme Science Fiction SD Cards Search Engine Ranking Search Engines Season 1 Season 10 Season 11 Security Security Cameras Server-side JavaScript Serverless Framework Servers Shell Scripts Silence Simsimi Skype SmugMug Social Media Social Media Networks Social Media Warfare Social Network Management Social Networks Software Development Software Patents Space Flight Space Ship Reuse Space Ships SpaceX Spear Phishing Spring Spring Boot Spy Satellites SQLite3 SSD Drives SSD upgrade SSH SSH Key SSL Stand For Truth Strange Parts Swagger Synchronizing Files Tegan Jovanka Telescopes Terrorism The Cybermen The Daleks The Master Time-Series Database Tom Baker Torchwood Total Information Awareness Trump Trump Administration Trump Campaign Twitter Ubuntu Udemy UDOO US Department of Defense Video editing Virtual Private Networks VirtualBox VLC VNC VOIP Vue.js Walmart Weapons Systems Web Applications Web Developer Resources Web Development Web Development Tools Web Marketing Webpack Website Advertising Website Business Models Weeping Angels WhatsApp William Hartnell Window Insulation Windows Windows Alternatives Wordpress World Wide Web Yahoo YouTube YouTube Adpocalypse YouTube Monetization