fix(ya-vigil-reporter): respect the http api (path)

- `reporter/probe_id/node_id/`
- `reporter/probe_id/node_id/replica_id/`

Author: aegenet

README.md

@@ -71,7 +71,7 @@ export interface IYaVigilReporter {
   /** Cron is running ? */
   get isRunning(): boolean;
 
-  /** Manual reporting */
+  /** Report the replica */
   report(args?: { /** @default true */ reThrow?: boolean }): Promise<YaVigilReportResult>;
 
   /** Flush the replica */
@@ -89,14 +89,15 @@ export interface YaVigilReporterOptions {
   /** `reporter_token` from Vigil `config.cfg` */
   token: string;
 
-  /** Probe ID containing the parent Node for Replica */
-  probe_id: string;
-
-  /** Node ID containing Replica */
+  /** The parent node of the reporting replica */
   node_id: string;
 
-  /** Replica ID */
+  /** The parent probe of the node */
+  probe_id: string;
+
+  /** The replica unique identifier (eg. the server LAN IP) */
   replica_id: string;
+
   /**
    * Reporting interval in seconds
    *
@@ -122,6 +123,10 @@ export interface YaVigilReporterOptions {
 }
 ```
 
+## Vigil HTTP API Specifications
+
+- [Vigil Reporter HTTP API](https://github.com/valeriansaliou/vigil/blob/master/PROTOCOL.md#vigil-reporter-http-api) protocol specifications.
+- [Vigil Manager HTTP API](https://github.com/valeriansaliou/vigil/blob/master/PROTOCOL.md#vigil-manager-http-api) protocol specifications.
 
 # Coverage
 [![codecov](https://codecov.io/gh/aegenet/ya-vigil-reporter/branch/main/graph/badge.svg?token=NRN5ODOY91)](https://codecov.io/gh/aegenet/ya-vigil-reporter)

src/i-ya-vigil-reporter.ts

@@ -16,7 +16,7 @@ export interface IYaVigilReporter {
   /** Cron is running ? */
   get isRunning(): boolean;
 
-  /** Manual reporting */
+  /** Report the replica */
   report(args?: { /** @default true */ reThrow?: boolean }): Promise<YaVigilReportResult>;
 
   /** Flush the replica */

src/models/ya-vigil-reporter-options.ts

@@ -8,14 +8,15 @@ export interface YaVigilReporterOptions {
   /** `reporter_token` from Vigil `config.cfg` */
   token: string;
 
-  /** Probe ID containing the parent Node for Replica */
-  probe_id: string;
-
-  /** Node ID containing Replica */
+  /** The parent node of the reporting replica */
   node_id: string;
 
-  /** Replica ID */
+  /** The parent probe of the node */
+  probe_id: string;
+
+  /** The replica unique identifier (eg. the server LAN IP) */
   replica_id: string;
+
   /**
    * Reporting interval in seconds
    *

src/tests/create-fake-vigil-server.spec.ts

@@ -3,7 +3,7 @@ import { delay } from '../utils/ya-workload.spec';
 
 export function createFakeVigilServer() {
   const server = fastify({ logger: true });
-  server.post('/reporter/:probe_id/:node_id', async (request: FastifyRequest, reply: FastifyReply) => {
+  server.post('/reporter/:probe_id/:node_id/', async (request: FastifyRequest, reply: FastifyReply) => {
     const { probe_id, node_id } = request.params as any;
     const { replica, interval, load } = request.body as any;
 
@@ -41,7 +41,7 @@ export function createFakeVigilServer() {
       reply.status(400).send((error as Error).message);
     }
   });
-  server.delete('/reporter/:probe_id/:node_id/:replica', async (request: FastifyRequest, reply: FastifyReply) => {
+  server.delete('/reporter/:probe_id/:node_id/:replica/', async (request: FastifyRequest, reply: FastifyReply) => {
     const { probe_id, node_id, replica } = request.params as any;
 
     try {

src/ya-vigil-reporter.spec.ts

@@ -142,6 +142,7 @@ describe('ya-vigil-reporter', () => {
           assert.ok(err);
           assert.ok(!vigilReporter.isRunning);
         },
+        flush: true,
       });
     });
 

src/ya-vigil-reporter.ts

@@ -39,7 +39,7 @@ export class YaVigilReporter implements IYaVigilReporter {
     if (!baseURL.endsWith('/')) {
       baseURL += '/';
     }
-    baseURL += `reporter/${encodeURIComponent(probe_id)}/${encodeURIComponent(node_id)}`;
+    baseURL += `reporter/${encodeURIComponent(probe_id)}/${encodeURIComponent(node_id)}/`;
     this._baseURL = baseURL;
     this._reporterAuthz = `Basic ${Buffer.from(':' + token).toString('base64')}`;
     this._reporterHeader = {
@@ -90,12 +90,18 @@ export class YaVigilReporter implements IYaVigilReporter {
   /** @inheritdoc */
   public async end(args?: { flush?: boolean; done?: (error?: Error) => void }): Promise<void> {
     args ||= {};
+    let doneFunc = args!.done;
     await this.stop(args)
-      .then(() => {
-        args!.done?.();
-      })
       .catch(error => {
-        args!.done?.(error);
+        try {
+          doneFunc?.(error);
+        } finally {
+          // avoid another call if doneFunc throw an error
+          doneFunc = undefined;
+        }
+      })
+      .then(() => {
+        doneFunc?.();
       });
   }
 
@@ -166,7 +172,7 @@ export class YaVigilReporter implements IYaVigilReporter {
       this._options.logger?.info?.('ya-vigil-reporter.flush');
 
       await yaFetchWTimeout(
-        this._baseURL + '/' + encodeURIComponent(this._options.replica_id),
+        this._baseURL + encodeURIComponent(this._options.replica_id) + '/',
         {
           method: 'DELETE',
           headers: {