[Improvement-18224][API] Migrate UsersService Map<String,Object> returns to typed returns#18234
Open
ruanwenjun wants to merge 1 commit intoapache:devapache/dolphinscheduler:devfrom
ruanwenjun:chore/api-users-service-typed-returnsruanwenjun/dolphinscheduler:chore/api-users-service-typed-returnsCopy head branch name to clipboard
Open
[Improvement-18224][API] Migrate UsersService Map<String,Object> returns to typed returns#18234ruanwenjun wants to merge 1 commit intoapache:devapache/dolphinscheduler:devfrom ruanwenjun:chore/api-users-service-typed-returnsruanwenjun/dolphinscheduler:chore/api-users-service-typed-returnsCopy head branch name to clipboard
ruanwenjun wants to merge 1 commit intoapache:devapache/dolphinscheduler:devfrom
ruanwenjun:chore/api-users-service-typed-returnsruanwenjun/dolphinscheduler:chore/api-users-service-typed-returnsCopy head branch name to clipboard
Conversation
…rns to typed returns
Refactor 17 UsersService methods that returned Map<String, Object> to
typed returns / void with ServiceException, mirroring the pattern
established by EnvironmentService.
Methods migrated:
- createUser(8 args) -> User
- deleteUserById -> void
- grantProject / grantProjectWithReadPerm / grantProjectByCode -> void
- revokeProject / revokeProjectById -> void
- grantNamespaces / grantDataSource -> void
- getUserInfo -> User (tenantCode / alertGroup / timeZone populated, password stripped)
- queryAllGeneralUsers / queryUserList(User) -> List<User>
- unauthorizedUser / authorizedUser -> List<User>
- registerUser / activateUser -> User
- batchActivateUser -> Map<String, Object> (kept Map; nested success/failed
buckets keep wire field names byte-for-byte)
batchActivateUser switches its inner loop to a try/catch around
activateUser since activateUser now throws ServiceException; the wire
shape (success.{sum, userName} / failed.{sum, info}) is unchanged.
UsersController forwards typed values via Result.success and the
authorizedUser endpoint drops its bespoke try/catch since
ApiException + ApiExceptionHandler now provide the equivalent fallback.
PythonGateway.deleteUser already discarded the return value, so the
void return causes no Py4J impact. The other Py4J / SSO callers all
use the already-typed createUser overloads.
Full module test suite: 682 tests, 0 failures.
|
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
1 participant
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
Refactor 17 UsersService methods that returned Map<String, Object> to typed returns / void with ServiceException, mirroring the pattern established by EnvironmentService.
Methods migrated:
batchActivateUser switches its inner loop to a try/catch around activateUser since activateUser now throws ServiceException; the wire shape (success.{sum, userName} / failed.{sum, info}) is unchanged.
UsersController forwards typed values via Result.success and the authorizedUser endpoint drops its bespoke try/catch since ApiException + ApiExceptionHandler now provide the equivalent fallback.
PythonGateway.deleteUser already discarded the return value, so the void return causes no Py4J impact. The other Py4J / SSO callers all use the already-typed createUser overloads.
Full module test suite: 682 tests, 0 failures.
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