Merge pull request #56 from companieshouse/IDVA6-1401-fix-logging

Removed some redundant logging, and standardised "Acsp" in logs.
companieshouse · Aug 9, 2024 · df70daa · df70daa
2 parents 5b9040d + c615a6b
commit df70daa
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 10 deletions.
diff --git a/...in/java/uk/gov/companieshouse/acsp/manage/users/controller/AcspMembershipsController.java b/...in/java/uk/gov/companieshouse/acsp/manage/users/controller/AcspMembershipsController.java
@@ -17,7 +17,6 @@
 import uk.gov.companieshouse.acsp.manage.users.service.AcspMembersService;
 import uk.gov.companieshouse.acsp.manage.users.service.UsersService;
 import uk.gov.companieshouse.acsp.manage.users.utils.PaginationValidatorUtil;
-import uk.gov.companieshouse.acsp.manage.users.utils.RequestContextUtil;
 import uk.gov.companieshouse.acsp.manage.users.utils.StaticPropertyUtil;
 import uk.gov.companieshouse.api.accounts.user.model.User;
 import uk.gov.companieshouse.api.acsp_manage_users.api.AcspMembershipsInterface;
@@ -55,7 +54,7 @@ private void throwBadRequestWhenActionIsNotPermittedByOAuth2User( final String r
     final var requestingUserMembership =
             acspMembersService.fetchActiveAcspMembership( requestingUserId, acspNumber )
                     .orElseThrow( () -> {
-                      LOG.error( "Requesting user is not a member of the acsp" );
+                      LOG.error( "Requesting user is not a member of the Acsp" );
                       return new BadRequestRuntimeException( PLEASE_CHECK_THE_REQUEST_AND_TRY_AGAIN );
                     } );
 
@@ -82,21 +81,19 @@ public ResponseEntity<AcspMembership> addMemberForAcsp( final String xRequestId,
     try {
       targetUser = usersService.fetchUserDetails( targetUserId );
     } catch ( NotFoundRuntimeException exception ) {
-      LOG.error( "Could not find user" );
       throw new BadRequestRuntimeException( ERROR_CODE_1001.getCode() );
     }
 
     AcspDataDao acspDataDao;
     try {
       acspDataDao = acspDataService.fetchAcspData( acspNumber );
     } catch ( NotFoundRuntimeException exception ) {
-      LOG.error("Could not find Acsp" );
       throw new BadRequestRuntimeException( PLEASE_CHECK_THE_REQUEST_AND_TRY_AGAIN );
     }
 
     final var memberships = acspMembersService.fetchAcspMembershipDaos( targetUserId, false );
     if ( !memberships.isEmpty() ) {
-      LOG.error( "User already has an active ACSP membership" );
+      LOG.error( "User already has an active Acsp membership" );
       throw new BadRequestRuntimeException( ERROR_CODE_1002.getCode() );
     }
 
@@ -124,7 +121,7 @@ public ResponseEntity<AcspMembershipsList> findMembershipsForUserAndAcsp(
     logMap.put(ACSP_NUMBER_KEY, acspNumber);
     logMap.put("includeRemoved", includeRemoved);
     logMap.put("userEmail", requestBody.getUserEmail());
-    LOG.info("Getting members for ACSP & User email", logMap);
+    LOG.info("Getting members for Acsp & User email", logMap);
 
     if (Objects.isNull(requestBody.getUserEmail())) {
       LOG.error(String.format("%s: A user email was not provided.", requestId));
@@ -154,7 +151,7 @@ public ResponseEntity<AcspMembershipsList> findMembershipsForUserAndAcsp(
     logMap.put(REQUEST_ID_KEY, requestId);
     logMap.put("userEmail", userEmail);
     logMap.put(ACSP_NUMBER_KEY, acspNumber);
-    LOG.info("Getting members for ACSP & User email", successLogMap);
+    LOG.info("Getting members for Acsp & User email", successLogMap);
 
     return new ResponseEntity<>(acspMembershipsList, HttpStatus.OK);
   }
@@ -174,7 +171,7 @@ public ResponseEntity<AcspMembershipsList> getMembersForAcsp(
     logMap.put("pageIndex", pageIndex);
     logMap.put("itemsPerPage", itemsPerPage);
     logMap.put("role", role);
-    LOG.info("Getting members for ACSP", logMap);
+    LOG.info("Getting members for Acsp", logMap);
 
     final boolean roleIsValid =
         Optional.ofNullable(role)
@@ -211,7 +208,7 @@ public ResponseEntity<AcspMembershipsList> getMembersForAcsp(
     logMap.put(
         "membersCount",
         Optional.ofNullable(acspMembershipsList.getItems()).map(List::size).orElse(0));
-    LOG.info("Getting members for ACSP", successLogMap);
+    LOG.info("Getting members for Acsp", successLogMap);
 
     return new ResponseEntity<>(acspMembershipsList, HttpStatus.OK);
   }

diff --git a/...java/uk/gov/companieshouse/acsp/manage/users/controller/UserAcspMembershipController.java b/...java/uk/gov/companieshouse/acsp/manage/users/controller/UserAcspMembershipController.java
@@ -38,7 +38,7 @@ public ResponseEntity<AcspMembershipsList> getAcspMembershipsForUserId(
     LOG.infoContext(
         xRequestId,
         String.format(
-            "Successfully fetched ACSP memberships for the user with ID %s",
+            "Successfully fetched Acsp memberships for the user %s",
             loggedUser.getUserId()),
         null);
     return new ResponseEntity<>(acspMemberships, HttpStatus.OK);