optimize(api): disable GraphSpaceAPI and ManagerAPI in standalone mode by contrueCT · Pull Request #2966 · apache/hugegraph

contrueCT · 2026-03-10T10:02:23Z

Purpose of the PR

close [Bug] protect GraphSpaceAPI in non-hstore status #2964

Main Changes

The issue requires GraphSpaceAPI to return a friendly response in standalone mode. During code investigation, I found that ManagerAPI has a similar problem: in standalone mode, manager.graphSpace(name) returns a fake new GraphSpace("DEFAULT"), which causes ManagerAPI.validGraphSpace() to pass incorrectly. As a result, ManagerAPI can still enter logic that is not actually supported in standalone mode, leading to unfriendly errors or behavior that does not match the API semantics. For consistency and correctness, I applied the same standalone-mode guard to ManagerAPI as well.

Add public isUsePD() accessor to GraphManager to expose PD status
Add checkPdModeEnabled() helper in API base class
Call checkPdModeEnabled() in all public methods of GraphSpaceAPI (list/get/create/manage/delete)
Call checkPdModeEnabled() in all public methods of ManagerAPI (createManager/delete/list/checkRole/getRolesInGs)
Returns HTTP 400 with message 'GraphSpace management is not supported in standalone mode'
Add standalone-mode rejection tests in GraphSpaceApiTest and ManagerApiTest

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?

Dependencies (add/update license info & regenerate_known_dependencies.sh)
Modify configurations
The public API
Other affects (typed here)
Nope

Documentation Status

Doc - TODO
Doc - Done
Doc - No Need

- Add public isUsePD() accessor to GraphManager to expose PD status - Add checkPdModeEnabled() helper in API base class - Call checkPdModeEnabled() in all public methods of GraphSpaceAPI (list/get/create/manage/delete) - Call checkPdModeEnabled() in all public methods of ManagerAPI (createManager/delete/list/checkRole/getRolesInGs) - Returns HTTP 400 with message 'GraphSpace management is not supported in standalone mode' - Add standalone-mode rejection tests in GraphSpaceApiTest and ManagerApiTest

…ndalone

Copilot

Pull request overview

This PR addresses issue #2964 by disabling GraphSpaceAPI and ManagerAPI endpoints in standalone (non-PD) mode, returning a friendly HTTP 400 error instead of allowing logic that doesn't apply outside of PD mode.

Changes:

Added isUsePD() public accessor to GraphManager to expose PD status
Added checkPdModeEnabled() static helper in API base class, called at the start of all public methods in GraphSpaceAPI and ManagerAPI
Added standalone-mode rejection tests in GraphSpaceApiTest and ManagerApiTest

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
`GraphManager.java`	Exposes `isUsePD()` as a public method
`API.java`	Adds `checkPdModeEnabled()` helper throwing HTTP 400 in non-PD mode
`GraphSpaceAPI.java`	Guards all public endpoints with `checkPdModeEnabled()`
`ManagerAPI.java`	Guards all public endpoints with `checkPdModeEnabled()`
`GraphSpaceApiTest.java`	Tests that all GraphSpaceAPI endpoints return 400 in standalone mode
`ManagerApiTest.java`	Tests that all ManagerAPI endpoints return 400 in standalone mode

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/API.java

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/core/GraphManager.java

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/space/GraphSpaceAPI.java

hugegraph-server/hugegraph-test/src/main/java/org/apache/hugegraph/api/ManagerApiTest.java

...erver/hugegraph-test/src/main/java/org/apache/hugegraph/api/GraphSpaceApiStandaloneTest.java

Copilot

Pull request overview

Copilot reviewed 9 out of 10 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/space/GraphSpaceAPI.java

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/core/GraphManager.java

...h-server/hugegraph-test/src/main/java/org/apache/hugegraph/api/ManagerApiStandaloneTest.java

...erver/hugegraph-test/src/main/java/org/apache/hugegraph/api/GraphSpaceApiStandaloneTest.java

Copilot

Pull request overview

Copilot reviewed 9 out of 10 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

hugegraph-server/hugegraph-test/src/main/java/org/apache/hugegraph/api/BaseApiTest.java

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/API.java

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/core/GraphManager.java

imbajin · 2026-03-13T09:38:58Z

...h-server/hugegraph-test/src/main/java/org/apache/hugegraph/api/ManagerApiStandaloneTest.java

+    }
+
+    @Test
+    public void testListManagerReturnsFriendlyError() {


⚠️ The new standalone tests only exercise the ADMIN branch, so they don't actually lock down the regression described in the PR body. The problematic path was that validGraphSpace() could still succeed in standalone mode because manager.graphSpace(name) returns a synthetic DEFAULT space, and that only happens in the SPACE / SPACE_MEMBER branches.

ASCII view:

checkPdModeEnabled() | +-- ADMIN <- covered here +-- SPACE <- regression path \-- SPACE_MEMBER <- regression path

Please add at least one standalone test with type=SPACE or type=SPACE_MEMBER against a non-DEFAULT graphspace, so this PR verifies the branch that used to fall through.

Suggested change

public void testListManagerReturnsFriendlyError() {

@Test

public void testListSpaceManagerReturnsFriendlyError() {

Response r = this.client().get(managerPath("nonexistent"),

Map.of("type", (Object) HugePermission.SPACE));

String content = assertResponseStatus(400, r);

Assert.assertTrue(content.contains(STANDALONE_ERROR));

}

Copilot

Pull request overview

Copilot reviewed 9 out of 10 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

hugegraph-server/hugegraph-test/src/main/java/org/apache/hugegraph/api/BaseApiTest.java

+        }
+        catch (IOException e) {


hugegraph-server/hugegraph-test/src/main/java/org/apache/hugegraph/api/BaseApiTest.java

+        }
+        else {


Copilot

Pull request overview

Copilot reviewed 9 out of 10 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

hugegraph-server/hugegraph-test/src/main/java/org/apache/hugegraph/api/ManagerApiTest.java

+        Map<String, List<Map<String, Object>>> resultMap = JsonUtil.fromJson(result,
+                                                                             new TypeReference<Map<String, List<Map<String, Object>>>>() {
+                                                                             });


imbajin · 2026-03-15T14:01:52Z

hugegraph-server/hugegraph-test/src/main/java/org/apache/hugegraph/api/BaseApiTest.java

+        String backend = System.getProperty("backend");
+        Assume.assumeTrue(
+                "skip standalone tests: backend is '" + backend + "' (hstore/PD mode)",
+                backend != null && !backend.equals("hstore"));


⚠️ assumeStandaloneMode() uses a double-negative condition (backend != null && !backend.equals("hstore")), which reduces readability. Prefer an explicit boolean variable and Assume.assumeFalse(...) for clarity and null-safety:

boolean isPdMode = "hstore".equals(backend); Assume.assumeFalse("Skip in PD/distributed mode", isPdMode);

imbajin · 2026-03-15T14:05:23Z

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/API.java

        }
    }

+    public static void checkPdModeEnabled(GraphManager manager) {


⚠️ Method name checkPdModeEnabled() is non-idiomatic for a method that throws — Java convention uses imperative names like ensure* or require* for assertion/guard methods. Consider renaming:

public static void ensurePdModeEnabled(GraphManager manager) {

Also missing: a null-check for manager and a Javadoc comment explaining what exception is thrown and when.

imbajin · 2026-03-15T14:05:29Z

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/API.java

        }
    }

+    public static void checkPdModeEnabled(GraphManager manager) {


⚠️ Declaring this as public static on the widely-used API base class unnecessarily expands the public API surface. Since this guard is only called from API subclasses, consider reducing visibility to protected:

protected static void checkPdModeEnabled(GraphManager manager) {

imbajin · 2026-03-15T14:05:35Z

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/API.java

+    public static void checkPdModeEnabled(GraphManager manager) {
+        if (!manager.usePD()) {
+            throw new HugeException(
+                    "GraphSpace management is not supported in standalone mode");


🧹 The error message "GraphSpace management is not supported in standalone mode" is duplicated across production code and tests. Extract it to a constant to avoid typos and make future changes easier:

private static final String PD_MODE_REQUIRED_MSG = "GraphSpace management is not supported in standalone mode";

imbajin · 2026-03-15T14:05:41Z

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/core/GraphManager.java

    }

-    private boolean usePD() {
+    public boolean usePD() {


⚠️ usePD() is an ambiguous name for a public boolean accessor — Java convention for boolean getters is is* or has*. Consider renaming to isPdEnabled() or isUsePD() to make the intent clear:

public boolean isPdEnabled() { return this.PDExist; }

contrueCT and others added 3 commits March 10, 2026 17:34

Merge branch 'master' into feat/disable-graphspace-manager-api-in-sta…

df94447

…ndalone

fix(api): merge mistake

cae50d1

imbajin requested a review from Copilot March 10, 2026 12:57

Copilot AI reviewed Mar 10, 2026

View reviewed changes

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/API.java Show resolved Hide resolved

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/core/GraphManager.java Outdated Show resolved Hide resolved

Copilot started reviewing on behalf of imbajin March 10, 2026 13:04 View session

imbajin reviewed Mar 10, 2026

View reviewed changes

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/space/GraphSpaceAPI.java Show resolved Hide resolved

imbajin reviewed Mar 10, 2026

View reviewed changes

hugegraph-server/hugegraph-test/src/main/java/org/apache/hugegraph/api/ManagerApiTest.java Outdated Show resolved Hide resolved

contrueCT added 2 commits March 10, 2026 23:13

test(api): add tests for GraphSpaceAPI and ManagerAPI in standalone mode

e29d967

test(api): add tests for GraphSpaceAPI and ManagerAPI in standalone mode

68ed7f6

contrueCT requested a review from imbajin March 11, 2026 09:46

imbajin requested a review from Copilot March 11, 2026 10:42

Copilot started reviewing on behalf of imbajin March 11, 2026 10:43 View session

imbajin reviewed Mar 11, 2026

View reviewed changes

...erver/hugegraph-test/src/main/java/org/apache/hugegraph/api/GraphSpaceApiStandaloneTest.java Show resolved Hide resolved

Copilot AI reviewed Mar 11, 2026

View reviewed changes

fix: guard graphspace management APIs in standalone mode

c8c1c0c

contrueCT requested review from Copilot and imbajin March 11, 2026 16:11

Copilot AI reviewed Mar 11, 2026

View reviewed changes

Copilot started reviewing on behalf of contrueCT March 11, 2026 16:26 View session

imbajin reviewed Mar 13, 2026

View reviewed changes

imbajin requested a review from Copilot March 13, 2026 09:45

Copilot started reviewing on behalf of imbajin March 13, 2026 09:45 View session

Copilot AI reviewed Mar 13, 2026

View reviewed changes

hugegraph-server/hugegraph-test/src/main/java/org/apache/hugegraph/api/BaseApiTest.java Outdated

Comment on lines +537 to +538

}

catch (IOException e) {

hugegraph-server/hugegraph-test/src/main/java/org/apache/hugegraph/api/BaseApiTest.java Outdated

Comment on lines +513 to +514

}

else {

contrueCT added 2 commits March 14, 2026 23:42

style: format code for consistency in BaseApiTest.java

c89ca9e

test(api): cover SPACE branch regression in ManagerApiStandaloneTest

1a1db05

contrueCT requested a review from imbajin March 15, 2026 02:47

imbajin requested a review from Copilot March 15, 2026 13:26

Copilot started reviewing on behalf of imbajin March 15, 2026 13:26 View session

Copilot AI reviewed Mar 15, 2026

View reviewed changes

hugegraph-server/hugegraph-test/src/main/java/org/apache/hugegraph/api/ManagerApiTest.java

Comment on lines +325 to +327

Map<String, List<Map<String, Object>>> resultMap = JsonUtil.fromJson(result,

new TypeReference<Map<String, List<Map<String, Object>>>>() {

});

imbajin reviewed Mar 15, 2026

View reviewed changes

-    public void testListManagerReturnsFriendlyError() {
+    @Test
+    public void testListSpaceManagerReturnsFriendlyError() {
+        Response r = this.client().get(managerPath("nonexistent"),
+                                       Map.of("type", (Object) HugePermission.SPACE));
+        String content = assertResponseStatus(400, r);
+        Assert.assertTrue(content.contains(STANDALONE_ERROR));
+    }

Conversation

contrueCT commented Mar 10, 2026

Purpose of the PR

Main Changes

Verifying these changes

Does this PR potentially affect the following parts?

Documentation Status

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

imbajin Mar 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

imbajin Mar 15, 2026

Choose a reason for hiding this comment

Uh oh!

imbajin Mar 15, 2026

Choose a reason for hiding this comment

Uh oh!

imbajin Mar 15, 2026

Choose a reason for hiding this comment

Uh oh!

imbajin Mar 15, 2026

Choose a reason for hiding this comment

Uh oh!

imbajin Mar 15, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants