Skip to content

fix(server): ensure graph clear API does not clear meta table for hbase #2911

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LYD031106 wants to merge 4 commits into
base: master
Choose a base branch
from
Open

fix(server): ensure graph clear API does not clear meta table for hbase #2911

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fbb5e04
fix(server): ensure graph clear API does not clear meta table
LYD031106 Nov 16, 2025
9c810fd
fix(server): ensure graph clear API does not clear system table
LYD031106 Nov 20, 2025
004684e
fix(server): Improve the test cases
LYD031106 Nov 30, 2025
7676f54
fix(server): ensure graph clear API does not clear meta table
LYD031106 Dec 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions ...er/hugegraph-hbase/src/main/java/org/apache/hugegraph/backend/store/hbase/HbaseStore.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,14 @@ protected List<String> tableNames() {
.collect(Collectors.toList());
}

protected List<String> truncatedTableNames() {
Copy link
Member

@imbajin imbajin Dec 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

‼️ Critical: Method name doesn't follow Java naming conventions

The method name truncatedTableNames() is grammatically incorrect and misleading. It suggests tables that have already been truncated, when it actually returns tables that SHOULD be truncated.

Suggested change
protected List<String> truncatedTableNames() {
protected List<String> getNonMetaTableNames() {
// Exclude meta table to preserve system metadata during graph clear
return this.tables.entrySet().stream()
.filter(e -> !(HugeType.META == e.getKey()))
.map(e -> e.getValue().table())
.collect(Collectors.toList());
}

Alternative names: getClearableTableNames(), getDataTableNames(), or getTableNamesExcludingMeta()

return this.tables.values().stream()
.filter(table -> !(table instanceof HbaseTables.Meta ||
table instanceof HbaseTables.Counters))
.map(BackendTable::table)
Copy link
Member

@imbajin imbajin Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

‼️ Critical: Logic Error - Counters Table Should Be Truncated

The Counters table contains graph-specific data like vertex/edge ID sequences. When truncating a graph, this data should be cleared to avoid ID conflicts when repopulating the graph.

Only the Meta table (which stores backend version metadata) should be preserved during truncation.

Suggested change
.map(BackendTable::table)
protected List<String> truncatedTableNames() {
return this.tables.values().stream()
.filter(table -> !(table instanceof HbaseTables.Meta))
.map(BackendTable::table)
.collect(Collectors.toList());
}

.collect(Collectors.toList());
}

public String namespace() {
return this.namespace;
}
Expand Down Expand Up @@ -371,7 +379,7 @@ public void truncate() {
};

// Truncate tables
List<String> tables = this.tableNames();
List<String> tables = this.truncatedTableNames();
Map<String, Future<Void>> futures = new HashMap<>(tables.size());

try {
Expand Down Expand Up @@ -401,7 +409,6 @@ public void truncate() {
throw new BackendException(
"Failed to truncate table for '%s' store", e, this.store);
}
Copy link
Member

@imbajin imbajin Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Minor: Unnecessary Whitespace Change

Removing this blank line is cosmetic and adds noise to the diff without functional benefit. Consider keeping the original formatting to make the diff cleaner and focus on actual logic changes.


LOG.debug("Store truncated: {}", this.store);
}

Expand Down
57 changes: 57 additions & 0 deletions ...erver/hugegraph-test/src/main/java/org/apache/hugegraph/unit/hbase/BaseHbaseUnitTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
/*
*
* * 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.
Copy link
Member

@imbajin imbajin Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wrong header format

*
*/

package org.apache.hugegraph.unit.hbase;

import org.apache.commons.configuration2.Configuration;
import org.apache.hugegraph.backend.store.hbase.HbaseStoreProvider;
import org.apache.hugegraph.config.HugeConfig;
import org.apache.hugegraph.testutil.Utils;
import org.apache.hugegraph.unit.BaseUnitTest;
import org.junit.After;

Copy link
Member

@imbajin imbajin Nov 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Naming: Space missing in class declaration

Minor style issue:

Suggested change
public class BaseHbaseUnitTest extends BaseUnitTest {

public class BaseHbaseUnitTest extends BaseUnitTest{
Copy link
Member

@imbajin imbajin Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Code Style: Formatting

Missing space after class declaration:

Suggested change
public class BaseHbaseUnitTest extends BaseUnitTest{
public class BaseHbaseUnitTest extends BaseUnitTest {


private static final String GRAPH_NAME = "test_graph";

protected HugeConfig config;
protected HbaseStoreProvider provider;

public void setup() {
Configuration conf = Utils.getConf();
this.config = new HugeConfig(conf);
this.provider = new HbaseStoreProvider();
Copy link
Member

@imbajin imbajin Dec 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

‼️ Critical: Potential resource leak in setup()

If any exception occurs after opening stores but before sessions.open(), the opened stores won't be properly closed. This can lead to resource leaks in test execution.

Suggested change
this.provider = new HbaseStoreProvider();
@Before
public void setup() throws IOException {
Configuration conf = Utils.getConf();
this.config = new HugeConfig(conf);
this.provider = new HbaseStoreProvider();
try {
this.provider.open(GRAPH_NAME);
this.provider.loadSystemStore(config).open(config);
this.provider.loadGraphStore(config).open(config);
this.provider.loadSchemaStore(config).open(config);
this.provider.init();
this.sessions = new HbaseSessions(config, GRAPH_NAME,
this.provider.loadGraphStore(config).store());
this.sessions.open();
} catch (Exception e) {
tearDown();
throw e;
}
}

this.provider.open(GRAPH_NAME);
this.provider.loadSystemStore(config).open(config);
Copy link
Member

@imbajin imbajin Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Missing space after comma - code style

For code consistency, add a space after commas in method calls.

Suggested change
this.provider.loadSystemStore(config).open(config);
this.sessions = new HbaseSessions(config, GRAPH_NAME, this.provider.loadGraphStore(config).store());

this.provider.loadGraphStore(config).open(config);
this.provider.loadSchemaStore(config).open(config);
this.provider.init();
}

@After
public void down(){
Copy link
Member

@imbajin imbajin Nov 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Code quality: Silent exception swallowing

Using empty catch blocks makes debugging difficult. Consider:

Suggested change
public void down(){
@After
public void down(){
if (this.store != null) {
try {
this.store.close();
} catch (Exception e) {
LOG.warn("Failed to close store", e);
}
}
if (this.provider != null) {
try {
this.provider.close();
} catch (Exception e) {
LOG.warn("Failed to close provider", e);
}
}
}

Copy link
Member

@imbajin imbajin Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Missing space after comma in log statement

Suggested change
public void down(){
LOG.warn("Failed to close provider", e);

if (this.provider != null) {
try {
this.provider.close();
Copy link
Member

@imbajin imbajin Dec 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Code style: inconsistent spacing

Missing space after catch keyword.

Suggested change
this.provider.close();
} catch (Exception e) {

} catch (Exception e) {
LOG.warn("Failed to close provider",e);
}
}
}
}
43 changes: 43 additions & 0 deletions ...ph-server/hugegraph-test/src/main/java/org/apache/hugegraph/unit/hbase/HbaseUnitTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*
*
* * 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.unit.hbase;

import org.apache.hugegraph.backend.store.BackendStore;
import org.apache.hugegraph.testutil.Assert;
import org.junit.Before;
import org.junit.Test;

public class HbaseUnitTest extends BaseHbaseUnitTest {
@Before
Copy link
Member

@imbajin imbajin Nov 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Test setup/teardown issue

Both BaseHbaseUnitTest and HbaseUnitTest have setup/teardown methods that may cause issues:

  1. Duplicate cleanup: @After in both base and child class will close store/provider twice
  2. Setup order: Child's @Before runs after parent's, but calls provider.open() which may conflict

Suggestion:

Suggested change
@Before
@Before
public void setUp(){
super.setup(); // Call parent setup first
this.provider.open(GRAPH_NAME);
this.provider.init();
}
@After
public void teardown(){
// Remove duplicate cleanup - handled by parent
// Only add child-specific cleanup here if needed
}

public void setUp(){
super.setup();
}

@Test
Copy link
Member

@imbajin imbajin Nov 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Test coverage insufficient

The test only verifies version equality but doesn't validate:

  1. Meta table content: Check that specific meta entries (like backend version, graph name, etc.) are preserved
  2. Data table clearing: Verify that actual graph data (vertices, edges) are properly cleared
  3. Concurrent operations: Test behavior when truncate is called during other operations

Suggestion:

@Test
public void testHbaseMetaVersion(){
    // Insert some test data
    // ... add vertices/edges ...
    
    String beforeVersion = this.store.storedVersion();
    // Get other meta entries
    
    this.store.truncate();
    
    String afterVersion = this.store.storedVersion();
    Assert.assertEquals(beforeVersion, afterVersion);
    
    // Verify data is cleared but meta is intact
    // ... check vertices/edges are gone ...
    // ... check other meta entries preserved ...
}

Copy link
Member

@imbajin imbajin Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Incomplete Test Coverage

The test only verifies that meta version is preserved, but doesn't verify the actual truncation behavior. Consider adding assertions to verify:

  1. Data tables are actually truncated (e.g., insert some data, truncate, verify data is gone)
  2. Meta table content remains intact
  3. The graph can be used normally after truncation

Example enhancement:

@Test
public void testHbaseMetaVersionAfterTruncate() {
    BackendStore systemStore = this.provider.loadSystemStore(config);
    BackendStore graphStore = this.provider.loadGraphStore(config);
    
    // Record initial version
    String beforeVersion = systemStore.storedVersion();
    
    // Insert some test data to verify truncation
    // ... add test data insertion code ...
    
    // Perform truncation
    this.provider.truncate();
    
    // Verify version preserved
    String afterVersion = systemStore.storedVersion();
    Assert.assertEquals(beforeVersion, afterVersion);
    
    // Verify data tables are empty
    // ... add verification code ...
}

public void testMysqlMetaVersion(){
Copy link
Member

@imbajin imbajin Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Test Method Name Mismatch

The test method is named testMysqlMetaVersion() but it's testing HBase functionality. This appears to be a copy-paste error from MySQL tests.

Suggested change
public void testMysqlMetaVersion(){
@Test
public void testHbaseMetaVersionAfterTruncate() {

This makes the test's purpose clearer and matches the actual functionality being tested.

BackendStore systemStore = this.provider.loadSystemStore(config);
String beforeVersion = systemStore.storedVersion();
this.provider.truncate();
String afterInitVersion = systemStore.storedVersion();
Assert.assertNotNull(beforeVersion);
Assert.assertNotNull(afterInitVersion);
Assert.assertEquals(beforeVersion, afterInitVersion);
}
}
Loading