feat: support running in background and CORS headers

Author: billiegoose

README.md

@@ -18,14 +18,15 @@ Git hooks such as `hooks/update` and `hooks/post-receive` are automatically supp
 
 It also supports HTTP Basic Auth password protection of repos so you can test how your code handles 401 errors.
 
+Using `isomorphic-git` and testing things from browsers? Fear not, `git-http-mock-server` includes appropriate CORS headers.
+
 ## How to use
 
 ```sh
 npm install --save-dev git-http-mock-server
 ```
 
-Now `cd` to a directory in which you have some bare git repos
-and run this server:
+Now `cd` to a directory in which you have some bare git repos and run this server:
 
 ```sh
 > cd __fixtures__
@@ -34,16 +35,33 @@ test-repo1.git    test-repo2.git   imaginatively-named-repo.git
 > git-http-mock-server
 ```
 
-Now clone and push away...
+Now in another shell, clone and push away...
 ```sh
+> git clone http://localhost:8174/test-repo1.git
+> git clone http://localhost:8174/test-repo2.git
 > git clone http://localhost:8174/imaginatively-named-repo.git
 ```
 
+## Run in the background
+
+If you want to reuse the same shell (as part of a shell script, for example)
+you can run the server as a daemon in the background:
+
+```sh
+> git-http-mock-server start
+> # do stuff
+> git-http-mock-server stop
+```
+
+Just be sure to run `start` and `stop` from the same working directory.
+(The `start` command writes the PID of the server to `./git-http-mock-server.pid` so that the `stop` command knows what process to kill.)
+
 ### Environment Variables
 
 - `GIT_HTTP_MOCK_SERVER_PORT` default is 8174 (to be compatible with [git-http-server](https://github.com/bahamas10/node-git-http-server))
 - `GIT_HTTP_MOCK_SERVER_ROUTE` default is `/`
 - `GIT_HTTP_MOCK_SERVER_ROOT` default is `process.cwd()`
+- `GIT_HTTP_MOCK_SERVER_ALLOW_ORIGIN` default is `*` (used for CORS)
 
 ### .htpasswd support
 

bin.js

@@ -3,12 +3,13 @@
 var http = require('http')
 var path = require('path')
 var factory = require('./middleware')
+var cors = require('./cors')
 
 var config = {
   root: path.resolve(process.cwd(), process.env.GIT_HTTP_MOCK_SERVER_ROOT || '.'),
   glob: '*',
   route: process.env.GIT_HTTP_MOCK_SERVER_ROUTE || '/'
 }
 
-var server = http.createServer(factory(config))
+var server = http.createServer(cors(factory(config)))
 server.listen(process.env.GIT_HTTP_MOCK_SERVER_PORT || 8174)

cors.js

@@ -0,0 +1,50 @@
+const origin = process.env.GIT_HTTP_MOCK_SERVER_ALLOW_ORIGIN
+const allowHeaders = [
+  'accept-encoding',
+  'accept-language',
+  'accept',
+  'access-control-allow-origin',
+  'authorization',
+  'cache-control',
+  'connection',
+  'content-length',
+  'content-type',
+  'dnt',
+  'pragma',
+  'range',
+  'referer',
+  'user-agent',
+  'x-http-method-override',
+  'x-requested-with',
+]
+const exposeHeaders = [
+  'accept-ranges',
+  'age',
+  'cache-control',
+  'content-length',
+  'content-language',
+  'content-type',
+  'date',
+  'etag',
+  'expires',
+  'last-modified',
+  'pragma',
+  'server',
+  'transfer-encoding',
+  'vary',
+  'x-github-request-id',
+]
+const allowMethods = [
+  'POST',
+  'GET',
+  'OPTIONS'
+]
+const cors = require('micro-cors')({
+  allowHeaders,
+  exposeHeaders,
+  allowMethods,
+  allowCredentials: false,
+  origin
+})
+
+module.exports = cors

daemon.js

@@ -0,0 +1,61 @@
+#!/usr/bin/env node
+const fs = require('fs')
+const path = require('path')
+const {spawn} = require('child_process')
+const kill = require('tree-kill')
+const minimisted = require('minimisted')
+
+const cmdName = 'git-http-mock-server'
+const target = require.resolve('./bin.js')
+const args = [
+  target
+]
+
+async function main({_: [cmd]}) {
+  switch (cmd) {
+    case 'start': {
+      require('daemonize-process')()
+      let server = spawn(
+        'node', args,
+        {
+          stdio: 'inherit',
+          windowsHide: true,
+        }
+      )
+      fs.writeFileSync(
+        path.join(process.cwd(), `${cmdName}.pid`),
+        String(process.pid),
+        'utf8'
+      )
+      process.on('exit', server.kill)
+      return
+    }
+    case 'stop': {
+      let pid
+      try {
+        pid = fs.readFileSync(
+          path.join(process.cwd(), `${cmdName}.pid`),
+          'utf8'
+        );
+      } catch (err) {
+        console.log(`No ${cmdName}.pid file`)
+        return
+      }
+      pid = parseInt(pid)
+      console.log('killing', pid)
+      kill(pid, (err) => {
+        if (err) {
+          console.log(err)
+        } else {
+          fs.unlinkSync(path.join(process.cwd(), `${cmdName}.pid`))
+        }
+      })
+      return
+    }
+    default: {
+      require(target)
+    }
+  }
+}
+
+minimisted(main)

middleware.js

@@ -9,6 +9,10 @@ var fixturez = require('fixturez')
 var backend = require('git-http-backend')
 var htpasswd = require('htpasswd-js')
 
+function pad (str) {
+  return (str + '    ').slice(0, 7)
+}
+
 function factory (config) {
   if (!config.root) throw new Error('Missing required "gitHttpServer.root" config option')
   if (!config.route) throw new Error('Missing required "gitHttpServer.route" config option')
@@ -39,13 +43,20 @@ function factory (config) {
   }
 
   return async function middleware (req, res, next) {
+    // handle pre-flight OPTIONS
+    if (req.method === 'OPTIONS') {
+      res.statusCode = 204
+      res.end('')
+      console.log(chalk.green('[git-http-server] 204 ' + pad(req.method) + ' ' + req.url))
+      return
+    }
     if (!next) next = () => void(0)
     try {
       var gitdir = getGitDir(req)
     } catch (err) {
       res.statusCode = 404
       res.end(err.message + '\n')
-      console.log(chalk.red('[git-http-server] 404 ' + req.url))
+      console.log(chalk.red('[git-http-server] 404 ' + pad(req.method) + ' ' + req.url))
       return
     }
     if (gitdir == null) return next()
@@ -63,9 +74,12 @@ function factory (config) {
       let cred = auth.parse(req.headers['authorization'])
       if (cred === undefined) {
         res.statusCode = 401
+        // The default reason phrase used in Node is "Unauthorized", but
+        // we will use "Authorization Required" to match what Github uses.
+        res.statusMessage = 'Authorization Required'
         res.setHeader('WWW-Authenticate', 'Basic')
         res.end('Unauthorized' + '\n')
-        console.log(chalk.red('[git-http-server] 401 ' + req.url))
+        console.log(chalk.green('[git-http-server] 401 ' + pad(req.method) + ' ' + req.url))
         return
       }
       let valid = await htpasswd.authenticate({
@@ -75,9 +89,12 @@ function factory (config) {
       })
       if (!valid) {
         res.statusCode = 401
+        // The default reason phrase used in Node is "Unauthorized", but
+        // we will use "Authorization Required" to match what Github uses.
+        res.statusMessage = 'Authorization Required'
         res.setHeader('WWW-Authenticate', 'Basic')
         res.end('Bad credentials' + '\n')
-        console.log(chalk.red('[git-http-server] 401 ' + req.url))
+        console.log(chalk.green('[git-http-server] 401 ' + pad(req.method) + ' ' + req.url))
         return
       }
     }
@@ -86,12 +103,12 @@ function factory (config) {
       if (err) {
         res.statusCode = 500
         res.end(err + '\n')
-        console.log(chalk.red('[git-http-server] 500 ' + req.url))
+        console.log(chalk.red('[git-http-server] 500 ' + pad(req.method) + ' ' + req.url))
         return
       }
 
       res.setHeader('content-type', service.type)
-      console.log(chalk.green('[git-http-server] 200 ' + req.url))
+      console.log(chalk.green('[git-http-server] 200 ' + pad(req.method) + ' ' + req.url))
       // console.log('[git-http-server] ' + service.cmd + ' ' + service.args.concat(gitdir).join(' '))
       var ps = spawn(service.cmd, service.args.concat(gitdir))
       ps.stdout.pipe(service.createStream()).pipe(ps.stdin)

package.json

@@ -4,7 +4,7 @@
   "description": "Clone and push to git repository test fixtures over HTTP.",
   "main": "index.js",
   "bin": {
-    "git-http-mock-server": "bin.js"
+    "git-http-mock-server": "daemon.js"
   },
   "scripts": {
     "test": "echo \"No tests\"",
@@ -30,9 +30,13 @@
   "dependencies": {
     "basic-auth": "^2.0.0",
     "chalk": "^2.4.1",
+    "daemonize-process": "^1.0.9",
     "fixturez": "^1.1.0",
     "git-http-backend": "^1.0.2",
-    "htpasswd-js": "^1.0.2"
+    "htpasswd-js": "^1.0.2",
+    "micro-cors": "^0.1.1",
+    "minimisted": "^2.0.0",
+    "tree-kill": "^1.2.0"
   },
   "devDependencies": {
     "semantic-release": "15.1.7",