JSPM

attachments

RPC 2.0 Microservice.

A microservice provides work with attachments for entities from other microservices. For example: images, videos.

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: attachments
• MS_CONFIG_NAME - Configuration microservice name. Default: configuration
• MS_WORKERS - Microservice queue workers count. Default: 1
• MS_ENABLE_REMOTE_MIDDLEWARE - Enable remote middleware feature. Set 0 to disable. Default: 1 (enabled)
• MS_STORAGE_TYPE - Microservice storage type.
• 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
• MS_GRAFANA_LOKI_CONFIG - Grafana loki config. Default: null
• MS_ENABLE_GRAFANA_LOG - Enable grafana loki log (config from configuration ms). Default: 0
• MS_OPENTELEMETRY_ENABLE - Enable opentelemetry tracers. Default: 0
• MS_OPENTELEMETRY_OTLP_URL - Custom opentelemetry OTLP exporter URL. Default: undefined
• MS_OPENTELEMETRY_OTLP_URL_SRV - Custom opentelemetry OTLP URL it is SRV record. Default: 0
• MS_OPENTELEMETRY_DEBUG - Enable debug log opentelemetry. Default: 0
• AWS_ACCESS_KEY_ID - AWS access key ID, if you will use S3 to store files (if not configured from remote config.). Default: empty
• AWS_SECRET_ACCESS_KEY - AWS secret access key, if you will use S3 to store files (if not configured from remote config.) Default: empty
• AWS_REGION - AWS region, if you will use S3 to store files (if not configured from remote config.) Default: empty
• AWS_BUCKET_NAME - AWS S3 bucket name, if you will use S3 to store files (if not configured from remote config.) Default: empty
• AWS_FROM_CONFIG_MS - Get AWS credentials from configuration microservice. Set 0 to disable. Default: 1
• STORAGE_PATH_PREFIX - Path (url) prefix for attachments. Default: empty
• IMAGE_CONFIG_FROM_CONFIG_MS - Get image processing configuration from configuration microservice. Set 0 to disable. Default: 1
• IMAGE_PROCESSING_CONFIG - Image processing configuration JSON string. Default: {}
• LOCAL_STORAGE_PATH - Directory where files are saved for local storage provider. Default: data/files

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/attachments -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-attachments

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: 200 MB PEAK / ~160 MB
Run on JS: ~140 MB PEAK / 100 MB AWS Memory: ~200 MB (depends on allow file size)