[SELC-7128] feat: add new API checkUser (#269)

giulia-tremolada · web-flow · commit 6dc4301dd918 · 2025-06-05T17:57:12.000+02:00
diff --git a/apps/user-ms/src/main/docs/openapi.json b/apps/user-ms/src/main/docs/openapi.json
@@ -164,6 +164,93 @@
         } ]
       }
     },
+    "/institutions/{institutionId}/product/{productId}/check-user" : {
+      "post" : {
+        "tags" : [ "Institution" ],
+        "summary" : "Verify if a user is already onboarded on an institution and product given its fiscal code",
+        "description" : "Verify if a user is already onboarded on an institution and product given its fiscal code",
+        "operationId" : "checkUserUsingPOST",
+        "parameters" : [ {
+          "name" : "institutionId",
+          "in" : "path",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "name" : "productId",
+          "in" : "path",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/SearchUserDto"
+              }
+            }
+          }
+        },
+        "responses" : {
+          "200" : {
+            "description" : "OK",
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "type" : "boolean"
+                }
+              }
+            }
+          },
+          "400" : {
+            "description" : "Bad Request",
+            "content" : {
+              "application/problem+json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/Problem"
+                }
+              }
+            }
+          },
+          "401" : {
+            "description" : "Not Authorized",
+            "content" : {
+              "application/problem+json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/Problem"
+                }
+              }
+            }
+          },
+          "403" : {
+            "description" : "Forbidden",
+            "content" : {
+              "application/problem+json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/Problem"
+                }
+              }
+            }
+          },
+          "404" : {
+            "description" : "Not Found",
+            "content" : {
+              "application/problem+json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/Problem"
+                }
+              }
+            }
+          }
+        },
+        "security" : [ {
+          "SecurityScheme" : [ ]
+        } ]
+      }
+    },
     "/institutions/{institutionId}/products/{productId}/created-at" : {
       "put" : {
         "tags" : [ "Institution" ],
diff --git a/apps/user-ms/src/main/docs/openapi.yaml b/apps/user-ms/src/main/docs/openapi.yaml
@@ -118,6 +118,64 @@ paths:
           description: Not Allowed
       security:
       - SecurityScheme: []
+  /institutions/{institutionId}/product/{productId}/check-user:
+    post:
+      tags:
+      - Institution
+      summary: Verify if a user is already onboarded on an institution and product
+        given its fiscal code
+      description: Verify if a user is already onboarded on an institution and product
+        given its fiscal code
+      operationId: checkUserUsingPOST
+      parameters:
+      - name: institutionId
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: productId
+        in: path
+        required: true
+        schema:
+          type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/SearchUserDto"
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: boolean
+        "400":
+          description: Bad Request
+          content:
+            application/problem+json:
+              schema:
+                $ref: "#/components/schemas/Problem"
+        "401":
+          description: Not Authorized
+          content:
+            application/problem+json:
+              schema:
+                $ref: "#/components/schemas/Problem"
+        "403":
+          description: Forbidden
+          content:
+            application/problem+json:
+              schema:
+                $ref: "#/components/schemas/Problem"
+        "404":
+          description: Not Found
+          content:
+            application/problem+json:
+              schema:
+                $ref: "#/components/schemas/Problem"
+      security:
+      - SecurityScheme: []
   /institutions/{institutionId}/products/{productId}/created-at:
     put:
       tags:
diff --git a/apps/user-ms/src/main/java/it/pagopa/selfcare/user/controller/InstitutionController.java b/apps/user-ms/src/main/java/it/pagopa/selfcare/user/controller/InstitutionController.java
@@ -9,6 +9,7 @@
 import it.pagopa.selfcare.user.controller.response.UserInstitutionResponse;
 import it.pagopa.selfcare.user.controller.response.UserProductResponse;
 import it.pagopa.selfcare.user.controller.response.UsersCountResponse;
+import it.pagopa.selfcare.user.controller.response.product.SearchUserDto;
 import it.pagopa.selfcare.user.model.constants.OnboardedProductState;
 import it.pagopa.selfcare.user.service.UserService;
 import it.pagopa.selfcare.user.util.GeneralUtils;
@@ -145,4 +146,25 @@ public Uni<DeletedUserCountResponse> deleteUserInstitutionProductUsers(@PathPara
                         productId.replaceAll("[^a-zA-Z0-9-_]", ""));
     }
 
+    @Operation(
+            summary = "Verify if a user is already onboarded on an institution and product given its fiscal code",
+            operationId = "checkUserUsingPOST",
+            description = "Verify if a user is already onboarded on an institution and product given its fiscal code"
+    )
+    @APIResponses(value = {
+            @APIResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = Boolean.class), mediaType = "application/json")),
+            @APIResponse(responseCode = "400", description = "Bad Request", content = @Content(schema = @Schema(implementation = Problem.class), mediaType = "application/problem+json")),
+            @APIResponse(responseCode = "401", description = "Not Authorized", content = @Content(schema = @Schema(implementation = Problem.class), mediaType = "application/problem+json")),
+            @APIResponse(responseCode = "403", description = "Forbidden", content = @Content(schema = @Schema(implementation = Problem.class), mediaType = "application/problem+json")),
+            @APIResponse(responseCode = "404", description = "Not Found", content = @Content(schema = @Schema(implementation = Problem.class), mediaType = "application/problem+json"))
+    })
+    @POST
+    @Path(value = "/{institutionId}/product/{productId}/check-user")
+    @Produces(MediaType.APPLICATION_JSON)
+    public Uni<Boolean> checkUser(@PathParam(value = "institutionId") String institutionId,
+                                  @PathParam(value = "productId") String productId,
+                                  @Valid SearchUserDto searchUserDto) {
+        return userService.checkUser(searchUserDto.getFiscalCode(), institutionId, productId);
+    }
+
 }
diff --git a/apps/user-ms/src/main/java/it/pagopa/selfcare/user/controller/response/product/SearchUserDto.java b/apps/user-ms/src/main/java/it/pagopa/selfcare/user/controller/response/product/SearchUserDto.java
@@ -1,17 +1,16 @@
 package it.pagopa.selfcare.user.controller.response.product;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
+import jakarta.validation.constraints.NotNull;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
-import javax.validation.constraints.NotNull;
-
 @AllArgsConstructor
 @NoArgsConstructor
 @Getter
 public class SearchUserDto {
     @JsonProperty(required = true)
-    @NotNull
+    @NotNull(message = "Fiscal code is required")
     private String fiscalCode;
 }
diff --git a/apps/user-ms/src/main/java/it/pagopa/selfcare/user/service/UserInstitutionService.java b/apps/user-ms/src/main/java/it/pagopa/selfcare/user/service/UserInstitutionService.java
@@ -45,7 +45,7 @@ public interface UserInstitutionService {
 
     Uni<UserInstitution> persistOrUpdate(UserInstitution userInstitution);
 
-    Uni<Boolean> existsValidUserProduct(String userId, String institutionId, String productId, PermissionTypeEnum permission);
+    Uni<Boolean> existsValidUserProduct(String userId, String institutionId, String productId, PermissionTypeEnum permission, List<OnboardedProductState> status);
 
     Uni<Long> updateInstitutionDescription(String institutionId, UpdateDescriptionDto updateDescriptionDto);
 
diff --git a/apps/user-ms/src/main/java/it/pagopa/selfcare/user/service/UserInstitutionServiceDefault.java b/apps/user-ms/src/main/java/it/pagopa/selfcare/user/service/UserInstitutionServiceDefault.java
@@ -240,10 +240,10 @@ public Uni<UserInstitution> persistOrUpdate(UserInstitution userInstitution) {
     }
 
     @Override
-    public Uni<Boolean> existsValidUserProduct(String userId, String institutionId, String productId, PermissionTypeEnum permission) {
+    public Uni<Boolean> existsValidUserProduct(String userId, String institutionId, String productId, PermissionTypeEnum permission, List<OnboardedProductState> status) {
 
         Map<String, Object> userInstitutionFilterMap = UserInstitutionFilter.builder().userId(userId).institutionId(institutionId).build().constructMap();
-        OnboardedProductFilter.OnboardedProductFilterBuilder builder = OnboardedProductFilter.builder().productId(productId).status(List.of(ACTIVE, PENDING, TOBEVALIDATED));
+        OnboardedProductFilter.OnboardedProductFilterBuilder builder = OnboardedProductFilter.builder().productId(productId).status(status);
         if (permission.equals(PermissionTypeEnum.ADMIN)) {
             builder.role(SelfCareRole.fromSelfCareAuthority(permission.name()));
         }
diff --git a/apps/user-ms/src/main/java/it/pagopa/selfcare/user/service/UserPermissionServiceImpl.java b/apps/user-ms/src/main/java/it/pagopa/selfcare/user/service/UserPermissionServiceImpl.java
@@ -6,6 +6,10 @@
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 
+import java.util.List;
+
+import static it.pagopa.selfcare.user.model.constants.OnboardedProductState.*;
+
 @Slf4j
 @ApplicationScoped
 @RequiredArgsConstructor
@@ -18,6 +22,6 @@ public Uni<Boolean> hasPermission(String institutionId, String productId, Permis
         log.trace("hasPermission start");
         log.debug("check permission {} for userId: {}, institutionId: {} and productId: {}", permission, userId, institutionId, productId);
 
-        return userInstitutionService.existsValidUserProduct(userId, institutionId, productId, permission);
+        return userInstitutionService.existsValidUserProduct(userId, institutionId, productId, permission, List.of(ACTIVE, PENDING, TOBEVALIDATED));
     }
 }
diff --git a/apps/user-ms/src/main/java/it/pagopa/selfcare/user/service/UserService.java b/apps/user-ms/src/main/java/it/pagopa/selfcare/user/service/UserService.java
@@ -63,4 +63,6 @@ public interface UserService {
     Uni<UserInstitutionWithActions> getUserInstitutionWithPermission(String userId, String institutionId, String productId);
 
     Uni<UsersCountResponse> getUsersCount(String institutionId, String productId, List<PartyRole> roles, List<OnboardedProductState> status);
+
+    Uni<Boolean> checkUser(String fiscalCode, String institutionId, String productId);
 }
diff --git a/apps/user-ms/src/main/java/it/pagopa/selfcare/user/service/UserServiceImpl.java b/apps/user-ms/src/main/java/it/pagopa/selfcare/user/service/UserServiceImpl.java
@@ -7,6 +7,7 @@
 import it.pagopa.selfcare.onboarding.common.PartyRole;
 import it.pagopa.selfcare.product.entity.Product;
 import it.pagopa.selfcare.product.service.ProductService;
+import it.pagopa.selfcare.user.constant.PermissionTypeEnum;
 import it.pagopa.selfcare.user.controller.request.AddUserRoleDto;
 import it.pagopa.selfcare.user.controller.request.CreateUserDto;
 import it.pagopa.selfcare.user.controller.request.UpdateDescriptionDto;
@@ -34,6 +35,7 @@
 import it.pagopa.selfcare.user.util.ActionMapRetriever;
 import it.pagopa.selfcare.user.util.UserUtils;
 import jakarta.enterprise.context.ApplicationScoped;
+import jakarta.ws.rs.WebApplicationException;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
@@ -85,13 +87,10 @@ public class UserServiceImpl implements UserService {
     private final ActionMapRetriever actionMapRetriever;
 
     Supplier<String> randomMailId = () -> (MAIL_ID_PREFIX + UUID.randomUUID());
-
     private static final String WORK_CONTACTS = "workContacts";
-
     static final String USERS_WORKS_FIELD_LIST = "fiscalCode,familyName,email,name,workContacts";
-
     public static final String USERS_FIELD_LIST_WITHOUT_FISCAL_CODE = "name,familyName,email,workContacts";
-
+    public static final String USER_FIELD_LIST_WITHOUT_WORK_CONTACTS = "name,familyName,fiscalCode";
     private static final String USER_INSTITUTION_FOUNDED = "UserInstitution with userId: {} and institutionId: {} founded";
     private static final String USER_INSTITUTION_NOT_FOUND = "UserInstitution with userId: {} and institutionId: {} not found";
 
@@ -853,4 +852,22 @@ public Uni<UsersCountResponse> getUsersCount(String institutionId, String produc
                 .onItem().transform(count -> new UsersCountResponse(institutionId, productId, roleList, statusList, count));
     }
 
+    @Override
+    public Uni<Boolean> checkUser(String fiscalCode, String institutionId, String productId) {
+        return userRegistryService.searchUsingPOST(USER_FIELD_LIST_WITHOUT_WORK_CONTACTS, new UserSearchDto(fiscalCode))
+                .flatMap(user -> userInstitutionService.existsValidUserProduct(
+                        user.getId().toString(),
+                        institutionId,
+                        productId,
+                        PermissionTypeEnum.ANY,
+                        List.of(ACTIVE,SUSPENDED)
+                ))
+                .onFailure(this::isNotFound)
+                .recoverWithItem(false);
+    }
+
+    private boolean isNotFound(Throwable throwable) {
+        return ((WebApplicationException) throwable).getResponse().getStatus() == 404;
+    }
+
 }
diff --git a/apps/user-ms/src/test/java/it/pagopa/selfcare/user/controller/InstitutionControllerTest.java b/apps/user-ms/src/test/java/it/pagopa/selfcare/user/controller/InstitutionControllerTest.java
@@ -13,6 +13,7 @@
 import it.pagopa.selfcare.user.controller.response.UserInstitutionResponse;
 import it.pagopa.selfcare.user.controller.response.UserProductResponse;
 import it.pagopa.selfcare.user.controller.response.UsersCountResponse;
+import it.pagopa.selfcare.user.controller.response.product.SearchUserDto;
 import it.pagopa.selfcare.user.exception.ResourceNotFoundException;
 import it.pagopa.selfcare.user.model.constants.OnboardedProductState;
 import it.pagopa.selfcare.user.service.UserService;
@@ -286,4 +287,42 @@ void deleteUserInstitutionProductUsers_NotAuthorized() {
                 .statusCode(401);
     }
 
+    @Test
+    @TestSecurity(user = "userJwt")
+    void checkUser() {
+        final String fiscalCode = "fiscalCode";
+        final String institutionId = "institutionId";
+        final String productId = "productId";
+
+        Mockito.when(userService.checkUser(fiscalCode, institutionId, productId))
+                .thenReturn(Uni.createFrom().item(Boolean.TRUE));
+
+        given()
+                .when()
+                .contentType(ContentType.JSON)
+                .pathParam("institutionId", institutionId)
+                .pathParam("productId", productId)
+                .body(new SearchUserDto(fiscalCode))
+                .post("/{institutionId}/product/{productId}/check-user")
+                .then()
+                .statusCode(200);
+    }
+
+    @Test
+    void checkUser_NotAuthorized() {
+        final String fiscalCode = "fiscalCode";
+        final String institutionId = "institutionId";
+        final String productId = "productId";
+
+        given()
+                .when()
+                .contentType(ContentType.JSON)
+                .pathParam("institutionId", institutionId)
+                .pathParam("productId", productId)
+                .body(new SearchUserDto(fiscalCode))
+                .post("/{institutionId}/product/{productId}/check-user")
+                .then()
+                .statusCode(401);
+    }
+
 }
diff --git a/apps/user-ms/src/test/java/it/pagopa/selfcare/user/service/UserInstitutionServiceTest.java b/apps/user-ms/src/test/java/it/pagopa/selfcare/user/service/UserInstitutionServiceTest.java
diff --git a/apps/user-ms/src/test/java/it/pagopa/selfcare/user/service/UserPermissionServiceImplTest.java b/apps/user-ms/src/test/java/it/pagopa/selfcare/user/service/UserPermissionServiceImplTest.java
diff --git a/apps/user-ms/src/test/java/it/pagopa/selfcare/user/service/UserServiceTest.java b/apps/user-ms/src/test/java/it/pagopa/selfcare/user/service/UserServiceTest.java
diff --git a/apps/user-ms/src/test/resources/features/institution.feature b/apps/user-ms/src/test/resources/features/institution.feature
diff --git a/apps/user-ms/src/test/resources/mock/user-registry-api.json b/apps/user-ms/src/test/resources/mock/user-registry-api.json

Original file line number	Diff line number	Diff line change
`@@ -240,10 +240,10 @@ public Uni<UserInstitution> persistOrUpdate(UserInstitution userInstitution) {`
`240`	`240`	`}`
`241`	`241`
`242`	`242`	`@Override`
`243`		`- public Uni<Boolean> existsValidUserProduct(String userId, String institutionId, String productId, PermissionTypeEnum permission) {`
	`243`	`+ public Uni<Boolean> existsValidUserProduct(String userId, String institutionId, String productId, PermissionTypeEnum permission, List<OnboardedProductState> status) {`
`244`	`244`
`245`	`245`	`Map<String, Object> userInstitutionFilterMap = UserInstitutionFilter.builder().userId(userId).institutionId(institutionId).build().constructMap();`
`246`		`- OnboardedProductFilter.OnboardedProductFilterBuilder builder = OnboardedProductFilter.builder().productId(productId).status(List.of(ACTIVE, PENDING, TOBEVALIDATED));`
	`246`	`+ OnboardedProductFilter.OnboardedProductFilterBuilder builder = OnboardedProductFilter.builder().productId(productId).status(status);`
`247`	`247`	`if (permission.equals(PermissionTypeEnum.ADMIN)) {`
`248`	`248`	`builder.role(SelfCareRole.fromSelfCareAuthority(permission.name()));`
`249`	`249`	`}`
Original file line number	Diff line number	Diff line change
`@@ -63,4 +63,6 @@ public interface UserService {`
`63`	`63`	`Uni<UserInstitutionWithActions> getUserInstitutionWithPermission(String userId, String institutionId, String productId);`
`64`	`64`
`65`	`65`	`Uni<UsersCountResponse> getUsersCount(String institutionId, String productId, List<PartyRole> roles, List<OnboardedProductState> status);`
	`66`	`+`
	`67`	`+ Uni<Boolean> checkUser(String fiscalCode, String institutionId, String productId);`
`66`	`68`	`}`