Creating middleware

These docs are for local-web-server v3, see an earlier revision for v2

Local-web-server uses Koa as its middleware engine so first I recommend reading the Koa guide to writing middleware.

Create a middleware module

This is the minimum code required to create a middleware module. A middleware module should export a class with a middleware method. The method is passed the active ws configuration and must return a Koa middleware function.

This example sets the response body to 'Hello'. Save it to a file named mw-example.js.

class Example {
  middleware () {
    return (ctx) => {
      ctx.response.body = 'Hello'
    }
  }
}

module.exports = Example

Use the middleware module

Test your module by running the following command. By setting --stack you override the built-in stack with the middleware supplied.

$ ws --stack mw-example.js
Serving at http://mbp.local:8100, http://127.0.0.1:8100, http://192.168.0.100:8100

Check you get the expected response.

$ curl http://127.0.0.1:8100
Hello

Middleware options

You can parameterise middleware by adding an optionDefinitions method which returns one or more OptionDefinition objects. Let's add an optionDefinitions method to our Example class which defines an option called message which will be a string.

class Example {
  optionDefinitions () {
    return [
      { name: 'message', type: String, description: 'A message to print.'}
    ]
  }
  middleware () {
    return (ctx) => {
      ctx.response.body = 'Hello'
    }
  }
}

module.exports = Example

If you view the ws usage guide with the example module loaded you'll see your middleware and its options listed under "Middleware stack" and "Middleware options".

$ ws --stack mw-example.js --help

We can use the --message value to customise our response body.

class Example {
  optionDefinitions () {
    return [
      { name: 'message', type: String, description: 'A message to print.'}
    ]
  }
  middleware (config) {
    return (ctx) => {
      ctx.response.body = config.message
    }
  }
}

module.exports = Example

Now, we can configure our middleware to respond with a different message.

$ ws --stack mw-example.js --message "🦆 🦆 🦆"
Serving at http://mbp.local:8100, http://127.0.0.1:8100, http://192.168.0.100:8100

Check we receive the new, parameterised response.

$ curl http://127.0.0.1:8100
🦆 🦆 🦆

Description

Notice how in the --help output the description field for your middleware is empty. To set a description, define a description method which returns a string.

class Example {
  description () {
    return 'Demonstrating how a response can be controlled by config or command line.'
  }

  optionDefinitions () {
    return [
      { name: 'message', type: String, description: 'A message to print.'}
    ]
  }
  middleware (config) {
    return (ctx) => {
      ctx.response.body = config.message
    }
  }
}

module.exports = Example

Verbose events

To send debug information to the --verbose output, you can emit a verbose event from any method within the module passing a key and value.

class Example {
  middleware () {
    return function (ctx) {
      this.emit('verbose', 'middleware.example.message', 'Responding with Hello')
      ctx.response.body = 'Hello.'
    }
  }
}

module.exports = Example

Share

That's it! Reuse your middleware between projects, publish it on npm and share with the world.