chore(dashmate): report port check errors (#2245)

Author: shumkov

packages/dashmate/src/listr/tasks/doctor/collectSamplesTaskFactory.js

@@ -167,7 +167,8 @@ export default function collectSamplesTaskFactory(
                 title: 'Core P2P port',
                 task: async () => {
                   const port = config.get('core.p2p.port');
-                  const response = await providers.mnowatch.checkPortStatus(port, config.get('externalIp'));
+                  const response = await providers.mnowatch.checkPortStatus(port, config.get('externalIp'))
+                    .catch((e) => e.toString());
 
                   ctx.samples.setServiceInfo('core', 'p2pPort', response);
                 },
@@ -177,7 +178,8 @@ export default function collectSamplesTaskFactory(
                 enabled: () => config.get('platform.enable'),
                 task: async () => {
                   const port = config.get('platform.gateway.listeners.dapiAndDrive.port');
-                  const response = await providers.mnowatch.checkPortStatus(port, config.get('externalIp'));
+                  const response = await providers.mnowatch.checkPortStatus(port, config.get('externalIp'))
+                    .catch((e) => e.toString());
 
                   ctx.samples.setServiceInfo('gateway', 'httpPort', response);
                 },
@@ -186,7 +188,8 @@ export default function collectSamplesTaskFactory(
                 title: 'Tenderdash P2P port',
                 task: async () => {
                   const port = config.get('platform.drive.tenderdash.p2p.port');
-                  const response = await providers.mnowatch.checkPortStatus(port, config.get('externalIp'));
+                  const response = await providers.mnowatch.checkPortStatus(port, config.get('externalIp'))
+                    .catch((e) => e.toString());
 
                   ctx.samples.setServiceInfo('drive_tenderdash', 'p2pPort', response);
                 },

packages/dashmate/src/status/providers.js

@@ -1,5 +1,4 @@
 import https from 'https';
-import { PortStateEnum } from './enums/portState.js';
 
 const MAX_REQUEST_TIMEOUT = 5000;
 const MAX_RESPONSE_SIZE = 1 * 1024 * 1024; // 1 MB
@@ -82,10 +81,9 @@ export default {
         path: ip ? `/${port}/?validateIp=${ip}` : `/${port}/`,
         method: 'GET',
         family: 4, // Force IPv4
-        timeout: MAX_REQUEST_TIMEOUT,
       };
 
-      return new Promise((resolve) => {
+      return new Promise((resolve, reject) => {
         const req = https.request(options, (res) => {
           let data = '';
 
@@ -95,9 +93,12 @@ export default {
               // eslint-disable-next-line no-console
               console.warn(`Port check request failed with status code ${res.statusCode}`);
             }
-            // Consume response data to free up memory
-            res.resume();
-            resolve(PortStateEnum.ERROR);
+
+            const error = new Error(`Invalid status code ${res.statusCode}`);
+
+            res.destroy(error);
+
+            // Do not handle request further
             return;
           }
 
@@ -109,14 +110,14 @@ export default {
             data += chunk;
 
             if (data.length > MAX_RESPONSE_SIZE) {
-              resolve(PortStateEnum.ERROR);
-
               if (process.env.DEBUG) {
                 // eslint-disable-next-line no-console
                 console.warn('Port check response size exceeded');
               }
 
-              req.destroy();
+              const error = new Error('Response size exceeded');
+
+              req.destroy(error);
             }
           });
 
@@ -126,13 +127,19 @@ export default {
           });
         });
 
+        req.setTimeout(MAX_REQUEST_TIMEOUT, () => {
+          const error = new Error('Port check timed out');
+
+          req.destroy(error);
+        });
+
         req.on('error', (e) => {
           if (process.env.DEBUG) {
             // eslint-disable-next-line no-console
             console.warn(`Port check request failed: ${e}`);
           }
 
-          resolve(PortStateEnum.ERROR);
+          reject(e);
         });
 
         req.end();

packages/dashmate/src/status/scopes/core.js

@@ -1,4 +1,5 @@
 /* eslint-disable camelcase */
+import { PortStateEnum } from '../enums/portState.js';
 import providers from '../providers.js';
 import { ServiceStatusEnum } from '../enums/serviceStatus.js';
 import { DockerStatusEnum } from '../enums/dockerStatus.js';
@@ -116,7 +117,8 @@ export default function getCoreScopeFactory(
 
     const providersResult = await Promise.allSettled([
       providers.github.release('dashpay/dash'),
-      providers.mnowatch.checkPortStatus(config.get('core.p2p.port'), config.get('externalIp')),
+      providers.mnowatch.checkPortStatus(config.get('core.p2p.port'), config.get('externalIp'))
+        .catch(() => PortStateEnum.ERROR),
       providers.insight(config.get('network')).status(),
     ]);
 

packages/dashmate/src/status/scopes/platform.js

@@ -1,4 +1,5 @@
 import prettyMs from 'pretty-ms';
+import { PortStateEnum } from '../enums/portState.js';
 import DockerComposeError from '../../docker/errors/DockerComposeError.js';
 import providers from '../providers.js';
 import { DockerStatusEnum } from '../enums/dockerStatus.js';
@@ -90,8 +91,10 @@ export default function getPlatformScopeFactory(
     // Collecting platform data fails if Tenderdash is waiting for core to sync
     if (info.serviceStatus === ServiceStatusEnum.up) {
       const portStatusResult = await Promise.allSettled([
-        providers.mnowatch.checkPortStatus(config.get('platform.gateway.listeners.dapiAndDrive.port'), config.get('externalIp')),
-        providers.mnowatch.checkPortStatus(config.get('platform.drive.tenderdash.p2p.port'), config.get('externalIp')),
+        providers.mnowatch.checkPortStatus(config.get('platform.gateway.listeners.dapiAndDrive.port'), config.get('externalIp'))
+          .catch(() => PortStateEnum.ERROR),
+        providers.mnowatch.checkPortStatus(config.get('platform.drive.tenderdash.p2p.port'), config.get('externalIp'))
+          .catch(() => PortStateEnum.ERROR),
       ]);
       const [httpPortState, p2pPortState] = portStatusResult.map((result) => (result.status === 'fulfilled' ? result.value : null));
 

packages/dashmate/test/unit/status/scopes/core.spec.js

@@ -78,7 +78,7 @@ describe('getCoreScopeFactory', () => {
       });
 
       mockGithubProvider.returns('v1337-dev');
-      mockMNOWatchProvider.returns('OPEN');
+      mockMNOWatchProvider.resolves('OPEN');
       mockInsightProvider.returns({
         status: this.sinon.stub().returns({
           info: { blocks: 1337 },
@@ -219,7 +219,7 @@ describe('getCoreScopeFactory', () => {
       });
 
       mockGithubProvider.returns('v1337-dev');
-      mockMNOWatchProvider.returns('OPEN');
+      mockMNOWatchProvider.resolves('OPEN');
       mockInsightProvider.returns({
         status: this.sinon.stub().returns({
           info: { blocks: 1337 },
@@ -271,7 +271,7 @@ describe('getCoreScopeFactory', () => {
       });
 
       mockGithubProvider.returns(Promise.reject());
-      mockMNOWatchProvider.returns(PortStateEnum.ERROR);
+      mockMNOWatchProvider.rejects(PortStateEnum.ERROR);
       mockInsightProvider.returns({
         status: () => Promise.reject(),
       });