feat: add method for find registered microservices

Author: MatthewPattell

__tests__/services/abstract-microservice-test.ts

@@ -1,3 +1,4 @@
+/* eslint-disable camelcase */
 import dns from 'dns';
 import axios from 'axios';
 import { expect } from 'chai';
@@ -412,4 +413,18 @@ describe('services/abstract-microservice', () => {
   it('should correctly return channel prefix', () => {
     expect(ms).to.have.property('channelPrefix').to.equal(ms.getChannelPrefix());
   });
+
+  it('should correctly return list of registered microservices', async () => {
+    const channels = {
+      $info: {},
+      'ms/demo': { worker_ids: [] },
+      'ms/example': { worker_ids: ['worker-id'] },
+    };
+    const stubbed = sinon.stub(axios, 'request').resolves({ data: channels });
+
+    expect(await ms.lookup()).to.deep.equal(['demo', 'example']);
+    expect(await ms.lookup(true)).to.deep.equal(['example']);
+
+    stubbed.restore();
+  });
 });

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@lomray/microservice-nodejs-lib",
-	"version": "2.4.5",
+	"version": "1.0.0",
 	"description": "Package for create microservice architecture based on NodeJS & inverted json.",
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",

src/services/abstract-microservice.ts

@@ -242,6 +242,29 @@ abstract class AbstractMicroservice {
     return handledParams;
   }
 
+  /**
+   * Get list of registered microservices
+   */
+  public async lookup(isOnlyAvailable = false): Promise<string[]> {
+    const ijsonConnection = await this.getConnection();
+    const { data } = await axios.request({ url: `${ijsonConnection}/rpc/details` });
+    const prefix = `${this.getChannelPrefix()}/`;
+
+    return Object.entries(data ?? {}).reduce(
+      (res: string[], [channel, params]: [string, Record<string, any>]) => {
+        if (
+          channel.startsWith(prefix) &&
+          (!isOnlyAvailable || (params?.worker_ids?.length ?? 0) > 0)
+        ) {
+          res.push(channel.replace(prefix, ''));
+        }
+
+        return res;
+      },
+      [],
+    );
+  }
+
   /**
    * Get task from queue
    * @protected