feat(api): optimize api compatibility

lxcmyf · lxcmyf · commit d0aa39c4e890 · 2023-08-17T23:40:04.000+08:00
diff --git a/chainbase/src/main/java/org/tron/core/capsule/TransactionCapsule.java b/chainbase/src/main/java/org/tron/core/capsule/TransactionCapsule.java
@@ -346,6 +346,10 @@ public static byte[] getOwner(Transaction.Contract contract) {
         }
       }
       return owner.toByteArray();
+    } catch (InvalidProtocolBufferException invalidProtocolBufferException) {
+      logger.warn("InvalidProtocolBufferException occurred because {}, please verify the interface "
+          + "input parameters", invalidProtocolBufferException.getMessage());
+      return new byte[0];
     } catch (Exception ex) {
       logger.error(ex.getMessage());
       return new byte[0];
diff --git a/framework/build.gradle b/framework/build.gradle
@@ -85,6 +85,7 @@ dependencies {
     compile group: 'org.pf4j', name: 'pf4j', version: '2.5.0'
 
     testImplementation group: 'org.springframework', name: 'spring-test', version: '5.2.0.RELEASE'
+    testImplementation group: 'org.springframework', name: 'spring-web', version: '5.2.0.RELEASE'
 
     compile group: 'org.zeromq', name: 'jeromq', version: '0.5.3'
     compile project(":chainbase")
diff --git a/framework/src/main/java/org/tron/core/services/http/GetAssetIssueListServlet.java b/framework/src/main/java/org/tron/core/services/http/GetAssetIssueListServlet.java
@@ -1,5 +1,6 @@
 package org.tron.core.services.http;
 
+import java.io.IOException;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import lombok.extern.slf4j.Slf4j;
@@ -8,29 +9,43 @@
 import org.tron.api.GrpcAPI.AssetIssueList;
 import org.tron.core.Wallet;
 
-
 @Component
 @Slf4j(topic = "API")
 public class GetAssetIssueListServlet extends RateLimiterServlet {
 
   @Autowired
   private Wallet wallet;
 
+  @Override
   protected void doGet(HttpServletRequest request, HttpServletResponse response) {
     try {
       boolean visible = Util.getVisible(request);
-      AssetIssueList reply = wallet.getAssetIssueList();
-      if (reply != null) {
-        response.getWriter().println(JsonFormat.printToString(reply, visible));
-      } else {
-        response.getWriter().println("{}");
-      }
+      response(response, visible);
     } catch (Exception e) {
       Util.processError(e, response);
     }
   }
 
+  @Override
   protected void doPost(HttpServletRequest request, HttpServletResponse response) {
-    doGet(request, response);
+    try {
+      PostParams params = PostParams.getPostParams(request);
+      boolean visible = Util.getVisible(request);
+      if (!visible) {
+        visible = params.isVisible();
+      }
+      response(response, visible);
+    } catch (Exception e) {
+      Util.processError(e, response);
+    }
+  }
+
+  private void response(HttpServletResponse response, boolean visible) throws IOException {
+    AssetIssueList reply = wallet.getAssetIssueList();
+    if (reply != null) {
+      response.getWriter().println(JsonFormat.printToString(reply, visible));
+    } else {
+      response.getWriter().println("{}");
+    }
   }
 }
diff --git a/framework/src/main/java/org/tron/core/services/http/GetAvailableUnfreezeCountServlet.java b/framework/src/main/java/org/tron/core/services/http/GetAvailableUnfreezeCountServlet.java
@@ -23,6 +23,9 @@ protected void doGet(HttpServletRequest request, HttpServletResponse response) {
     try {
       boolean visible = Util.getVisible(request);
       String ownerAddress = request.getParameter("ownerAddress");
+      if (ownerAddress == null) {
+        ownerAddress = request.getParameter("owner_address");
+      }
       if (visible) {
         ownerAddress = Util.getHexAddress(ownerAddress);
       }
diff --git a/framework/src/main/java/org/tron/core/services/http/GetBlockByNumServlet.java b/framework/src/main/java/org/tron/core/services/http/GetBlockByNumServlet.java
@@ -18,14 +18,21 @@ public class GetBlockByNumServlet extends RateLimiterServlet {
   @Autowired
   private Wallet wallet;
 
+  @Override
   protected void doGet(HttpServletRequest request, HttpServletResponse response) {
     try {
-      fillResponse(Util.getVisible(request), Long.parseLong(request.getParameter("num")), response);
+      long num = 0;
+      String numStr = request.getParameter("num");
+      if (numStr != null) {
+        num = Long.parseLong(numStr);
+      }
+      fillResponse(Util.getVisible(request), num, response);
     } catch (Exception e) {
       Util.processError(e, response);
     }
   }
 
+  @Override
   protected void doPost(HttpServletRequest request, HttpServletResponse response) {
     try {
       PostParams params = PostParams.getPostParams(request);
diff --git a/framework/src/main/java/org/tron/core/services/http/GetCanDelegatedMaxSizeServlet.java b/framework/src/main/java/org/tron/core/services/http/GetCanDelegatedMaxSizeServlet.java
@@ -18,10 +18,15 @@ public class GetCanDelegatedMaxSizeServlet extends RateLimiterServlet {
   @Autowired
   private Wallet wallet;
 
+  @Override
   protected void doGet(HttpServletRequest request, HttpServletResponse response) {
     try {
       boolean visible = Util.getVisible(request);
-      int type = Integer.parseInt(request.getParameter("type"));
+      int type = 0;
+      String typeStr = request.getParameter("type");
+      if (typeStr != null) {
+        type = Integer.parseInt(typeStr);
+      }
       String ownerAddress = request.getParameter("owner_address");
       if (visible) {
         ownerAddress = Util.getHexAddress(ownerAddress);
@@ -34,6 +39,7 @@ protected void doGet(HttpServletRequest request, HttpServletResponse response) {
     }
   }
 
+  @Override
   protected void doPost(HttpServletRequest request, HttpServletResponse response) {
     try {
       PostParams params = PostParams.getPostParams(request);
diff --git a/framework/src/main/java/org/tron/core/services/http/GetCanWithdrawUnfreezeAmountServlet.java b/framework/src/main/java/org/tron/core/services/http/GetCanWithdrawUnfreezeAmountServlet.java
@@ -18,23 +18,29 @@ public class GetCanWithdrawUnfreezeAmountServlet extends RateLimiterServlet {
   @Autowired
   private Wallet wallet;
 
+  @Override
   protected void doGet(HttpServletRequest request, HttpServletResponse response) {
     try {
       boolean visible = Util.getVisible(request);
       String ownerAddress = request.getParameter("owner_address");
-      long timestamp = Long.valueOf(request.getParameter("timestamp"));
+      long timestamp = 0;
+      String timestampStr = request.getParameter("timestamp");
+      if (timestampStr != null) {
+        timestamp = Long.parseLong(timestampStr);
+      }
       if (visible) {
         ownerAddress = Util.getHexAddress(ownerAddress);
       }
       fillResponse(visible,
-              ByteString.copyFrom(ByteArray.fromHexString(ownerAddress)),
-              timestamp,
-              response);
+          ByteString.copyFrom(ByteArray.fromHexString(ownerAddress)),
+          timestamp,
+          response);
     } catch (Exception e) {
       Util.processError(e, response);
     }
   }
 
+  @Override
   protected void doPost(HttpServletRequest request, HttpServletResponse response) {
     try {
       PostParams params = PostParams.getPostParams(request);
diff --git a/framework/src/main/java/org/tron/core/services/http/GetNowBlockServlet.java b/framework/src/main/java/org/tron/core/services/http/GetNowBlockServlet.java
@@ -1,5 +1,6 @@
 package org.tron.core.services.http;
 
+import java.io.IOException;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import lombok.extern.slf4j.Slf4j;
@@ -8,29 +9,43 @@
 import org.tron.core.Wallet;
 import org.tron.protos.Protocol.Block;
 
-
 @Component
 @Slf4j(topic = "API")
 public class GetNowBlockServlet extends RateLimiterServlet {
 
   @Autowired
   private Wallet wallet;
 
+  @Override
   protected void doGet(HttpServletRequest request, HttpServletResponse response) {
     try {
       boolean visible = Util.getVisible(request);
-      Block reply = wallet.getNowBlock();
-      if (reply != null) {
-        response.getWriter().println(Util.printBlock(reply, visible));
-      } else {
-        response.getWriter().println("{}");
-      }
+      response(response, visible);
     } catch (Exception e) {
       Util.processError(e, response);
     }
   }
 
+  @Override
   protected void doPost(HttpServletRequest request, HttpServletResponse response) {
-    doGet(request, response);
+    try {
+      PostParams params = PostParams.getPostParams(request);
+      boolean visible = Util.getVisible(request);
+      if (!visible) {
+        visible = params.isVisible();
+      }
+      response(response, visible);
+    } catch (Exception e) {
+      Util.processError(e, response);
+    }
+  }
+
+  private void response(HttpServletResponse response, boolean visible) throws IOException {
+    Block reply = wallet.getNowBlock();
+    if (reply != null) {
+      response.getWriter().println(Util.printBlock(reply, visible));
+    } else {
+      response.getWriter().println("{}");
+    }
   }
 }
diff --git a/framework/src/main/java/org/tron/core/services/http/ListNodesServlet.java b/framework/src/main/java/org/tron/core/services/http/ListNodesServlet.java
@@ -1,5 +1,6 @@
 package org.tron.core.services.http;
 
+import java.io.IOException;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import lombok.extern.slf4j.Slf4j;
@@ -8,29 +9,43 @@
 import org.tron.api.GrpcAPI.NodeList;
 import org.tron.core.Wallet;
 
-
 @Component
 @Slf4j(topic = "API")
 public class ListNodesServlet extends RateLimiterServlet {
 
   @Autowired
   private Wallet wallet;
 
+  @Override
   protected void doGet(HttpServletRequest request, HttpServletResponse response) {
     try {
       boolean visible = Util.getVisible(request);
-      NodeList reply = wallet.listNodes();
-      if (reply != null) {
-        response.getWriter().println(JsonFormat.printToString(reply, visible));
-      } else {
-        response.getWriter().println("{}");
-      }
+      response(response, visible);
     } catch (Exception e) {
       Util.processError(e, response);
     }
   }
 
+  @Override
   protected void doPost(HttpServletRequest request, HttpServletResponse response) {
-    doGet(request, response);
+    try {
+      PostParams params = PostParams.getPostParams(request);
+      boolean visible = Util.getVisible(request);
+      if (!visible) {
+        visible = params.isVisible();
+      }
+      response(response, visible);
+    } catch (Exception e) {
+      Util.processError(e, response);
+    }
+  }
+
+  private void response(HttpServletResponse response, boolean visible) throws IOException {
+    NodeList reply = wallet.listNodes();
+    if (reply != null) {
+      response.getWriter().println(JsonFormat.printToString(reply, visible));
+    } else {
+      response.getWriter().println("{}");
+    }
   }
 }
diff --git a/framework/src/main/java/org/tron/core/services/http/ListProposalsServlet.java b/framework/src/main/java/org/tron/core/services/http/ListProposalsServlet.java
@@ -1,5 +1,6 @@
 package org.tron.core.services.http;
 
+import java.io.IOException;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import lombok.extern.slf4j.Slf4j;
@@ -8,29 +9,43 @@
 import org.tron.api.GrpcAPI.ProposalList;
 import org.tron.core.Wallet;
 
-
 @Component
 @Slf4j(topic = "API")
 public class ListProposalsServlet extends RateLimiterServlet {
 
   @Autowired
   private Wallet wallet;
 
+  @Override
   protected void doGet(HttpServletRequest request, HttpServletResponse response) {
     try {
       boolean visible = Util.getVisible(request);
-      ProposalList reply = wallet.getProposalList();
-      if (reply != null) {
-        response.getWriter().println(JsonFormat.printToString(reply, visible));
-      } else {
-        response.getWriter().println("{}");
-      }
+      response(response, visible);
     } catch (Exception e) {
       Util.processError(e, response);
     }
   }
 
+  @Override
   protected void doPost(HttpServletRequest request, HttpServletResponse response) {
-    doGet(request, response);
+    try {
+      PostParams params = PostParams.getPostParams(request);
+      boolean visible = Util.getVisible(request);
+      if (!visible) {
+        visible = params.isVisible();
+      }
+      response(response, visible);
+    } catch (Exception e) {
+      Util.processError(e, response);
+    }
+  }
+
+  private void response(HttpServletResponse response, boolean visible) throws IOException {
+    ProposalList reply = wallet.getProposalList();
+    if (reply != null) {
+      response.getWriter().println(JsonFormat.printToString(reply, visible));
+    } else {
+      response.getWriter().println("{}");
+    }
   }
 }
diff --git a/framework/src/main/java/org/tron/core/services/http/PostParams.java b/framework/src/main/java/org/tron/core/services/http/PostParams.java
@@ -1,5 +1,8 @@
 package org.tron.core.services.http;
 
+import static org.apache.http.entity.ContentType.APPLICATION_FORM_URLENCODED;
+import static org.tron.core.services.http.Util.getJsonString;
+
 import java.util.stream.Collectors;
 import javax.servlet.http.HttpServletRequest;
 import lombok.Getter;
@@ -21,6 +24,9 @@ public PostParams(String params, boolean visible) {
   public static PostParams getPostParams(HttpServletRequest request) throws Exception {
     String input = request.getReader().lines().collect(Collectors.joining(System.lineSeparator()));
     Util.checkBodySize(input);
+    if (APPLICATION_FORM_URLENCODED.getMimeType().equals(request.getContentType())) {
+      input = getJsonString(input);
+    }
     boolean visible = Util.getVisiblePost(input);
     return new PostParams(input, visible);
   }
diff --git a/framework/src/main/java/org/tron/core/services/http/Util.java b/framework/src/main/java/org/tron/core/services/http/Util.java
diff --git a/framework/src/test/java/org/tron/core/services/http/GetAssetIssueListServletTest.java b/framework/src/test/java/org/tron/core/services/http/GetAssetIssueListServletTest.java
diff --git a/framework/src/test/java/org/tron/core/services/http/GetNowBlockServletTest.java b/framework/src/test/java/org/tron/core/services/http/GetNowBlockServletTest.java
diff --git a/framework/src/test/java/org/tron/core/services/http/ListNodesServletTest.java b/framework/src/test/java/org/tron/core/services/http/ListNodesServletTest.java
diff --git a/framework/src/test/java/org/tron/core/services/http/ListProposalsServletTest.java b/framework/src/test/java/org/tron/core/services/http/ListProposalsServletTest.java

Original file line number	Diff line number	Diff line change
`@@ -346,6 +346,10 @@ public static byte[] getOwner(Transaction.Contract contract) {`
`346`	`346`	`}`
`347`	`347`	`}`
`348`	`348`	`return owner.toByteArray();`
	`349`	`+ } catch (InvalidProtocolBufferException invalidProtocolBufferException) {`
	`350`	`+ logger.warn("InvalidProtocolBufferException occurred because {}, please verify the interface "`
	`351`	`+ + "input parameters", invalidProtocolBufferException.getMessage());`
	`352`	`+ return new byte[0];`
`349`	`353`	`} catch (Exception ex) {`
`350`	`354`	`logger.error(ex.getMessage());`
`351`	`355`	`return new byte[0];`