feat: first working version 🎉 (#1)

* WIP: initialize repo

* fixed options

* fix protos

* working protocols

* added some logs

* persistence/mqemitter support

* use custom hasher for authorizer

* fix defaults in commander

* remove unused dep

* promisify everything

* set start as default command

* added missing 'use strict'

* removed useless return

* use map for authorizer users to prevent prototype pollution

* fix persistence and refactor code

* promisify cli

* use fs.promises

* fix authorizer users methods

* docs

* fix missing escape in ascii

* remove unsued const

* first test

* add missing aedes options

* fix: init new command each time

* test multiple servers

* authorizer tests

* test persistences from config

* updated docs

* refactor files

* github actions

* fix action

* docs ci badge

* lgtm badges

* stats support

* test authorizer errors

* test errors

* remove unused var

* added missing aedes events

* fix remove useless comments

* remove useless comments

* removed useless async

* docs fix indentation

* remove mosca comments

* better logging

* removed custom promisify

* test persistence in separete jobs using env vars

.github/workflows/ci.yml

@@ -0,0 +1,54 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  mongodb:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x]
+    services:
+      mongodb:
+        image: mongo:3.4.23
+        ports:
+          - 27017:27017
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: |
+        npm install
+        npm run test
+      env:
+          DB: mongodb
+  redis:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x]
+    services:
+      redis:
+        image: redis
+        ports:
+        - 6379:6379
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: |
+        npm install
+        npm run test
+      env:
+          DB: redis

.gitignore

@@ -102,3 +102,7 @@ dist
 
 # TernJS port file
 .tern-port
+
+.vscode
+
+credentials.json

.taprc

@@ -0,0 +1,8 @@
+jobs: 1
+no-esm: true
+no-ts: true
+no-jsx: true
+no-flow: true
+coverage: true
+browser: false
+coverage-report: html

README.md

@@ -1 +1,157 @@
-# aedes-cli
+# aedes-cli
+
+![CI](https://github.com/moscajs/aedes-cli/workflows/CI/badge.svg)
+[![Total alerts](https://img.shields.io/lgtm/alerts/g/moscajs/aedes-cli.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/moscajs/aedes-cli/alerts/)
+[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/moscajs/aedes-cli.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/moscajs/aedes-cli/context:javascript)
+
+Aedes MQTT broker cli plugin
+
+## Install
+
+Install the library using [npm](http://npmjs.org/).
+
+```bash
+npm install aedes-cli -g
+```
+
+## Usage
+
+Here you can see the options accepted by the command line tool:
+
+```bash
+$ aedes --help
+______   ________  _______   ________   ______  
+/      \ |        \|       \ |        \ /      \
+|  $$$$$$\| $$$$$$$$| $$$$$$$\| $$$$$$$$|  $$$$$$\
+| $$__| $$| $$__    | $$  | $$| $$__    | $$___\$$
+| $$    $$| $$  \   | $$  | $$| $$  \    \$$    \
+| $$$$$$$$| $$$$$   | $$  | $$| $$$$$    _\$$$$$$\
+| $$  | $$| $$_____ | $$__/ $$| $$_____ |  \__| $$
+| $$  | $$| $$     \| $$    $$| $$     \ \$$    $$
+\$$   \$$ \$$$$$$$$ \$$$$$$$  \$$$$$$$$  \$$$$$$
+
+Usage: aedes [options] [command]
+
+Options:
+  -V, --version                    output the version number
+  -p, --port <n>                   the port to listen to
+  --host <IP>                      the host to listen to
+  --protos <protos>                comma separeted protocols. Allowed values are tcp, ws, wss, tls (default: ["tcp"])
+  --credentials <file>             the file containing the credentials (default: "./credentials.json")
+  --authorize-publish <pattern>    the pattern for publishing to topics for the added user
+  --authorize-subscribe <pattern>  the pattern for subscribing to topics for the added user
+  --concurrency <n>                broker maximum number of concurrent messages delivered by mqemitter
+  --queueLimit <n>                 broker maximum number of queued messages before client session is established
+  --maxClientsIdLength <n>         broker option to override MQTT 3.1.0 clients Id length limit
+  --heartbeatInterval <n>          interval in millisconds at which broker beats its health signal in $SYS/<broker.id>/heartbeat
+  --connectTimeout <n>             maximum waiting time in milliseconds waiting for a CONNECT packet.
+  --key <file>                     the server's private key
+  --cert <file>                    the certificate issued to the server
+  --reject-unauthorized            reject clients using self signed certificates (default: true)
+  --tls-port <n>                   the TLS port to listen to
+  --ws-port <n>                    start an mqtt-over-websocket server on the specified port
+  --wss-port <n>                   start an mqtt-over-secure-websocket server on the specified port
+  --disable-stats                  disable the publishing of stats under $SYS (default: true)
+  --broker-id <id>                 the id of the broker in the $SYS/<id> namespace
+  -c, --config <c>                 the config file to use (override every other option)
+  -v, --verbose                    set the log level to INFO
+  --very-verbose                   set the log level to DEBUG
+  --no-pretty                      JSON logs
+  -h, --help                       display help for command
+
+Commands:
+  adduser <user> <pass>            Add a user to the given credentials file
+  rmuser <user>                    Removes a user from the given credentials file
+  start                            start the server (optional)
+  help [command]                   display help for command
+```
+
+To fully use Aedes you need to define a configuration file where the communication
+broker is defined. Here follows an example using Mongodb.
+
+A configuration file is structured in the following way:
+
+```js
+module.exports = {
+  protos: ['tcp'],
+  host: '127.0.0.1',
+  port: 1883,
+  wsPort: 3000,
+  wssPort: 4000,
+  tlsPort: 8883,
+  brokerId: 'aedes-cli',
+  credentials: './credentials.json',
+  persistence: {
+    name: 'mongodb',
+    options: {
+      url: 'mongodb://127.0.0.1/aedes'
+    }
+  },
+  mq: {
+    name: 'mongodb',
+    options: {
+      url: 'mongodb://127.0.0.1/aedes'
+    }
+  },
+  key: null,
+  cert: null,
+  rejectUnauthorized: true,
+  verbose: false,
+  veryVerbose: false,
+  noPretty: false
+}
+
+```
+
+## Authorization
+
+Aedes supports user authentication through the use of a specific json file.
+In order to create one run the following command.
+
+```bash
+// add a user
+$ aedes adduser <user> <pass> --credentials ./credentials.json
+
+// add a user specifying the authorized topics
+$ aedes adduser myuser mypass --credentials ./credentials.json \
+  --authorize-publish 'hello/*' --authorize-subscribe 'hello/*'
+
+// remove a user
+$ aedes rmuser myuser --credentials ./credentials.json
+
+// start aedes with a specific set of credentials:
+$ aedes --credentials ./credentials.json
+```
+
+The patterns are checked and validated using [Minimatch](https://github.com/isaacs/minimatch).
+The credentials file is automatically reloaded by aedes when it receives a `SIGHUP`.
+
+## Persistence and Emitters
+
+The MQTT specification requires a persistent storage for offline QoS 1
+subscription that has been done by an unclean client. Aedes offers several
+persitance options.
+
+Supported persistences are:
+
+- [aedes-persistence]: In-memory implementation of an Aedes persistence
+- [aedes-persistence-mongodb]: MongoDB persistence for Aedes
+- [aedes-persistence-redis]: Redis persistence for Aedes
+
+Emitters are needed to deliver messages to subscribed clients. In a cluster environment it is used also to share messages between brokers instances
+
+All of them can be configured from the configuration file, under the `persistence` and `mq` key.
+
+Supported mqemitters are:
+
+- [mqemitter]: An opinionated memory Message Queue with an emitter-style API
+- [mqemitter-redis]: Redis-powered mqemitter
+- [mqemitter-mongodb]: Mongodb based mqemitter
+
+[aedes-persistence]: https://www.npmjs.com/aedes-persistence
+[aedes-persistence-mongodb]: https://www.npmjs.com/aedes-persistence-mongodb
+[aedes-persistence-redis]: https://www.npmjs.com/aedes-persistence-redis
+
+[mqemitter]: https://www.npmjs.com/mqemitter
+[mqemitter-redis]: https://www.npmjs.com/mqemitter-redis
+[mqemitter-mongodb]: https://www.npmjs.com/mqemitter-mongodb

bin/aedes

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+
+var ascii = `
+______   ________  _______   ________   ______  
+/      \\ |        \\|       \\ |        \\ /      \\ 
+|  $$$$$$\\| $$$$$$$$| $$$$$$$\\| $$$$$$$$|  $$$$$$\\
+| $$__| $$| $$__    | $$  | $$| $$__    | $$___\\$$
+| $$    $$| $$  \\   | $$  | $$| $$  \\    \\$$    \\ 
+| $$$$$$$$| $$$$$   | $$  | $$| $$$$$    _\\$$$$$$\\
+| $$  | $$| $$_____ | $$__/ $$| $$_____ |  \\__| $$
+| $$  | $$| $$     \\| $$    $$| $$     \\ \\$$    $$
+\\$$   \\$$ \\$$$$$$$$ \\$$$$$$$  \\$$$$$$$$  \\$$$$$$                                        
+`
+
+console.log(ascii)
+
+require('../lib/cli')(process.argv)
+  .catch((err) => {
+    console.log(err)
+    process.exit(1)
+  })

config.js

@@ -0,0 +1,29 @@
+module.exports = {
+  // SERVERS
+  protos: ['tcp'],
+  host: '127.0.0.1',
+  port: 1883,
+  wsPort: 3000,
+  wssPort: 4000,
+  tlsPort: 8883,
+  key: null,
+  cert: null,
+  rejectUnauthorized: true,
+  // AUTHORIZER
+  credentials: './credentials.json',
+  // AEDES
+  brokerId: 'aedes-cli',
+  concurrency: 100,
+  queueLimit: 42,
+  maxClientsIdLength: 23,
+  heartbeatInterval: 60000,
+  connectTimeout: 30000,
+  disableStats: true,
+  // PERSISTENCES
+  persistence: null,
+  mq: null,
+  // LOGGER
+  verbose: false,
+  veryVerbose: false,
+  noPretty: false
+}