st 2.0.0 → 3.0.1

package/.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: Test
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        node: [lts/*, current]
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Install Dependencies
+        run: |
+          npm install --no-progress
+      - name: Run tests
+        run: |
+          npm test

package/.travis.yml

@@ -1,10 +1,10 @@
 sudo: false
 language: node_js
 node_js:
-  - '10'
   - '12'
+  - '14'
   - lts/*
-  - current
+  - node
 branches:
   only:
     - master

package/bin/server.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 const st = require('../st.js')
 const http = require('http')
+const { STATUS_CODES } = http
 let port = +(process.env.PORT || 1337)
 let host
 let dir = ''
@@ -180,7 +181,7 @@ http.createServer(function (q, s) {
     return
   }
   s.statusCode = 404
-  s.end('not found')
+  s.end(STATUS_CODES[s.statusCode])
 }).listen(port, host, function () {
   const addr = this.address()
   const port = addr.port

package/package.json

@@ -1,28 +1,28 @@
 {
   "name": "st",
-  "version": "2.0.0",
+  "version": "3.0.1",
   "description": "A module for serving static files.  Does etags, caching, etc.",
   "main": "st.js",
   "bin": "bin/server.js",
   "dependencies": {
     "async-cache": "^1.1.0",
-    "bl": "^4.0.0",
-    "fd": "~0.0.2",
-    "mime": "^2.4.4",
+    "bl": "^5.0.0",
+    "fd": "~0.0.3",
+    "mime": "^2.5.2",
     "negotiator": "~0.6.2"
   },
   "optionalDependencies": {
     "graceful-fs": "^4.2.3"
   },
   "devDependencies": {
-    "request": "^2.88.0",
-    "rimraf": "^3.0.0",
-    "standard": "^14.3.1",
-    "tap": "^14.9.2"
+    "request": "^2.88.2",
+    "rimraf": "^3.0.2",
+    "standard": "^16.0.3",
+    "tap": "^15.0.9"
   },
   "scripts": {
     "lint": "standard",
-    "test": "npm run lint && tap test/*.js test/cli/*-test.js"
+    "test": "npm run lint && tap test/*.js test/cli/*-test.js --no-coverage"
   },
   "repository": {
     "type": "git",

package/st.js

@@ -13,6 +13,7 @@ const http = require('http')
 const AC = require('async-cache')
 const FD = require('fd')
 const bl = require('bl')
+const { STATUS_CODES } = http
 
 const defaultCacheOptions = {
   fd: {
@@ -114,8 +115,10 @@ class Mount {
     this.opt = opt
     this.url = opt.url
     this.path = opt.path
-    this._index = opt.index === false ? false
-      : typeof opt.index === 'string' ? opt.index
+    this._index = opt.index === false
+      ? false
+      : typeof opt.index === 'string'
+        ? opt.index
         : true
     this.fdman = FD()
 
@@ -220,7 +223,10 @@ class Mount {
 
   // get a path from a url
   getPath (u) {
-    return path.join(this.path, u)
+    // trailing slash removal to fix Node.js v23 bug
+    // https://github.com/nodejs/node/pull/55527
+    // can be removed when this is resolved and released
+    return path.join(this.path, u.replace(/\/+$/, ''))
   }
 
   // get a url from a path
@@ -251,7 +257,7 @@ class Mount {
     // If we got a 403, then it's explicitly forbidden.
     if (req.sturl === 403 || (!this.opt.dot && (/(^|\/)\./).test(req.sturl))) {
       res.statusCode = 403
-      res.end('Forbidden')
+      res.end(STATUS_CODES[res.statusCode])
       return true
     }
 
@@ -347,9 +353,12 @@ class Mount {
   }
 
   error (er, res) {
-    res.statusCode = typeof er === 'number' ? er
-      : er.code === 'ENOENT' || er.code === 'EISDIR' ? 404
-        : er.code === 'EPERM' || er.code === 'EACCES' ? 403
+    res.statusCode = typeof er === 'number'
+      ? er
+      : er.code === 'ENOENT' || er.code === 'EISDIR'
+        ? 404
+        : er.code === 'EPERM' || er.code === 'EACCES'
+          ? 403
           : 500
 
     if (typeof res.error === 'function') {
@@ -358,7 +367,7 @@ class Mount {
     }
 
     res.setHeader('content-type', 'text/plain')
-    res.end(http.STATUS_CODES[res.statusCode] + '\n')
+    res.end(STATUS_CODES[res.statusCode] + '\n')
   }
 
   index (p, req, res) {
@@ -559,10 +568,14 @@ class Mount {
         return ['<a href="' + linkName + '">' + showName + '</a>',
           d.mtime, d.size, showName]
       }).sort((a, b) => {
-        return a[2] === '-' && b[2] !== '-' ? -1 // dirs first
-          : a[2] !== '-' && b[2] === '-' ? 1
-            : a[0].toLowerCase() < b[0].toLowerCase() ? -1 // then alpha
-              : a[0].toLowerCase() > b[0].toLowerCase() ? 1
+        return a[2] === '-' && b[2] !== '-' // dirs first
+          ? -1
+          : a[2] !== '-' && b[2] === '-'
+            ? 1
+            : a[0].toLowerCase() < b[0].toLowerCase() // then alpha
+              ? -1
+              : a[0].toLowerCase() > b[0].toLowerCase()
+                ? 1
                 : 0
       }).forEach((line) => {
         const namePad = new Array(8 + nameLen - line[3].length).join(' ')

package/test/basic.js

@@ -97,6 +97,14 @@ test('multiball!', (t) => {
   }
 })
 
+test('trailing slash', (t) => {
+  req('/test/test/fixtures/', (er, res, body) => {
+    t.equal(res.statusCode, 200)
+    t.ok(/<html>.*Index of \/test\/fixtures<[\s\S]+index\.html[\s\S]+space in filename\.txt[\s\S]+<\/html>/.test(body.toString()))
+    t.end()
+  })
+})
+
 test('space in filename', (t) => {
   req('/test/test/fixtures/space in filename.txt', (er, res, body) => {
     t.equal(res.statusCode, 200)

package/test/cli/basic-test.js

@@ -4,12 +4,12 @@ const { serve, stExpect } = require('./common')
 test('Basic cli operation', (t) => {
   serve([], (req) => {
     req('/st.js', (er, res, body) => {
-      t.ifError(er) &&
+      t.error(er) &&
       t.equal(res.statusCode, 200) &&
       t.equal(body.toString(), stExpect)
     })
   }, (er, stdout, stderr) => {
-    t.ifError(er)
+    t.error(er)
     t.match(stdout, /^listening at http:\/\/(\[::\]|0\.0\.0\.0):[0-9]+\n$/)
     t.equal(stderr, '')
     t.end()
@@ -19,12 +19,12 @@ test('Basic cli operation', (t) => {
 test('Listening on localhost only', (t) => {
   serve(['--localhost'], (req) => {
     req('/st.js', (er, res, body) => {
-      t.ifError(er) &&
+      t.error(er) &&
       t.equal(res.statusCode, 200) &&
       t.equal(body.toString(), stExpect)
     })
   }, (er, stdout, stderr) => {
-    t.ifError(er)
+    t.error(er)
     t.match(stdout, /^listening at http:\/\/localhost:[0-9]+\n$/)
     t.equal(stderr, '')
     t.end()

package/test/cli/host-test.js

@@ -1,4 +1,5 @@
 const os = require('os')
+const dns = require('dns')
 let { test, fail, comment } = require('tap')
 const { serve } = require('./common')
 const port = 1338
@@ -44,7 +45,7 @@ function testServer (name, args, addr, canConnect, cannotConnect) {
       canConnect.forEach(checkConnections(t, req, true))
       cannotConnect.forEach(checkConnections(t, req, false))
     }, (err, stdout, stderr) => {
-      t.ifError(err)
+      t.error(err)
       t.equal(stderr, '')
       if (addr) {
         t.equal(stdout, 'listening at ' + addr2url(addr) + '\n')
@@ -59,7 +60,7 @@ function checkConnections (t, req, canConnect) {
     const url = addr2url(addr, '/st.js')
     req(url, (er, res, body) => {
       if (canConnect) {
-        t.ifError(er, url) && t.equal(res.statusCode, 200, url)
+        t.error(er, url) && t.equal(res.statusCode, 200, url)
       } else {
         t.ok(er, url)
       }
@@ -73,12 +74,6 @@ testServer(
   ['127.0.0.1', 'localhost', otherAddress], []
 )
 
-testServer(
-  'Restricted to localhost',
-  ['--localhost'], 'localhost',
-  ['127.0.0.1', 'localhost'], [otherAddress]
-)
-
 testServer(
   'Restricted to non-local host',
   ['--host', otherAddress], otherAddress,
@@ -90,3 +85,14 @@ testServer(
   ['--host', '127.0.0.1'], '127.0.0.1',
   ['127.0.0.1'], ['::1']
 )
+
+dns.lookup('localhost', (err, address) => {
+  if (err) {
+    throw err
+  }
+  testServer(
+    'Restricted to localhost',
+    ['--localhost'], 'localhost',
+    [address, 'localhost'], [otherAddress]
+  )
+})

package/test/common.js

@@ -2,7 +2,7 @@ const path = require('path')
 const fs = require('fs')
 const http = require('http')
 const request = require('request')
-const { test, tearDown } = require('tap')
+const { test, teardown } = require('tap')
 
 const st = require('../st.js')
 
@@ -56,7 +56,7 @@ test('setup', (t) => {
   })
 })
 
-tearDown(() => {
+teardown(() => {
   server.close()
 })
 

package/test/dot-common.js

@@ -1,7 +1,7 @@
 const path = require('path')
 const http = require('http')
 const request = require('request')
-const { test, tearDown } = require('tap')
+const { test, teardown } = require('tap')
 
 const st = require('../st.js')
 
@@ -37,7 +37,7 @@ test('setup', (t) => {
   })
 })
 
-tearDown(() => {
+teardown(() => {
   server.close()
 })
 

package/test/gzip-after-no-gzip.js

@@ -25,7 +25,7 @@ test('gzips second response', (t) => {
     t.equal(res.headers['x-from-cache'], 'true')
 
     t.ok(body, 'returned a body')
-    t.notEqual(body.toString(), stExpect, 'gzipped string')
+    t.not(body.toString(), stExpect, 'gzipped string')
 
     zlib.gunzip(body, (er, body) => {
       if (er) {

package/test/multi-mount.js

@@ -90,7 +90,7 @@ test('setup middleware server', function (t) {
       })
     })
   })
-  middlewareServer.listen(port, '127.0.0.1', function () {
+  middlewareServer.listen(port, 'localhost', function () {
     t.pass('listening')
     t.end()
   })
@@ -103,7 +103,7 @@ test('setup regular server', function (t) {
       return res.end(`Not a match: ${req.url}`)
     }
   })
-  server.listen(port + 1, '127.0.0.1', function () {
+  server.listen(port + 1, 'localhost', function () {
     t.pass('listening')
     t.end()
   })
@@ -114,6 +114,7 @@ const stExpect = fs.readFileSync(require.resolve('../st.js')).toString()
 
 test('/test/st.js', function (t) {
   req('/test/st.js', function (er, res, body) {
+    t.error(er)
     t.equal(res.statusCode, 200)
     t.ok(res.headers.etag)
     stEtag = res.headers.etag

package/test/preset-cache-control.js

@@ -1,5 +1,5 @@
 const st = require('../st.js')
-const { test, tearDown } = require('tap')
+const { test, teardown } = require('tap')
 const path = require('path')
 const http = require('http')
 const request = require('request')
@@ -42,7 +42,7 @@ test('setup', (t) => {
   })
 })
 
-tearDown(() => {
+teardown(() => {
   server.close()
 })