[Improvement-18224][API] Migrate small-service Map<String,Object> returns to typed returns#18230
Open
ruanwenjun wants to merge 1 commit intoapache:devfrom
Open
[Improvement-18224][API] Migrate small-service Map<String,Object> returns to typed returns#18230ruanwenjun wants to merge 1 commit intoapache:devfrom
ruanwenjun wants to merge 1 commit intoapache:devfrom
Conversation
…urns to typed returns
Batch-migrate seven Map<String, Object> methods across five small services
to typed return / void + ServiceException, with cascading updates to the
controllers, PythonGateway and unit tests:
TenantService
- queryByTenantCode(String): Tenant (nullable; only consumed by PythonGateway)
TaskGroupQueueService
- queryTasksByGroupId(...): PageInfo<TaskGroupQueue>
ProjectWorkerGroupRelationService
- queryAssignedWorkerGroupsByProject(User, Long): List<ProjectWorkerGroup>
UiPluginService
- queryUiPluginsByType(PluginType): List<PluginDefine>
- queryUiPluginDetailById(int): PluginDefine
EnvironmentWorkerGroupRelationService
- queryEnvironmentWorkerGroupRelation(Long): List<EnvironmentWorkerGroupRelation>
- queryAllEnvironmentWorkerGroupRelationList(): List<EnvironmentWorkerGroupRelation>
HTTP wire format is preserved:
* Standard endpoints (TaskGroup, UiPlugin) now wrap the typed return in
Result.success(data); ApiExceptionHandler converts ServiceException to
the same Result(code, msg) shape that BaseController.returnDataList(map)
produced.
* The non-standard ProjectWorkerGroupController.queryAssignedWorkerGroups
endpoint still returns a raw Map<String, Object>; the controller now
builds the {STATUS, MSG, DATA_LIST} map from the typed service return so
the JSON body remains byte-for-byte identical on success. Permission
failures translate the legacy hasProjectAndPerm(Map) status into a
ServiceException, so the error path now goes through ApiExceptionHandler
(Result shape) instead of the raw Map.
Py4J boundary is preserved: PythonGateway.queryTenantByCode now returns
the Tenant directly from the service (still null on miss, matching the
previous behavior where DATA_LIST was unset).
ExecutorService.forceStartTaskInstance is intentionally deferred — its
only caller is TaskGroupServiceImpl.forceStartTask, which itself returns
Map<String, Object> and is part of the larger TaskGroupService migration.
Migrating it now would require a temporary Map-rebuild in TaskGroupServiceImpl
that the next PR would immediately undo.
Part of the migration series tracked by apache#18224.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
|
||
| Map<String, Object> result = uiPluginService.queryUiPluginsByType(pluginType); | ||
| return returnDataList(result); | ||
| public Result<List<PluginDefine>> queryUiPluginsByType(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser, |
|
|
||
| Map<String, Object> result = uiPluginService.queryUiPluginDetailById(pluginId); | ||
| return returnDataList(result); | ||
| public Result<PluginDefine> queryUiPluginDetailById(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser, |
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Was this PR generated or assisted by AI?
YES, ops 4.7
Purpose of the pull request
Brief change log
Batch-migrate seven Map<String, Object> methods across five small services to typed return / void + ServiceException, with cascading updates to the controllers, PythonGateway and unit tests:
TenantService
TaskGroupQueueService
ProjectWorkerGroupRelationService
UiPluginService
EnvironmentWorkerGroupRelationService
HTTP wire format is preserved:
Py4J boundary is preserved: PythonGateway.queryTenantByCode now returns the Tenant directly from the service (still null on miss, matching the previous behavior where DATA_LIST was unset).
ExecutorService.forceStartTaskInstance is intentionally deferred — its only caller is TaskGroupServiceImpl.forceStartTask, which itself returns Map<String, Object> and is part of the larger TaskGroupService migration. Migrating it now would require a temporary Map-rebuild in TaskGroupServiceImpl that the next PR would immediately undo.
Part of the migration series tracked by #18224.
Verify this pull request
This pull request is code cleanup without any test coverage.
(or)
This pull request is already covered by existing tests, such as (please describe tests).
(or)
This change added tests and can be verified as follows:
(or)
Pull Request Notice
Pull Request Notice
If your pull request contains incompatible change, you should also add it to
docs/docs/en/guide/upgrade/incompatible.md