Some general improvements to the getting started guide (#347)

* Some general improvements to the getting started guide

- Includes a shutdown handler (best practice)
- Uses a modern, async-aware test runner (Jest)
- Aligns on the change to use port 5006 (+3 squashed commits)

* Update README.md

Co-authored-by: Ed Morley <[email protected]>

* Update package.json

Co-authored-by: Ed Morley <[email protected]>

* Drop `version` + add `private: true`

---------

Co-authored-by: Ed Morley <[email protected]>

Author: colincasey

Procfile

@@ -1 +1 @@
-web: npm start
+web: node index.js

README.md

@@ -1,6 +1,6 @@
 # node-js-getting-started
 
-A barebones Node.js app using [Express 4](http://expressjs.com/).
+A barebones Node.js app using [Express](https://expressjs.com/).
 
 This application supports the [Getting Started on Heroku with Node.js](https://devcenter.heroku.com/articles/getting-started-with-nodejs) article - check it out.
 
@@ -15,7 +15,7 @@ $ npm install
 $ npm start
 ```
 
-Your app should now be running on [localhost:5001](http://localhost:5001/).
+Your app should now be running on [localhost:5006](http://localhost:5006/).
 
 ## Deploying to Heroku
 

index.js

@@ -1,11 +1,27 @@
 const express = require('express')
 const path = require('path')
 
-const PORT = process.env.PORT || 5001
-
-express()
-  .use(express.static(path.join(__dirname, 'public')))
-  .set('views', path.join(__dirname, 'views'))
-  .set('view engine', 'ejs')
-  .get('/', (req, res) => res.render('pages/index'))
-  .listen(PORT, () => console.log(`Listening on ${ PORT }`))
+const port = process.env.PORT || 5006
+
+const app = express()
+
+app.use(express.static(path.join(__dirname, 'public')))
+app.set('views', path.join(__dirname, 'views'))
+app.set('view engine', 'ejs')
+
+app.get('/', (req, res) => {
+  res.render('pages/index')
+})
+
+const server = app.listen(port, () => {
+  console.log(`Listening on ${port}`)
+})
+
+process.on('SIGTERM', async () => {
+  console.log('SIGTERM signal received: gracefully shutting down')
+  if (server) {
+    server.close(() => {
+      console.log('HTTP server closed')
+    })
+  }
+})

package-lock.json

@@ -1,21 +1,21 @@
 {
   "name": "node-js-getting-started",
-  "version": "0.3.0",
-  "description": "A sample Node.js app using Express 4",
+  "private": true,
+  "description": "A sample Node.js app using Express",
   "engines": {
-    "node": "22.x"
+    "node": "18.x || 20.x || 22.x"
   },
   "main": "index.js",
   "scripts": {
     "start": "node index.js",
-    "test": "node test.js"
+    "test": "jest"
   },
   "dependencies": {
-    "ejs": "^3.1.9",
-    "express": "^4.15.2"
+    "ejs": "^3.1.10",
+    "express": "^5.0.1"
   },
   "devDependencies": {
-    "tape": "^5.7.4"
+    "jest": "^29.7.0"
   },
   "repository": {
     "type": "git",

package.json

@@ -1,32 +1,39 @@
-const { spawn } = require('child_process');
+const { spawn } = require('child_process')
 const { request } = require('http')
-const { URL } = require('url')
-const test = require('tape');
 
-// Start the app
-const env = Object.assign({}, process.env, {PORT: 5001});
-const child = spawn('node', ['index.js'], {env});
+const PORT = process.env.PORT || 5006
 
-test('responds to requests', (t) => {
-  t.plan(4);
+describe('getting started guide', () => {
+  let app
 
-  // Wait until the server is ready
-  child.stdout.on('data', _ => {
-    // Make a request to our app
-    (async () => {
-      const response = await get('http://127.0.0.1:5001')
-      // stop the server
-      child.kill();
-      // No error
-      t.false(response.error);
-      // Successful response
-      t.equal(response.statusCode, 200);
-      // Assert content checks
-      t.notEqual(response.body.indexOf("<title>Node.js Getting Started on Heroku</title>"), -1);
-      t.notEqual(response.body.indexOf("Getting Started on Heroku with Node.js"), -1);
-    })();
-  });
-});
+  beforeEach(async () => {
+    app = spawn('node', ['index.js'])
+    app.stdout.on('data', (data) => console.log(data.toString()))
+    // give the server a short time to start up
+    return new Promise(resolve => setTimeout(resolve, 500))
+  })
+
+  afterEach(() => {
+    if (app) {
+      app.stdout.removeAllListeners()
+      app.kill('SIGTERM')
+    }
+  })
+
+  it('should bind to IPv4 and respond to GET /', async () => {
+    const response = await get(`http://127.0.0.1:${PORT}`)
+    expect(response.statusCode).toBe(200)
+    expect(response.body).toMatch("<title>Node.js Getting Started on Heroku</title>")
+    expect(response.body).toMatch("Getting Started on Heroku with Node.js")
+  })
+
+  it('should bind to IPv6 and respond to GET /', async () => {
+    const response = await get(`http://[::1]:${PORT}`)
+    expect(response.statusCode).toBe(200)
+    expect(response.body).toMatch("<title>Node.js Getting Started on Heroku</title>")
+    expect(response.body).toMatch("Getting Started on Heroku with Node.js")
+  })
+})
 
 async function get(url) {
   return new Promise((resolve, reject) => {
@@ -36,11 +43,11 @@ async function get(url) {
       res.on('data', (data) => body += data)
       res.on('end', () => {
         resolve({
-          error: false,
           statusCode: res.statusCode,
           body: body
         })
       })
+      res.on('error', reject)
     })
     req.on('error', reject)
     req.end()