Summer '23 Release (API v58.0) - v4.11.0

[jongpie]

Manage Package Changes

One change in this PR that's specific to the manage package: .forceignore has been updated to exclude the new CustomIndex for the field LogEntry__c.OriginLocation__c (added in v4.10.5). The CustomIndex metadata type is considered generally available by Salesforce, but there have been a handful of gack errors reported that are related to the custom index failing to deploy in some orgs. So, as a precaution, the CustomIndex is unfortunately being excluded from the managed package this release to avoid any related upgrade issues - hopefully, the index will be added to the next managed package version, the Winter '24 release.

Core Unlocked Package Changes

Metadata API Version Updated to v58.0

• Updated all metadata to API v58.0 (Summer '23 release)
• Updated some picklist values to have options for API v58.0 and 59.0
• Simplified some Apex calls to String.join() to remove extra conversions of Set<String> to List<String> - Summer '23 now supports iterating over Set<Object>
• Retrieved the metadata for fields & objects so the repo's version more closely matches the XML returned by the platform

logEntryEventStream LWC Enhancements

Currently, the LWC logEntryEventStream uses the emp API to subscribe/display the stream of LogEntryEvent__e platform events, which counts towards your org's daily limit for platform event delivery allocation (the docs for Platform Event Allocations has more details on this limit).

To help mitigate the usage of the org daily limit for platform event daily delivery allocations, this release includes 2 related changes:

• Added new control "Max Number of Events to Stream" (shown as #1 in the screenshot below) to set the max number of events to deliver to the LWC before the component auto-pauses the stream. A counter of the total number of events streamed for your session has also been added (shown as #2 in the screenshot below), as well as a <lightning-progress-ring> to show the percentage of events to stream before the component auto-pauses itself (shown as #3 in the screenshot below)

  

• Resolved Add new LoggerParameter__mdt record to enable/disable logEntryEventStream lwc #488 by adding new LoggerParameter__mdt record EnableLogEntryEventStream - when set to false, the entire component is completely disabled for the entire organization. The buttons on the LWC are hidden, input elements are disabled, and a warning message is displayed:

  

loggerHomeHeader LWC Enhancements

• Added plugin information to the header component in 2 places:

  • Added a count of enabled plugins directly below the lightning card's title. This only displays when 1 or more plugins are enabled in your org (not available in the managed package)

    

  • Added a comma-separated list of enabled plugins to 'Environment Details' button modal. This only displays when 1 or more plugins are enabled in your org (not available in the managed package)

    

LoggerHomePage FlexiPage Changes

• Updated the LoggerAdmin dashboard component on the LoggerHomePage FlexiPage to not hide the dashboard on error (controlled by updating the componentInstanceProperties attribute hideOnError to false - shown in App Builder with MS Paint's amazing ⚡ shape in the screenshot below). Previously, if the dashboard had any errors (such as permission issues with the running user), the home page just displayed an unhelpful empty space in place of the dashboard, making it hard to tell if the page had loaded properly or if the dashboard had an error. Now, the dashboard will display either way.

  

LoggerAdmin Dashboard Changes

• Removed the XML node <runningUser>test-triqc8kt7jj0@example.com</runningUser> in LoggerAdmin.dashboard-meta.xml that caused problems for orgs that deploy the metadata (instead of using the unlocked or managed packages)
  • This value was from a scratch org used for building the dashboard, and including it in the metadata worked fine when deploying to other scratch orgs & when creating/installing package versions (even though that particular username would not exist in other orgs). However, when deploying Nebula Logger's metadata to production orgs, the deployment would fail due to not being able to find the matching user. Removing the XML node entirely avoids the deployment issue altogether, and seems cleaner than storing a random scratch org username inside of git

More Label Changes

• Updated the labels for several metadata items to start with "Nebula Logger" (instead of just "Logger") for clarity on what metadata is part of Nebula Logger - this is especially helpful in orgs that deploy the metadata (instead of using the unlocked or managed packages). The changed metadata includes:
  • AnimationRule
  • CustomPermission
  • FlexiPage
  • GlobalValueSet
  • LWCs
  • Permission Sets
  • Visualforce page

Updated Permission Sets

• Small bugfix from v4.10.6 release - updated the LoggerAdmin & LoggerLogViewer permission sets to add missing Apex class access to LoggerHomeHeaderController

README.md & Pipeline Changes

• Updated README.md to include the package installation command for the SF CLI (in addition to the SFDX CLI)
• Updated README.md to use the "classic" commands for SFDX CLI to better support people that are still using older versions of the SFDX CLI
• Updated the pipeline's pwsh script so it automatically update the package version ID in README.md for the new SF CLI command

[jamessimone]

Don’t forget the String.join changes!

[jongpie]

@jamessimone thanks for the reminder! I.... had already forgot about it! 😅

[codecov]

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.59 🎉

Comparison is base (36f7440) 94.94% compared to head (8b6356e) 95.54%.

❗ Current head 8b6356e differs from pull request most recent head 6df8a4f. Consider uploading reports for the commit 6df8a4f to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #507      +/-   ##
==========================================
+ Coverage   94.94%   95.54%   +0.59%     
==========================================
  Files          59       48      -11     
  Lines        5994     5045     -949     
  Branches      129        0     -129     
==========================================
- Hits         5691     4820     -871     
+ Misses        298      225      -73     
+ Partials        5        0       -5     

Flag	Coverage Δ
Apex	95.54% <100.00%> (+0.04%)	⬆️
LWC	?

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...-logger/core/main/logger-engine/classes/Logger.cls	96.10% <ø> (ø)
...ore/main/configuration/classes/LoggerParameter.cls	100.00% <100.00%> (ø)
...r/core/main/configuration/classes/LoggerPlugin.cls	96.92% <100.00%> (+0.25%)	⬆️
...nagement/classes/LogEntryEventStreamController.cls	100.00% <100.00%> (ø)
...g-management/classes/LogManagementDataSelector.cls	100.00% <100.00%> (+1.00%)	⬆️
...-management/classes/LoggerHomeHeaderController.cls	100.00% <100.00%> (ø)

... and 11 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.