feat: add config entity to config microservice & create helpers package for all microservices

refactor structure

Author: MatthewPattell

microservices/configuration/README.md

@@ -20,6 +20,7 @@ This microservice provides configuration for all other microservices. Single poi
 - [HOW TO DEVELOP](#how-to-develop)
 
 ### <a id="environments"></a>ENVIRONMENTS:
+- `NODE_ENV` - Can be `production` or `development`. Default: `development`
 - `MS_CONNECTION` - Invert json host and port (with protocol). Default: `http://127.0.0.1:8001`
 - `MS_NAME` - Microservice name. Default: `gateway`
 - `MS_DISABLE_REMOTE_MIDDLEWARE` - Disable remote middleware feature. Default: `0`
@@ -28,6 +29,7 @@ This microservice provides configuration for all other microservices. Single poi
 - `DB_USERNAME` - Database host. Default: `postgres`
 - `DB_PASSWORD` - Database host. Default: `example`
 - `DB_DATABASE` - Database host. Default: `ms-configuration`
+- `MS_CONFIGS` - JSON string for configure initial `Config` values. Default: `[]`
 
 ### <a id="how-to-develop"></a>HOW TO DEVELOP:
 1. Run `Inverted Json` job server.

microservices/configuration/__helpers__/sinon-chai.ts

@@ -1,4 +1,6 @@
 import chai from 'chai';
 import sinonChai from 'sinon-chai';
+import Log from '@services/log';
 
 chai.use(sinonChai);
+Log.configure({ silent: true });

microservices/configuration/__mocks__/config-repository.ts

@@ -0,0 +1,16 @@
+import TypeormMock from '@lomray/microservice-helpers/mocks/typeorm';
+import rewiremock from 'rewiremock';
+import sinon from 'sinon';
+import OriginalConfigRepository from '@repositories/config-repository';
+
+const { default: ConfigRepository } = rewiremock.proxy<{
+  default: typeof OriginalConfigRepository;
+}>(() => require('@repositories/config-repository'), {
+  typeorm: TypeormMock.mock,
+});
+
+class ConfigRepositoryMock extends ConfigRepository {
+  bulkSave = sinon.stub();
+}
+
+export default ConfigRepositoryMock;

microservices/configuration/__mocks__/typeorm.ts

@@ -1,8 +1,7 @@
+import TypeormMock from '@lomray/microservice-helpers/mocks/typeorm';
+import TypeormExtensionMock from '@lomray/microservice-helpers/mocks/typeorm-extension';
 import { expect } from 'chai';
 import rewiremock from 'rewiremock';
-import sinon from 'sinon';
-import TypeormMock from '@__mocks__/typeorm';
-import TypeormExtensionMock from '@__mocks__/typeorm-extension';
 
 const { createDbConnection, connectionDbOptions } = rewiremock.proxy(() => require('@config/db'), {
   typeorm: TypeormMock.mock,
@@ -15,14 +14,6 @@ describe('config/db', () => {
     TypeormExtensionMock.sandbox.reset();
   });
 
-  before(() => {
-    sinon.stub(console, 'info');
-  });
-
-  after(() => {
-    sinon.restore();
-  });
-
   it('should correct create db connection', async () => {
     await createDbConnection(connectionDbOptions);
 

microservices/configuration/__tests__/config/db-test.ts

@@ -1,21 +1,31 @@
+import TypeormMock from '@lomray/microservice-helpers/mocks/typeorm';
 import { Microservice } from '@lomray/microservice-nodejs-lib';
 import { RemoteMiddlewareServer } from '@lomray/microservice-remote-middleware';
 import { expect } from 'chai';
+import rewiremock from 'rewiremock';
 import sinon from 'sinon';
 import type { Connection } from 'typeorm';
+import ConfigRepositoryMock from '@__mocks__/config-repository';
 import * as DBConfig from '@config/db';
 import { microserviceOptions, microserviceParams } from '@config/ms';
 import { MS_NAME, MS_CONNECTION } from '@constants/index';
-import { start } from '../src';
+import { start as OriginalStart } from '../src';
+
+const { start } = rewiremock.proxy<{ start: typeof OriginalStart }>(() => require('../src'), {
+  typeorm: TypeormMock.mock,
+});
 
 describe('start', () => {
-  const middlewareRepo = { middleware: 'repo' };
   const dbConnectionMock = {
-    getRepository: sinon.stub().returns(middlewareRepo),
+    getRepository: sinon.stub().returns({}),
   } as unknown as Promise<Connection>;
+  const configRepository = new ConfigRepositoryMock();
 
   before(() => {
     sinon.stub(console, 'info');
+    TypeormMock.sandbox.reset();
+
+    TypeormMock.stubs.getCustomRepository.returns(configRepository);
   });
 
   beforeEach(() => {
@@ -29,7 +39,8 @@ describe('start', () => {
   it('should correct start microservice', async () => {
     const spyCreate = sinon.spy(Microservice, 'create');
     let stubbedStart;
-    let remoteMiddlewareInstance;
+    let addRegisterEndpointSpy;
+    let addObtainEndpointSpy;
     let dbConnection;
     let isRunBeforeStart = false;
 
@@ -43,7 +54,8 @@ describe('start', () => {
           dbConnection = connection;
         },
         afterInitRemoteMiddleware: (remoteMiddleware) => {
-          remoteMiddlewareInstance = remoteMiddleware;
+          addRegisterEndpointSpy = sinon.spy(remoteMiddleware, 'addRegisterEndpoint');
+          addObtainEndpointSpy = sinon.spy(remoteMiddleware, 'addObtainEndpoint');
         },
         beforeStart: () => {
           isRunBeforeStart = true;
@@ -57,7 +69,9 @@ describe('start', () => {
     expect(stubbedStart).to.calledOnce;
     expect(isRunBeforeStart).to.ok;
     expect(dbConnection).to.deep.equal(dbConnectionMock);
-    expect(remoteMiddlewareInstance).property('repository').to.deep.equal(middlewareRepo);
+    expect(addRegisterEndpointSpy).to.calledOnce;
+    expect(addObtainEndpointSpy).to.calledOnce;
+    expect(configRepository.bulkSave).to.calledOnce;
   });
 
   it('should correct start microservice without remote middleware', async () => {

microservices/configuration/__tests__/index-test.ts

@@ -0,0 +1,33 @@
+import TypeormMock from '@lomray/microservice-helpers/mocks/typeorm';
+import { expect } from 'chai';
+import rewiremock from 'rewiremock';
+import { getCustomRepository } from 'typeorm';
+import Config from '@entities/config';
+import OriginalConfigRepository from '@repositories/config-repository';
+
+const { default: ConfigRepository } = rewiremock.proxy<{
+  default: typeof OriginalConfigRepository;
+}>(() => require('@repositories/config-repository'), {
+  typeorm: TypeormMock.mock,
+});
+
+describe('repositories/config-repository', () => {
+  beforeEach(() => {
+    TypeormMock.sandbox.reset();
+  });
+
+  it('should correct split by chunks and create configs', async () => {
+    const instance = getCustomRepository(ConfigRepository);
+    const sampleConfigs: Partial<Config>[] = Array(5).fill({
+      microservice: 'demo',
+      type: 'db',
+    });
+
+    await instance.bulkSave(sampleConfigs, 2);
+
+    const [, entities, config] = TypeormMock.entityManager.save.firstCall.args;
+
+    expect(entities).to.length(sampleConfigs.length);
+    expect(config.chunk).to.equal(2);
+  });
+});