feat: refactor structure, prepare for new cli

Author: MatthewPattell

.github/workflows/build.yml

@@ -136,7 +136,7 @@ jobs:
         with:
           name: "Lomray-Software/microservices/${{ env.MICROSERVICE_NAME }}"
           tags: "latest${{ needs.changed-microservices.outputs.docker-tag }},${{ steps.package-version.outputs.version}}"
-          dockerfile: Dockerfile-nodejs
+          dockerfile: node_modules/@lomray/microservice-config/Dockerfile-nodejs
           context: ${{ env.WORK_DIR }}
           buildoptions: "--compress --force-rm --no-cache"
           username: ${{ github.actor }}

Dockerfile-nodejs

@@ -1,7 +1,3 @@
 module.exports = {
-	ui:         'bdd',
-	timeout:    5000,
-  extension:  ['ts'],
-	watchFiles: ['__tests__/**/*.ts', 'src/**/*.ts'],
-  require:    ['./__helpers__/sinon-chai.ts', './__helpers__/root-hooks.ts'],
+	...require('@lomray/microservice-config/mocharc'),
 };

microservices/attachments/.mocharc.js

@@ -23,39 +23,13 @@ A microservice provides work with attachments for entities from other microservi
 - [MEMORY USAGE](#memory-usage)
 
 ### <a id="environments"></a>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_BUCKET_ACL` - AWS S3 bucket ACL (e.g.: public-read). Default: `empty`
-- `AWS_FROM_CONFIG_MS` - Get AWS credentials from configuration microservice. Set `0` to disable. Default: `1`
 - `MS_STORAGE_DOMAIN` - Access to attachments through storage domain. Default: ``
 - `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`
-- `MS_CONSOLE_LOG_LEVEL` - Change console log level. Default: `info`
+- [See full list `COMMON ENVIRONMENTS`](https://github.com/Lomray-Software/microservice-helpers#common-environments)
 
 ### <a id="how-to-run"></a>HOW TO RUN:
 1. Run `Inverted Json` job server.

microservices/attachments/README.md

@@ -1,8 +1,6 @@
-import { Log } from '@lomray/microservice-helpers';
 import { expect } from 'chai';
 import rewiremock from 'rewiremock';
 import sinon from 'sinon';
-import { msParams } from '@config/ms';
 
 describe('microservice: start', () => {
   const sandbox = sinon.createSandbox();
@@ -26,15 +24,4 @@ describe('microservice: start', () => {
     expect(args).to.have.property('msParams');
     expect(args).to.have.property('registerMethods');
   });
-
-  it('should have microservice custom logger', () => {
-    const { logDriver } = msParams;
-    const LogInfoSpy = sandbox.spy(Log, 'log');
-
-    if (typeof logDriver !== 'boolean') {
-      logDriver?.(() => 'test');
-    }
-
-    expect(LogInfoSpy).to.calledOnce;
-  });
 });

microservices/attachments/__tests__/index-test.ts

@@ -5,7 +5,7 @@ import sinon from 'sinon';
 import { getRepository } from 'typeorm';
 import { bucketNameMock } from '@__mocks__/common';
 import AttachmentType from '@constants/attachment-type';
-import { IMAGE_CONFIG_FROM_CONFIG_MS, IMAGE_PROCESSING_CONFIG } from '@constants/index';
+import CONST from '@constants/index';
 import StorageType from '@constants/storage-type';
 import Attachment from '@entities/attachment';
 import Image from '@services/attachment/image';
@@ -29,8 +29,8 @@ describe('services/attachment/image', () => {
 
     const storage = await StorageFactory.create(StorageType.s3);
     const config = await ImageProcessingConfig.get({
-      isFromConfigMs: IMAGE_CONFIG_FROM_CONFIG_MS,
-      config: IMAGE_PROCESSING_CONFIG,
+      isFromConfigMs: CONST.IS_IMAGE_CONFIG_FROM_CONFIG_MS,
+      config: CONST.IMAGE_PROCESSING_CONFIG,
     });
 
     const service = new Image(AttachmentType.image, TypeormMock.entityManager, storage, config);
@@ -59,8 +59,8 @@ describe('services/attachment/image', () => {
 
     const storage = await StorageFactory.create('S3');
     const config = await ImageProcessingConfig.get({
-      isFromConfigMs: IMAGE_CONFIG_FROM_CONFIG_MS,
-      config: IMAGE_PROCESSING_CONFIG,
+      isFromConfigMs: CONST.IS_IMAGE_CONFIG_FROM_CONFIG_MS,
+      config: CONST.IMAGE_PROCESSING_CONFIG,
     });
 
     const service = new Image(AttachmentType.image, TypeormMock.entityManager, storage, config);
@@ -81,8 +81,8 @@ describe('services/attachment/image', () => {
 
     const storage = await StorageFactory.create('S3');
     const config = await ImageProcessingConfig.get({
-      isFromConfigMs: IMAGE_CONFIG_FROM_CONFIG_MS,
-      config: IMAGE_PROCESSING_CONFIG,
+      isFromConfigMs: CONST.IS_IMAGE_CONFIG_FROM_CONFIG_MS,
+      config: CONST.IMAGE_PROCESSING_CONFIG,
     });
 
     const service = new Image(AttachmentType.image, TypeormMock.entityManager, storage, config);

microservices/attachments/__tests__/methods/meta-test.ts

@@ -18,7 +18,7 @@ describe('services/external/s3-aws-sdk', () => {
   it('should successfully create instance with options', async () => {
     ImageProcessingConfig.reset();
 
-    const configMs = await ImageProcessingConfig.get({ isFromConfigMs: 0, config });
+    const configMs = await ImageProcessingConfig.get({ isFromConfigMs: false, config });
 
     expect(configMs).to.deep.equal(config);
   });
@@ -34,7 +34,7 @@ describe('services/external/s3-aws-sdk', () => {
     sandbox.stub(RemoteConfig, 'get').resolves(fromRemoteConfig);
 
     const remoteConfig = await ImageProcessingConfig.get({
-      isFromConfigMs: 1,
+      isFromConfigMs: true,
       config,
     });
 

microservices/attachments/__tests__/services/attachment/image-test.ts

@@ -20,7 +20,7 @@ describe('services/external/s3-aws-sdk', () => {
       bucketName: bucketNameMock,
     };
 
-    const { s3, bucketName } = await S3AwsSdk.get({ isFromConfigMs: 0, options });
+    const { s3, bucketName } = await S3AwsSdk.get({ isFromConfigMs: false, options });
 
     expect(s3.config.accessKeyId).to.equal(options.accessKeyId);
     expect(s3.config.secretAccessKey).to.equal(options.secretAccessKey);
@@ -40,7 +40,7 @@ describe('services/external/s3-aws-sdk', () => {
 
     sandbox.stub(RemoteConfig, 'get').resolves(fromRemoteConfig);
 
-    const { s3, bucketName } = await S3AwsSdk.get({ isFromConfigMs: 1 });
+    const { s3, bucketName } = await S3AwsSdk.get({ isFromConfigMs: true });
 
     expect(s3.config.accessKeyId).to.equal(fromRemoteConfig.accessKeyId);
     expect(s3.config.secretAccessKey).to.equal(fromRemoteConfig.secretAccessKey);

microservices/attachments/__tests__/services/external/image-processing-config-test.ts

@@ -9,7 +9,7 @@ import S3Storage from '@services/storage/s3';
 
 describe('services/attachment/image', () => {
   const options = {
-    isFromConfigMs: 1,
+    isFromConfigMs: true,
     options: {
       accessKeyId: 'access_key_id',
       secretAccessKey: 'secret_access_key',