Merge pull request #1751 from spacemeshos/feat-1737-export-net-info

Export network info from Settings screen

app/infra/eventsService/eventsService.ts

@@ -247,6 +247,8 @@ class EventsService {
 
   /** **************************************   MISC   ***************************************** */
 
+  static exportNetInfo = () => ipcRenderer.invoke(ipcConsts.EXPORT_NET_INFO);
+
   static print = ({ content }: { content: string }) =>
     ipcRenderer.send(ipcConsts.PRINT, { content });
 

app/screens/settings/Settings.tsx

@@ -491,6 +491,17 @@ class Settings extends Component<Props, State> {
               ))}
             </SettingsSection>
             <SettingsSection title={categories[3]} name={categories[3]}>
+              <SettingRow
+                upperPartLeft="Export network information"
+                upperPartRight={
+                  <Button
+                    onClick={eventsService.exportNetInfo}
+                    text="EXPORT INFO"
+                    width={180}
+                  />
+                }
+                rowName=""
+              />
               <SettingRow
                 upperPartLeft={getFormattedTimestamp(genesisTime)}
                 isUpperPartLeftText

app/vars/ipcConsts.ts

@@ -99,6 +99,7 @@ enum IpcChannel {
   REQUEST_QUICKSYNC_CHECK = 'REQUEST_QUICKSYNC_CHECK',
   UPDATE_QUICKSYNC_STATUS = 'UPDATE_QUICKSYNC_STATUS',
   UPDATE_ATX_COUNT = 'UPDATE_ATX_COUNT',
+  EXPORT_NET_INFO = 'EXPORT_NET_INFO',
 }
 
 export default IpcChannel;

desktop/AdminService.ts

@@ -1,6 +1,7 @@
 import { ProtoGrpcType } from '../api/generated';
 import { Event } from '../api/generated/spacemesh/v1/Event';
 
+import { PeerInfo__Output } from '../api/generated/spacemesh/v1/PeerInfo';
 import Logger from './logger';
 import NetServiceFactory from './NetServiceFactory';
 import { getPrivateNodeConnectionConfig } from './main/utils';
@@ -37,6 +38,23 @@ class AdminService extends NetServiceFactory<
     );
     return this.cancelEventsStream;
   };
+
+  getPeerInfo = () =>
+    new Promise((resolve, reject) => {
+      if (!this.service) {
+        reject(new Error('Service is not started yet'));
+        return;
+      }
+
+      const result: PeerInfo__Output[] = [];
+      const stream = this.service?.PeerInfoStream({});
+      if (!stream) {
+        resolve([]);
+        return;
+      }
+      stream.on('data', (d) => result.push(d));
+      stream.on('close', () => resolve(result));
+    });
 }
 
 export default AdminService;

desktop/DebugService.ts

@@ -0,0 +1,28 @@
+import { ProtoGrpcType } from '../api/generated';
+
+import Logger from './logger';
+import NetServiceFactory from './NetServiceFactory';
+import { getPrivateNodeConnectionConfig } from './main/utils';
+
+const PROTO_PATH = 'vendor/api/spacemesh/v1/debug.proto';
+
+class DebugService extends NetServiceFactory<
+  ProtoGrpcType,
+  'v1',
+  'DebugService'
+> {
+  logger = Logger({ className: 'DebugService' });
+
+  createService = () => {
+    this.createNetService(
+      PROTO_PATH,
+      getPrivateNodeConnectionConfig(),
+      'v1',
+      'DebugService'
+    );
+  };
+
+  getNetworkInfo = () => this.callService('NetworkInfo', {});
+}
+
+export default DebugService;

desktop/main/reactions/handleExportInfoIPC.ts

@@ -0,0 +1,63 @@
+import { writeFile } from 'fs/promises';
+import { combineLatest, from, map, mergeMap, Observable } from 'rxjs';
+import { BrowserWindow, dialog } from 'electron';
+import { handleIPC, handlerResult, makeSubscription } from '../rx.utils';
+import { ipcConsts } from '../../../app/vars';
+import AdminService from '../../AdminService';
+import DebugService from '../../DebugService';
+import Logger from '../../logger';
+
+const logger = Logger({ className: 'handleExportInfoIPC' });
+
+const saveDialog = async (
+  browser: BrowserWindow,
+  data: Record<string, any>
+) => {
+  const { canceled, filePath } = await dialog.showSaveDialog(browser, {
+    title: 'Export network info',
+    buttonLabel: 'Export',
+    defaultPath: 'netInfo.json',
+  });
+  if (canceled || !filePath) {
+    return { filePath: null, data, canceled };
+  }
+  return { filePath, data, canceled };
+};
+
+const handleExportInfoIPC = ($mainWindow: Observable<BrowserWindow>) =>
+  makeSubscription(
+    handleIPC(
+      ipcConsts.EXPORT_NET_INFO,
+      () => {
+        const adminService = new AdminService();
+        const debugService = new DebugService();
+        debugService.createService();
+        adminService.createService();
+
+        const netInfo = from(debugService.getNetworkInfo());
+        const peerInfo = from(adminService.getPeerInfo());
+
+        return combineLatest([netInfo, peerInfo, $mainWindow]).pipe(
+          mergeMap(([netInfo, peerInfo, browser]) =>
+            from(saveDialog(browser, { netInfo, peerInfo }))
+          ),
+          map(handlerResult)
+        );
+      },
+      (data) => data
+    ),
+    ({ filePath, data }) => {
+      if (filePath) {
+        writeFile(filePath, JSON.stringify(data, null, 2), 'utf-8')
+          // eslint-disable-next-line promise/always-return
+          .then(() => {
+            logger.log('Network data exported', { filePath, data });
+          })
+          .catch((err) =>
+            logger.error('Cannot write file', err, { filePath, data })
+          );
+      }
+    }
+  );
+
+export default handleExportInfoIPC;

desktop/main/startApp.ts

@@ -49,6 +49,7 @@ import syncAutoStartAndConfig from './reactions/syncAutoStartAndConfig';
 import restartNode from './reactions/restartNode';
 import { updateConfigHash } from './configHash';
 import { ensureConfigCacheDir } from './fallbackConfigs';
+import handleExportInfoIPC from './reactions/handleExportInfoIPC';
 
 const positiveNum = (def: number, n: number) => (n > 0 ? n : def);
 
@@ -271,6 +272,7 @@ const startApp = (): AppStore => {
     listenNodeConfigAndRestartNode($nodeConfig, $managers),
     handleBenchmarksIpc($mainWindow, $nodeConfig),
     syncAutoStartAndConfig($warnings),
+    handleExportInfoIPC($mainWindow),
   ];
 
   return {

desktop/testMode.ts

@@ -39,26 +39,19 @@ export const getTestModeNodeConfig = (): NodeConfig => ({
   main: {
     'layer-duration': '6s',
     'layers-per-epoch': 10,
-    'eligibility-confidence-param': 18,
-    'tick-size': 67000,
     'network-hrp': HRP.Standalone,
   },
-  genesis: {
-    'genesis-time': TEST_MODE_GENESIS_TIME,
-    'genesis-extra-data': 'standalone',
-  },
   poet: {
-    'phase-shift': '30s',
     'cycle-gap': '30s',
-    'grace-period': '10s',
   },
   post: {
     'post-labels-per-unit': 128,
     'post-max-numunits': 4,
     'post-min-numunits': 1,
-    'post-k1': 12,
-    'post-k2': 4,
-    'post-k3': 4,
+  },
+  genesis: {
+    'genesis-time': TEST_MODE_GENESIS_TIME,
+    'genesis-extra-data': 'standalone',
   },
 });
 

shared/types/node.ts

@@ -102,6 +102,7 @@ export interface NodeConfig {
   post: {
     'post-labels-per-unit': number;
     'post-max-numunits': number;
+    'post-min-numunits'?: number;
   };
 }