Node.js — Fix „Socket Hang Up“ Errors

Node.js published the first release of version 19.0.0 on October 18th, 2022. After that, we updated some of the Supercharge packages to run tests for Node.js 19 to ensure compatibility of the packages.

One hiccup we noticed were the test runs for the @supercharge/sttp package. Sttp is our Http client providing a pleasant developer experience. Yet, when testing on Node.js 19 we always ran into a „Socket Hang Up“ error.

This tutorial shows you how to fix these errors!

Node.js Series Overview

  1. String Replace All Appearances
  2. Remove All Whitespace From a String in JavaScript
  3. Generate a Random ID or String in Node.js or JavaScript
  4. Remove Extra Spaces From a String in JavaScript or Node.js
  5. Remove Numbers From a String in JavaScript or Node.js
  6. Get the Part Before a Character in a String in JavaScript or Node.js
  7. Get the Part After a Character in a String in JavaScript or Node.js
  8. How to Check if a Value is a String in JavaScript or Node.js
  9. Check If a String Includes All Strings in JavaScript/Node.js/TypeScript
  10. Check if a Value is a String in JavaScript and Node.js
  11. Limit and Truncate a String to a Given Length in JavaScript and Node.js
  12. Split a String into a List of Characters in JavaScript and Node.js
  13. How to Generage a UUID in Node.js
  14. Reverse a String in JavaScript or Node.js
  15. Split a String into a List of Lines in JavaScript or Node.js
  16. Split a String into a List of Words in JavaScript or Node.js
  17. Detect if a String is in camelCase Format in Javascript or Node.js
  18. Check If a String Is in Lowercase in JavaScript or Node.js
  19. Check If a String is in Uppercase in JavaScript or Node.js
  20. Get the Part After First Occurrence in a String in JavaScript or Node.js
  21. Get the Part Before First Occurrence in a String in JavaScript or Node.js
  22. Get the Part Before Last Occurrence in a String in JavaScript or Node.js
  23. Get the Part After Last Occurrence in a String in JavaScript or Node.js
  24. How to Count Words in a File
  25. How to Shuffle the Characters of a String in JavaScript or Node.js
  26. Append Characters or Words to a String in JavaScript or Node.js (Coming soon)
  27. Check if a String is Empty in JavaScript or Node.js (Coming soon)
  28. Ensure a String Ends with a Given Character in JavaScript or Node.js (Coming soon)
  29. Left-Trim Characters Off a String in JavaScript or Node.js (Coming soon)
  30. Right-Trim Characters Off a String in JavaScript or Node.js (Coming soon)
  31. Lowercase the First Character of a String in JavaScript or Node.js (Coming soon)
  32. Uppercase the First Character of a String in JavaScript or Node.js (Coming soon)
  33. Prepend Characters or Words to a String in JavaScript or Node.js (Coming soon)
  1. Get Number of Seconds Since Epoch in JavaScript
  2. Get Tomorrow’s Date in JavaScript
  3. Increase a Date in JavaScript by One Week
  4. Add Seconds to a Date in Node.js and JavaScript
  5. Add Month(s) to a Date in JavaScript or Node.js
  6. Add Week(s) to a Date in JavaScript or Node.js
  7. Get the Current Year in JavaScript or Node.js
  8. How to Get a UNIX Timestamp in JavaScript or Node.js
  9. How to Convert a UNIX Timestamp to a Date in JavaScript or Node.js
  10. Add Days to a Date in JavaScript or Node.js
  11. Get Yesterday's Date in JavaScript or Node.js
  12. Add Minutes to a Date in JavaScript or Node.js (Coming soon)
  13. Add Hours to a Date in JavaScript or Node.js (Coming soon)
  14. Check If a Date Is Today in JavaScript or Node.js (Coming soon)
  15. Check If a Date is Tomorrow in JavaScript or Node.js (Coming soon)
  16. Check If a Date is Yesterday in JavaScript or Node.js (Coming soon)
  17. How to Format a Date YYYY-MM-DD in JavaScript or Node.js (Coming soon)

Fixing the „Socket Hang Up“ Errors in Node.js (v19)

The failing tests in the Sttp package were only on Node.js 19. There must be a change in in the Node.js 19.x release line that causes the socket hang up issues.

And the change is that starting from Node.js 19 the HTTP server uses HTTP(S)/1.1 Keep-Alive by default. This sets the keepAlive setting of the HTTP server to true which means outgoing HTTP(S) connections automatically use HTTP 1.1 Keep-Alive with a timeout of 5 seconds.

The keep-alive is related to our tests running into „socket hang up“ issues because we expected the HTTP connection to be closed after using it. But keeping the connection alive would cause issues with our testing setup.

Close Connections on Your HTTP Server

You can configure your Node.js HTTP server to not keep connections alive by providing the keepAlive option when creating your server instance:

import { createServer } from 'node:http'

const server = createServer({ keepAlive: false }, (req, res) => {  
  //
})

Close Connections Using the Connection Header

You may close HTTP connections using the Connection: 'close' header with your requests or responses. Clients may send the header or you append this header to the response:

// close connections from client
import { Sttp } from '@supercharge/sttp'

const response = await Sttp  
  .withHeaders({ Connection: 'close' })
  .get('http://localhost:3000/base-url')


// close connections with the server response
import { createServer } from 'node:http'

const server = createServer({ keepAlive: false }, (req, res) => {  
  res.setHeader('Connection', 'close')
  res.end('Request handled :)')
})

Change the Keep-Alive Timeout

In case you want the keep-alive functionality to stay enabled, you can adjust the timeout value. Assign your timeout value in milliseconds to the Node.js HTTP server instance:

import { createServer } from 'node:http'

const server = createServer((req, res) => {  
  //
})

// change the keep-alive timeout to 3 seconds
server.keepAliveTimeout = 3000  

Enjoy keep-alive connections in Node.js!


Mentioned Resources

Explore the Library

Find interesting tutorials and solutions for your problems.