[DDW-987] Debug the main process (#2893)

Co-authored-by: Daniel Main <[email protected]>

Author: renanvalentin

CHANGELOG.md

@@ -5,6 +5,16 @@
 ### Features
 
 - Implemented error message when trying to leave wallet without enough ada to support tokens ([PR 2783](https://github.com/input-output-hk/daedalus/pull/2783))
+
+### Chores
+
+- Removed SASS ts-lint ignore comments ([PR 2870](https://github.com/input-output-hk/daedalus/pull/2870))
+- Enabled debugging of the main process ([PR 2893](https://github.com/input-output-hk/daedalus/pull/2893))
+
+## 4.9.0
+
+### Features
+
 - Added display of current/unspent rewards ([PR 2803](https://github.com/input-output-hk/daedalus/pull/2803))
 - Improve the syncing screen by showing syncing progress split into three stages ([PR 2877](https://github.com/input-output-hk/daedalus/pull/2877))
 - Improved stake pool searchbar ([PR 2847](https://github.com/input-output-hk/daedalus/pull/2847))
@@ -19,10 +29,6 @@
 
 - Fixed Daedalus menu in Storybook used for theme and language selection ([PR 2886](https://github.com/input-output-hk/daedalus/pull/2886))
 
-### Chores
-
-- Removed SASS ts-lint ignore comments ([PR 2870](https://github.com/input-output-hk/daedalus/pull/2870))
-
 ## 4.9.0-FC1
 
 ### Features

README.md

@@ -194,6 +194,15 @@ Make sure to list bootstrap in externals in `webpack.config.base.js` or the app
 externals: ['bootstrap']
 ```
 
+### Debugging
+
+You can debug the main process by following one of these approaches:
+- [VSCode](https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_attaching-to-nodejs)
+- [Chrome](https://nodejs.org/en/docs/guides/debugging-getting-started/#inspector-clients)
+- [IntelliJ](https://www.jetbrains.com/help/idea/run-debug-configuration-node-js-remote-debug.html)
+
+The inspector runs on port 9229
+
 ## Testing
 
 You can find more details regarding tests setup within

gulpfile.js

@@ -8,6 +8,7 @@ const rendererWebpackConfig = require('./source/renderer/webpack.config');
 
 // Setup electron-connect server to start the app in development mode
 let electronServer;
+const electronServerAgs = ['--inspect=9229'];
 // Gulp input sources for main and renderer compilation
 const mainInputSource = () => gulp.src('source/main/index.ts');
 const rendererInputSource = () => gulp.src('source/renderer/index.ts');
@@ -47,7 +48,7 @@ const buildMainWatch = () => (done) =>
     .pipe(
       webpackStream(mainWebpackWatchConfig, webpack, () => {
         // Restart app every time after main script has been re-compiled
-        electronServer.restart();
+        electronServer.restart(electronServerAgs);
         done();
       })
     )
@@ -79,7 +80,7 @@ gulp.task(
 gulp.task('clean:dist', shell.task('rimraf ./dist'));
 
 gulp.task('server:start', (done) => {
-  electronServer.start();
+  electronServer.start(electronServerAgs);
   done();
 });
 
@@ -92,13 +93,10 @@ gulp.task('server:create:dev', (done) => {
 });
 
 gulp.task('server:create:debug', (done) => {
-  createElectronServer(
-    {
-      NODE_ENV: process.env.NODE_ENV,
-      XCURSOR_PATH: '/usr/share/icons' || 'development',
-    },
-    ['--inspect', '--inspect-brk']
-  );
+  createElectronServer({
+    NODE_ENV: process.env.NODE_ENV,
+    XCURSOR_PATH: '/usr/share/icons' || 'development',
+  });
   done();
 });