Skip to content

v4.11.0 - Summer '23 Release

Compare
Choose a tag to compare
@jongpie jongpie released this 29 Jun 17:12
· 60 commits to main since this release
a834b5a

Managed Package Release - v4.11.0

This release is for both the unlocked package (as always), as well as the managed package! You can see everything that's changed between v4.10.0 and v4.11.0 by reviewing:

  • The v4.11.0 milestone to see all of the issues & pull requests that are included in the this release.
  • The diff between v4.10.0 and v4.11.0 to see all of the code & metadata changes that have been committed since the last managed package release.

⚠️ For orgs that are upgrading to this version of the managed package: two details to be aware of:

  1. The enhancement from is purposefully being excluded from the managed package for this release. Release v4.10.5 added a custom index to the field LogEntry__c.OriginLocation__c to help optimize anything that filters on this field, such as SOQL queries, list views, reports, etc. This was implemented using the recently-added metadata type CustomIndex, which is considered generally-available (GA). However, there have been a handful of related errors reported due to the CustomIndex metadata, so it's being excluded from the managed package this release as a precaution to avoid any related upgrade issues.
  2. There are some recent label changes to some existing metadata - most notably, the new lightning app "Logger Console" has been relabeled to "Nebula Logger". This change will not be automatically applied to orgs that are upgrading - you will continue to see the lightning app labeled as "Logger Console" in your org. It is completely your choice if you would like to keep the existing label, or manually relabel it in your org. If you would like to relabel it in your org, you can edit it under Setup --> App Manager --> edit the Logger Console app.

Core Unlocked Package Changes - v4.11.0

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)

    image

  • Resolved #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:

    image

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)

      image

    • 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)

      image

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.

    image

LoggerAdmin Dashboard Changes

  • Removed the XML node <runningUser>[email protected]</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 & Release Notes 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
  • Updated release notes to start including the SF CLI command (see below!)

Installation Info

Core Unlocked Package - no namespace

Full Changelog: v4.10.6...v4.11.0

Core Managed Package - Nebula namespace

Full Changelog: v4.9.0...v4.10.0