feat: add support for attach jvm debugger (#549)

Signed-off-by: Jeffrey Tang <[email protected]>
Signed-off-by: JeffreyDallas <[email protected]>
Co-authored-by: Jeromy Cannon <[email protected]>

Author: JeffreyDallas

README.md.template

@@ -377,6 +377,57 @@ You can find log for running solo command under the directory `~/.solo/logs/`
 The file `solo.log` contains the logs for the solo command. 
 The file `hashgraph-sdk.log` contains the logs from solo client when sending transactions to network nodes.
 
+## Using Intellj remote debug with solo
+
+NOTE: the hedera-services path referenced '../hedera-services/hedera-node/data' may need to be updated based on what directory you are currently in.  This also assumes that you have done an assemble/build and the directory contents are up-to-date.
+
+Example 1: attach jvm debugger to a hedera node
+```bash
+./test/e2e/setup-e2e.sh
+solo node keys --gossip-keys --tls-keys
+solo network deploy -i node1,node2,node3 --debug-nodeid node2
+solo node setup -i node1,node2,node3 --local-build-path ../hedera-services/hedera-node/data
+solo node start -i node1,node2,node3 --debug-nodeid node2
+```
+
+Once you see the following message, you can launch jvm debugger from Intellij
+```
+❯ Check all nodes are ACTIVE
+  Check node: node1,
+  Check node: node3,  Please attach JVM debugger now.
+  Check node: node4,
+```
+
+Example 2: attach jvm debugger with node add operation
+
+```bash
+./test/e2e/setup-e2e.sh
+solo node keys --gossip-keys --tls-keys 
+solo network deploy -i node1,node2,node3 --pvcs
+solo node setup -i node1,node2,node3 --local-build-path ../hedera-services/hedera-node/data
+solo node start -i node1,node2,node3
+solo node add --gossip-keys --tls-keys --node-id node4 --debug-nodeid node4 --local-build-path ../hedera-services/hedera-node/data
+```
+
+Example 3: attach jvm debugger with node update operation
+```bash
+./test/e2e/setup-e2e.sh
+solo node keys --gossip-keys --tls-keys 
+solo network deploy -i node1,node2,node3
+solo node setup -i node1,node2,node3 --local-build-path ../hedera-services/hedera-node/data
+solo node start -i node1,node2,node3
+solo node update --node-id node2  --debug-nodeid node2 --local-build-path ../hedera-services/hedera-node/data --new-account-number 0.0.7 --gossip-public-key ./s-public-node2.pem --gossip-private-key ./s-private-node2.pem --agreement-public-key ./a-public-node2.pem --agreement-private-key ./a-private-node2.pem
+```
+
+Example 4: attach jvm debugger with node delete operation
+```bash
+./test/e2e/setup-e2e.sh
+solo node keys --gossip-keys --tls-keys 
+solo network deploy -i node1,node2,node3,node4
+solo node setup -i node1,node2,node3,node4 --local-build-path ../hedera-services/hedera-node/data
+solo node start -i node1,node2,node3,node4
+solo node delete --node-id node2  --debug-nodeid node3
+```
 
 ## Support
 

src/commands/flags.mjs

@@ -745,6 +745,17 @@ export const persistentVolumeClaims = {
   }
 }
 
+/** @type {CommandFlag} **/
+export const debugNodeId = {
+  constName: 'debugNodeId',
+  name: 'debug-nodeid',
+  definition: {
+    describe: 'Enable default jvm debug port (5005) for the given node id',
+    defaultValue: '',
+    type: 'string'
+  }
+}
+
 /** @type {CommandFlag[]} **/
 export const allFlags = [
   accountId,
@@ -785,6 +796,7 @@ export const allFlags = [
   grpcEndpoints,
   hederaExplorerTlsHostName,
   hederaExplorerTlsLoadBalancerIp,
+  debugNodeId,
   localBuildPath,
   log4j2Xml,
   namespace,

src/commands/network.mjs

@@ -25,7 +25,7 @@ import { constants, Templates } from '../core/index.mjs'
 import * as prompts from './prompts.mjs'
 import * as helpers from '../core/helpers.mjs'
 import path from 'path'
-import { validatePath } from '../core/helpers.mjs'
+import { addDebugOptions, validatePath } from '../core/helpers.mjs'
 import fs from 'fs'
 
 export class NetworkCommand extends BaseCommand {
@@ -74,6 +74,7 @@ export class NetworkCommand extends BaseCommand {
       flags.fstChartVersion,
       flags.hederaExplorerTlsHostName,
       flags.hederaExplorerTlsLoadBalancerIp,
+      flags.debugNodeId,
       flags.log4j2Xml,
       flags.namespace,
       flags.nodeIDs,
@@ -138,6 +139,17 @@ export class NetworkCommand extends BaseCommand {
       valuesArg += this.prepareValuesFiles(config.valuesFile)
     }
 
+    if (config.app !== constants.HEDERA_APP_NAME) {
+      const index = config.nodeIds.length
+      for (let i = 0; i < index; i++) {
+        valuesArg += ` --set "hedera.nodes[${i}].root.extraEnv[0].name=JAVA_MAIN_CLASS"`
+        valuesArg += ` --set "hedera.nodes[${i}].root.extraEnv[0].value=com.swirlds.platform.Browser"`
+      }
+      valuesArg = addDebugOptions(valuesArg, config.debugNodeId, 1)
+    } else {
+      valuesArg = addDebugOptions(valuesArg, config.debugNodeId)
+    }
+
     const profileName = this.configManager.getFlag(flags.profileName)
     this.profileValuesFile = await this.profileManager.prepareValuesForFstChart(profileName)
     if (this.profileValuesFile) {
@@ -182,6 +194,7 @@ export class NetworkCommand extends BaseCommand {
       flags.bootstrapProperties,
       flags.cacheDir,
       flags.chainId,
+      flags.debugNodeId,
       flags.deployHederaExplorer,
       flags.deployMirrorNode,
       flags.hederaExplorerTlsLoadBalancerIp,