fix: format and clean code in modules #2439

msgui · 2024-02-02T05:59:50Z

Purpose of the PR

subtask of [Summary] Enhance code style warnings in server #2435

Main Changes

Format & clean code in submodels:

API
Scylladb
Postgresql
Rocksdb
Palo
Mysql
Hbase
Cassandra
Test

Verifying these changes

Trivial rework / code cleanup without any test coverage. (No Need)
Already covered by existing tests, such as (please modify tests here).
Need tests and can be verified as follows:
- xxx

Does this PR potentially affect the following parts?

Documentation Status

Doc - TODO
Doc - Done
Doc - No Need

codecov · 2024-02-02T06:08:15Z

Codecov Report

Attention: 79 lines in your changes are missing coverage. Please review.

Comparison is base (7586779) 66.21% compared to head (e13dea5) 66.23%.

Files	Patch %	Lines
...n/java/org/apache/hugegraph/api/graph/EdgeAPI.java	58.62%	7 Missing and 5 partials ⚠️
...java/org/apache/hugegraph/api/graph/VertexAPI.java	9.09%	9 Missing and 1 partial ⚠️
.../org/apache/hugegraph/opencypher/CypherPlugin.java	0.00%	8 Missing ⚠️
...egraph/backend/store/cassandra/CassandraShard.java	37.50%	5 Missing ⚠️
...egraph/backend/store/cassandra/CassandraStore.java	50.00%	4 Missing and 1 partial ⚠️
.../java/org/apache/hugegraph/api/graph/BatchAPI.java	33.33%	4 Missing ⚠️
.../apache/hugegraph/api/filter/LoadDetectFilter.java	25.00%	3 Missing ⚠️
...ain/java/org/apache/hugegraph/api/job/TaskAPI.java	0.00%	3 Missing ⚠️
...egraph/backend/store/cassandra/CassandraTable.java	62.50%	1 Missing and 2 partials ⚠️
...raph/backend/store/rocksdb/RocksDBStdSessions.java	81.25%	3 Missing ⚠️
... and 16 more

Additional details and impacted files

@@             Coverage Diff              @@
##             master    #2439      +/-   ##
============================================
+ Coverage     66.21%   66.23%   +0.01%     
+ Complexity      828      827       -1     
============================================
  Files           511      511              
  Lines         42598    42594       -4     
  Branches       5942     5938       -4     
============================================
+ Hits          28208    28212       +4     
+ Misses        11582    11576       -6     
+ Partials       2808     2806       -2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

...aph-server/hugegraph-core/src/main/java/org/apache/hugegraph/backend/cache/CacheManager.java

imbajin

A lot of align could be merged into one line (manually), but it will cost some time

...h-cassandra/src/main/java/org/apache/hugegraph/backend/store/cassandra/CassandraMetrics.java

...aph-cassandra/src/main/java/org/apache/hugegraph/backend/store/cassandra/CassandraShard.java

...aph-cassandra/src/main/java/org/apache/hugegraph/backend/store/cassandra/CassandraStore.java

imbajin · 2024-02-07T10:01:59Z

...-postgresql/src/main/java/org/apache/hugegraph/backend/store/postgresql/PostgresqlTable.java

        protected String escapeAndWrapString(String value) {
            if (value.equals("\u0000")) {
-                return "\'\'";
+                return "''";


better add a test or test it in local env first? (at least maybe add a PR comment here)

imbajin · 2024-02-07T10:07:20Z

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/cypher/CypherClient.java

-        final StringBuilder builder = new StringBuilder("CypherClient{");
-        builder.append("userName='").append(userName).append('\'')
-               .append(", token='").append(token).append('\'').append('}');
+        String builder = "CypherClient{" + "userName='" + userName + '\'' +
+                         ", token='" + token + '\'' + '}';

-        return builder.toString();
+        return builder;


ignore the clean for StringBuilder (due to perf influence, check if we could config the rule to ignore it)

we could remove the unless SB transfer if we could ensure it's the call frequency is low

imbajin · 2024-02-07T10:08:39Z

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/auth/HugeGraphAuthProxy.java

        Context context = getContext();
        if (context == null) {
            return null;
        }
        return context.user().toJson();
    }

-    protected static void logUser(User user, String path) {
+    static void logUser(User user, String path) {


consider keeping them first (modification should be separated & careful)

imbajin · 2024-02-07T10:10:02Z

hugegraph-server/hugegraph-dist/docker/README.md

ensure no UI diff

imbajin · 2024-02-07T10:11:34Z

hugegraph-server/hugegraph-dist/docker/example/docker-compose-cassandra.yml

@@ -49,7 +49,7 @@ services:
    networks:
      - ca-network
    healthcheck:
-      test: ["CMD", "cqlsh", "--execute", "describe keyspaces;"]
+      test: [ "CMD", "cqlsh", "--execute", "describe keyspaces;" ]


seems better to config the yaml file rules to keep it as the origin style?

imbajin · 2024-02-07T10:12:15Z

hugegraph-server/hugegraph-dist/docker/scripts/remote-connect.groovy

-:remote connect tinkerpop.server conf/remote.yaml
-:> hugegraph
+: remote connect tinkerpop . server conf / remote.yaml
+: > hugegraph


need ignore/exclude it

imbajin · 2024-02-07T10:12:43Z

hugegraph-server/hugegraph-dist/src/assembly/static/conf/gremlin-server.yaml

+      org.apache.hugegraph.plugin.HugeGraphGremlinPlugin: { },
+      org.apache.tinkerpop.gremlin.server.jsr223.GremlinServerGremlinPlugin: { },


keep original style

imbajin · 2024-02-07T10:14:39Z

hugegraph-server/hugegraph-test/src/main/java/org/apache/hugegraph/core/VertexCoreTest.java

-        final double min15 = new BigDecimal(1.234567890987654321d)
-                .setScale(15, BigDecimal.ROUND_DOWN)
+        final double min15 = new BigDecimal("1.234567890987654321")
+                .setScale(15, RoundingMode.DOWN)


double & string number are the same case? need check it carefully

imbajin · 2024-02-07T10:15:19Z

hugegraph-server/hugegraph-test/src/main/java/org/apache/hugegraph/core/VertexCoreTest.java

-        long splitSize = 1 * 1024 * 1024 - 1;
+        long splitSize = 1024 * 1024 - 1;


better keep it if we could config the rule (if we can't just remove it)

imbajin · 2024-02-07T10:16:27Z

hugegraph-server/hugegraph-test/src/main/java/org/apache/hugegraph/core/VertexCoreTest.java

@@ -9140,7 +9141,7 @@ public void testEnhanceTextMatch() {
        Assert.assertEquals(1, vertices.size());
        Assert.assertTrue(vertices.contains(vertex5));

-        vertices = g.V().has("name", Text.contains("(秦始皇2|秦始皇3)")).toList();
+        vertices = g.V().has("name", Text.contains("(秦始皇 2|秦始皇 3)")).toList();


be careful to change the space in code? (better just changed them in comment) to avoid risks

TODO: address the align space (now we use 8 instead 4?)

imbajin

Most of the files were checked except for some clean rules that did not take effect (consider address them together in another PR )

Format & clean code in submodels: 1. API 2. Scylladb 3. Postgresql 4. Rocksdb 5. Palo 6. Mysql 7. Hbase 8. Cassandra 9. Test --------- Co-authored-by: imbajin <[email protected]>

dosubot bot added size:XXL This PR changes 1000+ lines, ignoring generated files. api Changes of API cassandra Cassandra backend rocksdb RocksDB backend labels Feb 2, 2024

msgui mentioned this pull request Feb 2, 2024

[Summary] Enhance code style warnings in server #2435

Closed

18 tasks

msgui changed the title ~~chore: Format&Clean code~~ fix: Format and clean code in modules Feb 2, 2024

dosubot bot modified the milestones: 1.3.0, 1.5.0 Feb 2, 2024

msgui changed the title ~~fix: Format and clean code in modules~~ fix: format and clean code in modules Feb 2, 2024

msgui force-pushed the format- branch from 64992fc to 49aa0a2 Compare February 7, 2024 03:34

dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. and removed size:XXL This PR changes 1000+ lines, ignoring generated files. labels Feb 7, 2024

imbajin reviewed Feb 7, 2024

View reviewed changes

...aph-server/hugegraph-core/src/main/java/org/apache/hugegraph/backend/cache/CacheManager.java Outdated Show resolved Hide resolved

msgui force-pushed the format- branch from 49aa0a2 to cf94c91 Compare February 7, 2024 05:22

msgui requested a review from imbajin February 7, 2024 06:06

imbajin reviewed Feb 7, 2024

View reviewed changes

msgui added 6 commits February 8, 2024 21:04

format&clean code in api

6efc446

format&clean code in cassandra

bbccb34

format&clean code in scylladb

b2fc705

format&clean code in postgresql

fecb1b2

format&clean code in rocksdb

8d3d840

format&clean code in palo

a0cdf89

msgui added 4 commits February 8, 2024 21:31

format&clean code in mysql

fb0e17e

format&clean code in hbase

31f7fe4

format&clean code in test 1-45

4348534

format&clean code in test 46-109

badacb3

msgui force-pushed the format- branch from 10a7730 to badacb3 Compare February 8, 2024 15:31

fix

4030818

msgui requested a review from imbajin February 19, 2024 10:04

imbajin added 2 commits February 19, 2024 19:27

enhance graph element API & revert some change

13ebf93

TODO: address the align space (now we use 8 instead 4?)

tiny fix for previous commit

e13dea5

imbajin approved these changes Feb 19, 2024

View reviewed changes

dosubot bot added the lgtm This PR has been approved by a maintainer label Feb 19, 2024

imbajin requested a review from VGalaxies February 19, 2024 12:30

VGalaxies approved these changes Feb 19, 2024

View reviewed changes

imbajin merged commit 5cb9aad into apache:master Feb 20, 2024
21 checks passed

msgui deleted the format- branch March 15, 2024 04:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: format and clean code in modules #2439

fix: format and clean code in modules #2439

msgui commented Feb 2, 2024 •

edited

Loading

codecov bot commented Feb 2, 2024 •

edited

Loading

imbajin left a comment

imbajin Feb 7, 2024

imbajin Feb 7, 2024

imbajin Feb 7, 2024

imbajin Feb 7, 2024

imbajin Feb 7, 2024

imbajin Feb 7, 2024

imbajin Feb 7, 2024

imbajin Feb 7, 2024

imbajin Feb 7, 2024

imbajin Feb 7, 2024

imbajin left a comment

		org.apache.hugegraph.plugin.HugeGraphGremlinPlugin: { },
		org.apache.tinkerpop.gremlin.server.jsr223.GremlinServerGremlinPlugin: { },

		long splitSize = 1 * 1024 * 1024 - 1;
		long splitSize = 1024 * 1024 - 1;

fix: format and clean code in modules #2439

fix: format and clean code in modules #2439

Conversation

msgui commented Feb 2, 2024 • edited Loading

Purpose of the PR

Main Changes

Verifying these changes

Does this PR potentially affect the following parts?

Documentation Status

codecov bot commented Feb 2, 2024 • edited Loading

Codecov Report

imbajin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

imbajin left a comment

Choose a reason for hiding this comment

msgui commented Feb 2, 2024 •

edited

Loading

codecov bot commented Feb 2, 2024 •

edited

Loading