Fix UnrecognizedPropertyException: Unrecognized field "timeOut (#4213)

* fix UnrecognizedPropertyException: Unrecognized field "timeOut
apache · Feb 14, 2023 · 0f7899b · 0f7899b
1 parent 89d0ed5
commit 0f7899b
Show file tree

Hide file tree

Showing 2 changed files with 75 additions and 0 deletions.
diff --git a/...n/src/main/java/org/apache/linkis/manager/common/protocol/engine/EngineCreateRequest.java b/...n/src/main/java/org/apache/linkis/manager/common/protocol/engine/EngineCreateRequest.java
@@ -21,12 +21,21 @@
 
 import java.util.Map;
 
+import com.fasterxml.jackson.annotation.JsonAlias;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 public class EngineCreateRequest implements EngineRequest, RequestMethod {
 
   private Map<String, String> properties;
 
   private Map<String, Object> labels;
 
+  /*
+  `timeOut` compatible with older versions
+  It is recommended to use `timeout`
+   */
+  @JsonProperty("timeOut")
+  @JsonAlias("timeout")
   private long timeout;
 
   private String user;

diff --git a/...c/test/java/org/apache/linkis/manager/common/protocol/engine/EngineCreateRequestTest.java b/...c/test/java/org/apache/linkis/manager/common/protocol/engine/EngineCreateRequestTest.java
@@ -0,0 +1,66 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.linkis.manager.common.protocol.engine;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+class EngineCreateRequestTest {
+
+  private final ObjectMapper objectMapper = new ObjectMapper();
+
+  @Test
+  void testTimeout() {
+    ObjectNode jNode = objectMapper.createObjectNode();
+    // "timeout", "properties", "createService", "user", "description", "labels", "ignoreTimeout"
+    jNode.put("timeout", 1000);
+    jNode.put("user", "hadoop");
+    jNode.put("description", "test for node");
+    jNode.put("ignoreTimeout", false);
+
+    try {
+      EngineCreateRequest engineCreateRequest =
+          objectMapper.treeToValue(jNode, EngineCreateRequest.class);
+      assertEquals(engineCreateRequest.getTimeout(), jNode.get("timeout").asLong());
+    } catch (JsonProcessingException e) {
+      fail("Should not have thrown any exception", e);
+    }
+  }
+
+  @Test
+  void testTimeOut() {
+    ObjectNode jNode = objectMapper.createObjectNode();
+    // "timeout", "properties", "createService", "user", "description", "labels", "ignoreTimeout"
+    jNode.put("timeOut", 1000);
+    jNode.put("user", "hadoop");
+    jNode.put("description", "test for node");
+    jNode.put("ignoreTimeout", false);
+
+    try {
+      EngineCreateRequest engineCreateRequest =
+          objectMapper.treeToValue(jNode, EngineCreateRequest.class);
+      assertEquals(engineCreateRequest.getTimeout(), jNode.get("timeOut").asLong());
+    } catch (JsonProcessingException e) {
+      fail("Should not have thrown any exception", e);
+    }
+  }
+}