Callable Logger updates (#835)

* Fixed internally reported issue with tags not being passed as a List<String> but as a List<Object> from OmniStudio

* Closed #814 by adding tryCatch callable method for OmniStudio

* Updated CallableLogger to add some explanatory comments for the OmniStudio-specific code

Author: jamessimone

README.md

@@ -5,13 +5,13 @@
 
 The most robust observability solution for Salesforce experts. Built 100% natively on the platform, and designed to work seamlessly with Apex, Lightning Components, Flow, OmniStudio, and integrations.
 
-## Unlocked Package - v4.15.5
+## Unlocked Package - v4.15.6
 
-[![Install Unlocked Package in a Sandbox](./images/btn-install-unlocked-package-sandbox.png)](https://test.salesforce.com/packaging/installPackage.apexp?p0=04t5Y0000015p5jQAA)
-[![Install Unlocked Package in Production](./images/btn-install-unlocked-package-production.png)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t5Y0000015p5jQAA)
+[![Install Unlocked Package in a Sandbox](./images/btn-install-unlocked-package-sandbox.png)](https://test.salesforce.com/packaging/installPackage.apexp?p0=04t5Y0000015pEdQAI)
+[![Install Unlocked Package in Production](./images/btn-install-unlocked-package-production.png)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t5Y0000015pEdQAI)
 [![View Documentation](./images/btn-view-documentation.png)](https://github.com/jongpie/NebulaLogger/wiki)
 
-`sf package install --wait 20 --security-type AdminsOnly --package 04t5Y0000015p5jQAA`
+`sf package install --wait 20 --security-type AdminsOnly --package 04t5Y0000015pEdQAI`
 
 ---
 

nebula-logger/core/main/logger-engine/classes/CallableLogger.cls

@@ -72,6 +72,11 @@ global without sharing class CallableLogger implements System.Callable {
   @SuppressWarnings('PMD.ApexDoc, PMD.StdCyclomaticComplexity')
   private class CallableHandler {
     public void handleCall(String action, Map<String, Object> input, Map<String, Object> output) {
+      if (action == 'tryCatch') {
+        action = 'newEntry';
+        input.put(ARGUMENT_MESSAGE, 'An unexpected error occurred:\n' + System.JSON.serializePretty(input));
+        input.put(ARGUMENT_LOGGING_LEVEL, System.LoggingLevel.ERROR.name());
+      }
       switch on action {
         // Methods for transaction IDs / parent transaction IDs
         when 'getTransactionId' {
@@ -148,7 +153,10 @@ global without sharing class CallableLogger implements System.Callable {
         logEntryEventBuilder.setRecord((Map<Id, SObject>) input.get(ARGUMENT_RECORD_MAP));
       }
       if (input.containsKey(ARGUMENT_TAGS)) {
-        logEntryEventBuilder.addTags((List<String>) input.get(ARGUMENT_TAGS));
+        List<Object> tags = (List<Object>) input.get(ARGUMENT_TAGS);
+        for (Object tag : tags) {
+          logEntryEventBuilder.addTag(tag?.toString());
+        }
       }
       if (CallableLogger.isOmniStudioInput(input)) {
         LogEntryEvent__e logEntryEvent = logEntryEventBuilder.getLogEntryEvent();
@@ -172,20 +180,10 @@ global without sharing class CallableLogger implements System.Callable {
   }
 
   private static String getFormattedMessage(Map<String, Object> originalInput) {
-    String message = (String) originalInput.get(ARGUMENT_MESSAGE);
+    String message = (String) originalInput.get(ARGUMENT_MESSAGE) ?? '';
 
     if (CallableLogger.isOmniStudioInput(originalInput)) {
-      Map<String, Object> cleanedInput = new Map<String, Object>();
-      for (String inputName : originalInput.keySet()) {
-        Object inputValue = originalInput.get(inputName);
-        if (inputValue instanceof Map<String, Object>) {
-          cleanedInput.put(inputName, inputValue);
-        }
-      }
-
-      if (cleanedInput.keySet().isEmpty() == false) {
-        message += '\n\nOmniStudio Input:\n' + System.JSON.serializePretty(cleanedInput);
-      }
+      message += addOmniStudioSpecificFormatting(originalInput);
     }
 
     return message;
@@ -194,4 +192,19 @@ global without sharing class CallableLogger implements System.Callable {
   private static Boolean isOmniStudioInput(Map<String, Object> input) {
     return input.containsKey(OMNISTUDIO_ARGUMENT_INPUT_OMNI_PROCESS_ID) || Logger.getCurrentQuiddity() == System.Quiddity.REMOTE_ACTION;
   }
+
+  private static String addOmniStudioSpecificFormatting(Map<String, Object> originalInput) {
+    // "Remote Actions of Omniscripts and Integration Procedures can invoke any class that implements Callable"
+    // within both of those, OmniStudio developers can declaratively add "Additional Inputs", which themselves
+    // are a key/value pairing
+    Map<String, Object> cleanedOmniStudioInputs = new Map<String, Object>();
+    for (String inputName : originalInput.keySet()) {
+      Object inputValue = originalInput.get(inputName);
+      if (inputValue instanceof Map<String, Object>) {
+        cleanedOmniStudioInputs.put(inputName, inputValue);
+      }
+    }
+    // if we've added any of the so-called Additional Inputs, help to differentiate them within the larger message
+    return cleanedOmniStudioInputs.isEmpty() == false ? '\n\nOmniStudio Input:\n' + System.JSON.serializePretty(cleanedOmniStudioInputs) : '';
+  }
 }

nebula-logger/core/main/logger-engine/classes/Logger.cls

@@ -15,7 +15,7 @@
 global with sharing class Logger {
   // There's no reliable way to get the version number dynamically in Apex
   @TestVisible
-  private static final String CURRENT_VERSION_NUMBER = 'v4.15.5';
+  private static final String CURRENT_VERSION_NUMBER = 'v4.15.6';
   private static final System.LoggingLevel FALLBACK_LOGGING_LEVEL = System.LoggingLevel.DEBUG;
   private static final List<LogEntryEventBuilder> LOG_ENTRIES_BUFFER = new List<LogEntryEventBuilder>();
   private static final String MISSING_SCENARIO_ERROR_MESSAGE = 'No logger scenario specified. A scenario is required for logging in this org.';

nebula-logger/core/main/logger-engine/lwc/logger/loggerService.js

@@ -10,7 +10,7 @@ import LoggerServiceTaskQueue from './loggerServiceTaskQueue';
 import getSettings from '@salesforce/apex/ComponentLogger.getSettings';
 import saveComponentLogEntries from '@salesforce/apex/ComponentLogger.saveComponentLogEntries';
 
-const CURRENT_VERSION_NUMBER = 'v4.15.5';
+const CURRENT_VERSION_NUMBER = 'v4.15.6';
 
 const CONSOLE_OUTPUT_CONFIG = {
   messagePrefix: `%c  Nebula Logger ${CURRENT_VERSION_NUMBER}  `,

nebula-logger/core/tests/logger-engine/classes/CallableLogger_Tests.cls

@@ -500,7 +500,7 @@ private class CallableLogger_Tests {
   static void it_adds_new_entry_with_tags_when_using_standard_approach() {
     System.LoggingLevel loggingLevel = System.LoggingLevel.FINE;
     String message = 'some log entry message';
-    List<String> tags = new List<String>{ 'some-tag', 'another-tag' };
+    List<Object> tags = new List<Object>{ 'some-tag', 'another-tag', 1 };
 
     System.Callable callableLoggerInstance = (System.Callable) System.Type.forName('CallableLogger').newInstance();
     Map<String, Object> returnedOutput = (Map<String, Object>) callableLoggerInstance
@@ -623,4 +623,17 @@ private class CallableLogger_Tests {
     System.Assert.areEqual(0, Logger.getBufferSize());
     System.Assert.areEqual(targetSaveMethodName, Logger.lastSaveMethodNameUsed);
   }
+
+  @IsTest
+  static void it_logs_try_catch_when_passed_as_action() {
+    System.Callable callableLoggerInstance = (System.Callable) System.Type.forName('CallableLogger').newInstance();
+    Map<String, Object> input = new Map<String, Object>{ 'argument_1' => 'first arg', 'argument_2' => 'second arg' };
+
+    Map<String, Object> returnedOutput = (Map<String, Object>) callableLoggerInstance.call('tryCatch', input.clone());
+
+    System.Assert.areEqual(true, returnedOutput.get('isSuccess'), 'Expected isSuccess == true. Output received: ' + returnedOutput);
+    LogEntryEvent__e logEntryEvent = ((LogEntryEventBuilder) returnedOutput.get('logEntryEventBuilder')).getLogEntryEvent();
+    System.Assert.areEqual('An unexpected error occurred:\n' + System.JSON.serializePretty(input), logEntryEvent.Message__c);
+    System.Assert.areEqual(System.LoggingLevel.ERROR.name(), logEntryEvent.LoggingLevel__c);
+  }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nebula-logger",
-  "version": "4.15.5",
+  "version": "4.15.6",
   "description": "The most robust logger for Salesforce. Works with Apex, Lightning Components, Flow, Process Builder & Integrations. Designed for Salesforce admins, developers & architects.",
   "author": "Jonathan Gillespie",
   "license": "MIT",

sfdx-project.json

@@ -9,9 +9,9 @@
       "path": "./nebula-logger/core",
       "definitionFile": "./config/scratch-orgs/base-scratch-def.json",
       "scopeProfiles": true,
-      "versionNumber": "4.15.5.NEXT",
-      "versionName": "Bugfix for AuthSession with null LoginHistory exception message handling",
-      "versionDescription": "Added safe navigation operator on LoginHistory from authSession records to avoid a NullPointerException",
+      "versionNumber": "4.15.6.NEXT",
+      "versionName": "Adds tryCatch CallableLogger method",
+      "versionDescription": "tryCatch CallableLogger method for OmniStudio and other decoupled logging usages",
       "postInstallUrl": "https://github.com/jongpie/NebulaLogger/wiki",
       "releaseNotesUrl": "https://github.com/jongpie/NebulaLogger/releases",
       "unpackagedMetadata": {
@@ -210,6 +210,7 @@
     "Nebula Logger - Core@4.15.3-improved-testability-of-queries": "04t5Y0000015ok2QAA",
     "Nebula Logger - Core@4.15.4-flowlogger-exception-message-handling": "04t5Y0000015oklQAA",
     "Nebula Logger - Core@4.15.5-bugfix-for-authsession-with-null-loginhistory-exception-message-handling": "04t5Y0000015p5jQAA",
+    "Nebula Logger - Core@4.15.6-adds-trycatch-callablelogger-method": "04t5Y0000015pEdQAI",
     "Nebula Logger - Core Plugin - Async Failure Additions": "0Ho5Y000000blO4SAI",
     "Nebula Logger - Core Plugin - Async Failure Additions@1.0.0": "04t5Y0000015lhiQAA",
     "Nebula Logger - Core Plugin - Async Failure Additions@1.0.1": "04t5Y0000015lhsQAA",