Merge pull request #6228 from halibobo1205/feat/services_init_opt

CodeNinjaEvan · web-flow · commit f6e41683ee5a · 2025-03-06T18:04:57.000+08:00
feat(service): exit when services failed to start
diff --git a/common/src/main/java/org/tron/common/log/LogService.java b/common/src/main/java/org/tron/common/log/LogService.java
@@ -0,0 +1,26 @@
+package org.tron.common.log;
+
+import ch.qos.logback.classic.LoggerContext;
+import ch.qos.logback.classic.joran.JoranConfigurator;
+import java.io.File;
+import org.slf4j.LoggerFactory;
+import org.tron.core.exception.TronError;
+
+public class LogService {
+
+  public static void load(String path) {
+    try {
+      File file = new File(path);
+      if (!file.exists() || !file.isFile() || !file.canRead()) {
+        return;
+      }
+      LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory();
+      JoranConfigurator configurator = new JoranConfigurator();
+      configurator.setContext(lc);
+      lc.reset();
+      configurator.doConfigure(file);
+    } catch (Exception e) {
+      throw new TronError(e, TronError.ErrCode.LOG_LOAD);
+    }
+  }
+}
diff --git a/common/src/main/java/org/tron/common/prometheus/Metrics.java b/common/src/main/java/org/tron/common/prometheus/Metrics.java
@@ -5,9 +5,9 @@
 import io.prometheus.client.Histogram;
 import io.prometheus.client.exporter.HTTPServer;
 import io.prometheus.client.hotspot.DefaultExports;
-import java.io.IOException;
 import lombok.extern.slf4j.Slf4j;
 import org.tron.common.parameter.CommonParameter;
+import org.tron.core.exception.TronError;
 
 @Slf4j(topic = "metrics")
 public class Metrics {
@@ -32,9 +32,8 @@ public static synchronized  void init() {
         new HTTPServer.Builder().withPort(port).build();
         logger.info("prometheus exposed on port : {}", port);
         initialized = true;
-      } catch (IOException e) {
-        CommonParameter.getInstance().setMetricsPrometheusEnable(false);
-        logger.error("{}", e.getMessage());
+      } catch (Exception e) {
+        throw new TronError(e, TronError.ErrCode.PROMETHEUS_INIT);
       }
     }
   }
diff --git a/common/src/main/java/org/tron/core/exception/TronError.java b/common/src/main/java/org/tron/core/exception/TronError.java
@@ -40,6 +40,11 @@ public enum ErrCode {
     EVENT_SUBSCRIBE_ERROR(1),
     AUTO_STOP_PARAMS(1),
     API_SERVER_INIT(1),
+    EVENT_SUBSCRIBE_INIT(1),
+    PROMETHEUS_INIT(1),
+    TRON_NET_SERVICE_INIT(1),
+    ZCASH_INIT(1),
+    LOG_LOAD(1),
     SOLID_NODE_INIT(0);
 
     private final int code;
diff --git a/framework/src/main/java/org/tron/core/db/Manager.java b/framework/src/main/java/org/tron/core/db/Manager.java
@@ -137,6 +137,7 @@
 import org.tron.core.metrics.MetricsUtil;
 import org.tron.core.service.MortgageService;
 import org.tron.core.service.RewardViCalService;
+import org.tron.core.services.event.exception.EventException;
 import org.tron.core.store.AccountAssetStore;
 import org.tron.core.store.AccountIdIndexStore;
 import org.tron.core.store.AccountIndexStore;
@@ -2098,7 +2099,7 @@ private void startEventSubscribing() {
           .start(Args.getInstance().getEventPluginConfig());
 
       if (!eventPluginLoaded) {
-        logger.error("Failed to load eventPlugin.");
+        throw new EventException("Failed to load eventPlugin.");
       }
 
       FilterQuery eventFilter = Args.getInstance().getEventFilter();
@@ -2107,7 +2108,7 @@ private void startEventSubscribing() {
       }
 
     } catch (Exception e) {
-      logger.error("{}", e);
+      throw new TronError(e, TronError.ErrCode.EVENT_SUBSCRIBE_INIT);
     }
   }
 
diff --git a/framework/src/main/java/org/tron/core/net/TronNetService.java b/framework/src/main/java/org/tron/core/net/TronNetService.java
@@ -15,6 +15,7 @@
 import org.tron.common.overlay.message.Message;
 import org.tron.common.parameter.CommonParameter;
 import org.tron.core.config.args.Args;
+import org.tron.core.exception.TronError;
 import org.tron.core.net.message.adv.TransactionMessage;
 import org.tron.core.net.messagehandler.TransactionsMsgHandler;
 import org.tron.core.net.peer.PeerConnection;
@@ -102,7 +103,7 @@ public void start() {
       effectiveCheckService.init();
       logger.info("Net service start successfully");
     } catch (Exception e) {
-      logger.error("Net service start failed", e);
+      throw new TronError(e, TronError.ErrCode.TRON_NET_SERVICE_INIT);
     }
   }
 
diff --git a/framework/src/main/java/org/tron/core/zen/ZksnarkInitService.java b/framework/src/main/java/org/tron/core/zen/ZksnarkInitService.java
@@ -9,6 +9,7 @@
 import org.springframework.stereotype.Component;
 import org.tron.common.zksnark.JLibrustzcash;
 import org.tron.common.zksnark.LibrustzcashParam;
+import org.tron.core.exception.TronError;
 import org.tron.core.exception.ZksnarkException;
 
 @Slf4j(topic = "API")
@@ -40,7 +41,7 @@ public static void librustzcashInitZksnarkParams() {
       JLibrustzcash.librustzcashInitZksnarkParams(
           new LibrustzcashParam.InitZksnarkParams(spendPath, spendHash, outputPath, outputHash));
     } catch (ZksnarkException e) {
-      logger.error("librustzcashInitZksnarkParams fail!", e);
+      throw new TronError(e, TronError.ErrCode.ZCASH_INIT);
     }
     logger.info("init zk param done");
   }
diff --git a/framework/src/main/java/org/tron/program/FullNode.java b/framework/src/main/java/org/tron/program/FullNode.java
@@ -1,16 +1,13 @@
 package org.tron.program;
 
-import ch.qos.logback.classic.LoggerContext;
-import ch.qos.logback.classic.joran.JoranConfigurator;
 import com.beust.jcommander.JCommander;
-import java.io.File;
 import lombok.extern.slf4j.Slf4j;
-import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.support.DefaultListableBeanFactory;
 import org.tron.common.application.Application;
 import org.tron.common.application.ApplicationFactory;
 import org.tron.common.application.TronApplicationContext;
 import org.tron.common.exit.ExitManager;
+import org.tron.common.log.LogService;
 import org.tron.common.parameter.CommonParameter;
 import org.tron.common.prometheus.Metrics;
 import org.tron.core.Constant;
@@ -20,23 +17,6 @@
 @Slf4j(topic = "app")
 public class FullNode {
 
-
-  public static void load(String path) {
-    try {
-      File file = new File(path);
-      if (!file.exists() || !file.isFile() || !file.canRead()) {
-        return;
-      }
-      LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory();
-      JoranConfigurator configurator = new JoranConfigurator();
-      configurator.setContext(lc);
-      lc.reset();
-      configurator.doConfigure(file);
-    } catch (Exception e) {
-      logger.error(e.getMessage());
-    }
-  }
-
   /**
    * Start the FullNode.
    */
@@ -46,7 +26,7 @@ public static void main(String[] args) {
     Args.setParam(args, Constant.TESTNET_CONF);
     CommonParameter parameter = Args.getInstance();
 
-    load(parameter.getLogbackPath());
+    LogService.load(parameter.getLogbackPath());
 
     if (parameter.isHelp()) {
       JCommander jCommander = JCommander.newBuilder().addObject(Args.PARAMETER).build();
diff --git a/framework/src/test/java/org/tron/core/db/TransactionExpireTest.java b/framework/src/test/java/org/tron/core/db/TransactionExpireTest.java
@@ -46,6 +46,7 @@ public void init() throws IOException {
     Args.setParam(new String[] {"--output-directory",
         temporaryFolder.newFolder().toString()}, Constant.TEST_CONF);
     CommonParameter.PARAMETER.setMinEffectiveConnection(0);
+    CommonParameter.getInstance().setP2pDisable(true);
 
     context = new TronApplicationContext(DefaultConfig.class);
     wallet = context.getBean(Wallet.class);
diff --git a/framework/src/test/java/org/tron/core/exception/TronErrorTest.java b/framework/src/test/java/org/tron/core/exception/TronErrorTest.java
@@ -1,10 +1,36 @@
 package org.tron.core.exception;
 
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertThrows;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.mockStatic;
+
+import java.io.IOException;
+import java.nio.file.Path;
+import org.junit.After;
 import org.junit.Assert;
+import org.junit.Rule;
 import org.junit.Test;
+import org.junit.rules.TemporaryFolder;
+import org.junit.runner.RunWith;
+import org.mockito.MockedStatic;
+import org.mockito.Mockito;
+import org.mockito.junit.MockitoJUnitRunner;
+import org.tron.common.log.LogService;
+import org.tron.common.zksnark.JLibrustzcash;
+import org.tron.core.zen.ZksnarkInitService;
 
+@RunWith(MockitoJUnitRunner.class)
 public class TronErrorTest {
 
+  @Rule
+  public TemporaryFolder temporaryFolder = new TemporaryFolder();
+
+  @After
+  public void  clearMocks() {
+    Mockito.clearAllCaches();
+  }
+
   @Test
   public void testTronError() {
     TronError tronError = new TronError("message", TronError.ErrCode.WITNESS_KEYSTORE_LOAD);
@@ -16,4 +42,26 @@ public void testTronError() {
     tronError = new TronError(new Throwable(), TronError.ErrCode.LEVELDB_INIT);
     Assert.assertEquals(tronError.getErrCode(), TronError.ErrCode.LEVELDB_INIT);
   }
+
+  @Test
+  public void ZksnarkInitTest() {
+    try (MockedStatic<JLibrustzcash> mock = mockStatic(JLibrustzcash.class)) {
+      mock.when(JLibrustzcash::isOpenZen).thenReturn(true);
+      mock.when(() -> JLibrustzcash.librustzcashInitZksnarkParams(any()))
+          .thenAnswer(invocation -> {
+            throw new ZksnarkException("Zksnark init failed");
+          });
+      TronError thrown = assertThrows(TronError.class,
+          ZksnarkInitService::librustzcashInitZksnarkParams);
+      assertEquals(TronError.ErrCode.ZCASH_INIT, thrown.getErrCode());
+    }
+  }
+
+  @Test
+  public void LogLoadTest() throws IOException {
+    LogService.load("non-existent.xml");
+    Path path = temporaryFolder.newFile("logback.xml").toPath();
+    TronError thrown = assertThrows(TronError.class, () -> LogService.load(path.toString()));
+    assertEquals(TronError.ErrCode.LOG_LOAD, thrown.getErrCode());
+  }
 }
diff --git a/framework/src/test/java/org/tron/core/services/RpcApiServicesTest.java b/framework/src/test/java/org/tron/core/services/RpcApiServicesTest.java
@@ -143,6 +143,7 @@ public static void init() throws IOException {
     getInstance().setRpcOnPBFTPort(PublicMethod.chooseRandomPort());
     getInstance().setMetricsPrometheusPort(PublicMethod.chooseRandomPort());
     getInstance().setMetricsPrometheusEnable(true);
+    getInstance().setP2pDisable(true);
     String fullNode = String.format("%s:%d", getInstance().getNodeLanIp(),
         getInstance().getRpcPort());
     String solidityNode = String.format("%s:%d", getInstance().getNodeLanIp(),
diff --git a/framework/src/test/java/org/tron/core/services/filter/HttpApiAccessFilterTest.java b/framework/src/test/java/org/tron/core/services/filter/HttpApiAccessFilterTest.java
@@ -45,6 +45,7 @@ public class HttpApiAccessFilterTest extends BaseTest {
     Args.getInstance().setPBFTHttpPort(PublicMethod.chooseRandomPort());
     Args.getInstance().setSolidityNodeHttpEnable(true);
     Args.getInstance().setSolidityHttpPort(PublicMethod.chooseRandomPort());
+    Args.getInstance().setP2pDisable(true);
   }
 
   @Test
diff --git a/framework/src/test/java/org/tron/core/services/filter/LiteFnQueryGrpcInterceptorTest.java b/framework/src/test/java/org/tron/core/services/filter/LiteFnQueryGrpcInterceptorTest.java
@@ -61,6 +61,7 @@ public static void init() throws IOException {
     Args.getInstance().setRpcOnSolidityPort(PublicMethod.chooseRandomPort());
     Args.getInstance().setRpcPBFTEnable(true);
     Args.getInstance().setRpcOnPBFTPort(PublicMethod.chooseRandomPort());
+    Args.getInstance().setP2pDisable(true);
     String fullnode = String.format("%s:%d", Args.getInstance().getNodeLanIp(),
             Args.getInstance().getRpcPort());
     String solidityNode = String.format("%s:%d", Args.getInstance().getNodeLanIp(),
diff --git a/framework/src/test/java/org/tron/core/services/filter/LiteFnQueryHttpFilterTest.java b/framework/src/test/java/org/tron/core/services/filter/LiteFnQueryHttpFilterTest.java
@@ -44,6 +44,7 @@ public class LiteFnQueryHttpFilterTest extends BaseTest {
     Args.getInstance().setJsonRpcHttpFullNodeEnable(false);
     Args.getInstance().setJsonRpcHttpSolidityNodeEnable(false);
     Args.getInstance().setJsonRpcHttpPBFTNodeEnable(false);
+    Args.getInstance().setP2pDisable(true);
   }
 
   /**
diff --git a/framework/src/test/java/org/tron/core/services/filter/RpcApiAccessInterceptorTest.java b/framework/src/test/java/org/tron/core/services/filter/RpcApiAccessInterceptorTest.java
@@ -62,6 +62,7 @@ public static void init() throws IOException {
     Args.getInstance().setRpcOnSolidityPort(PublicMethod.chooseRandomPort());
     Args.getInstance().setRpcPBFTEnable(true);
     Args.getInstance().setRpcOnPBFTPort(PublicMethod.chooseRandomPort());
+    Args.getInstance().setP2pDisable(true);
     String fullNode = String.format("%s:%d", Args.getInstance().getNodeLanIp(),
         Args.getInstance().getRpcPort());
     String solidityNode = String.format("%s:%d", Args.getInstance().getNodeLanIp(),
diff --git a/framework/src/test/java/org/tron/core/services/http/TriggerSmartContractServletTest.java b/framework/src/test/java/org/tron/core/services/http/TriggerSmartContractServletTest.java
@@ -35,6 +35,7 @@ public static void init() throws Exception {
     Args.getInstance().needSyncCheck = false;
     Args.getInstance().setFullNodeHttpEnable(true);
     Args.getInstance().setFullNodeHttpPort(PublicMethod.chooseRandomPort());
+    Args.getInstance().setP2pDisable(true);
     httpNode = String.format("%s:%d", "127.0.0.1",
         Args.getInstance().getFullNodeHttpPort());
   }

Original file line number	Diff line number	Diff line change
`@@ -137,6 +137,7 @@`
`137`	`137`	`import org.tron.core.metrics.MetricsUtil;`
`138`	`138`	`import org.tron.core.service.MortgageService;`
`139`	`139`	`import org.tron.core.service.RewardViCalService;`
	`140`	`+import org.tron.core.services.event.exception.EventException;`
`140`	`141`	`import org.tron.core.store.AccountAssetStore;`
`141`	`142`	`import org.tron.core.store.AccountIdIndexStore;`
`142`	`143`	`import org.tron.core.store.AccountIndexStore;`
`@@ -2098,7 +2099,7 @@ private void startEventSubscribing() {`
`2098`	`2099`	`.start(Args.getInstance().getEventPluginConfig());`
`2099`	`2100`
`2100`	`2101`	`if (!eventPluginLoaded) {`
`2101`		`- logger.error("Failed to load eventPlugin.");`
	`2102`	`+ throw new EventException("Failed to load eventPlugin.");`
`2102`	`2103`	`}`
`2103`	`2104`
`2104`	`2105`	`FilterQuery eventFilter = Args.getInstance().getEventFilter();`
`@@ -2107,7 +2108,7 @@ private void startEventSubscribing() {`
`2107`	`2108`	`}`
`2108`	`2109`
`2109`	`2110`	`} catch (Exception e) {`
`2110`		`- logger.error("{}", e);`
	`2111`	`+ throw new TronError(e, TronError.ErrCode.EVENT_SUBSCRIBE_INIT);`
`2111`	`2112`	`}`
`2112`	`2113`	`}`
`2113`	`2114`