Skip to content

feat(server): adapt Hubble 2.0 frontend APIs and implement default graph/role management#3008

Open
Yeaury wants to merge 9 commits intoapache:masterfrom
Yeaury:feat/hubble-api-compatibility
Open

feat(server): adapt Hubble 2.0 frontend APIs and implement default graph/role management#3008
Yeaury wants to merge 9 commits intoapache:masterfrom
Yeaury:feat/hubble-api-compatibility

Conversation

@Yeaury
Copy link
Copy Markdown

@Yeaury Yeaury commented Apr 24, 2026

Purpose of the PR

Adapt API endpoints required by the Hubble 2.0 frontend to achieve feature parity with the internal version. The community edition of HugeGraph Server currently lacks several critical APIs that the Hubble frontend depends on (graph profile listing, default graph management, default role management, schema templates, etc.), preventing the Hubble frontend from properly using core graph and role management features. This PR adds the missing APIs to enable full integration between the Hubble 2.0 frontend and the community edition Server.

Link apache/hugegraph-toolchain#632

Main Changes

1. GraphsAPI — Graph Management Endpoint Enhancements (GraphsAPI.java)

  • GET /graphspaces/{graphspace}/graphs/profile — New graph profile listing endpoint with prefix filtering, default-graph-first sorting, and full config info (nickname, create_time, default status, etc.)
  • GET /graphspaces/{graphspace}/graphs/{name}/default — Set a graph as default
  • GET /graphspaces/{graphspace}/graphs/{name}/undefault — Unset a graph as default
  • GET /graphspaces/{graphspace}/graphs/default — Get current user's default graph list
  • PUT /graphspaces/{graphspace}/graphs/{name} — Graph management operations (currently supports update action for nickname updates)
  • POST /graphspaces/{graphspace}/graphs (form-urlencoded) — Hubble frontend form-based graph creation compatibility
  • Auto-fill HStore/PD mode defaults (backend=hstore, serializer=binary, store={name}) during graph creation, and map frontend schema field to schema.init_template

2. GraphSpaceAPI — Default Role Management (GraphSpaceAPI.java)

  • POST /graphspaces/{graphspace}/role — Create default role (supports SPACE/ANALYST/OBSERVER)
  • GET /graphspaces/{graphspace}/role — Check if a user/group has a specified default role
  • DELETE /graphspaces/{graphspace}/role — Delete default role
  • Remove unnecessary PD mode restriction from listProfile endpoint
  • Add @JsonIgnoreProperties(ignoreUnknown = true) to tolerate unknown fields from the frontend

3. ManagerAPI — Role Query (ManagerAPI.java)

  • GET /auth/manager/default — New endpoint for Hubble frontend to query if the current user has a specified default role

4. SchemaTemplateAPI — Schema Template CRUD (New File)

  • GET /graphspaces/{graphspace}/schematemplates — List all schema templates
  • GET /graphspaces/{graphspace}/schematemplates/{name} — Get a specific template
  • POST /graphspaces/{graphspace}/schematemplates — Create template
  • PUT /graphspaces/{graphspace}/schematemplates/{name} — Update template
  • DELETE /graphspaces/{graphspace}/schematemplates/{name} — Delete template

5. Authentication & Authorization Layer (AuthManager.java, StandardAuthManager.java, StandardAuthManagerV2.java, HugeGraphAuthProxy.java)

  • Added 10 new methods to AuthManager interface: setDefaultGraph/unsetDefaultGraph/getDefaultGraph and createDefaultRole/createSpaceDefaultRole/isDefaultRole/deleteDefaultRole, etc.
  • StandardAuthManager and StandardAuthManagerV2 implement the above interfaces using existing HugeGroup/HugeBelong/HugeRole metadata mechanisms
  • HugeGraphAuthProxy.AuthManagerProxy adds corresponding delegate methods to properly forward calls to the underlying authManager

6. Utilities (ConfigUtil.java, GraphManager.java)

  • ConfigUtil.writeConfigToString() — New utility method to serialize graph configuration to string (used by the listProfile endpoint)
  • GraphManager — Added graph management helper methods

Verifying these changes

  • Need tests and can be verified as follows:
    • Verify the full graph management flow via Hubble frontend (create graph, list, profile query)
    • Verify default graph set/unset/query via Hubble frontend
    • Verify Schema template CRUD operations
    • Verify default role (SPACE/ANALYST/OBSERVER) creation, query, and deletion
    • Directly test all new endpoints via REST API

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

Yeaury added 5 commits April 24, 2026 10:53
- Add listProfile endpoint with default graph sorting and prefix filtering
- Add setDefault/unsetDefault/getDefault endpoints for default graph management
- Add manage(PUT) endpoint for graph nickname update
- Add createByForm for form-urlencoded graph creation compatibility
- Auto-fill HStore/PD defaults (backend/serializer/store) during graph creation
- Add setDefaultRole/checkDefaultRole/deleteDefaultRole in GraphSpaceAPI
- Add checkDefaultRole endpoint in ManagerAPI
- Add default role interfaces in AuthManager
- Implement default role CRUD in StandardAuthManager and StandardAuthManagerV2
- Add stub proxy methods in HugeGraphAuthProxy
- Add new SchemaTemplateAPI with list/get/create/update/delete operations
- Fix package path from api.profile to api.space
- Use HugeGraphAuthProxy.username() instead of authManager.username()
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds/extends HugeGraph Server REST endpoints and auth-layer capabilities needed by the Hubble 2.0 frontend, focusing on graph profile listing, default graph selection, default role management, and schema template CRUD within graphspaces.

Changes:

  • Added graph profile listing + default-graph set/unset/query APIs, plus graph create compatibility tweaks.
  • Implemented default-graph/default-role persistence methods in the AuthManager interface and its implementations/proxies.
  • Introduced schema template CRUD API and corresponding GraphManager helpers.

Reviewed changes

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

Show a summary per file
File Description
hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/util/ConfigUtil.java Adds config-to-string helper used by graph profile listing.
hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/auth/AuthManager.java Extends auth interface for default graph/role operations.
hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/auth/StandardAuthManager.java Implements new default graph/role methods (non-PD auth manager).
hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/auth/StandardAuthManagerV2.java Implements new default graph/role methods (PD-mode auth manager).
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/auth/HugeGraphAuthProxy.java Proxies/delegates new AuthManager methods.
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/core/GraphManager.java Adds schema template management helpers.
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/profile/GraphsAPI.java Adds graph profile listing, default graph APIs, manage/update behavior, and create defaults.
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/space/GraphSpaceAPI.java Adds default role management endpoints and JSON tolerance.
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/auth/ManagerAPI.java Adds endpoint to query whether current user has a default role.
hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/space/SchemaTemplateAPI.java New schema template CRUD endpoint implementation.
Comments suppressed due to low confidence (1)

hugegraph-server/hugegraph-api/src/main/java/org/apache/hugegraph/api/profile/GraphsAPI.java:443

  • configs is only validated as non-null when clone_graph_name is empty. If clone_graph_name is provided and the request body is omitted/empty, configs can be null and convConfig(configs) will throw a NullPointerException in the clone branch. Consider defaulting configs to an empty map (or making convConfig() null-safe) before using it for cloning.
        // Check required parameters for creating graph
        if (StringUtils.isEmpty(clone)) {
            // Only check required parameters when creating new graph, not when cloning
            E.checkArgument(configs != null, "Config parameters cannot be null");
            // Auto-fill defaults for PD/HStore mode when not provided
            configs.putIfAbsent("backend", "hstore");
            configs.putIfAbsent("serializer", "binary");
            configs.putIfAbsent("store", name);
            // Map frontend 'schema' field to backend config key
            Object schema = configs.remove("schema");
            if (schema != null && !schema.toString().isEmpty()) {
                configs.put("schema.init_template", schema.toString());
            }
        }

        String creator = HugeGraphAuthProxy.username();

        if (StringUtils.isNotEmpty(clone)) {
            // Clone from existing graph
            LOG.debug("Clone graph '{}' to '{}' in graph space '{}'", clone, name, graphSpace);
            graph = manager.cloneGraph(graphSpace, clone, name, convConfig(configs));
        } else {
            // Create new graph
            graph = manager.createGraph(graphSpace, name, creator,
                                        convConfig(configs), true);
        }

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

…#3008)

- fix: use @POST/@delete for setDefault/unsetDefault (REST semantics)
- fix: add null/empty validation before role field access in GraphSpaceAPI
  to prevent NPE in setDefaultRole/checkDefaultRole/deleteDefaultRole
- fix: change isPrefix to private static and guard nickname null in
  GraphSpaceAPI and GraphsAPI
- fix: ConfigUtil.writeConfigToString always returns JSON regardless
  of whether config was loaded from file, fixing listProfile endpoint
- fix: add @RolesAllowed annotations to SchemaTemplateAPI endpoints
- fix: use ForbiddenException (403) instead of HugeException (400)
  for authorization failures in SchemaTemplateAPI and GraphSpaceAPI
- fix: correct LOG placeholder count in SchemaTemplateAPI.delete
- fix: use HugeException ('%s') format instead of SLF4J '{}' format
- fix: replace com.alipay StringUtils with commons-lang3 in ManagerAPI
- fix: add @consumes and checkUpdate() validation to SchemaTemplate.update
- fix: add ensurePdModeEnabled guard to ManagerAPI.checkDefaultRole
- fix: guard configs null access in GraphsAPI.create clone branch
@imbajin
Copy link
Copy Markdown
Member

imbajin commented Apr 25, 2026

新增 API 单机版(非 PD)兼容性对照

目标:社区默认的 RocksDB 单机版通过 graphspace=DEFAULT 使用 GraphsAPI,应支持图的增删改查和基础权限管理。GraphSpaceAPI、ManagerAPI、SchemaTemplateAPI 属于 PD 专属功能,不需要兼容。

需要兼容单机版的端点(GraphsAPI)

API 端点 当前状态 问题说明 需要的改动
GET .../graphs/profile ⚠️ ConfigUtil.writeConfigToString 序列化全部配置项,可能泄露 password/token 等敏感字段 白名单过滤或排除敏感 key
PUT .../graphs/{name} (manage/update nickname) 1. isExistedGraphNickname() 调用 metaManager.graphConfigs() — 非 PD 下 MetaManager 未初始化,NPE;2. exist.nickname() 只改内存,缺少持久化调用 1. 加 isPDEnabled() 分支,非 PD 下用内存图列表做去重;2. 补充持久化调用
POST .../graphs (create JSON) 无条件执行 configs.putIfAbsent("backend", "hstore"),单机版默认 RocksDB 会被覆盖为 hstore 导致创建失败 if (manager.isPDEnabled()) 包裹 hstore/binary 默认值填充
POST .../graphs/{name} (createByText) 委托 create() 方法,同上 同上(修复 create 即可)
POST .../graphs/{name}/default (设置默认图) StandardAuthManager 已实现
DELETE .../graphs/{name}/default (取消默认图) StandardAuthManager 已实现
GET .../graphs/default (查询默认图) StandardAuthManager 已实现

PD 专属端点(无需兼容单机版)

API 端点 归属 说明
POST/GET/DELETE .../graphspaces/{gs}/role GraphSpaceAPI 图空间级角色管理,PD-only by design
GET /auth/manager/default ManagerAPI 已有 ensurePdModeEnabled() 门禁
GET/POST/PUT/DELETE .../schematemplates[/{name}] SchemaTemplateAPI 全部走 metaManager,PD-only

总结:7 个 GraphsAPI 端点需要兼容单机版。其中 3 个需要代码改动(manage 需加 isPDEnabled() 分支 + 持久化修复,create/createByText 需条件化 hstore 默认值),1 个需过滤敏感配置,3 个已可正常工作。

Yeaury added 2 commits April 26, 2026 16:16
… mode

## Background

Hubble 2.0 previously relied exclusively on PD mode (distributed HStore
backend). This PR makes the server-side APIs fully compatible with the
community default: single-node RocksDB without PD/HStore, so that Hubble
remains functional out of the box for all deployment modes.

## Core bug fixes

### GraphsAPI
- Fix `create()`: `backend=hstore` / `serializer=binary` defaults are now
  only injected when `manager.isPDEnabled()` is true, preventing graph
  creation failures on standalone RocksDB deployments.
- Fix `manage()`: replace `exist.nickname(nickname)` (in-memory only) with
  `manager.updateGraphNickname()`, which persists the change to PD meta
  storage in distributed mode and gracefully falls back to in-memory update
  in standalone mode.
- Fix `manage()`: relax `actionMap.size() == 2` validation to
  `containsKey(GRAPH_ACTION)`, so extra fields from the frontend no longer
  cause spurious 400 errors.
- Guard `getDefaultGraph()`, `setDefault()`, `unsetDefault()`, and
  `getDefault()` with `isPDEnabled()` checks; return empty results in
  standalone mode instead of throwing NPE.
- Fix `listProfile()`: guard `getDefaultGraph()` call with `isPDEnabled()`;
  add null-safe fallback for `gs.nickname()` in non-PD mode.

### GraphManager
- `isExistedGraphNickname()`: add non-PD branch that scans in-memory graphs
  instead of accessing the uninitialized `metaManager`, preventing NPE in
  standalone mode.
- New `updateGraphNickname()`: updates in-memory graph instance first, then
  persists nickname to `metaManager` only in PD mode.

### ConfigUtil
- `writeConfigToString()`: always serializes config to JSON (previously
  could emit raw properties format), fixing `listProfile` deserialization.
- New `isSensitiveKey()`: filters keys containing `password`, `secret`,
  `token`, `credential`, `private_key`, or `auth.key` from the serialized
  output to prevent credential leakage through the API.

### ManagerAPI
- Add `ensurePdModeEnabled()` guard to all PD-specific endpoints
  (`createManager`, `deleteManager`, `list`, `checkRole`, `getRolesInGs`,
  `checkDefaultRole`).
- Wrap `HugeDefaultRole.valueOf()` in try-catch to return HTTP 400 instead
  of HTTP 500 when an invalid role string is supplied.

### SchemaTemplateAPI
- Fix incorrect `HugeException` import; replace with `ForbiddenException`
  for proper HTTP 403 semantics.
- Add missing `@RolesAllowed` annotations and implement `checkUpdate()`
  validation.

### StandardAuthManager
- Implement `setDefaultGraph` / `getDefaultGraph` / `unsetDefaultGraph`
  using marker-group pattern (HugeGroup + HugeBelong) for persistence.
- Implement `createDefaultRole` / `createSpaceDefaultRole` /
  `isDefaultRole` / `deleteDefaultRole` with the same marker-group
  mechanism.
- Add detailed design-note Javadoc explaining the workaround, its
  limitations, and the non-PD degradation path.

## Code quality improvements

- Extract shared `isPrefix(Map, String)` helper and `DATE_FORMATTER`
  constant into the `API` base class, eliminating ~30 lines of duplicated
  code across `GraphsAPI` and `GraphSpaceAPI`.
- Replace non-thread-safe `SimpleDateFormat` (constructed per-request) with
  a single static `DateTimeFormatter` (immutable, thread-safe).
- Fix 12-hour clock format `hh` → 24-hour `HH` in `GraphSpaceAPI`.
@Yeaury Yeaury marked this pull request as ready for review April 26, 2026 09:47
@dosubot dosubot Bot added the size:XXL This PR changes 1000+ lines, ignoring generated files. label Apr 26, 2026
@dosubot dosubot Bot added api Changes of API feature New feature labels Apr 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api Changes of API feature New feature size:XXL This PR changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants