relatedLogEntries LWC Improvements (#956)

* Refactored RelatedLogEntriesController to use SOSL to search for the related record ID in all fields (instead of only checking LogEntry__c.RecordId__c)

* Also updated the controller so picklist labels are returned instead of the raw value (e.g., LoggingLevel__c's labels include emojis that are now displayed)

* Updated relatedLogEntries LWC to visually better align with the appearance of standard related lists

* Scope creep: cleaned up a few unrelated bits in a few Apex classes

* Scope creep: Added Apex class access for CallableLogger to the LoggerLogCreator permission set to ensure the running user can use it in contexts like OmniStudio

Author: jongpie

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.17.2
+## Unlocked Package - v4.17.3
 
-[![Install Unlocked Package in a Sandbox](./images/btn-install-unlocked-package-sandbox.png)](https://test.salesforce.com/packaging/installPackage.apexp?p0=04tg700000015gnAAA)
-[![Install Unlocked Package in Production](./images/btn-install-unlocked-package-production.png)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04tg700000015gnAAA)
+[![Install Unlocked Package in a Sandbox](./images/btn-install-unlocked-package-sandbox.png)](https://test.salesforce.com/packaging/installPackage.apexp?p0=04tg70000001IMHAA2)
+[![Install Unlocked Package in Production](./images/btn-install-unlocked-package-production.png)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04tg70000001IMHAA2)
 [![View Documentation](./images/btn-view-documentation.png)](https://github.com/jongpie/NebulaLogger/wiki)
 
-`sf package install --wait 20 --security-type AdminsOnly --package 04tg700000015gnAAA`
+`sf package install --wait 20 --security-type AdminsOnly --package 04tg70000001IMHAA2`
 
 ---
 

docs/apex/Log-Management/LogManagementDataSelector.md

@@ -457,29 +457,6 @@ List<Schema.Group>
 
 The list of matching `Schema.Group` records
 
-#### `getRecordLogEntries(Id recordId, String fieldsClause, String orderByClause, Integer rowLimit)` → `List<LogEntry__c>`
-
-Returns the list of `LogEntry__c` records related to the specified record ID
-
-##### Parameters
-
-| Param           | Description                                                                        |
-| --------------- | ---------------------------------------------------------------------------------- |
-| `recordId`      | The `ID` to use for filtering `LogEntry__c` records                                |
-| `fieldsClause`  | A comma-separated `String` of field API names to include in the query              |
-| `orderByClause` | A comma-separated `String` of field API names to use for sorting the query results |
-| `rowLimit`      | The maximum number of records to return                                            |
-
-##### Return
-
-**Type**
-
-List&lt;LogEntry\_\_c&gt;
-
-**Description**
-
-The list of matching `LogEntry__c` records
-
 #### `getTagsByName(Set<String> tagNames)` → `List<LoggerTag__c>`
 
 Returns a list of `LoggerTag__c` records with one of the specified tag names

docs/apex/Log-Management/RelatedLogEntriesController.md

@@ -10,7 +10,7 @@ Controller class for the lightning web component `related-log-entries`
 
 ### Methods
 
-#### `getQueryResult(Id recordId,String fieldSetName,Integer rowLimit,Integer rowOffset,String sortByFieldName,String sortDirection,String search)` → `LogEntryQueryResult`
+#### `getQueryResult(Id recordId,String fieldSetName,Integer rowLimit,String sortByFieldName,String sortDirection,String search)` → `LogEntryQueryResult`
 
 Used by the component relatedLogEntries to get log entries for a particular record (based on record ID)
 
@@ -21,7 +21,6 @@ Used by the component relatedLogEntries to get log entries for a particular reco
 | `recordId`        | Used to filter LogEntry**c records where RecordId**c == recordId |
 | `fieldSetName`    | The API/developer name of the field set                          |
 | `rowLimit`        | The max number of rows to query                                  |
-| `rowOffset`       | Reserved for future use                                          |
 | `sortByFieldName` | The field to sort by                                             |
 | `sortDirection`   | The direction to sort by (asc or desc))                          |
 | `search`          | An optional search term to filter by                             |
@@ -128,8 +127,4 @@ Contains the plural label of the log entry sObject, fetched using a describe cal
 
 contains the log entry results from the query.
 
-###### `totalLogEntriesCount` → `Integer`
-
-Contains the number of records returned via the log entries query.
-
 ---

docs/apex/Logger-Engine/LogEntryEventBuilder.md

@@ -36,6 +36,10 @@ Used by `Logger` to instantiate a new instance of `LogEntryEventBuilder`
 
 #### `aggregateQueriesMax` → `Integer`
 
+#### `apexCursorFetchCallsMax` → `Integer`
+
+#### `apexCursorRowsMax` → `Integer`
+
 #### `asyncCallsMax` → `Integer`
 
 #### `calloutsMax` → `Integer`

nebula-logger/core/main/log-management/classes/LogEntryFieldSetPicklist.cls

@@ -38,7 +38,7 @@ public without sharing class LogEntryFieldSetPicklist extends VisualEditor.Dynam
   }
 
   private VisualEditor.DataRow createDataRow(Schema.FieldSet fieldSet) {
-    String namespacePrefix = String.isBlank(fieldSet.getNameSpace()) ? '' : fieldSet.getNameSpace() + '__';
+    String namespacePrefix = String.isBlank(fieldSet.getNamespace()) ? '' : fieldSet.getNamespace() + '__';
     return new VisualEditor.DataRow(fieldSet.getLabel(), namespacePrefix + fieldSet.getName());
   }
 }

nebula-logger/core/main/log-management/classes/LogManagementDataSelector.cls

@@ -364,29 +364,6 @@ public without sharing virtual class LogManagementDataSelector {
     return [SELECT Id, DeveloperName FROM Group WHERE Type = 'Queue' AND DeveloperName IN :queueDeveloperNames];
   }
 
-  /**
-   * @description Returns the list of `LogEntry__c` records related to the specified record ID
-   * @param  recordId      The `ID` to use for filtering `LogEntry__c` records
-   * @param  fieldsClause  A comma-separated `String` of field API names to include in the query
-   * @param  orderByClause A comma-separated `String` of field API names to use for sorting the query results
-   * @param  rowLimit      The maximum number of records to return
-   * @return               The list of matching `LogEntry__c` records
-   */
-  @SuppressWarnings('PMD.ExcessiveParameterList')
-  public virtual List<LogEntry__c> getRecordLogEntries(Id recordId, String fieldsClause, String orderByClause, Integer rowLimit) {
-    List<Object> queryTextReplacements = new List<Object>{
-      fieldsClause,
-      Schema.LogEntry__c.SObjectType.toString(),
-      Schema.LogEntry__c.RecordId__c.toString(),
-      orderByClause,
-      rowLimit
-    };
-    String logEntryQuery = 'SELECT {0} FROM {1} WHERE {2} = :recordId ORDER BY {3} LIMIT {4}';
-    logEntryQuery = String.format(logEntryQuery, queryTextReplacements);
-
-    return (List<LogEntry__c>) System.Database.query(String.escapeSingleQuotes(logEntryQuery));
-  }
-
   /**
    * @description Returns a list of `LoggerTag__c` records with one of the specified tag names
    * @param  tagNames The set of `String` tag names to query

nebula-logger/core/main/log-management/classes/RelatedLogEntriesController.cls

@@ -19,7 +19,7 @@ public with sharing class RelatedLogEntriesController {
    * @param  recordId        Used to filter LogEntry__c records where RecordId__c == recordId
    * @param  fieldSetName    The API/developer name of the field set
    * @param  rowLimit        The max number of rows to query
-   * @param  rowOffset       Reserved for future use
+
    * @param  sortByFieldName The field to sort by
    * @param  sortDirection   The direction to sort by (asc or desc))
    * @param  search          An optional search term to filter by
@@ -31,57 +31,52 @@ public with sharing class RelatedLogEntriesController {
     Id recordId,
     String fieldSetName,
     Integer rowLimit,
-    Integer rowOffset,
     String sortByFieldName,
     String sortDirection,
     String search
   ) {
-    // TODO use rowOffset to implement infinite-loading
     FieldSetMetadata fieldSetMetdata = new FieldSetMetadata(LOG_ENTRY_SOBJECT_TYPE, fieldSetName);
 
     String fieldsClause = getFieldsClause(fieldSetMetdata.fields);
     String orderByClause = getOrderByClause(sortByFieldName, sortDirection);
 
-    List<LogEntry__c> records;
-    if (String.isNotBlank(search) && search.length() >= 3) {
-      records = search(recordId, search, fieldsClause, orderByClause, rowLimit);
-    } else {
-      records = LogManagementDataSelector.getInstance().getRecordLogEntries(recordId, fieldsClause, orderByClause, rowLimit);
-    }
-
-    // Somewhat redundant security check for FLS (but extra security > less security)
-    System.SObjectAccessDecision securityDecision = System.Security.stripInaccessible(System.AccessType.READABLE, records);
-    records = securityDecision.getRecords();
-
-    Integer totalLogEntriesCount = LogManagementDataSelector.getInstance().getCountOfRelatedRecordLogEntries(recordId);
-
-    return new LogEntryQueryResult(fieldSetMetdata, records, totalLogEntriesCount);
+    List<LogEntry__c> records = search(recordId, search, fieldsClause, orderByClause, rowLimit);
+    return new LogEntryQueryResult(fieldSetMetdata, records);
   }
 
-  // Private static helper methods
-
   @SuppressWarnings('PMD.ExcessiveParameterList')
   private static List<LogEntry__c> search(Id recordId, String searchTerm, String fieldsClause, String orderByClause, Integer rowLimit) {
-    searchTerm = '\'*' + String.escapeSingleQuotes(searchTerm) + '*\'';
+    // SOSL can search for a 15-character ID, but for some reason, using the 18-character version returns no results (╯‵□′)╯︵┻━┻
+    String fullSearchExpression = '*' + String.escapeSingleQuotes(String.valueOf(recordId).left(15)) + '*';
+    if (String.isNotBlank(searchTerm)) {
+      fullSearchExpression += ' AND *' + String.escapeSingleQuotes(searchTerm) + '*';
+    }
+    fullSearchExpression = '\'' + fullSearchExpression + '\'';
 
     List<Object> searchTextReplacements = new List<Object>{
-      searchTerm,
+      fullSearchExpression,
       String.valueOf(Schema.LogEntry__c.SObjectType),
       fieldsClause,
-      String.valueOf(Schema.LogEntry__c.RecordId__c),
       orderByClause,
       rowLimit
     };
-    String logEntrySearch = 'FIND {0} IN ALL FIELDS RETURNING {1}({2} WHERE {3} = :recordId ORDER BY {4} LIMIT {5})';
-    logEntrySearch = String.format(logEntrySearch, searchTextReplacements);
+    String logEntrySearch = String.format('FIND {0} IN ALL FIELDS RETURNING {1} ({2} ORDER BY {3} LIMIT {4})', searchTextReplacements);
 
-    return (List<LogEntry__c>) System.Search.query(logEntrySearch).get(0);
+    List<LogEntry__c> matches = (List<LogEntry__c>) System.Search.query(logEntrySearch).get(0);
+
+    // Somewhat redundant security check for FLS (but extra security > less security)
+    return System.Security.stripInaccessible(System.AccessType.READABLE, matches).getRecords();
   }
 
   private static String getFieldsClause(List<FieldMetadata> fields) {
-    List<String> fieldNames = new List<String>();
+    // Make sure these fields are always included, even if they're not in the fieldset, in case the LWC needs them
+    Set<String> fieldNames = new Set<String>{
+      LogEntry__c.DatabaseResultJson__c.toString(),
+      LogEntry__c.RecordId__c.toString(),
+      LogEntry__c.RecordJson__c.toString()
+    };
     for (FieldMetadata fieldMetadata : fields) {
-      fieldNames.add(fieldMetadata.fieldName);
+      fieldNames.add(fieldMetadata.type == 'picklist' ? ('toLabel(' + fieldMetadata.fieldName + ')') : fieldMetadata.fieldName);
 
       // For lookups, also include the display name of parent object
       if (fieldMetadata.lookupDisplayFieldName != null) {
@@ -186,19 +181,12 @@ public with sharing class RelatedLogEntriesController {
     @AuraEnabled
     public List<LogEntry__c> records { get; set; }
 
-    /**
-     * @description Contains the number of records returned via the log entries query.
-     */
-    @AuraEnabled
-    public Integer totalLogEntriesCount { get; set; }
-
-    private LogEntryQueryResult(FieldSetMetadata fieldSetMetadata, List<LogEntry__c> records, Integer totalLogEntriesCount) {
+    private LogEntryQueryResult(FieldSetMetadata fieldSetMetadata, List<LogEntry__c> records) {
       this.fieldSet = fieldSetMetadata;
       this.isAccessible = LOG_ENTRY_SOBJECT_TYPE.getDescribe().isAccessible();
       this.label = LOG_ENTRY_SOBJECT_TYPE.getDescribe().getLabel();
       this.labelPlural = LOG_ENTRY_SOBJECT_TYPE.getDescribe().getLabelPlural();
       this.records = records;
-      this.totalLogEntriesCount = totalLogEntriesCount;
     }
   }
 
@@ -235,7 +223,7 @@ public with sharing class RelatedLogEntriesController {
         }
       }
 
-      String namespacePrefix = String.isBlank(fieldSet.getNameSpace()) ? '' : fieldSet.getNameSpace() + '__';
+      String namespacePrefix = String.isBlank(fieldSet.getNamespace()) ? '' : fieldSet.getNamespace() + '__';
 
       this.label = fieldSet.getLabel();
       this.name = namespacePrefix + fieldSet.getName();

nebula-logger/core/main/log-management/lwc/relatedLogEntries/__tests__/data/getQueryResult.json

@@ -1,5 +1,4 @@
 {
-  "totalLogEntriesCount": 4,
   "records": [
     {
       "attributes": { "type": "LogEntry__c", "url": "/services/data/v53.0/sobjects/LogEntry__c/a0054000004OazXAAS" },

nebula-logger/core/main/log-management/lwc/relatedLogEntries/relatedLogEntries.html

@@ -5,32 +5,47 @@
 
 <template>
   <template if:true={showComponent}>
-    <lightning-card title={title} icon-name="custom:custom83" class="log-entry-card">
-      <div class="slds-grid" slot="actions">
-        <lightning-input
-          class="slds-m-right_xx-small"
-          data-id="enter-search"
-          placeholder="Search"
-          type="search"
-          value={search}
-          onchange={handleSearchChange}
-          variant="label-hidden"
-        ></lightning-input>
-        <lightning-button-icon icon-name="utility:refresh" onclick={refresh}></lightning-button-icon>
+    <article class="slds-card slds-card_boundary">
+      <div class="slds-card__header slds-grid">
+        <header class="slds-media slds-media_center slds-has-flexi-truncate">
+          <div class="slds-media__figure">
+            <lightning-icon icon-name="custom:custom83" size="small"></lightning-icon>
+          </div>
+          <div class="slds-media__body slds-m-bottom_small">
+            <h2 class="slds-card__header-title">
+              <span class="slds-truncate">{title}</span>
+            </h2>
+          </div>
+          <div class="slds-no-flex">
+            <lightning-input
+              class="slds-m-right_xx-small"
+              data-id="enter-search"
+              placeholder="Search"
+              type="search"
+              value={search}
+              onchange={handleSearchChange}
+              style="display: inline-block"
+              variant="label-hidden"
+            ></lightning-input>
+            <lightning-button-icon icon-name="utility:refresh" onclick={refresh}></lightning-button-icon>
+          </div>
+        </header>
       </div>
-      <div class="slds-is-relative">
-        <lightning-datatable
-          key-field="id"
-          show-row-number-column="true"
-          data={queryResult.records}
-          columns={queryResult.fieldSet.fields}
-          onsort={handleSort}
-          sorted-by={sortBy}
-          sorted-direction={sortDirection}
-          default-sort-direction={sortDirection}
-        ></lightning-datatable>
+      <div class="slds-card__body">
         <lightning-spinner if:true={isLoading} size="small"></lightning-spinner>
+        <div class="slds-is-relative" if:true={queryResult}>
+          <lightning-datatable
+            key-field="id"
+            show-row-number-column="true"
+            data={queryResult.records}
+            columns={queryResult.fieldSet.fields}
+            onsort={handleSort}
+            sorted-by={sortBy}
+            sorted-direction={sortDirection}
+            default-sort-direction={sortDirection}
+          ></lightning-datatable>
+        </div>
       </div>
-    </lightning-card>
+    </article>
   </template>
 </template>

nebula-logger/core/main/log-management/lwc/relatedLogEntries/relatedLogEntries.js

@@ -17,13 +17,20 @@ export default class RelatedLogEntries extends LightningElement {
   @api search = '';
   @api queryResult;
 
-  @track showComponent = false;
-  @track title;
   @track wiredResult;
   @track isLoading = true;
 
+  get title() {
+    return this.queryResult ? this.queryResult.labelPlural + ' (' + this.queryResult.records.length + ')' : '';
+  }
+
+  get showComponent() {
+    return this.queryResult?.isAccessible === true;
+  }
+
   @api
   handleSort(event) {
+    this.isLoading = true;
     this.sortBy = event.detail.fieldName;
     this.sortDirection = event.detail.sortDirection;
   }
@@ -43,15 +50,11 @@ export default class RelatedLogEntries extends LightningElement {
     search: '$search'
   })
   wiredLogEntries(result) {
+    this.isLoading = true;
     this.wiredResult = result;
     if (result.data) {
-      let queryResult = this.processResult(result.data);
-      this.queryResult = queryResult;
-      this.showComponent = queryResult.isAccessible;
-      this.title = queryResult.labelPlural + ' (' + queryResult.totalLogEntriesCount + ' Total)';
+      this.queryResult = this.processResult(result.data);
     } else if (result.error) {
-      this.logEntryData = undefined;
-      this.logEntryColumns = undefined;
       /* eslint-disable-next-line no-console */
       console.log(result.error);
     }