CIRC-2364 Anonymize Single Request Post API by yuntianhu · Pull Request #1632 · folio-org/mod-circulation

yuntianhu · 2025-11-12T20:05:51Z

CIRC-2364-Anonymize Single Request Post API #1632

Ticket Description

Purpose/Overview:
Create a /request-anonymization/{request UUID} Post API for anonymizing one a single closed request

Requirements/Scope:

Verify that the user has the UI-Requests Request-Anonymize Single Execute capability

Anonymizes request as described in https://folio-org.atlassian.net/browse/CIRC-2292

Returns an error message if anonymization fails

Acceptance Criteria:

Post API for single request anonymization by UUID is created

Summary of Work Completed for Request Anonymization (CIRC-2364 / CIRC-2292)

I implemented backend support for manual single-request anonymization in mod-circulation, including all core API logic, data scrubbing, integration with storage, permissions, event publishing, and automated tests. This work completes a brand-new FOLIO circulation feature.

Added the new backend API endpoint POST /request-anonymization/{requestId}
Implemented full service logic including ID validation, request fetching, status validation, PII scrubbing, persistence, and event publishing.
Implemented scrubbing of requesterId, proxyUserId, requester, proxy, and delivery address fields.
Integrated updates with requestRepository and eventPublisher.
Created comprehensive tests for the anonymization workflow.
Corrected ModuleDescriptor-template.json structure and permissions.
Added new permission capability for anonymization operations.
Verified PubSub integration through LOG_RECORD audit events.

Approach for Single Request Anonymization

Introduced dedicated service layer with validation, scrub PII, update and publish logging
Designed for future dependency injection
Added new API endpoint
Capability set / permission work
Test suite creation
Debugging & stability work
Architectural alignment

Create a /request-anonymization/{request UUID} Post API for anonymizing one a single closed request Requirements/Scope: Verify that the user has the UI-Requests Request-Anonymize Single Execute capability Anonymizes request as described in https://folio-org.atlassian.net/browse/CIRC-2292 Returns an error message if anonymization fails Acceptance Criteria: Post API for single request anonymization by UUID is created

…ate wiring, update tests.

descriptors/ModuleDescriptor-template.json

src/main/java/org/folio/circulation/infrastructure/storage/requests/RequestRepository.java

src/main/java/org/folio/circulation/resources/RequestAnonymizationResource.java

src/main/java/org/folio/circulation/services/EventPublisher.java

src/main/java/org/folio/circulation/services/RequestAnonymizationService.java

src/test/java/api/requests/RequestAnonymizationApiTests.java

src/test/java/org/folio/circulation/domain/anonymization/AnonymizeRequestTests.java

longvo-cv

LGTM! Solid implementation

descriptors/ModuleDescriptor-template.json

src/main/java/org/folio/circulation/resources/RequestAnonymizationResource.java

src/main/java/org/folio/circulation/services/RequestAnonymizationService.java

src/test/java/api/requests/RequestAnonymizationServiceTest.java

src/test/java/api/requests/RequestAnonymizationApiTests.java

src/test/java/api/requests/RequestAnonymizationServiceTest.java

OleksandrVidinieiev · 2025-11-20T15:30:39Z

@yuntianhu In the future, please mention Jira ticket name in your commit messages: CIRC-2364 My awesome commit message. And when you are ready to merge your PR, please use "Squash and merge" button instead of "Create a merge commit". This makes future release process much easier.

yuntianhu · 2025-11-20T15:39:48Z

@OleksandrVidinieiev Thank you for the reminder, I will surely remember to do it 😄

- Add permissionsRequired and modulePermissions for /request-anonymization/{requestId} handler in ModuleDescriptor-template.json - Use UuidUtil.isUuid in RequestAnonymizationService and return failed validation when requestId is invalid - Simplify fetchRequest to delegate to requestRepository.getById without extra failWhen logic - Change scrubPii to return Request instead of Result and call it via mapResult - Simplify publishLog to return Result<Void> from eventPublisher without remapping - Fix Result chain to use flatMapResult for validateStatus and after(...) for async update/log - Remove unused validationError helper that relied on old ValidationError constructor - Update RequestAnonymizationServiceTest to inject mocks via constructor (remove reflection) - Adjust not-found test to return failed RecordNotFoundFailure instead of succeeded(null) - Reorder imports in tests to follow mod-circulation import order convention

remove a unused line

descriptors/ModuleDescriptor-template.json

src/main/java/org/folio/circulation/services/RequestAnonymizationService.java

src/test/java/api/requests/RequestAnonymizationServiceTest.java

descriptors/ModuleDescriptor-template.json

ramls/schema/anonymize-single-request-response.json

src/main/java/org/folio/circulation/services/EventPublisher.java

Fix displayName/description wording: "anonymize request" instead of "anonymize requests". Update permission name to modperms.circulation.requests.anonymize.single. Remove redundant modulePermission already included in anonymize.single. Inline RequestRepository.using(...) initializer into single line. Condense ValidationErrorFailure.failedValidation(...) into one line. Add UUID format validation to requestId in anonymize-single-request-response.json. Remove extra spacing alignment in EventPublisher .put() calls. Replace wildcard imports in RequestAnonymizationServiceTest with explicit imports. Reorder imports to follow mod-circulation import convention. Adjust permission naming to follow FOLIO scope convention (item vs collection).

sonarqubecloud · 2025-11-24T15:59:49Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
86.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

yuntianhu added 7 commits November 12, 2025 13:58

clean the request-anonymization.raml

424fb3e

add description to anonymize-single-request-response.json

3424f23

Merge branch 'master' into CIRC-2364

820bc28

solve issues and increase test coverage

b1eea2e

solve issues and increase test coverage

9041de9

update RequestAnonymizationResource, RequestAnonymizationService, upd…

8a45dfe

…ate wiring, update tests.

yuntianhu requested review from a team, alexanderkurash and longvo-cv November 14, 2025 15:48

yuntianhu added 2 commits November 17, 2025 10:39

tidy up the code and remove duplicates and unused codes

c7d91f9

remove the unused method parameter. edit permission.

6d69952

yuntianhu changed the title ~~CIRC 2364-Anonymize Single Request Post API~~ CIRC-2364-Anonymize Single Request Post API Nov 17, 2025

roman-barannyk reviewed Nov 18, 2025

View reviewed changes

yuntianhu added 3 commits November 18, 2025 11:09

code corrections according to code review

77b8b8e

delete extra space

8da0432

cla: retry signature

435fffd

yuntianhu requested review from a team and roman-barannyk November 18, 2025 17:33

remove unused local variable.

257cced

longvo-cv approved these changes Nov 19, 2025

View reviewed changes

OleksandrVidinieiev requested changes Nov 20, 2025

View reviewed changes

yuntianhu requested a review from OleksandrVidinieiev November 21, 2025 15:12

CIRC-2364-Anonymize Single Request Post API

7fe7644

remove a unused line

yuntianhu requested a review from a team November 21, 2025 15:46

OleksandrVidinieiev reviewed Nov 24, 2025

View reviewed changes

OleksandrVidinieiev approved these changes Nov 24, 2025

View reviewed changes

alexanderkurash reviewed Nov 24, 2025

View reviewed changes

descriptors/ModuleDescriptor-template.json Outdated Show resolved Hide resolved

ramls/schema/anonymize-single-request-response.json Show resolved Hide resolved

src/main/java/org/folio/circulation/services/EventPublisher.java Outdated Show resolved Hide resolved

yuntianhu requested a review from alexanderkurash November 24, 2025 16:02

alexanderkurash changed the title ~~CIRC-2364-Anonymize Single Request Post API~~ CIRC-2364 Anonymize Single Request Post API Nov 24, 2025

alexanderkurash approved these changes Nov 24, 2025

View reviewed changes

yuntianhu merged commit 23a0ace into master Nov 24, 2025
8 checks passed

yuntianhu deleted the CIRC-2364 branch December 8, 2025 15:09

Conversation

yuntianhu commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CIRC-2364-Anonymize Single Request Post API #1632

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

longvo-cv left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

OleksandrVidinieiev commented Nov 20, 2025

Uh oh!

yuntianhu commented Nov 20, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Nov 24, 2025

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

yuntianhu commented Nov 12, 2025 •

edited

Loading