Refactor logging and deindexing utilities in AEM plugin

Introduces TurAemPluginUtils to centralize log message formatting for object details in the AEM plugin. Refactors log statements in TurAemPluginProcess and TurConnectorContextImpl to use the new utility methods, improving consistency and clarity. Also renames deleteComponentsListedAsDeIndexed to deleteContentsToBeDeIndexed in TurConnectorIndexingService for better method naming.

Author: alegauss

turing-aem/aem-plugin/src/main/java/com/viglet/turing/connector/plugin/aem/TurAemPluginProcess.java

@@ -276,14 +276,17 @@ public void indexContentId(TurConnectorSession session, TurAemSource turAemSourc
     }
 
     private void sendToTuringToBeDeIndexed(TurConnectorSession session, String contentId, boolean standalone) {
-        log.info("DeIndex because {} object ({}) infinity Json file not found. transactionId = {}",
-                contentId, session.getSource(), session.getTransactionId());
         turConnectorContext.getIndexingItem(contentId, session.getSource(), session.getProviderName())
                 .forEach(
-                        indexing ->
-                                turConnectorContext.addJobItem(deIndexJob(session, indexing), session, standalone));
+                        indexing -> {
+                            log.info("DeIndex because {} infinity Json file not found.",
+                                    TurAemPluginUtils.getObjectDetailForLogs(contentId, indexing, session));
+                            turConnectorContext.addJobItem(deIndexJob(session, indexing), session, standalone);
+                        });
     }
 
+
+
     private TurSNJobItem deIndexJob(TurConnectorSession session,
                                     TurConnectorIndexing turConnectorIndexingDTO) {
         return deIndexJob(session, turConnectorIndexingDTO.getSites(), turConnectorIndexingDTO.getLocale(),
@@ -438,17 +441,16 @@ private void indexObject(@NotNull TurAemObject aemObject, TurAemModel turAemMode
                             TurAemCommonsUtils.getLocaleFromAemObject(turAemSourceContext, aemObject),
                             aemObject.getPath());
                     turConnectorContext.addJobItem(deIndexJobItem, session, true);
-                    log.info("Forcing deIndex because {} object ({}) is not publishing. transactionId = {}",
-                            aemObject.getPath(), turAemSourceContext.getId(), session.getTransactionId());
+                    log.info("Forcing deIndex because {} is not publishing.",
+                            TurAemPluginUtils.getObjectDetailForLogs(aemObject, turAemSourceContext, session));
                 } else {
-                    log.info("Ignoring deIndex because {} object ({}) is not publishing. transactionId = {}",
-                            aemObject.getPath(), turAemSourceContext.getId(), session.getTransactionId());
+                    log.info("Ignoring deIndex because {} is not publishing.",
+                            TurAemPluginUtils.getObjectDetailForLogs(aemObject, turAemSourceContext, session));
                 }
             }
         }
     }
 
-
     private void indexByEnvironment(TurAemEnv turAemEnv, String snSite,
                                     @NotNull TurAemObject aemObject, TurAemModel turAemModel,
                                     List<TurSNAttributeSpec> turSNAttributeSpecList,

turing-aem/aem-plugin/src/main/java/com/viglet/turing/connector/plugin/aem/TurAemPluginUtils.java

@@ -0,0 +1,30 @@
+package com.viglet.turing.connector.plugin.aem;
+
+import com.viglet.turing.connector.aem.commons.TurAemCommonsUtils;
+import com.viglet.turing.connector.aem.commons.TurAemObject;
+import com.viglet.turing.connector.aem.commons.context.TurAemSourceContext;
+import com.viglet.turing.connector.commons.TurConnectorSession;
+import com.viglet.turing.connector.commons.domain.TurConnectorIndexing;
+
+import static com.viglet.turing.connector.aem.commons.bean.TurAemEnv.PUBLISHING;
+
+public class TurAemPluginUtils {
+    public static String getObjectDetailForLogs(TurAemObject aemObject, TurAemSourceContext turAemSourceContext,
+                                          TurConnectorSession session) {
+        return "%s object (%s - %s - %s: %s)".formatted(
+                aemObject.getPath(),
+                turAemSourceContext.getId(),
+                PUBLISHING,
+                TurAemCommonsUtils.getLocaleFromAemObject(turAemSourceContext, aemObject),
+                session.getTransactionId());
+    }
+    public static String getObjectDetailForLogs(String contentId, TurConnectorIndexing indexing,
+                                          TurConnectorSession session) {
+        return "%s object (%s - %s - %s: %s)".formatted(
+                contentId,
+                session.getSource(),
+                indexing.getEnvironment(),
+                indexing.getLocale(),
+                session.getTransactionId());
+    }
+}

turing-connector/connector-app/src/main/java/com/viglet/turing/connector/impl/TurConnectorContextImpl.java

@@ -168,7 +168,7 @@ private void ignoreIndexingRulesStatus(TurSNJobItem turSNJobItem,
 
 
     private void ignoreIndexingRulesLog(TurSNJobItem turSNJobItem, TurConnectorSession session) {
-        log.info("{} was ignored by Indexing Rules.", getObjetDetailForLogs(turSNJobItem, session));
+        log.info("{} was ignored by Indexing Rules.", getObjectDetailForLogs(turSNJobItem, session));
     }
 
     private boolean indexingRuleIgnore(TurConnectorSession turConnectorSession, TurSNJobItem turSNJobItem) {
@@ -177,7 +177,6 @@ private boolean indexingRuleIgnore(TurConnectorSession turConnectorSession, TurS
                         .anyMatch(rule -> ignoredJobItem(turSNJobItem, rule));
     }
 
-
     private boolean ignoredJobItem(TurSNJobItem turSNJobItem, TurConnectorIndexingRuleModel rule) {
         for (String ruleValue : rule.getValues()) {
             if (StringUtils.isNotBlank(ruleValue)) {
@@ -234,34 +233,35 @@ private void sendToMessageQueueWhenMaxSize(TurConnectorSession session) {
     private void unchangedLog(TurSNJobItem turSNJobItem,
                               TurConnectorSession session) {
         if (!indexingService.exists(turSNJobItem, session)) return;
-        log.info("Unchanged {}", getObjetDetailForLogs(turSNJobItem, session));
+        log.info("Unchanged {}", getObjectDetailForLogs(turSNJobItem, session));
     }
 
     private void reindexLog(TurSNJobItem turSNJobItem,
                             TurConnectorSession session) {
         indexingService.getList(turSNJobItem, session).forEach(indexing ->
-                log.info("ReIndexed {} object ({} - {} - {}) from {} to {} and transactionId = {}",
-                        turSNJobItem.getId(), session.getSource(), turSNJobItem.getLocale(),
-                        turSNJobItem.getEnvironment(),
+                log.info("ReIndexed {} from {} to {}",
+                        getObjectDetailForLogs(turSNJobItem, session),
                         indexing.getChecksum(),
-                        turSNJobItem.getChecksum(),
-                        session.getTransactionId()));
+                        turSNJobItem.getChecksum()));
     }
 
     private void deIndexObjects(TurConnectorSession session) {
         List<TurConnectorIndexingModel> deindexedItems = indexingService.getShouldBeDeIndexedList(session);
         if (deindexedItems.isEmpty())
             return;
         deindexedItems.forEach(deIndexedItem -> createJobDeleteFromCreate(session, deIndexedItem));
-        indexingService.deleteComponentsListedAsDeIndexed(session);
+        indexingService.deleteContentsToBeDeIndexed(session);
         sendToMessageQueue(session);
     }
 
     private void createJobDeleteFromCreate(TurConnectorSession session,
                                            TurConnectorIndexingModel turConnectorIndexing) {
-        log.info("DeIndex {} object ({} - {} - {}) systemId and {} transactionId",
-                turConnectorIndexing.getObjectId(), turConnectorIndexing.getSource(), turConnectorIndexing.getLocale(),
-                turConnectorIndexing.getEnvironment(), session.getTransactionId());
+        log.info("DeIndex {} object ({} - {} - {}: {})",
+                turConnectorIndexing.getObjectId(),
+                turConnectorIndexing.getSource(),
+                turConnectorIndexing.getEnvironment(),
+                turConnectorIndexing.getLocale(),
+                session.getTransactionId());
         Map<String, Object> attributes = new HashMap<>();
         attributes.put(ID_ATTR, turConnectorIndexing.getObjectId());
         attributes.put(SOURCE_APPS_ATTR,
@@ -284,13 +284,13 @@ private void modifyIndexing(TurSNJobItem turSNJobItem,
 
     private void recreateDuplicatedIndexing(TurSNJobItem turSNJobItem, TurConnectorSession session, boolean standalone) {
         indexingService.delete(session, turSNJobItem);
-        log.info("Removed duplicated status {}", getObjetDetailForLogs(turSNJobItem, session));
+        log.info("Removed duplicated status {}", getObjectDetailForLogs(turSNJobItem, session));
         indexingService.save(turSNJobItem, session, PREPARE_FORCED_REINDEX, standalone);
         setSuccessStatus(turSNJobItem, session, PREPARE_FORCED_REINDEX);
-        log.info("Recreated status {}", getObjetDetailForLogs(turSNJobItem, session));
+        log.info("Recreated status {}", getObjectDetailForLogs(turSNJobItem, session));
     }
 
-    private String getObjetDetailForLogs(TurSNJobItem turSNJobItem, TurConnectorSession session) {
+    private String getObjectDetailForLogs(TurSNJobItem turSNJobItem, TurConnectorSession session) {
         return "%s object (%s - %s - %s: %s)".formatted(
                 turSNJobItem.getId(),
                 session.getSource(),
@@ -304,15 +304,15 @@ private void updateIndexing(TurSNJobItem turSNJobItem, TurConnectorSession sessi
                                 TurIndexingStatus status,
                                 boolean standalone) {
         indexingService.update(turSNJobItem, session, turConnectorIndexingList, status, standalone);
-        log.info("Updated status {}", getObjetDetailForLogs(turSNJobItem, session));
+        log.info("Updated status {}", getObjectDetailForLogs(turSNJobItem, session));
     }
 
 
     private void createIndexing(TurSNJobItem turSNJobItem,
                                 TurConnectorSession session,
                                 boolean standalone) {
         indexingService.save(turSNJobItem, session,PREPARE_INDEX, standalone);
-        log.info("Created status {}", getObjetDetailForLogs(turSNJobItem, session));
+        log.info("Created status {}", getObjectDetailForLogs(turSNJobItem, session));
         setSuccessStatus(turSNJobItem, session, PREPARE_INDEX);
     }
 

turing-connector/connector-app/src/main/java/com/viglet/turing/connector/service/TurConnectorIndexingService.java

@@ -31,7 +31,7 @@ public void deleteByProvider(String provider) {
         turConnectorIndexingRepository.deleteByProvider(provider);
     }
 
-    public void deleteComponentsListedAsDeIndexed(TurConnectorSession session) {
+    public void deleteContentsToBeDeIndexed(TurConnectorSession session) {
         turConnectorIndexingRepository.deleteBySourceAndProviderAndTransactionIdNot(session.getSource(),
                 session.getProviderName(), session.getTransactionId());
     }