[Improvement-18224][API] Migrate SchedulerService Map<String,Object> returns to typed returns#18226
Open
ruanwenjun wants to merge 1 commit intoapache:devfrom
Open
Conversation
…returns to typed returns
Refactor 5 SchedulerService methods from Map<String, Object> to typed
return + ServiceException, with cascading updates to the controller,
controller test and PythonGateway:
- insertSchedule(...): Schedule
- updateSchedule(...): Schedule
- queryScheduleList(User, long): List<ScheduleVO>
- previewSchedule(User, String): List<String>
- updateScheduleByWorkflowDefinitionCode(...): Schedule
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. The private updateSchedule helper now throws on
validation failure and returns the persisted Schedule on success, replacing
the Map-mutation contract.
Py4J boundary is preserved: PythonGateway.createOrUpdateSchedule reads the
new scheduleId via Schedule#getId() instead of result.get("scheduleId"),
so Python SDK clients see no behavior change.
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}
| * @return the next five fire time | ||
| */ | ||
| Map<String, Object> previewSchedule(User loginUser, String schedule); | ||
| List<String> previewSchedule(User loginUser, String schedule); |
|
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?
Purpose of the pull request
Refactor 5 SchedulerService methods from Map<String, Object> to typed return + ServiceException, with cascading updates to the controller, controller test and PythonGateway:
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. The private updateSchedule helper now throws on validation failure and returns the persisted Schedule on success, replacing the Map-mutation contract.
Py4J boundary is preserved: PythonGateway.createOrUpdateSchedule reads the new scheduleId via Schedule#getId() instead of result.get("scheduleId"), so Python SDK clients see no behavior change.
Part of the migration series tracked by #18224.
Brief change log
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