Skip to content

Commit e6cb75f

Browse files
IvanBorislavovDimitrovIvanBorislavovDimitrov
authored
Revert "Add logging during operations and files API calls (#1794)" (#1795)
This reverts commit 636ca41.
1 parent 636ca41 commit e6cb75f

8 files changed

Lines changed: 28 additions & 123 deletions

File tree

‎multiapps-controller-web/src/main/java/org/cloudfoundry/multiapps/controller/web/Constants.java‎

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -71,27 +71,6 @@ private Endpoints() {
7171
public static final String PURGE = "/purge";
7272
}
7373

74-
public static class ApiEndpointsNames {
75-
76-
private ApiEndpointsNames() {
77-
}
78-
79-
// Files API
80-
public static final String GET_FILES = "getFiles";
81-
public static final String UPLOAD_FILE = "uploadFile";
82-
public static final String START_UPLOAD_FROM_URL = "startUploadFromUrl";
83-
public static final String GET_UPLOAD_FROM_URL_JOB = "getUploadFromUrlJob";
84-
85-
// Operations API
86-
public static final String GET_OPERATIONS = "getOperations";
87-
public static final String START_OPERATION = "startOperation";
88-
public static final String GET_OPERATION = "getOperation";
89-
public static final String GET_OPERATION_ACTIONS = "getOperationActions";
90-
public static final String GET_OPERATION_LOGS = "getOperationLogs";
91-
public static final String GET_OPERATION_LOG_CONTENT = "getOperationLogContent";
92-
public static final String EXECUTE_OPERATION_ACTION = "executeOperationAction";
93-
}
94-
9574
public static final Set<String> NAMES_OF_SERVICE_PARAMETERS = Set.of(
9675
VARIABLE_NAME_SERVICE_ID, Variables.USER.getName(),
9776
Variables.USER_GUID.getName(), Variables.SPACE_NAME.getName(), Variables.SPACE_GUID.getName(),

‎multiapps-controller-web/src/main/java/org/cloudfoundry/multiapps/controller/web/Messages.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ public final class Messages {
2525
public static final String MISSING_PROPERTIES_FOR_CREATING_THE_SPECIFIC_PROVIDER = "Missing properties for creating the specific provider!";
2626
public static final String DEPLOY_FROM_URL_WRONG_CREDENTIALS_FOR_JOB_WITH_ID = "Credentials to {0} are wrong. Make sure that they are correct. Job id: {1}";
2727
public static final String JOB_NOT_UPDATED_FOR_0_SECONDS = "Job not updated for {0} seconds";
28+
2829
public static final String FAILED_TO_CREATE_BLOB_STORE_CONTEXT = "Failed to create BlobStoreContext";
2930

3031
// Audit log messages

‎multiapps-controller-web/src/main/java/org/cloudfoundry/multiapps/controller/web/api/impl/FilesApiServiceImpl.java‎

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11
package org.cloudfoundry.multiapps.controller.web.api.impl;
22

3+
import java.io.BufferedInputStream;
4+
import java.io.InputStream;
5+
import java.math.BigInteger;
6+
import java.text.MessageFormat;
7+
import java.time.LocalDateTime;
8+
import java.time.temporal.ChronoUnit;
9+
import java.util.Base64;
10+
import java.util.List;
11+
import java.util.concurrent.ExecutorService;
12+
import java.util.stream.Collectors;
13+
314
import jakarta.inject.Inject;
415
import jakarta.inject.Named;
5-
import jakarta.servlet.http.HttpServletRequest;
616
import org.cloudfoundry.multiapps.common.SLException;
717
import org.cloudfoundry.multiapps.controller.api.FilesApiService;
818
import org.cloudfoundry.multiapps.controller.api.model.AsyncUploadResult;
@@ -26,7 +36,6 @@
2636
import org.cloudfoundry.multiapps.controller.process.util.PriorityFuture;
2737
import org.cloudfoundry.multiapps.controller.web.Constants;
2838
import org.cloudfoundry.multiapps.controller.web.Messages;
29-
import org.cloudfoundry.multiapps.controller.web.monitoring.ApiUsageLogger;
3039
import org.cloudfoundry.multiapps.controller.web.upload.AsyncUploadJobOrchestrator;
3140
import org.cloudfoundry.multiapps.controller.web.upload.exception.RejectedAsyncUploadJobException;
3241
import org.cloudfoundry.multiapps.controller.web.util.SecurityContextUtil;
@@ -39,17 +48,6 @@
3948
import org.springframework.web.multipart.MultipartFile;
4049
import org.springframework.web.multipart.MultipartHttpServletRequest;
4150

42-
import java.io.BufferedInputStream;
43-
import java.io.InputStream;
44-
import java.math.BigInteger;
45-
import java.text.MessageFormat;
46-
import java.time.LocalDateTime;
47-
import java.time.temporal.ChronoUnit;
48-
import java.util.Base64;
49-
import java.util.List;
50-
import java.util.concurrent.ExecutorService;
51-
import java.util.stream.Collectors;
52-
5351
@Named
5452
public class FilesApiServiceImpl implements FilesApiService {
5553

@@ -76,15 +74,10 @@ public class FilesApiServiceImpl implements FilesApiService {
7674
@Inject
7775
private AsyncUploadJobOrchestrator asyncUploadJobOrchestrator;
7876
@Inject
79-
private ApiUsageLogger apiUsageLogger;
80-
@Inject
8177
private ExecutorService fileStorageThreadPool;
82-
@Inject
83-
private HttpServletRequest httpServletRequest;
8478

8579
@Override
8680
public ResponseEntity<List<FileMetadata>> getFiles(String spaceGuid, String namespace) {
87-
apiUsageLogger.logFilesReadCall(spaceGuid, namespace, Constants.ApiEndpointsNames.GET_FILES, httpServletRequest);
8881
try {
8982
filesApiServiceAuditLog.logGetFiles(SecurityContextUtil.getUsername(), spaceGuid, namespace);
9083
List<FileEntry> entries = fileService.listFiles(spaceGuid, namespace);
@@ -100,7 +93,6 @@ public ResponseEntity<List<FileMetadata>> getFiles(String spaceGuid, String name
10093

10194
@Override
10295
public ResponseEntity<FileMetadata> uploadFile(MultipartHttpServletRequest request, String spaceGuid, String namespace) {
103-
apiUsageLogger.logFilesMutatingCall(spaceGuid, namespace, Constants.ApiEndpointsNames.UPLOAD_FILE, request);
10496
LOGGER.trace(Messages.RECEIVED_UPLOAD_REQUEST, ServletUtil.decodeUri(request));
10597
var multipartFile = getFileFromRequest(request);
10698
try (InputStream in = new BufferedInputStream(multipartFile.getInputStream(), INPUT_STREAM_BUFFER_SIZE)) {
@@ -121,13 +113,11 @@ public ResponseEntity<FileMetadata> uploadFile(MultipartHttpServletRequest reque
121113

122114
@Override
123115
public ResponseEntity<Void> startUploadFromUrl(String spaceGuid, String namespace, FileUrl fileUrl) {
124-
apiUsageLogger.logFilesMutatingCall(spaceGuid, namespace, Constants.ApiEndpointsNames.START_UPLOAD_FROM_URL, httpServletRequest);
125116
String decodedUrl = new String(Base64.getUrlDecoder()
126117
.decode(fileUrl.getFileUrl()));
127118
String urlWithoutUserInfo = UriUtil.stripUserInfo(decodedUrl);
128119
LOGGER.trace(Messages.RECEIVED_UPLOAD_FROM_URL_REQUEST, urlWithoutUserInfo);
129120
filesApiServiceAuditLog.logStartUploadFromUrl(SecurityContextUtil.getUsername(), spaceGuid, decodedUrl);
130-
131121
var existingJob = getExistingJob(spaceGuid, namespace, urlWithoutUserInfo);
132122
if (existingJob == null) {
133123
return triggerUploadFromUrl(spaceGuid, namespace, urlWithoutUserInfo, decodedUrl, fileUrl.getUserCredentials());
@@ -154,7 +144,6 @@ private String getLocationHeader(String spaceGuid, String jobId) {
154144

155145
@Override
156146
public ResponseEntity<AsyncUploadResult> getUploadFromUrlJob(String spaceGuid, String namespace, String jobId) {
157-
apiUsageLogger.logFilesReadCall(spaceGuid, namespace, Constants.ApiEndpointsNames.GET_UPLOAD_FROM_URL_JOB, httpServletRequest);
158147
filesApiServiceAuditLog.logGetUploadFromUrlJob(SecurityContextUtil.getUsername(), spaceGuid, namespace, jobId);
159148
AsyncUploadJobEntry job = getJob(jobId, spaceGuid, namespace);
160149
if (job == null) {

‎multiapps-controller-web/src/main/java/org/cloudfoundry/multiapps/controller/web/api/impl/OperationsApiServiceImpl.java‎

Lines changed: 16 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
package org.cloudfoundry.multiapps.controller.web.api.impl;
22

3+
import java.text.MessageFormat;
4+
import java.time.ZoneId;
5+
import java.time.ZonedDateTime;
6+
import java.time.format.DateTimeFormatter;
7+
import java.util.Arrays;
8+
import java.util.Collections;
9+
import java.util.Date;
10+
import java.util.HashMap;
11+
import java.util.List;
12+
import java.util.Map;
13+
import java.util.Set;
14+
import java.util.UUID;
15+
import java.util.stream.Collectors;
16+
317
import jakarta.inject.Inject;
418
import jakarta.inject.Named;
519
import jakarta.persistence.NoResultException;
@@ -24,6 +38,7 @@
2438
import org.cloudfoundry.multiapps.controller.core.cf.CloudControllerClientFactory;
2539
import org.cloudfoundry.multiapps.controller.core.security.token.TokenService;
2640
import org.cloudfoundry.multiapps.controller.core.util.UserInfo;
41+
import org.cloudfoundry.multiapps.controller.persistence.Constants;
2742
import org.cloudfoundry.multiapps.controller.persistence.OrderDirection;
2843
import org.cloudfoundry.multiapps.controller.persistence.model.ProgressMessage;
2944
import org.cloudfoundry.multiapps.controller.persistence.model.ProgressMessage.ProgressMessageType;
@@ -39,9 +54,7 @@
3954
import org.cloudfoundry.multiapps.controller.process.metadata.ProcessTypeToOperationMetadataMapper;
4055
import org.cloudfoundry.multiapps.controller.process.util.OperationsHelper;
4156
import org.cloudfoundry.multiapps.controller.process.variables.Variables;
42-
import org.cloudfoundry.multiapps.controller.web.Constants;
4357
import org.cloudfoundry.multiapps.controller.web.Messages;
44-
import org.cloudfoundry.multiapps.controller.web.monitoring.ApiUsageLogger;
4558
import org.cloudfoundry.multiapps.controller.web.util.SecurityContextUtil;
4659
import org.flowable.engine.runtime.ProcessInstance;
4760
import org.slf4j.Logger;
@@ -50,21 +63,6 @@
5063
import org.springframework.http.ResponseEntity;
5164
import org.springframework.web.server.ResponseStatusException;
5265

53-
import java.text.MessageFormat;
54-
import java.time.ZoneId;
55-
import java.time.ZonedDateTime;
56-
import java.time.format.DateTimeFormatter;
57-
import java.util.Arrays;
58-
import java.util.Collections;
59-
import java.util.Date;
60-
import java.util.HashMap;
61-
import java.util.List;
62-
import java.util.Map;
63-
import java.util.Set;
64-
import java.util.UUID;
65-
import java.util.stream.Collectors;
66-
67-
import static org.cloudfoundry.multiapps.controller.persistence.Constants.VARIABLE_NAME_SERVICE_ID;
6866
import static org.cloudfoundry.multiapps.controller.web.Constants.NAMES_OF_SERVICE_PARAMETERS;
6967

7068
@Named
@@ -91,14 +89,9 @@ public class OperationsApiServiceImpl implements OperationsApiService {
9189
private ProcessActionRegistry processActionRegistry;
9290
@Inject
9391
private OperationsApiServiceAuditLog operationsApiServiceAuditLog;
94-
@Inject
95-
private ApiUsageLogger apiUsageLogger;
96-
@Inject
97-
private HttpServletRequest httpServletRequest;
9892

9993
@Override
10094
public ResponseEntity<List<Operation>> getOperations(String spaceGuid, String mtaId, List<String> stateStrings, Integer last) {
101-
apiUsageLogger.logOperationsReadCall(spaceGuid, Constants.ApiEndpointsNames.GET_OPERATIONS, null, httpServletRequest);
10295
operationsApiServiceAuditLog.logGetOperations(SecurityContextUtil.getUsername(), spaceGuid, mtaId);
10396
List<Operation.State> states = getStates(stateStrings);
10497
List<Operation> operations = filterByQueryParameters(last, states, spaceGuid, mtaId);
@@ -108,8 +101,6 @@ public ResponseEntity<List<Operation>> getOperations(String spaceGuid, String mt
108101

109102
@Override
110103
public ResponseEntity<Void> executeOperationAction(String spaceGuid, String operationId, String actionId) {
111-
apiUsageLogger.logOperationsMutatingCall(spaceGuid, Constants.ApiEndpointsNames.EXECUTE_OPERATION_ACTION, operationId,
112-
httpServletRequest);
113104
operationsApiServiceAuditLog.logExecuteOperationAction(SecurityContextUtil.getUsername(), spaceGuid, operationId, actionId);
114105
Operation operation = getOperationByOperationGuidAndSpaceGuid(operationId, spaceGuid);
115106
List<String> availableOperations = getAvailableActions(operation);
@@ -128,8 +119,6 @@ public ResponseEntity<Void> executeOperationAction(String spaceGuid, String oper
128119
@Override
129120
public ResponseEntity<List<Log>> getOperationLogs(String spaceGuid, String operationId) {
130121
try {
131-
apiUsageLogger.logOperationsReadCall(spaceGuid, Constants.ApiEndpointsNames.GET_OPERATION_LOGS, operationId,
132-
httpServletRequest);
133122
operationsApiServiceAuditLog.logGetOperationLogs(SecurityContextUtil.getUsername(), spaceGuid, operationId);
134123
getOperationByOperationGuidAndSpaceGuid(operationId, spaceGuid);
135124
List<String> logIds = logsService.getLogNames(spaceGuid, operationId);
@@ -149,8 +138,6 @@ public ResponseEntity<List<Log>> getOperationLogs(String spaceGuid, String opera
149138
@Override
150139
public ResponseEntity<String> getOperationLogContent(String spaceGuid, String operationId, String logId) {
151140
try {
152-
apiUsageLogger.logOperationsReadCall(spaceGuid, Constants.ApiEndpointsNames.GET_OPERATION_LOG_CONTENT, operationId,
153-
httpServletRequest);
154141
operationsApiServiceAuditLog.logGetOperationLogContent(SecurityContextUtil.getUsername(), spaceGuid, operationId, logId);
155142
String content = logsService.getOperationLog(spaceGuid, operationId, logId);
156143

@@ -163,7 +150,6 @@ public ResponseEntity<String> getOperationLogContent(String spaceGuid, String op
163150

164151
@Override
165152
public ResponseEntity<Operation> startOperation(String spaceGuid, Operation operation, HttpServletRequest httpServletRequest) {
166-
apiUsageLogger.logOperationsMutatingCall(spaceGuid, Constants.ApiEndpointsNames.START_OPERATION, null, httpServletRequest);
167153
operationsApiServiceAuditLog.logStartOperation(SecurityContextUtil.getUsername(), spaceGuid, operation);
168154
UserInfo authenticatedUser = getAuthenticatedUser();
169155
String processDefinitionKey = operationsHelper.getProcessDefinitionKey(operation);
@@ -181,7 +167,6 @@ public ResponseEntity<Operation> startOperation(String spaceGuid, Operation oper
181167

182168
@Override
183169
public ResponseEntity<Operation> getOperation(String spaceGuid, String operationId, String embed) {
184-
apiUsageLogger.logOperationsReadCall(spaceGuid, Constants.ApiEndpointsNames.GET_OPERATION, operationId, httpServletRequest);
185170
operationsApiServiceAuditLog.logGetOperation(SecurityContextUtil.getUsername(), spaceGuid, operationId, embed);
186171
Operation operation = getOperationByOperationGuidAndSpaceGuid(operationId, spaceGuid);
187172
if (!operation.getSpaceId()
@@ -228,7 +213,6 @@ private List<Operation> filterByQueryParameters(Integer lastRequestedOperationsC
228213

229214
@Override
230215
public ResponseEntity<List<String>> getOperationActions(String spaceGuid, String operationId) {
231-
apiUsageLogger.logOperationsReadCall(spaceGuid, Constants.ApiEndpointsNames.GET_OPERATION_ACTIONS, operationId, httpServletRequest);
232216
operationsApiServiceAuditLog.logGetOperationActions(spaceGuid, SecurityContextUtil.getUsername(), operationId);
233217
Operation operation = getOperationByOperationGuidAndSpaceGuid(operationId, spaceGuid);
234218
return ResponseEntity.ok()
@@ -273,7 +257,7 @@ private Operation addServiceParameters(Operation operation, String spaceGuid, St
273257

274258
String processDefinitionKey = operationsHelper.getProcessDefinitionKey(operation);
275259

276-
parameters.put(VARIABLE_NAME_SERVICE_ID, processDefinitionKey);
260+
parameters.put(Constants.VARIABLE_NAME_SERVICE_ID, processDefinitionKey);
277261
parameters.put(Variables.USER.getName(), user);
278262
parameters.put(Variables.USER_GUID.getName(), userGuid);
279263
parameters.put(Variables.SPACE_NAME.getName(), space.getName());

‎multiapps-controller-web/src/main/java/org/cloudfoundry/multiapps/controller/web/monitoring/ApiUsageLogger.java‎

Lines changed: 0 additions & 14 deletions
This file was deleted.

‎multiapps-controller-web/src/main/java/org/cloudfoundry/multiapps/controller/web/monitoring/NoopApiUsageLogger.java‎

Lines changed: 0 additions & 28 deletions
This file was deleted.

‎multiapps-controller-web/src/test/java/org/cloudfoundry/multiapps/controller/web/api/impl/FilesApiServiceImplTest.java‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@
3030
import org.cloudfoundry.multiapps.controller.persistence.services.AsyncUploadJobService;
3131
import org.cloudfoundry.multiapps.controller.persistence.services.FileService;
3232
import org.cloudfoundry.multiapps.controller.persistence.services.FileStorageException;
33-
import org.cloudfoundry.multiapps.controller.web.monitoring.ApiUsageLogger;
3433
import org.cloudfoundry.multiapps.controller.web.upload.AsyncUploadJobOrchestrator;
3534
import org.cloudfoundry.multiapps.controller.web.upload.exception.RejectedAsyncUploadJobException;
3635
import org.junit.jupiter.api.AfterEach;
@@ -77,8 +76,6 @@ class FilesApiServiceImplTest {
7776
private final FilesApiServiceImpl testedClass = new FilesApiServiceImpl();
7877
@Mock
7978
private FilesApiServiceAuditLog filesApiServiceAuditLog;
80-
@Mock
81-
private ApiUsageLogger apiUsageLogger;
8279
@Mock(name = "fileStorageThreadPool")
8380
private ExecutorService fileStorageThreadPool;
8481
@Mock

‎multiapps-controller-web/src/test/java/org/cloudfoundry/multiapps/controller/web/api/impl/OperationsApiServiceImplTest.java‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@
3737
import org.cloudfoundry.multiapps.controller.process.metadata.ProcessTypeToOperationMetadataMapper;
3838
import org.cloudfoundry.multiapps.controller.process.util.OperationsHelper;
3939
import org.cloudfoundry.multiapps.controller.process.variables.Variables;
40-
import org.cloudfoundry.multiapps.controller.web.monitoring.ApiUsageLogger;
4140
import org.flowable.engine.runtime.ProcessInstance;
4241
import org.junit.jupiter.api.Assertions;
4342
import org.junit.jupiter.api.BeforeEach;
@@ -86,8 +85,6 @@ class OperationsApiServiceImplTest {
8685
private ProcessAction processAction;
8786
@Mock
8887
private OperationsApiServiceAuditLog operationsApiServiceAuditLog;
89-
@Mock
90-
private ApiUsageLogger apiUsageLogger;
9188

9289
@InjectMocks
9390
private OperationsApiServiceImpl operationsApiService = new OperationsApiServiceImpl();

0 commit comments

Comments
 (0)