[Improvement-18224][API] Migrate EnvironmentService Map<String,Object> returns to typed returns#18225
Merged
SbloodyS merged 1 commit intoapache:devfrom May 9, 2026
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
|
||
| Map<String, Object> result = environmentService.queryEnvironmentByCode(environmentCode); | ||
| return returnDataList(result); | ||
| public Result<EnvironmentDto> queryEnvironmentByCode(@Parameter(hidden = true) @RequestAttribute(value = Constants.SESSION_USER) User loginUser, |
Member
Author
There was a problem hiding this comment.
ignore, will remove the loginUser at another PR, we should use ThreadLocal to hold this.
…> returns to typed returns Refactor 5 EnvironmentService methods from Map<String, Object> to typed return / void + ServiceException, with cascading updates to the controller, PythonGateway and unit test: - verifyEnvironment(String): void - queryEnvironmentByName(String): EnvironmentDto - queryEnvironmentByCode(Long): EnvironmentDto - queryAllEnvironmentList(User): List<EnvironmentDto> - deleteEnvironmentByCode(User, Long): void HTTP wire format is preserved: ApiExceptionHandler converts ServiceException to the same Result(code, msg) shape that BaseController.returnDataList(map) produced; success paths use Result.success(data) matching the prior JSON body byte-for-byte. EnvironmentControllerTest is unchanged on purpose. Py4J boundary is preserved: PythonGateway.getEnvironmentInfo continues to throw IllegalArgumentException with the same message format on lookup failure, so Python SDK clients see no behavior change. This is the first migration in the series tracked by apache#18224; the remaining services in dolphinscheduler-api will follow using the same template, after which BaseService.putMsg(Map) and BaseController.returnDataList(Map) can be removed.
ruanwenjun
force-pushed
the
chore/api-environment-service-typed-returns
branch
from
fd61a88 to
f63d456
Compare
|
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
3 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
related issue #18224
Brief change log
Refactor 5 EnvironmentService methods from Map<String, Object> to typed return / void + ServiceException, with cascading updates to the controller, PythonGateway and unit test:
HTTP wire format is preserved: ApiExceptionHandler converts ServiceException to the same Result(code, msg) shape that BaseController.returnDataList(map) produced; success paths use Result.success(data) matching the prior JSON body byte-for-byte. EnvironmentControllerTest is unchanged on purpose.
Py4J boundary is preserved: PythonGateway.getEnvironmentInfo continues to throw IllegalArgumentException with the same message format on lookup failure, so Python SDK clients see no behavior change.
This is the first migration in the series tracked by #18224; the remaining services in dolphinscheduler-api will follow using the same template, after which BaseService.putMsg(Map) and BaseController.returnDataList(Map) can be removed.
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