@lomray/microservice-notification v2.4.0

notification

RPC 2.0 Microservice.
This microservice provides notifications mechanism.

Navigation

• ENVIRONMENTS
• HOW TO RUN
• HOW TO DEVELOP
• MEMORY USAGE

ENVIRONMENTS:

• NODE_ENV - Can be production or development or tests. Default: development
• MS_CONNECTION - Invert json host and port (with protocol). Default: http://127.0.0.1:8001
• MS_CONNECTION_SRV - Invert json connection it is SRV record. Default: false
• MS_NAME - Microservice name. Default: notification
• MS_CONFIG_NAME - Configuration microservice name. Default: configuration
• MS_WORKERS - Microservice queue workers count. Default: 5
• MS_ENABLE_REMOTE_MIDDLEWARE - Enable remote middleware feature. Set 0 to disable. Default: 1 (enabled)
• DB_FROM_CONFIG_MS - Get db credentials from configuration microservice. Set 0 to disable. Default: 1
• DB_URL - Database url connection string. Default: undefined. Please use URL or credentials.
• DB_HOST - Database host. Default: 127.0.0.1
• DB_PORT - Database port. Default: 5432
• DB_USERNAME - Database user name. Default: postgres
• DB_PASSWORD - Database password. Default: example
• DB_DATABASE - Database db name. Default: ms-users
• EMAIL_PROVIDER - Email provider. Default: nodemailer
• EMAIL_DEFAULT_FROM - The email address from which messages will be sent. It can be configured from remote config. Default: undefined
• EMAIL_FROM_CONFIG_MS - Get email sdk credentials (nodemailer) from configuration microservice. Set 0 to disable. Default: 1
• EMAIL_TRANSPORTER_OPTIONS - Nodemailer transport options (if not configured from remote config.). JSON string. Default: {}
• AWS_ACCESS_KEY_ID - AWS access key, if you will use SES for sending email (if not configured from remote config.). Default: empty
• AWS_SECRET_ACCESS_KEY - AWS secret access key, if you will use SES for sending email (if not configured from remote config.). Default: empty
• AWS_REGION - AWS region, if you will use SES for sending email (if not configured from remote config.). Default: empty

HOW TO RUN:

1. Run Inverted Json job server.

docker run -it -p 8001:8001 lega911/ijson --log 47

2. Run microservice (please, see ENVIRONMENTS above for understand config)

npm run start:dev

3. Make some request

curl localhost:8001/ms/notification -d '{"id": "unique-id", "method": "demo", "params": {}}'

If you use JetBrains IDE, try to find run configurations in .run

You can also install microservice like npm package:

npm i --save @lomray/microservice-notification

HOW TO DEVELOP:

For develop this microservice, preferred use TDD technique. You can run all tests with watch flag or run one test:

// case 1
npm run test -- --watch

// case 2
NODE_ENV=tests TS_NODE_COMPILER_OPTIONS='{"target":"es6"}' mocha --harmony --no-warnings  __tests__/your-test-name.ts --require ts-node/register --recursive --watch

// check code coverage
nyc npm run test

That is all. Don't forget install npm dependencies (in root folder & local folder run: npm ci)

MEMORY USAGE:

Run on typescript: ~177 MB PEAK / ~162 MB
Run on JS: ~33 MB PEAK / ~26 MB