Swarm-host is a server for SPA test-modes which is based on express.js and uses lair-db as a data-storage.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
tests-data
tests
.gitignore
.npmignore
.travis.yml
LICENSE
README.md
package-lock.json
package.json
publish.sh
stryker.conf.js
tsconfig.json
tslint.json

README.md

swarm-host

Build Status npm version npm version Codacy Badge Coverage Status

Swarm-host is a server for SPA test-modes which is based on express.js and uses lair-db as a data-storage.

Install

npm i swarm-host --save

Usage

Create and start server

import compression = require('compression');
import {Server} from 'swarm-host';

// server itself
const server = Server.getServer();
// API prefix
server.namespace = '/api/v1';
// server port
server.port = 12345;
// Lair and Swarm-Host will tell a lot about what's going on with them
server.verbose = true;
// delay for each response (ms)
server.delay = 200;

server.startServer();

Server will listen port 12345 and use api-prefix /api/v1 for all requests. Each response will be sent with 200ms delay. body-parser-json is used by default.

Server without any routes is useless. It's time to add them.

Routing

Every Route is an instance of the class Route. It may be created by calling static method createRoute:

import {Route} from 'swarm-host';
Route.createRoute('get', '/all-users', (req, res, next, lair) => {
  // ...
});

Method createRoute takes three parameters:

  • request type - get, post or any other
  • url - path to handle
  • handler

handler is a function and takes four parameters:

  • req - express.js Request
  • res - express.js Response
  • next - express.js next-function
  • lair - lair-db instance

As an usual express-handler Route's handler must do something like:

res.json({...});
res.status(404).json({});

Route may be added to server by calling addRoute:

import {Server, Route} from 'swarm-host';
const server = Server.getServer();
server.addRoute(Route.createRoute(/*...*/)); 

Add some data

Lair-db is used like a data-storage in the Swarm-host. It has two methods to work with Lair-db. First one is a addFactory. It does the same as a lair.registerFactory and takes two parameters - factory-instance and factory-name:

import {Server, Factory} from 'swarm-host';

const server = Server.getServer();
server.addFactory(Factory.create({/* ... */}), 'factory-name');

Second method is a createRecords. It's just a wrapper for lair.createRecords. It takes two parameters - factory name and records count to create:

import {Server, Factory} from 'swarm-host';

const server = Server.getServer();
server.createRecords('factory-name', 10);

Method createRecords may be called only before server starts!

Predefined route-handlers

Class Route has a few methods that creates routes with predefined handlers.

get

Predefined route get is used to get one record or all records of the given type.

Multiple records:

import {Route} from 'swarm-host';
Route.get('/all-users', 'user', {depth: 1, ignoreRelated: ['subject']});

It's equal to:

import {Route} from 'swarm-host';
Route.createRoute('get', '/all-users', (req, res, next, lair) => {
  const data = lair.getAll('user', {
    depth: 1, 
    ignoreRelated: ['subject']
  });
  res.json(data);
});

Single record:

import {Route} from 'swarm-host';
Route.get('/all-users/:id', 'user', {depth: 1, ignoreRelated: ['subject']});

It's equal to:

import {Route} from 'swarm-host';
Route.createRoute('get', '/all-users', (req, res, next, lair) => {
  const data = lair.getOne('user', req.params.id, {
    depth: 1, 
    ignoreRelated: ['subject']
  });
  res.json(data);
});

Only routes with a single dynamic part are supported for Route.get used to get a single record.

post

Predefined route post is used to create a record of the given type.

import {Route} from 'swarm-host';
Route.post('/all-users', 'user', {depth: 1});

It's equal to:

import {Route} from 'swarm-host';
Route.createRoute('post', '/all-users', (req, res, next, lair) => {
  const data = lair.createOne('user', req.body, {depth: 1});
  res.json(data);
});

put, patch

Both predefined routes can be used to update a record of the given type by its id.

import {Route} from 'swarm-host';
Route.patch('/all-users/:id', 'user', {depth: 1});

It's equal to:

import {Route} from 'swarm-host';
Route.createRoute('patch', '/all-users/:id', (req, res, next, lair) => {
  const data = lair.updateOne('user', req.params.id, req.body, {depth: 1});
  res.json(data);
});

delete

Predefined route delete is used to delete a single record of the given type by its id.

import {Route} from 'swarm-host';
Route.delete('/all-users', 'user');

It's equal to:

import {Route} from 'swarm-host';
Route.createRoute('delete', '/all-users/:id', (req, res, next, lair) => {
  lair.deleteOne('user', req.params.id);
  res.json({});
});

Extra handler for predefined routes

Each predefined route takes extra parameter. It's a function used to serialize result of the proper Lair's method. This function takes 4 parameters:

  • req - express.js Request
  • res - express.js Response
  • data - result of Lair's method execution
  • lair - Lair instance

By default next function is used as extra-handler:

function handler(req, res, data, lair) {
  res.json(data);
}

Both Routes bellow are doing the same:

import {Route} from 'swarm-host';
Route.get('/all-users', 'user', {depth: 1});
import {Route} from 'swarm-host';
Route.get('/all-users', 'user', {depth: 1}, (req, res, data, lair) => {
  res.json(data);
});

Such extra-handlers are useful to serialize data before sending them in the Response.

Complex example

import {Server, Factory, Route} from 'swarm-host';
const faker = require('faker'); // npm i faker --save
const server = Server.getServer();
server.namespace = '/api/v1';
server.port = 12345;
server.verbose = true;
server.delay = 200;

const UserFactory = Factory.create({
  attrs: {
    name() {
      return faker.name.firstName();
    },
    age() {
      return faker.random.number({min: 1, max: 99});
    }
  }
});
server.addFactory(UserFactory, 'user');

const UsersRoute = Route.createRoute('get', '/all-users', (req, res, next, lair) => {
  const users = lair.getAll('user');
  res.json({
    data: users
  });
});
server.addRoute(UsersRoute);

server.startServer();