Sokyra-microservice-factory NPM

SMF. Node.js Microservice Factory

Automates development and deployment of containerized microservice stacks in Node.js.

Key concepts

monorepo: SMF core npm package manages custom services npm packages (the inversion-of-control pattern).
each service is a combination of custom code and built-in clients for connecting third-party services like databases, message brokers, etc.
each service is a separate Docker image/container. SMF also starts third-party services automatically.
SMF generates all Docker artifacts (docker-compose files, env files, data volumes, etc.) needed for starting the microservice stack.
one generic Dockerfile is used for building all the services images.
the command line interface helps add new services, select client dependencies and generate the boilerplate code.
automatic deployment to the cloud.
shared code can be defined in a single place (no extra npm packages needed).
services npm packages are isolated and can have overlapping dependencies.
centralized stack & environment config.
built-in pipelines for copying custom data & running custom scripts.
TypeScript is supported by default in all services.

Requirements

Docker, version 19.03.* or later.
Docker Compose, version 1.24.* or later.
Node.js, version 10.* or later.

Getting started

Install SMF, create a new project and start it:

npm install -g sokyra-microservice-factory
smf new test-stack
cd test-stack
smf up

Stop the stack, add a new service, start the stack again:

smf down
smf add service service-name
(select a template and third-party services dependencies)
smf up

Service templates

1. Basic worker:

Minimal boilerplate code, suited for a generic worker service.

2. Back-end (Express.js):

Web server with a demo route module. Use this URL to test when started:

http://localhost:3010/kittens

3. Front-end (React.js):

Web server (NGINX) with React app. Use this URL to test when started:

http://localhost:80

Debug: cd to a service app subfolder, run npm start.

BUILD_REACT_APP_API_URL environment variable controls how the front-end app is connected to the back-end service.

Local environment: BUILD_REACT_APP_API_URL=http://localhost:3010 by default, the React app connects to the back-end service directly.

Remote environment: BUILD_REACT_APP_API_URL=http://your-website-hostname/api by default, the React app connects to NGINX server, which redirects the requests to the back-end service.

Project configuration

See smf-stack.json file, e.g:

{
  "name": "project-name",
  "services": {
    "service1": {
      "clients": {
        "mongodb-mongoose": {
        },
        "rabbitmq-amqp": {
        }
      }
    },
    "service2": {
      "ports": {
        "80": "3000"
      },
      "clients": {
        "rabbitmq-amqp": {
        }
      }
    }
  },
  "clients": {
    "mongodb-mongoose": {
      "external": false
    },
    "rabbitmq-amqp": {
      "external": false
    }
  }
}

services > service-name > clients: third-party services dependencies.
services > service-name > ports: Docker ports mapping (host:container).
clients > client-name > external: if false SMF is responsible for starting the dependency service.
can start & connect multiple third-party services of the same type, e.g. 2 MongoDBs. In this case the client name has to be prefixed, e.g. db1@mongodb-mongoose, db2@mongodb-mongoose.

Environment variables

All environment variables are specified in smf-env.json file, e.g.:

{
  "services": {
    "demo": {},
    "service1": {
      "var1": "value1",
      "var2": "value2"
    }
  },
  "clients": {
    "rabbitmq-amqp": {
      "connect": {
        "RABBITMQ_URL": "amqp://admin:password@{hostname}:5672"
      },
      "start": {
        "RABBITMQ_DEFAULT_USER": "admin",
        "RABBITMQ_DEFAULT_PASS": "password"
      }
    },
    "mongodb-mongoose": {
      "connect": {
        "MONGODB_URI": "mongodb://{hostname}/db"
      },
      "start": {}
    }
  }
}

SMF uses smf-env.json to generate all required .env files for every service container automatically.
services > service-name > ...: custom services variables.
clients > client-name > start > ...: variables needed to start the dependency service.
clients > client-name > connect > ...: variables needed to connect to the dependency service from a custom one.
system placeholders (e.g. {hostname}) are replaced automatically at build time depending on the deployment circumstances.
some default clients > ... values are automatically added to the env config from the clients manifests when adding dependencies.
env vars which start with BUILD_ are passed as Docker build-time ARG vars.

Project structure

./build: compiled source JS code (auto-generated).
./build-stack/env: containers .env files (auto-generated).
./core: SMF core files.
./core/clients: SMF clients for third-party services.
./core/shared: shared modules.
./data: persistent data mapped using Docker volumes (databases, etc.).
./services: user-defined custom services.
.env: local .env file for debug purpose.
Dockerfile: a generic one for all services.
smf-deploy.json: deployment credentials.
smf-docker-base.yml: docker-compose file for third-party services (auto-generated).
smf-docker.yml: docker-compose file for services (auto-generated).
smf-env.json: environment variables.
smf-stack.json: project config: services definitions and clients dependencies.
tsconfig.json: TypeScript options.

Service structure

See ./services/service-name folder.

main.ts: service entry point code, e.g.:

export default class Main {
  run(core) {
    core.log('demo-main');

    setInterval(async () => {
      core.log('ping');
    },
    5000);
  }
}

npm's package.json & package-lock.json. Run npm install ... in the service folder to add the service specific libraries.
Dockerfile: (optional) overwrites the default Dockerfile if any build customization needed(see React frontend demo).
use SMF core from any source code module (folder independent):

import core from 'smf-core';
...
core.log(...);
core.shared.module1.func();

Service communication

Use a message broker to exchange messages between services. Select a broker (RabbitMQ by default) when creating a new service (smf add service ...).

Usage example:

import core from 'smf-core';

const messageBroker = core.client('rabbitmq-amqp');

// subscribe to the "demo.*" routes
await messageBroker.subscribe('demo.*');

// receive messages
messageBroker.on('message', message => {
  core.log(message);
});

// publish a message
messageBroker.publish('demo.hello', {text: 'hello'});

Event-driven routes naming convention is recommended, e.g. route = user.created, email.sent, etc.

Shared modules

Create JS modules with common code or config/constants which are accessible in all the services in the stack:

Add a JS module to core/shared folder (see auto-generated config & module1 examples there).
Add the JS module reference to import & export in core/shared/index.ts.
Call the module functions as core.shared.module.func in a service (see ./services/demo/main.ts).

Copy custom data

If a service uses some custom data, put it to the service's ./data subfolder. After the Docker image is built, the data is in the image's /data folder.

Run custom script

If a service runs custom scripts at runtime, put them to the service's ./library subfolder. After the Docker image is built, the scripts are in the image's /library folder.

Run custom script (Docker build time)

If a service needs to run a custom script (e.g. download & install extra dependencies) when the Docker image is being built, create install.sh file with bash commands in the service folder.

Deployment

Setup a machine with Docker and Docker Compose installed.

Requirements: Docker v19.03, Docker Compose v1.24 or later.

Debug

In the current version you can debug only one service at a time due to the shared .env file issue.

Stop the service container:

docker stop project-name-service-name

Build the service .env file (merge the service & clients env variables):

smf debug service-name

VSCode users: click Debug and Run > Start Debugging (Control-F5) in the editor.

Other IDEs: run tsc to build the source code and use ./build/core/index-debug.js as the starting script.

Dockerfile overload

Create a custom Dockerfile in the service folder in order to overload the generic one from the project root directory.

Demos

Clients

SMF clients are modules that connect user services to third-party ones (databases, message brokers, etc.).
clients are located in ./core/clients folder.
client name convention is service name-library name (e.g. mongodb-mongoose).

Existing clients:

Memcached
MongoDB
MySQL
PostgreSQL
RabbitMQ
Redis
Elasticsearch

In order to add a new client run:

smf add client client-name
(type a docker image name which is accessible on Dockerhub)

...then go to ./core/clients/client-name and edit main.ts file.

Client config is stored in smf-client.json manifest file, e.g. see the mongodb one:

{
  "docker": {
    "image": "mongo:latest",
    "ports": [27017],
    "volume": {
      "containerPath": "/data/db",
      "named": false 
    },
    "env": {
      "start": {
      },
      "connect": {
        "MONGODB_URI": "mongodb://{hostname}/db"
      }
    }
  }
}

image: Docker image.
ports: container ports to open.
volume > containerPath: Docker volume path in the container.
volume > named: if true use a Docker named volume vs the host mounted path.
env > start: default env variables for starting the container (e.g. see RabbitMQ client manifest)
env > connect: default env variables for connecting to the service from custom services.

Commands

smf new project-name
smf up
smf down
smf add service service-name
smf debug service-name
smf add client client-name (inputs: docker image name)

Bonus: Sails web app integration

run smf add service (skip service dependencies) to create the service boilerplate code.
cd to the new service folder, run run sails new web-sails to generate the Sails app code (don't change the app name).
add hosts to ./web-sails/config/env/production.js/onlyAllowOrigins.
(optionally) enable controllers actions blueprints: ./web-sails/config/blueprints.js > actions: true.

Root TypeScript build process ignores the web-sails folders, they are copied separately in Dockerfile. TypeScript is added to a Sails app using this instruction: https://sailsjs.com/documentation/tutorials/using-type-script