From 1e7cae8707a72a9c4208c586dd73f92d7c8d97ba Mon Sep 17 00:00:00 2001 From: eknizat <26163420+eknizat@users.noreply.github.com> Date: Wed, 29 Apr 2020 09:44:05 +0100 Subject: [PATCH] AT-711: Tidy up logging (#237) * Tidy up logging * Move AIOTransformRegistryTest to the same package as AIOTransformRegistry --- .../alfresco/transformer/AIOController.java | 41 +++++++++---------- .../AIOTransformRegistryTest.java | 7 +++- 2 files changed, 24 insertions(+), 24 deletions(-) rename alfresco-transform-core-aio/alfresco-transform-core-aio/src/test/java/org/alfresco/transformer/{transformers => }/AIOTransformRegistryTest.java (98%) diff --git a/alfresco-transform-core-aio/alfresco-transform-core-aio-boot/src/main/java/org/alfresco/transformer/AIOController.java b/alfresco-transform-core-aio/alfresco-transform-core-aio-boot/src/main/java/org/alfresco/transformer/AIOController.java index 3a7aef78..487cf83d 100644 --- a/alfresco-transform-core-aio/alfresco-transform-core-aio-boot/src/main/java/org/alfresco/transformer/AIOController.java +++ b/alfresco-transform-core-aio/alfresco-transform-core-aio-boot/src/main/java/org/alfresco/transformer/AIOController.java @@ -98,6 +98,11 @@ public class AIOController extends AbstractTransformerController public void processTransform(final File sourceFile, final File targetFile, final String sourceMimetype, final String targetMimetype, final Map transformOptions, final Long timeout) { + if (logger.isDebugEnabled()) + { + logger.debug("Processing request via queue endpoint. Params: sourceMimetype: '{}', targetMimetype: '{}', " + + "transformOptions: {}", sourceMimetype, targetMimetype, transformOptions); + } final String transform = getTransformerName(sourceFile, sourceMimetype, targetMimetype, transformOptions); transformInternal( transform, sourceFile, targetFile, sourceMimetype, targetMimetype, transformOptions); } @@ -136,7 +141,11 @@ public class AIOController extends AbstractTransformerController // It can be removed once legacy transformers are removed from ACS. @RequestParam (value = TRANSFORM_NAME_PROPERTY, required = false) String requestTransformName) { - debugLogTransform("Request parameters: ", sourceMimetype, targetMimetype, targetExtension, requestParameters); + if (logger.isDebugEnabled()) + { + logger.debug("Processing request via HTTP endpoint. Params: sourceMimetype: '{}', targetMimetype: '{}', " + + "targetExtension: '{}', requestParameters: {}", sourceMimetype, targetMimetype, targetExtension, requestParameters); + } //Remove all required parameters from request parameters to get the list of options List optionsToFilter = Arrays.asList(SOURCE_EXTENSION, TARGET_EXTENSION, TARGET_MIMETYPE, @@ -145,6 +154,11 @@ public class AIOController extends AbstractTransformerController transformOptions.keySet().removeAll(optionsToFilter); transformOptions.values().removeIf(v -> v.isEmpty()); + if (logger.isDebugEnabled()) + { + logger.debug("Filtered requestParameters into transformOptions: {}" + transformOptions); + } + final String targetFilename = createTargetFileName( sourceMultipartFile.getOriginalFilename(), targetExtension); getProbeTestTransform().incrementTransformerCount(); @@ -155,19 +169,12 @@ public class AIOController extends AbstractTransformerController String transform = requestTransformName; if (transform == null || transform.isEmpty()) { - if (logger.isDebugEnabled()) - { - logger.debug("Using engine config to determine the transform name."); - } transform = getTransformerName(sourceFile, sourceMimetype, targetMimetype, transformOptions); } else if (logger.isDebugEnabled()) { - logger.debug("Using transform name provided by the request."); + logger.debug("Using transform name provided in the request: " + requestTransformName); } - - debugLogTransform("Performing transform with parameters: ", sourceMimetype, targetMimetype, - targetExtension, transformOptions); transformInternal(transform, sourceFile, targetFile, sourceMimetype, targetMimetype, transformOptions); final ResponseEntity body = createAttachment(targetFilename, targetFile); @@ -178,16 +185,6 @@ public class AIOController extends AbstractTransformerController return body; } - private void debugLogTransform(final String message, final String sourceMimetype, final String targetMimetype, - final String targetExtension, final Map transformOptions) { - if (logger.isDebugEnabled()) - { - logger.debug( - "{} : sourceMimetype: '{}', targetMimetype: '{}', targetExtension: '{}', transformOptions: '{}'", - message, sourceMimetype, targetMimetype, targetExtension, transformOptions); - } - } - @Override public ResponseEntity info() { @@ -200,8 +197,8 @@ public class AIOController extends AbstractTransformerController final String sourceMimetype, final String targetMimetype, final Map transformOptions) { - logger.debug("Processing request with: sourceFile '{}', targetFile '{}', transformOptions" + - " '{}', timeout {} ms", sourceFile, targetFile, transformOptions); + logger.debug("Processing transform with: transformName; '{}', sourceFile '{}', targetFile '{}', transformOptions" + + " {}", transformName, sourceFile, targetFile, transformOptions); Transformer transformer = transformRegistry.getByTransformName(transformName); if (transformer == null) @@ -212,7 +209,7 @@ public class AIOController extends AbstractTransformerController if (logger.isDebugEnabled()) { - logger.debug("Performing transform '{}' using {}", transformName, transformer.getTransformerId()); + logger.debug("Performing transform with name '{}' using transformer with id '{}'.", transformName, transformer.getTransformerId()); } try diff --git a/alfresco-transform-core-aio/alfresco-transform-core-aio/src/test/java/org/alfresco/transformer/transformers/AIOTransformRegistryTest.java b/alfresco-transform-core-aio/alfresco-transform-core-aio/src/test/java/org/alfresco/transformer/AIOTransformRegistryTest.java similarity index 98% rename from alfresco-transform-core-aio/alfresco-transform-core-aio/src/test/java/org/alfresco/transformer/transformers/AIOTransformRegistryTest.java rename to alfresco-transform-core-aio/alfresco-transform-core-aio/src/test/java/org/alfresco/transformer/AIOTransformRegistryTest.java index 831b8aed..2579e9e6 100644 --- a/alfresco-transform-core-aio/alfresco-transform-core-aio/src/test/java/org/alfresco/transformer/transformers/AIOTransformRegistryTest.java +++ b/alfresco-transform-core-aio/alfresco-transform-core-aio/src/test/java/org/alfresco/transformer/AIOTransformRegistryTest.java @@ -24,11 +24,13 @@ * along with Alfresco. If not, see . * #L% */ -package org.alfresco.transformer.transformers; +package org.alfresco.transformer; import com.fasterxml.jackson.databind.ObjectMapper; import org.alfresco.transform.client.model.config.TransformConfig; -import org.alfresco.transformer.AIOTransformRegistry; +import org.alfresco.transformer.transformers.MiscAdapter; +import org.alfresco.transformer.transformers.TikaAdapter; +import org.alfresco.transformer.transformers.Transformer; import org.apache.pdfbox.pdmodel.PDDocument; import org.apache.pdfbox.text.PDFTextStripper; import org.junit.Before; @@ -41,6 +43,7 @@ import java.io.OutputStreamWriter; import java.io.StringWriter; import java.nio.file.Files; import java.util.Arrays; +import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Map;