fix: delete useless DisplayRolesOnUi annotation (#178)

InseeFr · Dec 5, 2023 · 6a366bf · 6a366bf
1 parent 28d35eb
commit 6a366bf
Show file tree

Hide file tree

Showing 19 changed files with 92 additions and 71 deletions.
diff --git a/src/main/java/fr/insee/queen/api/campaign/controller/CampaignController.java b/src/main/java/fr/insee/queen/api/campaign/controller/CampaignController.java
@@ -5,7 +5,6 @@
 import fr.insee.queen.api.campaign.service.CampaignService;
 import fr.insee.queen.api.campaign.service.exception.CampaignDeletionException;
 import fr.insee.queen.api.configuration.auth.AuthorityRole;
-import fr.insee.queen.api.configuration.swagger.role.DisplayRolesOnUI;
 import fr.insee.queen.api.pilotage.controller.PilotageComponent;
 import fr.insee.queen.api.web.authentication.AuthenticationHelper;
 import fr.insee.queen.api.web.validation.IdValid;
@@ -42,7 +41,6 @@ public class CampaignController {
      */
     @Operation(summary = "Get list of all campaigns")
     @GetMapping(path = "/admin/campaigns")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ADMIN_PRIVILEGES)
     public List<CampaignSummaryDto> getListCampaign() {
         String userId = authHelper.getUserId();
@@ -59,7 +57,6 @@ public List<CampaignSummaryDto> getListCampaign() {
      */
     @Operation(summary = "Create a campaign")
     @PostMapping(path = "/campaigns")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ADMIN_PRIVILEGES)
     @ResponseStatus(HttpStatus.CREATED)
     public void createCampaign(@Valid @RequestBody CampaignCreationData campaignInputDto) {
@@ -78,7 +75,6 @@ public void createCampaign(@Valid @RequestBody CampaignCreationData campaignInpu
      */
     @Operation(summary = "Delete a campaign")
     @DeleteMapping(path = "/campaign/{id}")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ADMIN_PRIVILEGES)
     @ResponseStatus(HttpStatus.OK)
     public void deleteCampaignById(@RequestParam("force") boolean force,

diff --git a/src/main/java/fr/insee/queen/api/campaign/controller/MetadataController.java b/src/main/java/fr/insee/queen/api/campaign/controller/MetadataController.java
@@ -2,7 +2,6 @@
 
 import fr.insee.queen.api.campaign.service.MetadataService;
 import fr.insee.queen.api.configuration.auth.AuthorityRole;
-import fr.insee.queen.api.configuration.swagger.role.DisplayRolesOnUI;
 import fr.insee.queen.api.web.validation.IdValid;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
@@ -36,7 +35,6 @@ public class MetadataController {
      */
     @Operation(summary = "Get metadata for a campaign ")
     @GetMapping(path = "/campaign/{id}/metadata")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ANY_ROLE)
     public String getMetadataByCampaignId(@IdValid @PathVariable(value = "id") String campaignId) {
         log.info("GET metadata for campaign with id {}", campaignId);
@@ -51,7 +49,6 @@ public String getMetadataByCampaignId(@IdValid @PathVariable(value = "id") Strin
      */
     @Operation(summary = "Get metadata for a questionnaire ")
     @GetMapping(path = "/questionnaire/{id}/metadata")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ANY_ROLE)
     public String getMetadataByQuestionnaireId(@IdValid @PathVariable(value = "id") String questionnaireId) {
         log.info("GET metadata for questionnaire with id {}", questionnaireId);

diff --git a/src/main/java/fr/insee/queen/api/campaign/controller/NomenclatureController.java b/src/main/java/fr/insee/queen/api/campaign/controller/NomenclatureController.java
@@ -3,7 +3,6 @@
 import fr.insee.queen.api.campaign.controller.dto.input.NomenclatureCreationData;
 import fr.insee.queen.api.campaign.service.NomenclatureService;
 import fr.insee.queen.api.configuration.auth.AuthorityRole;
-import fr.insee.queen.api.configuration.swagger.role.DisplayRolesOnUI;
 import fr.insee.queen.api.web.validation.IdValid;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
@@ -37,7 +36,6 @@ public class NomenclatureController {
      */
     @Operation(summary = "Get all nomenclatures Ids ")
     @GetMapping(path = "/nomenclatures")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ANY_ROLE)
     public List<String> getNomenclaturesId() {
         log.info("GET all nomenclatures Ids");
@@ -53,7 +51,6 @@ public List<String> getNomenclaturesId() {
      */
     @Operation(summary = "Get Nomenclature")
     @GetMapping(path = "/nomenclature/{id}")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ANY_ROLE)
     public String getNomenclatureById(@IdValid @PathVariable(value = "id") String nomenclatureId) {
         log.info("GET nomenclature with id {}", nomenclatureId);
@@ -68,7 +65,6 @@ public String getNomenclatureById(@IdValid @PathVariable(value = "id") String no
      */
     @Operation(summary = "Create/update a nomenclature ")
     @PostMapping(path = "/nomenclature")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ADMIN_PRIVILEGES)
     @ResponseStatus(HttpStatus.OK)
     public void postNomenclature(@Valid @RequestBody NomenclatureCreationData nomenclatureCreationDto) {
@@ -83,7 +79,6 @@ public void postNomenclature(@Valid @RequestBody NomenclatureCreationData nomenc
      */
     @Operation(summary = "Get list of required nomenclatures for a campaign")
     @GetMapping(path = "/campaign/{id}/required-nomenclatures")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ANY_ROLE)
     public List<String> getListRequiredNomenclature(@IdValid @PathVariable(value = "id") String campaignId) {
         log.info("GET required-nomenclatures for campaign with id {}", campaignId);
@@ -98,7 +93,6 @@ public List<String> getListRequiredNomenclature(@IdValid @PathVariable(value = "
      */
     @Operation(summary = "Get list of required nomenclature for a questionnaire")
     @GetMapping(path = "/questionnaire/{id}/required-nomenclatures")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ANY_ROLE)
     public List<String> getListRequiredNomenclatureByQuestionnaireId(@IdValid @PathVariable(value = "id") String questionnaireId) {
         log.info("GET required-nomenclatures for questionnaire model with id {}", questionnaireId);

diff --git a/src/main/java/fr/insee/queen/api/campaign/controller/QuestionnaireModelController.java b/src/main/java/fr/insee/queen/api/campaign/controller/QuestionnaireModelController.java
@@ -5,7 +5,6 @@
 import fr.insee.queen.api.campaign.controller.dto.output.QuestionnaireModelValueDto;
 import fr.insee.queen.api.campaign.service.QuestionnaireModelService;
 import fr.insee.queen.api.configuration.auth.AuthorityRole;
-import fr.insee.queen.api.configuration.swagger.role.DisplayRolesOnUI;
 import fr.insee.queen.api.surveyunit.controller.dto.output.SurveyUnitDto;
 import fr.insee.queen.api.surveyunit.controller.dto.output.SurveyUnitOkNokDto;
 import fr.insee.queen.api.surveyunit.service.SurveyUnitService;
@@ -46,7 +45,6 @@ public class QuestionnaireModelController {
      */
     @Operation(summary = "Get questionnaire list for a campaign ")
     @GetMapping(path = "/campaign/{id}/questionnaires")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ANY_ROLE)
     public List<QuestionnaireModelValueDto> getQuestionnaireDatasByCampaignId(
             @IdValid @PathVariable(value = "id") String campaignId) {
@@ -65,7 +63,6 @@ public List<QuestionnaireModelValueDto> getQuestionnaireDatasByCampaignId(
      */
     @Operation(summary = "Get questionnnaire")
     @GetMapping(path = "/questionnaire/{id}")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ANY_ROLE)
     public QuestionnaireModelValueDto getQuestionnaireData(@IdValid @PathVariable(value = "id") String questionnaireModelId) {
         log.info("GET questionnaire for id {}", questionnaireModelId);
@@ -80,7 +77,6 @@ public QuestionnaireModelValueDto getQuestionnaireData(@IdValid @PathVariable(va
      */
     @Operation(summary = "Get list of questionnaire ids for a campaign")
     @GetMapping(path = "/campaign/{id}/questionnaire-id")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ANY_ROLE)
     public List<QuestionnaireModelIdDto> getQuestionnaireIdsByCampaignId(
             @IdValid @PathVariable(value = "id") String campaignId) {
@@ -99,7 +95,6 @@ public List<QuestionnaireModelIdDto> getQuestionnaireIdsByCampaignId(
      */
     @Operation(summary = "Create a Questionnaire Model")
     @PostMapping(path = "/questionnaire-models")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ADMIN_PRIVILEGES)
     @ResponseStatus(HttpStatus.CREATED)
     public void createQuestionnaire(@RequestBody @Valid QuestionnaireModelCreationData questionnaireModelData) {
@@ -115,7 +110,6 @@ public void createQuestionnaire(@RequestBody @Valid QuestionnaireModelCreationDa
      */
     @Operation(summary = "Search questionnaire ids linked to survey units")
     @PostMapping(path = "/survey-units/questionnaire-model-id")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ANY_ROLE)
     public ResponseEntity<SurveyUnitOkNokDto> getQuestionnaireModelIdBySurveyUnits(
             @NotEmpty @RequestBody List<String> surveyUnitIdsToSearch) {

diff --git a/...gger/role/DisplayRolesOnUICustomizer.java → ...swagger/role/DisplayRolesOnSwaggerUI.java b/...gger/role/DisplayRolesOnUICustomizer.java → ...swagger/role/DisplayRolesOnSwaggerUI.java
@@ -7,7 +7,8 @@
 import org.springframework.web.method.HandlerMethod;
 
 @Component
-public class DisplayRolesOnUICustomizer implements OperationCustomizer {
+public class DisplayRolesOnSwaggerUI implements OperationCustomizer {
+    public static final String AUTHORIZED_ROLES = "Authorized roles: ";
 
     /**
      * Display roles allowed to use an endpoint in the description field
@@ -17,10 +18,6 @@ public class DisplayRolesOnUICustomizer implements OperationCustomizer {
      */
     @Override
     public Operation customize(Operation operation, HandlerMethod handlerMethod) {
-        var annotation = handlerMethod.getMethodAnnotation(DisplayRolesOnUI.class);
-        if (annotation == null) {
-            return operation;
-        }
         var preAuthorizeAnnotation = handlerMethod.getMethodAnnotation(PreAuthorize.class);
         StringBuilder description = new StringBuilder();
         if(preAuthorizeAnnotation == null) {
@@ -31,7 +28,7 @@ public Operation customize(Operation operation, HandlerMethod handlerMethod) {
                     .append(operation.getDescription())
                     .append("\n");
         }
-        description.append("Authorized roles: ");
+        description.append(AUTHORIZED_ROLES);
         String roles = preAuthorizeAnnotation.value();
         for(RoleUIMapper roleUIMapper : RoleUIMapper.values()) {
             if(roles.contains(roleUIMapper.getRoleExpression())) {

diff --git a/src/main/java/fr/insee/queen/api/configuration/swagger/role/DisplayRolesOnUI.java b/src/main/java/fr/insee/queen/api/configuration/swagger/role/DisplayRolesOnUI.java
diff --git a/src/main/java/fr/insee/queen/api/dataset/controller/DataSetController.java b/src/main/java/fr/insee/queen/api/dataset/controller/DataSetController.java
@@ -1,7 +1,6 @@
 package fr.insee.queen.api.dataset.controller;
 
 import fr.insee.queen.api.configuration.auth.AuthorityRole;
-import fr.insee.queen.api.configuration.swagger.role.DisplayRolesOnUI;
 import fr.insee.queen.api.dataset.service.DataSetInjectorService;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
@@ -32,7 +31,6 @@ public class DataSetController {
      */
     @Operation(summary = "Create dataset")
     @PostMapping(path = "/create-dataset")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ADMIN_PRIVILEGES)
     @ResponseStatus(HttpStatus.CREATED)
     public void createDataSet() {

diff --git a/src/main/java/fr/insee/queen/api/depositproof/controller/DepositProofController.java b/src/main/java/fr/insee/queen/api/depositproof/controller/DepositProofController.java
@@ -1,7 +1,6 @@
 package fr.insee.queen.api.depositproof.controller;
 
 import fr.insee.queen.api.configuration.auth.AuthorityRole;
-import fr.insee.queen.api.configuration.swagger.role.DisplayRolesOnUI;
 import fr.insee.queen.api.depositproof.service.DepositProofService;
 import fr.insee.queen.api.depositproof.service.exception.DepositProofException;
 import fr.insee.queen.api.depositproof.service.model.PdfDepositProof;
@@ -47,7 +46,6 @@ public class DepositProofController {
      */
     @Operation(summary = "Get deposit proof for a survey unit")
     @GetMapping(value = "/survey-unit/{id}/deposit-proof")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ANY_ROLE)
     public void generateDepositProof(@IdValid @PathVariable(value = "id") String surveyUnitId,
                                      HttpServletResponse response) {

diff --git a/src/main/java/fr/insee/queen/api/integration/controller/IntegrationController.java b/src/main/java/fr/insee/queen/api/integration/controller/IntegrationController.java
@@ -1,7 +1,6 @@
 package fr.insee.queen.api.integration.controller;
 
 import fr.insee.queen.api.configuration.auth.AuthorityRole;
-import fr.insee.queen.api.configuration.swagger.role.DisplayRolesOnUI;
 import fr.insee.queen.api.integration.controller.component.IntegrationComponent;
 import fr.insee.queen.api.integration.controller.dto.output.IntegrationResultsDto;
 import fr.insee.queen.api.web.authentication.AuthenticationHelper;
@@ -41,7 +40,6 @@ public class IntegrationController {
      */
     @Operation(summary = "Integrates the context of a campaign")
     @PostMapping(path = "/campaign/context", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ADMIN_PRIVILEGES)
     public IntegrationResultsDto integrateContext(@RequestParam("file") MultipartFile file) {
         String userId = authHelper.getUserId();

diff --git a/src/main/java/fr/insee/queen/api/paradata/controller/ParadataEventController.java b/src/main/java/fr/insee/queen/api/paradata/controller/ParadataEventController.java
@@ -3,7 +3,6 @@
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import fr.insee.queen.api.configuration.auth.AuthorityRole;
-import fr.insee.queen.api.configuration.swagger.role.DisplayRolesOnUI;
 import fr.insee.queen.api.paradata.service.ParadataEventService;
 import fr.insee.queen.api.pilotage.controller.PilotageComponent;
 import fr.insee.queen.api.pilotage.service.PilotageRole;
@@ -39,7 +38,6 @@ public class ParadataEventController {
      */
     @Operation(summary = "Create paradata event for a survey unit")
     @PostMapping(path = "/paradata")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ADMIN_PRIVILEGES + "||" + AuthorityRole.HAS_ROLE_INTERVIEWER)
     @ResponseStatus(HttpStatus.OK)
     public void addParadata(@NotNull @RequestBody ObjectNode paradataValue) {

diff --git a/src/main/java/fr/insee/queen/api/pilotage/controller/InterviewerController.java b/src/main/java/fr/insee/queen/api/pilotage/controller/InterviewerController.java
@@ -2,7 +2,6 @@
 
 import fr.insee.queen.api.campaign.controller.dto.output.CampaignSummaryDto;
 import fr.insee.queen.api.configuration.auth.AuthorityRole;
-import fr.insee.queen.api.configuration.swagger.role.DisplayRolesOnUI;
 import fr.insee.queen.api.pilotage.service.model.PilotageCampaign;
 import fr.insee.queen.api.surveyunit.controller.dto.output.SurveyUnitByCampaignDto;
 import fr.insee.queen.api.surveyunit.controller.dto.output.SurveyUnitDto;
@@ -43,7 +42,6 @@ public class InterviewerController {
     @Operation(summary = "Get campaign list for the current user")
     @Tag(name = "02. Campaigns")
     @GetMapping(path = "/campaigns")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ANY_ROLE)
     public List<CampaignSummaryDto> getInterviewerCampaignList() {
 
@@ -66,7 +64,6 @@ public List<CampaignSummaryDto> getInterviewerCampaignList() {
     @Operation(summary = "Get list of survey units linked to the current interviewer")
     @Tag(name = "06. Survey units")
     @GetMapping(path = "/survey-units/interviewer")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ADMIN_PRIVILEGES + "||" + AuthorityRole.HAS_ROLE_INTERVIEWER)
     public List<SurveyUnitDto> getInterviewerSurveyUnits() {
         String userId = authHelper.getUserId();
@@ -89,7 +86,6 @@ public List<SurveyUnitDto> getInterviewerSurveyUnits() {
     @Operation(summary = "Get list of survey units for a campaign")
     @Tag(name = "06. Survey units")
     @GetMapping(path = "/campaign/{id}/survey-units")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ANY_ROLE)
     public List<SurveyUnitByCampaignDto> getListSurveyUnitByCampaign(@IdValid @PathVariable(value = "id") String campaignId) {
         log.info("GET survey-units for campaign with id {}", campaignId);

diff --git a/src/main/java/fr/insee/queen/api/surveyunit/controller/CommentController.java b/src/main/java/fr/insee/queen/api/surveyunit/controller/CommentController.java
@@ -2,7 +2,6 @@
 
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import fr.insee.queen.api.configuration.auth.AuthorityRole;
-import fr.insee.queen.api.configuration.swagger.role.DisplayRolesOnUI;
 import fr.insee.queen.api.pilotage.controller.PilotageComponent;
 import fr.insee.queen.api.pilotage.service.PilotageRole;
 import fr.insee.queen.api.surveyunit.service.CommentService;
@@ -41,7 +40,6 @@ public class CommentController {
      */
     @Operation(summary = "Get comment for a survey unit")
     @GetMapping(path = "/survey-unit/{id}/comment")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ANY_ROLE)
     public String getCommentBySurveyUnit(@IdValid @PathVariable(value = "id") String surveyUnitId) {
         log.info("GET comment for reporting unit with id {}", surveyUnitId);
@@ -57,7 +55,6 @@ public String getCommentBySurveyUnit(@IdValid @PathVariable(value = "id") String
      */
     @Operation(summary = "Update comment for a survey unit")
     @PutMapping(path = "/survey-unit/{id}/comment")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ANY_ROLE)
     public void setComment(@NotNull @RequestBody ObjectNode commentValue,
                            @IdValid @PathVariable(value = "id") String surveyUnitId) {

diff --git a/src/main/java/fr/insee/queen/api/surveyunit/controller/DataController.java b/src/main/java/fr/insee/queen/api/surveyunit/controller/DataController.java
@@ -2,7 +2,6 @@
 
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import fr.insee.queen.api.configuration.auth.AuthorityRole;
-import fr.insee.queen.api.configuration.swagger.role.DisplayRolesOnUI;
 import fr.insee.queen.api.pilotage.controller.PilotageComponent;
 import fr.insee.queen.api.pilotage.service.PilotageRole;
 import fr.insee.queen.api.surveyunit.service.DataService;
@@ -37,7 +36,6 @@ public class DataController {
      */
     @Operation(summary = "Get data for a survey unit")
     @GetMapping(path = "/survey-unit/{id}/data")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ANY_ROLE)
     public String getDataBySurveyUnit(@IdValid @PathVariable(value = "id") String surveyUnitId) {
         log.info("GET Data for reporting unit with id {}", surveyUnitId);
@@ -54,7 +52,6 @@ public String getDataBySurveyUnit(@IdValid @PathVariable(value = "id") String su
      */
     @Operation(summary = "Update data for a survey unit")
     @PutMapping(path = "/survey-unit/{id}/data")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ANY_ROLE)
     public void updateData(@NotNull @RequestBody ObjectNode dataValue,
                            @IdValid @PathVariable(value = "id") String surveyUnitId) {

diff --git a/src/main/java/fr/insee/queen/api/surveyunit/controller/PersonalizationController.java b/src/main/java/fr/insee/queen/api/surveyunit/controller/PersonalizationController.java
@@ -2,7 +2,6 @@
 
 import com.fasterxml.jackson.databind.node.ArrayNode;
 import fr.insee.queen.api.configuration.auth.AuthorityRole;
-import fr.insee.queen.api.configuration.swagger.role.DisplayRolesOnUI;
 import fr.insee.queen.api.pilotage.controller.PilotageComponent;
 import fr.insee.queen.api.pilotage.service.PilotageRole;
 import fr.insee.queen.api.surveyunit.service.PersonalizationService;
@@ -37,7 +36,6 @@ public class PersonalizationController {
      */
     @Operation(summary = "Get personalization for a survey unit")
     @GetMapping(path = "/survey-unit/{id}/personalization")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ANY_ROLE)
     public String getPersonalizationBySurveyUnit(@IdValid @PathVariable(value = "id") String surveyUnitId) {
         log.info("GET personalization for reporting unit with id {}", surveyUnitId);
@@ -53,7 +51,6 @@ public String getPersonalizationBySurveyUnit(@IdValid @PathVariable(value = "id"
      */
     @Operation(summary = "Update personalization for a survey unit")
     @PutMapping(path = "/survey-unit/{id}/personalization")
-    @DisplayRolesOnUI
     @PreAuthorize(AuthorityRole.HAS_ANY_ROLE)
     public void setPersonalization(@IdValid @PathVariable(value = "id") String surveyUnitId,
                                    @NotNull @RequestBody ArrayNode personalizationValues) {