refact(client): update tests for new OLTP traverser APIs

.github/workflows/client-ci.yml

@@ -24,8 +24,7 @@ jobs:
     env:
       USE_STAGE: 'true' # Whether to include the stage repository.
       TRAVIS_DIR: hugegraph-client/assembly/travis
-      # TODO: replace it with the (latest - n) commit id (n >= 15)
-      COMMIT_ID: be6ee386b9939dc6bd6fcbdf2274b8acc3a0a314
+      COMMIT_ID: bfe9fae150446857412db23ada0dae9d05035837
     strategy:
       fail-fast: false
       matrix:

.github/workflows/client-go-ci.yml

@@ -21,8 +21,9 @@ jobs:
   client-go-ci:
     runs-on: ubuntu-latest
     env:
+      USE_STAGE: 'true' # Whether to include the stage repository.
       TRAVIS_DIR: hugegraph-client/assembly/travis
-      COMMIT_ID: be6ee386b9939dc6bd6fcbdf2274b8acc3a0a314
+      COMMIT_ID: bfe9fae150446857412db23ada0dae9d05035837
     strategy:
       fail-fast: false
       matrix:
@@ -46,6 +47,12 @@ jobs:
         with:
           fetch-depth: 2
 
+      - name: Use staged maven repo
+        if: ${{ env.USE_STAGE == 'true' }}
+        run: |
+          cp $HOME/.m2/settings.xml /tmp/settings.xml
+          mv -vf .github/configs/settings.xml $HOME/.m2/settings.xml
+
       - name: Prepare env and service
         run: |
           $TRAVIS_DIR/install-hugegraph-from-source.sh $COMMIT_ID

.github/workflows/hubble-ci.yml

@@ -23,8 +23,8 @@ on:
 
 env:
   TRAVIS_DIR: hugegraph-hubble/hubble-dist/assembly/travis
-  # TODO: replace it with the (latest - n) commit id (n >= 15)
-  COMMIT_ID: be6ee386b9939dc6bd6fcbdf2274b8acc3a0a314
+  # TODO: need update it later (eed6103359fe40d2f1476fb8c56d9388c3111a99)
+  COMMIT_ID: bfe9fae150446857412db23ada0dae9d05035837
 
 jobs:
   hubble-ci:

.github/workflows/loader-ci.yml

@@ -26,8 +26,7 @@ jobs:
       USE_STAGE: 'true' # Whether to include the stage repository.
       TRAVIS_DIR: hugegraph-loader/assembly/travis
       STATIC_DIR: hugegraph-loader/assembly/static
-      # TODO: replace it with the (latest - n) commit id (n >= 15)
-      COMMIT_ID: be6ee386b9939dc6bd6fcbdf2274b8acc3a0a314
+      COMMIT_ID: bfe9fae150446857412db23ada0dae9d05035837
       DB_USER: root
       DB_PASS: root
       DB_DATABASE: load_test

.github/workflows/tools-ci.yml

@@ -25,7 +25,7 @@ jobs:
       USE_STAGE: 'true' # Whether to include the stage repository.
       TRAVIS_DIR: hugegraph-tools/assembly/travis
       # TODO: could we use one param to unify it? or use a action template (could use one ci file)
-      COMMIT_ID: be6ee386b9939dc6bd6fcbdf2274b8acc3a0a314
+      COMMIT_ID: bfe9fae150446857412db23ada0dae9d05035837
     steps:
       - name: Install JDK 11
         uses: actions/setup-java@v3

hugegraph-client/assembly/travis/install-hugegraph-from-source.sh

@@ -32,9 +32,10 @@ git checkout "${COMMIT_ID}"
 mvn package -DskipTests -Dmaven.javadoc.skip=true -ntp
 
 # TODO: lack incubator after apache package release (update it later)
+cd hugegraph-server
 TAR=$(echo apache-hugegraph-*.tar.gz)
-tar zxf "${TAR}" -C ../
-cd ../
+tar zxf "${TAR}" -C ../../
+cd ../../
 rm -rf "${GIT_DIR}"
 # TODO: lack incubator after apache package release (update it later)
 HTTP_SERVER_DIR=$(echo apache-hugegraph-*.*)

hugegraph-client/src/main/java/org/apache/hugegraph/api/metrics/MetricsAPI.java

@@ -17,6 +17,7 @@
 
 package org.apache.hugegraph.api.metrics;
 
+import java.util.HashMap;
 import java.util.Map;
 
 import org.apache.hugegraph.util.CommonUtil;
@@ -27,6 +28,8 @@
 
 public class MetricsAPI extends API {
 
+    public static final String STATISTICS_PATH = "/statistics";
+
     public MetricsAPI(RestClient client) {
         super(client);
         this.path(this.type());
@@ -65,12 +68,39 @@ public Map<String, Object> backend(String graph) {
 
     @SuppressWarnings("unchecked")
     public Map<String, Map<String, Object>> all() {
+        Map<String,Object> params = new HashMap<>();
+        params.put("type", "json");
+        RestResult result = this.client.get(this.path(), params);
+        Map<?, ?> map = result.readObject(Map.class);
+        CommonUtil.checkMapClass(map, String.class, Map.class);
+        for (Object mapValue : map.values()) {
+            CommonUtil.checkMapClass(mapValue, String.class, Object.class);
+        }
+        return (Map<String, Map<String, Object>>) map;
+    }
+
+    @SuppressWarnings("unchecked")
+    public String allWithPromFormat() {
         RestResult result = this.client.get(this.path());
+        return result.content();
+    }
+
+    public Map<String, Map<String, Object>> statistics() {
+        Map<String,Object> params = new HashMap<>();
+        params.put("type", "json");
+        RestResult result = this.client.get(this.path() + STATISTICS_PATH, params);
         Map<?, ?> map = result.readObject(Map.class);
         CommonUtil.checkMapClass(map, String.class, Map.class);
         for (Object mapValue : map.values()) {
             CommonUtil.checkMapClass(mapValue, String.class, Object.class);
         }
+
         return (Map<String, Map<String, Object>>) map;
     }
+
+    @SuppressWarnings("unchecked")
+    public String statisticsWithPromFormat() {
+        RestResult result = this.client.get(this.path() + STATISTICS_PATH);
+        return result.content();
+    }
 }

hugegraph-client/src/main/java/org/apache/hugegraph/api/traverser/JaccardSimilarityAPI.java

@@ -26,6 +26,7 @@
 import org.apache.hugegraph.rest.RestResult;
 
 import org.apache.hugegraph.structure.constant.Direction;
+import org.apache.hugegraph.structure.traverser.JaccardSimilarity;
 import org.apache.hugegraph.structure.traverser.SingleSourceJaccardSimilarityRequest;
 
 import org.apache.hugegraph.util.E;
@@ -64,9 +65,9 @@ public double get(Object vertexId, Object otherId, Direction direction,
     }
 
     @SuppressWarnings("unchecked")
-    public Map<Object, Double> post(SingleSourceJaccardSimilarityRequest request) {
+    public JaccardSimilarity post(SingleSourceJaccardSimilarityRequest request) {
         this.client.checkApiVersion("0.58", "jaccard similar");
         RestResult result = this.client.post(this.path(), request);
-        return result.readObject(Map.class);
+        return result.readObject(JaccardSimilarity.class);
     }
 }

hugegraph-client/src/main/java/org/apache/hugegraph/api/traverser/SingleSourceShortestPathAPI.java

@@ -40,7 +40,7 @@ protected String type() {
 
     public WeightedPaths get(Object sourceId, Direction direction, String label,
                              String weight, long degree, long skipDegree,
-                             long capacity, int limit, boolean withVertex) {
+                             long capacity, int limit, boolean withVertex, boolean withEdge) {
         this.client.checkApiVersion("0.51", "single source shortest path");
         String source = GraphAPI.formatVertexId(sourceId, false);
 
@@ -60,6 +60,7 @@ public WeightedPaths get(Object sourceId, Direction direction, String label,
         params.put("capacity", capacity);
         params.put("limit", limit);
         params.put("with_vertex", withVertex);
+        params.put("with_edge", withEdge);
         RestResult result = this.client.get(this.path(), params);
         return result.readObject(WeightedPaths.class);
     }

hugegraph-client/src/main/java/org/apache/hugegraph/api/traverser/WeightedShortestPathAPI.java

@@ -41,7 +41,7 @@ protected String type() {
     public WeightedPath get(Object sourceId, Object targetId,
                             Direction direction, String label,
                             String weight, long degree, long skipDegree,
-                            long capacity, boolean withVertex) {
+                            long capacity, boolean withVertex, boolean withEdge) {
         this.client.checkApiVersion("0.51", "weighted shortest path");
         String source = GraphAPI.formatVertexId(sourceId, false);
         String target = GraphAPI.formatVertexId(targetId, false);
@@ -61,6 +61,7 @@ public WeightedPath get(Object sourceId, Object targetId,
         params.put("skip_degree", skipDegree);
         params.put("capacity", capacity);
         params.put("with_vertex", withVertex);
+        params.put("with_edge", withEdge);
         RestResult result = this.client.get(this.path(), params);
         return result.readObject(WeightedPath.class);
     }

hugegraph-client/src/main/java/org/apache/hugegraph/driver/MetricsManager.java

@@ -48,4 +48,16 @@ public Map<String, Map<String, Object>> system() {
     public Map<String, Map<String, Object>> all() {
         return this.metricsAPI.all();
     }
+
+    public String allWithPromFormat() {
+        return this.metricsAPI.allWithPromFormat();
+    }
+
+    public Map<String, Map<String, Object>> statistics() {
+        return this.metricsAPI.statistics();
+    }
+
+    public String statisticsWithPromFormat() {
+        return this.metricsAPI.statisticsWithPromFormat();
+    }
 }

hugegraph-client/src/main/java/org/apache/hugegraph/driver/TraverserManager.java

@@ -19,10 +19,7 @@
 
 import java.util.Iterator;
 import java.util.List;
-import java.util.Map;
 
-import org.apache.hugegraph.structure.constant.Direction;
-import org.apache.hugegraph.structure.constant.Traverser;
 import org.apache.hugegraph.api.traverser.AllShortestPathsAPI;
 import org.apache.hugegraph.api.traverser.CountAPI;
 import org.apache.hugegraph.api.traverser.CrosspointsAPI;
@@ -46,6 +43,8 @@
 import org.apache.hugegraph.api.traverser.VerticesAPI;
 import org.apache.hugegraph.api.traverser.WeightedShortestPathAPI;
 import org.apache.hugegraph.client.RestClient;
+import org.apache.hugegraph.structure.constant.Direction;
+import org.apache.hugegraph.structure.constant.Traverser;
 import org.apache.hugegraph.structure.graph.Edge;
 import org.apache.hugegraph.structure.graph.Edges;
 import org.apache.hugegraph.structure.graph.GraphIterator;
@@ -56,18 +55,19 @@
 import org.apache.hugegraph.structure.traverser.CountRequest;
 import org.apache.hugegraph.structure.traverser.CrosspointsRequest;
 import org.apache.hugegraph.structure.traverser.CustomizedCrosspoints;
-import org.apache.hugegraph.structure.traverser.MultiNodeShortestPathRequest;
-import org.apache.hugegraph.structure.traverser.PathsWithVertices;
+import org.apache.hugegraph.structure.traverser.CustomizedPathsRequest;
 import org.apache.hugegraph.structure.traverser.FusiformSimilarity;
 import org.apache.hugegraph.structure.traverser.FusiformSimilarityRequest;
-import org.apache.hugegraph.structure.traverser.SingleSourceJaccardSimilarityRequest;
+import org.apache.hugegraph.structure.traverser.JaccardSimilarity;
 import org.apache.hugegraph.structure.traverser.Kneighbor;
 import org.apache.hugegraph.structure.traverser.KneighborRequest;
 import org.apache.hugegraph.structure.traverser.Kout;
 import org.apache.hugegraph.structure.traverser.KoutRequest;
-import org.apache.hugegraph.structure.traverser.CustomizedPathsRequest;
+import org.apache.hugegraph.structure.traverser.MultiNodeShortestPathRequest;
 import org.apache.hugegraph.structure.traverser.PathsRequest;
+import org.apache.hugegraph.structure.traverser.PathsWithVertices;
 import org.apache.hugegraph.structure.traverser.Ranks;
+import org.apache.hugegraph.structure.traverser.SingleSourceJaccardSimilarityRequest;
 import org.apache.hugegraph.structure.traverser.TemplatePathsRequest;
 import org.apache.hugegraph.structure.traverser.WeightedPath;
 import org.apache.hugegraph.structure.traverser.WeightedPaths;
@@ -143,7 +143,7 @@ public double jaccardSimilarity(Object vertexId, Object otherId,
                                              label, degree);
     }
 
-    public Map<Object, Double> jaccardSimilarity(SingleSourceJaccardSimilarityRequest request) {
+    public JaccardSimilarity jaccardSimilarity(SingleSourceJaccardSimilarityRequest request) {
         return this.jaccardSimilarityAPI.post(request);
     }
 
@@ -241,55 +241,57 @@ public List<Path> allShortestPaths(Object sourceId, Object targetId,
 
     public WeightedPaths singleSourceShortestPath(Object sourceId,
                                                   String weight,
-                                                  boolean withVertex) {
+                                                  boolean withVertex,
+                                                  boolean withEdge) {
         return this.singleSourceShortestPath(sourceId, Direction.BOTH, null,
-                                             weight, withVertex);
+                                             weight, withVertex, withEdge);
     }
 
     public WeightedPaths singleSourceShortestPath(Object sourceId,
                                                   Direction direction,
                                                   String label, String weight,
-                                                  boolean withVertex) {
+                                                  boolean withVertex, boolean withEdge) {
         return this.singleSourceShortestPath(sourceId, direction, label, weight,
                                              Traverser.DEFAULT_MAX_DEGREE, 0L,
                                              Traverser.DEFAULT_CAPACITY,
-                                             Traverser.DEFAULT_PATHS_LIMIT, withVertex);
+                                             Traverser.DEFAULT_PATHS_LIMIT, withVertex, withEdge);
     }
 
     public WeightedPaths singleSourceShortestPath(Object sourceId,
                                                   Direction direction,
                                                   String label, String weight,
                                                   long degree, long skipDegree,
                                                   long capacity, int limit,
-                                                  boolean withVertex) {
+                                                  boolean withVertex, boolean withEdge) {
         return this.singleSourceShortestPathAPI.get(sourceId, direction, label,
                                                     weight, degree, skipDegree,
                                                     capacity, limit,
-                                                    withVertex);
+                                                    withVertex, withEdge);
     }
 
     public WeightedPath weightedShortestPath(Object sourceId, Object targetId,
-                                             String weight, boolean withVertex) {
+                                             String weight, boolean withVertex, boolean withEdge) {
         return this.weightedShortestPath(sourceId, targetId, Direction.BOTH,
-                                         null, weight, withVertex);
+                                         null, weight, withVertex, withEdge);
     }
 
     public WeightedPath weightedShortestPath(Object sourceId, Object targetId,
                                              Direction direction, String label,
                                              String weight,
-                                             boolean withVertex) {
+                                             boolean withVertex,
+                                             boolean withEdge) {
         return this.weightedShortestPath(sourceId, targetId, direction, label,
                                          weight, Traverser.DEFAULT_MAX_DEGREE, 0L,
-                                         Traverser.DEFAULT_CAPACITY, withVertex);
+                                         Traverser.DEFAULT_CAPACITY, withVertex, withEdge);
     }
 
     public WeightedPath weightedShortestPath(Object sourceId, Object targetId,
                                              Direction direction,
                                              String label, String weight,
                                              long degree, long skipDegree,
-                                             long capacity, boolean withVertex) {
+                                             long capacity, boolean withVertex, boolean withEdge) {
         return this.weightedShortestPathAPI.get(sourceId, targetId, direction, label, weight,
-                                                degree, skipDegree, capacity, withVertex);
+                                                degree, skipDegree, capacity, withVertex, withEdge);
     }
 
     public PathsWithVertices multiNodeShortestPath(MultiNodeShortestPathRequest request) {

hugegraph-client/src/main/java/org/apache/hugegraph/structure/constant/Traverser.java

@@ -33,4 +33,6 @@ public class Traverser {
     public static final double DEFAULT_ALPHA = 0.9;
     public static final int DEFAULT_MAX_TOP = 1000;
     public static final int DEFAULT_MAX_DEPTH = 5000;
+    public static final String TRAVERSE_MODE_BFS = "breadth_first_search";
+    public static final String TRAVERSE_MODE_DFS = "depth_first_search";
 }

hugegraph-client/src/main/java/org/apache/hugegraph/structure/traverser/ApiMeasure.java

@@ -0,0 +1,42 @@
+/*
+ * 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.hugegraph.structure.traverser;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class ApiMeasure {
+
+    @JsonProperty("edge_iterations")
+    private Long edgeIters;
+    @JsonProperty("vertice_iterations")
+    private Long verticeIters;
+    @JsonProperty("cost(ns)")
+    private Long totalTime;
+
+    public Long edgeIters() {
+        return this.edgeIters;
+    }
+
+    public Long verticeIters() {
+        return this.verticeIters;
+    }
+
+    public Long totalTime() {
+        return this.totalTime;
+    }
+}