feat: build admin lock/unlock account flow #171

UditThakkar · 2025-04-02T15:51:47Z

This pull request introduces a new REST API endpoint /admin/toggleLockStatus that allows adminsto toggle the lock status of a user account.

Key changes include:

Creation of the toggleLockStatus POST endpoint under the /admin path.
Implementation of the endpoint to receive a LockAccountDto containing the user's email.
Integration with the UserService to perform the logic of toggling the account lock status.
Implementation of input validation for the LockAccountDto to ensure the email is provided.
Implementation of proper error handling for scenarios such as user not found and invalid input, returning appropriate HTTP status codes and JSON responses.

Link to the issue: #32

feat: added test cases

Copilot

Pull Request Overview

This pull request implements a new admin endpoint to toggle the lock status of a user account. Key changes include adding a new LockAccountDto and related test support classes, integrating the lock toggle functionality into UserService and AdminApi, and updating security configuration to include a custom authentication failure handler.

Reviewed Changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/test/java/com/digitalsanctuary/spring/user/api/provider/holder/ApiTestArgumentsHolder.java	Added support for LockAccountDto in API test arguments.
src/test/java/com/digitalsanctuary/spring/user/api/provider/ApiTestLockAccountArgumentsProvider.java	Provided new test cases for lock account flow.
src/test/java/com/digitalsanctuary/spring/user/api/data/DataStatus.java	Extended DataStatus enum with NOT_FOUND status.
src/test/java/com/digitalsanctuary/spring/user/api/data/ApiTestData.java	Added new methods for lock account test responses.
src/test/java/com/digitalsanctuary/spring/user/api/AdminApiTest.java	Introduced tests for toggle lock status but with an endpoint mismatch.
src/main/java/com/digitalsanctuary/spring/user/util/ResponseUtil.java	Created utility methods for error and success JSON responses.
src/main/java/com/digitalsanctuary/spring/user/service/UserService.java	Implemented the toggleLockStatus method for toggling user lock state.
src/main/java/com/digitalsanctuary/spring/user/security/*	Updated security configuration and failure handling.
src/main/java/com/digitalsanctuary/spring/user/api/AdminApi.java	Added a new admin endpoint for toggling user lock status.

Copilot · 2025-04-02T18:21:42Z

src/test/java/com/digitalsanctuary/spring/user/api/data/ApiTestData.java

+                new String[]{"Account Locked"}, null
+        );
+    }
+    public static Response lockAccountFailry() {


The method name 'lockAccountFailry' appears to be misspelled. Consider renaming it to 'lockAccountFailure' for clarity.

Copilot · 2025-04-02T18:21:42Z

src/test/java/com/digitalsanctuary/spring/user/api/AdminApiTest.java

+    @ParameterizedTest
+    @ArgumentsSource(ApiTestLockAccountArgumentsProvider.class)
+    public void toggleLockStatusOfUser(ApiTestArgumentsHolder argumentsHolder) throws Exception {
+        ResultActions action = perform(MockMvcRequestBuilders.post(URL + "/lock").contentType(MediaType.APPLICATION_FORM_URLENCODED)


The test is calling the '/lock' endpoint but the implemented endpoint is '/toggleLockStatus'. Update the test to use the correct endpoint.

Suggested change

ResultActions action = perform(MockMvcRequestBuilders.post(URL + "/lock").contentType(MediaType.APPLICATION_FORM_URLENCODED)

ResultActions action = perform(MockMvcRequestBuilders.post(URL + "/toggleLockStatus").contentType(MediaType.APPLICATION_FORM_URLENCODED)

devondragon · 2025-04-02T18:35:16Z

High level comment: I don't love the lock API or service methods being toggles. I think there should be lockAccount and unlockAccount. I shouldn't have to query the current value, and then call the API to change it, hoping it hasn't changed in the mean time. I should be able to have largely idempotent clear actions.

UditThakkar · 2025-04-02T19:35:13Z

High level comment: I don't love the lock API or service methods being toggles. I think there should be lockAccount and unlockAccount. I shouldn't have to query the current value, and then call the API to change it, hoping it hasn't changed in the mean time. I should be able to have largely idempotent clear actions.

Thanks for the feedback! That makes sense I actually worked on a project where we had a similar feature with a "Lock Access" toggle in the admin panel. I see the benefit of having separate endpoints for clarity and idempotency. I’ll update the API to include distinct lockAccount and unlockAccount endpoints.

UditThakkar · 2025-04-02T20:01:45Z

I have updated the code, please help to check @devondragon

Copilot

Copilot reviewed 12 out of 12 changed files in this pull request and generated 4 comments.

Copilot · 2025-04-03T21:49:16Z

...va/com/digitalsanctuary/spring/user/api/provider/ApiTestAccountLockingArgumentsProvider.java

+            new ApiTestArgumentsHolder(
+                    ApiTestData.getEmptyLockAccountDto(),
+                    DataStatus.INVALID,
+                    ApiTestData.invalidBodyLockAccountFailry()


Consider correcting the spelling 'Failry' to 'Failure' in the method call 'invalidBodyLockAccountFailry()'.

Suggested change

ApiTestData.invalidBodyLockAccountFailry()

ApiTestData.invalidBodyLockAccountFailure()

Copilot · 2025-04-03T21:49:17Z

src/test/java/com/digitalsanctuary/spring/user/api/data/ApiTestData.java

+                new String[]{"Account Locked"}, null
+        );
+    }
+    public static Response lockAccountFailry() {


Consider correcting the spelling 'Failry' to 'Failure' in 'lockAccountFailry()'.

Copilot · 2025-04-03T21:49:17Z

src/test/java/com/digitalsanctuary/spring/user/api/data/ApiTestData.java

+                new String[]{"User not found"}, null
+        );
+    }
+    public static Response invalidBodyLockAccountFailry() {


Consider correcting the spelling 'Failry' to 'Failure' in 'invalidBodyLockAccountFailry()'.

src/test/java/com/digitalsanctuary/spring/user/api/AdminApiTest.java

…t.java Co-authored-by: Copilot <[email protected]>

feat: build admin lock account flow

40a3c9a

feat: added test cases

UditThakkar requested a review from devondragon April 2, 2025 15:51

UditThakkar mentioned this pull request Apr 2, 2025

Build Admin Lock Account Flow #32

Open

UditThakkar linked an issue Apr 2, 2025 that may be closed by this pull request

Build Admin Lock Account Flow #32

Open

UditThakkar changed the title ~~feat: build admin lock account flow~~ feat: build admin lock/unlock account flow Apr 2, 2025

devondragon requested a review from Copilot April 2, 2025 18:20

devondragon added the enhancement New feature or request label Apr 2, 2025

devondragon self-assigned this Apr 2, 2025

Copilot AI reviewed Apr 2, 2025

View reviewed changes

feat: refactored code and addressed comments

fd9607e

devondragon requested a review from Copilot April 3, 2025 21:47

Copilot AI reviewed Apr 3, 2025

View reviewed changes

Repository owner deleted a comment from Copilot bot Apr 3, 2025

Update src/test/java/com/digitalsanctuary/spring/user/api/AdminApiTes…

d6c813a

…t.java Co-authored-by: Copilot <[email protected]>

devondragon merged commit 3eb7801 into devondragon:issue-32-Build-Admin-Lock-Account-Flow Apr 3, 2025

UditThakkar mentioned this pull request Apr 5, 2025

fix: updated test cases #172

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: build admin lock/unlock account flow #171

feat: build admin lock/unlock account flow #171

UditThakkar commented Apr 2, 2025 •

edited

Loading

Copilot AI left a comment

Copilot AI Apr 2, 2025

Copilot AI Apr 2, 2025

devondragon commented Apr 2, 2025

UditThakkar commented Apr 2, 2025

UditThakkar commented Apr 2, 2025

Copilot AI left a comment

Copilot AI Apr 3, 2025

Copilot AI Apr 3, 2025

Copilot AI Apr 3, 2025

	ResultActions action = perform(MockMvcRequestBuilders.post(URL + "/lock").contentType(MediaType.APPLICATION_FORM_URLENCODED)
	ResultActions action = perform(MockMvcRequestBuilders.post(URL + "/toggleLockStatus").contentType(MediaType.APPLICATION_FORM_URLENCODED)

	ApiTestData.invalidBodyLockAccountFailry()
	ApiTestData.invalidBodyLockAccountFailure()

feat: build admin lock/unlock account flow #171

feat: build admin lock/unlock account flow #171

Conversation

UditThakkar commented Apr 2, 2025 • edited Loading

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Copilot AI Apr 2, 2025

Choose a reason for hiding this comment

Copilot AI Apr 2, 2025

Choose a reason for hiding this comment

devondragon commented Apr 2, 2025

UditThakkar commented Apr 2, 2025

UditThakkar commented Apr 2, 2025

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot AI Apr 3, 2025

Choose a reason for hiding this comment

Copilot AI Apr 3, 2025

Choose a reason for hiding this comment

Copilot AI Apr 3, 2025

Choose a reason for hiding this comment

UditThakkar commented Apr 2, 2025 •

edited

Loading