Added the option to automatically call the lightning-logger LWC (#743)

* Resolved #722 by adding the optional ability to automatically call Salesforce's lightning-logger LWC when logging via lightning components, which creates a "Lightning Logger" event in Event Monitoring
    * This includes new fields LoggerSettings__c.IsJavaScriptLightningLoggerEnabled__c and LoggerScenarioRule__mdt.IsJavaScriptLightningLoggerEnabled__c to control enabling this feature

* Finished some code cleanup left over from v4.13.15 in logEntryBuilder.js and ComponentLogger.cls
    * Now browser details are represented as an object in both JS and Apex, and some old deprecated properties have been removed
    * Also added some extra jest tests to validate that the browser details are being properly set
    
* Scope creep: fixed a small bug in a Logger where a System.debug() statement for scenario-based logging was using the wrong variable

* Scope creep: removed unnecessary access to FlowLogger in the permission set LoggerLogCreator
    * FlowLogger should only be called internally by Nebula Logger, so there's no need for users to have direct access to it

* Created additional scratch def files & added them to build.yml - each one corresponds to a specific Salesforce feature that's optionally used by Nebula Logger
    * There are now 5 scratch def files - 1 used for dev, and 4 used by the pipeline (base (used for packaging), event monitoring, experience cloud, and platform cache)
    * The pipeline will only create 2 scratch orgs at a time to avoid the dev hub's limit of 3 active scratch orgs (1 of 3 available is used for dev work)

* Removed an old/duplicate Experience Cloud site (used by the pipeline)

* Added Apex class access to 2 Experience Cloud Guest User profiles (used by the pipeline + dev) to simplify manual testing efforts

* Upgraded to sf rc v2.56.6 to use the new --concise flag on sf apex test run

* Upgraded to v4 of the codecov action in build.yml

* Added a new bash script, ./scripts/dev/setup-dev-scratch-org.sh, to automate setting up a new dev scratch org

Author: jongpie

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -1,6 +1,6 @@
 name: Bug Report
 description: File a bug report for Nebula Logger
-labels: ['bug']
+labels: ['Type: Bug']
 body:
   - type: dropdown
     id: package-edition

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -1,6 +1,6 @@
 name: Feature Request
 description: Suggest an enhancement for Nebula Logger
-labels: ['enhancement']
+labels: ['Type: Enhancement']
 body:
   - type: textarea
     attributes:

.github/workflows/build.yml

@@ -3,8 +3,8 @@ name: Build
 
 env:
   SF_DISABLE_AUTOUPDATE: true
-  SF_SKIP_NEW_VERSION_CHECK: true
   SF_LOG_LEVEL: debug
+  SF_SKIP_NEW_VERSION_CHECK: true
 
 on:
   push:
@@ -124,16 +124,16 @@ jobs:
         run: npm run test:lwc
 
       - name: 'Upload LWC code coverage to Codecov.io'
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           flags: LWC
 
   base-scratch-org-tests:
+    environment: 'Base Scratch Org'
     name: 'Run Base Scratch Org Tests'
     needs: [code-quality-tests]
     runs-on: ubuntu-latest
-    environment: 'Base Scratch Org'
     steps:
       - name: 'Checkout source code'
         uses: actions/checkout@v4
@@ -164,7 +164,7 @@ jobs:
           DEV_HUB_CONSUMER_KEY: ${{ secrets.DEV_HUB_CONSUMER_KEY }}
           DEV_HUB_JWT_SERVER_KEY: ${{ secrets.DEV_HUB_JWT_SERVER_KEY }}
 
-      - name: 'Create Base Scratch Org'
+      - name: 'Create Scratch Org'
         run: npx sf org create scratch --no-namespace --duration-days 1 --definition-file ./config/scratch-orgs/build-base-scratch-def.json --wait 20 --set-default --json
 
       - name: 'Deploy Source to Scratch Org'
@@ -191,11 +191,73 @@ jobs:
         run: npx sf org delete scratch --no-prompt
         if: ${{ always() }}
 
-  experience-cloud-scratch-org-tests:
-    name: 'Run Experience Cloud Scratch Org Tests'
+  event-monitoring-scratch-org-tests:
+    environment: 'Event Monitoring Scratch Org'
+    name: 'Run Event Monitoring Scratch Org Tests'
     needs: [code-quality-tests]
     runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout source code'
+        uses: actions/checkout@v4
+
+      - name: 'Restore node_modules cache'
+        id: cache-npm
+        uses: actions/cache@v4
+        with:
+          path: node_modules
+          key: npm-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            npm-${{ env.cache-name }}-
+            npm-
+
+      - name: 'Install npm dependencies'
+        if: steps.cache-npm.outputs.cache-hit != 'true'
+        run: npm ci
+
+      - name: 'Authorize Dev Hub'
+        shell: bash
+        run: |
+          npx sf version
+          echo "${{ env.DEV_HUB_JWT_SERVER_KEY }}" > ./jwt-server.key
+          npx sf org login jwt --instance-url ${{ env.DEV_HUB_AUTH_URL }} --client-id ${{ env.DEV_HUB_CONSUMER_KEY }} --username ${{ env.DEV_HUB_BOT_USERNAME }} --jwt-key-file ./jwt-server.key --set-default-dev-hub
+        env:
+          DEV_HUB_AUTH_URL: ${{ secrets.DEV_HUB_AUTH_URL }}
+          DEV_HUB_BOT_USERNAME: ${{ secrets.DEV_HUB_BOT_USERNAME }}
+          DEV_HUB_CONSUMER_KEY: ${{ secrets.DEV_HUB_CONSUMER_KEY }}
+          DEV_HUB_JWT_SERVER_KEY: ${{ secrets.DEV_HUB_JWT_SERVER_KEY }}
+
+      - name: 'Create Scratch Org'
+        run: npx sf org create scratch --no-namespace --duration-days 1 --definition-file ./config/scratch-orgs/build-event-monitoring-scratch-def.json --wait 20 --set-default --json
+
+      - name: 'Deploy Source to Scratch Org'
+        run: npx sf project deploy start --source-dir ./nebula-logger/
+
+      - name: 'Assign Logger Admin Permission Set'
+        run: npm run permset:assign:admin
+
+      - name: 'Validate Custom Metadata Records'
+        run: npx sf apex run --file ./scripts/build/validate-custom-metadata-records.apex
+
+      # Nebula Logger has functionality that queries the AuthSession object when the current user has an active session.
+      # The code should work with or without an active session, so the pipeline runs the tests twice - asynchronously and synchronously.
+      # This is done because, based on how you execute Apex tests, the running user may have an active session (synchrously) or not (asynchronously).
+      # Utlimately, this could/should probably be better mocked during tests, but the AuthSession is read-only in Apex, so it's a bit difficult to work with.
+      # Running the Apex tests sync & async serves as an extra level of integration testing to ensure that everything works with or without an active session.
+      - name: 'Run Apex Tests Asynchronously'
+        run: npm run test:apex:nocoverage
+
+      - name: 'Run Apex Tests Synchronously'
+        run: npm run test:apex:nocoverage -- --synchronous
+
+      - name: 'Delete Base Scratch Org'
+        run: npx sf org delete scratch --no-prompt
+        if: ${{ always() }}
+
+  experience-cloud-scratch-org-tests:
     environment: 'Experience Cloud Scratch Org'
+    name: 'Run Experience Cloud Scratch Org Tests'
+    needs: [code-quality-tests, base-scratch-org-tests]
+    runs-on: ubuntu-latest
     steps:
       - name: 'Checkout source code'
         uses: actions/checkout@v4
@@ -226,13 +288,13 @@ jobs:
           DEV_HUB_CONSUMER_KEY: ${{ secrets.DEV_HUB_CONSUMER_KEY }}
           DEV_HUB_JWT_SERVER_KEY: ${{ secrets.DEV_HUB_JWT_SERVER_KEY }}
 
-      - name: 'Create Experience Cloud Scratch Org'
+      - name: 'Create Scratch Org'
         run: npx sf org create scratch --no-namespace --duration-days 1 --definition-file ./config/scratch-orgs/build-experience-cloud-scratch-def.json --wait 20 --set-default --json
 
       - name: 'Deploy Source to Scratch Org'
         run: npx sf project deploy start --source-dir ./nebula-logger/
 
-      - name: 'Deploy Test Experience Site Metadata'
+      - name: 'Deploy Test Experience Sites Metadata'
         run: npm run experience:deploy
 
       - name: 'Assign Logger Admin Permission Set'
@@ -252,8 +314,9 @@ jobs:
       - name: 'Run Apex Tests Synchronously'
         run: npm run test:apex -- --synchronous
 
+      # This is the only scratch org that's used for uploading code coverage
       - name: 'Upload Apex test code coverage to Codecov.io'
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           flags: Apex
@@ -262,9 +325,71 @@ jobs:
         run: npx sf org delete scratch --no-prompt
         if: ${{ always() }}
 
+  platform-cache-scratch-org-tests:
+    environment: 'Platform Cache Scratch Org'
+    name: 'Run Platform Cache Scratch Org Tests'
+    needs: [code-quality-tests, event-monitoring-scratch-org-tests]
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout source code'
+        uses: actions/checkout@v4
+
+      - name: 'Restore node_modules cache'
+        id: cache-npm
+        uses: actions/cache@v4
+        with:
+          path: node_modules
+          key: npm-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            npm-${{ env.cache-name }}-
+            npm-
+
+      - name: 'Install npm dependencies'
+        if: steps.cache-npm.outputs.cache-hit != 'true'
+        run: npm ci
+
+      - name: 'Authorize Dev Hub'
+        shell: bash
+        run: |
+          npx sf version
+          echo "${{ env.DEV_HUB_JWT_SERVER_KEY }}" > ./jwt-server.key
+          npx sf org login jwt --instance-url ${{ env.DEV_HUB_AUTH_URL }} --client-id ${{ env.DEV_HUB_CONSUMER_KEY }} --username ${{ env.DEV_HUB_BOT_USERNAME }} --jwt-key-file ./jwt-server.key --set-default-dev-hub
+        env:
+          DEV_HUB_AUTH_URL: ${{ secrets.DEV_HUB_AUTH_URL }}
+          DEV_HUB_BOT_USERNAME: ${{ secrets.DEV_HUB_BOT_USERNAME }}
+          DEV_HUB_CONSUMER_KEY: ${{ secrets.DEV_HUB_CONSUMER_KEY }}
+          DEV_HUB_JWT_SERVER_KEY: ${{ secrets.DEV_HUB_JWT_SERVER_KEY }}
+
+      - name: 'Create Scratch Org'
+        run: npx sf org create scratch --no-namespace --duration-days 1 --definition-file ./config/scratch-orgs/build-platform-cache-scratch-def.json --wait 20 --set-default --json
+
+      - name: 'Deploy Source to Scratch Org'
+        run: npx sf project deploy start --source-dir ./nebula-logger/
+
+      - name: 'Assign Logger Admin Permission Set'
+        run: npm run permset:assign:admin
+
+      - name: 'Validate Custom Metadata Records'
+        run: npx sf apex run --file ./scripts/build/validate-custom-metadata-records.apex
+
+      # Nebula Logger has functionality that queries the AuthSession object when the current user has an active session.
+      # The code should work with or without an active session, so the pipeline runs the tests twice - asynchronously and synchronously.
+      # This is done because, based on how you execute Apex tests, the running user may have an active session (synchrously) or not (asynchronously).
+      # Utlimately, this could/should probably be better mocked during tests, but the AuthSession is read-only in Apex, so it's a bit difficult to work with.
+      # Running the Apex tests sync & async serves as an extra level of integration testing to ensure that everything works with or without an active session.
+      - name: 'Run Apex Tests Asynchronously'
+        run: npm run test:apex:nocoverage
+
+      - name: 'Run Apex Tests Synchronously'
+        run: npm run test:apex:nocoverage -- --synchronous
+
+      - name: 'Delete Base Scratch Org'
+        run: npx sf org delete scratch --no-prompt
+        if: ${{ always() }}
+
   create-managed-package-beta:
     name: 'Create Managed Package Beta'
-    needs: [lwc-tests, base-scratch-org-tests, experience-cloud-scratch-org-tests]
+    needs: [lwc-tests, base-scratch-org-tests, event-monitoring-scratch-org-tests, experience-cloud-scratch-org-tests, platform-cache-scratch-org-tests]
     if: ${{ github.ref != 'refs/heads/main' }}
     runs-on: ubuntu-latest
     environment: 'Demo Org'
@@ -377,7 +502,7 @@ jobs:
 
   promote-package-versions:
     name: 'Promote Package Versions'
-    needs: [lwc-tests, base-scratch-org-tests, experience-cloud-scratch-org-tests]
+    needs: [lwc-tests, base-scratch-org-tests, event-monitoring-scratch-org-tests, experience-cloud-scratch-org-tests, platform-cache-scratch-org-tests]
     if: ${{ github.ref == 'refs/heads/main' }}
     runs-on: ubuntu-latest
     steps:

README.md

@@ -5,15 +5,15 @@
 
 The most robust logger for Salesforce. Works with Apex, Lightning Components, Flow, Process Builder & Integrations. Designed for Salesforce admins, developers & architects.
 
-## Unlocked Package - v4.14.3
+## Unlocked Package - v4.14.4
 
-[![Install Unlocked Package in a Sandbox](./images/btn-install-unlocked-package-sandbox.png)](https://test.salesforce.com/packaging/installPackage.apexp?p0=04t5Y0000015oQjQAI)
-[![Install Unlocked Package in Production](./images/btn-install-unlocked-package-production.png)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t5Y0000015oQjQAI)
+[![Install Unlocked Package in a Sandbox](./images/btn-install-unlocked-package-sandbox.png)](https://test.salesforce.com/packaging/installPackage.apexp?p0=04t5Y0000015oRNQAY)
+[![Install Unlocked Package in Production](./images/btn-install-unlocked-package-production.png)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t5Y0000015oRNQAY)
 [![View Documentation](./images/btn-view-documentation.png)](https://jongpie.github.io/NebulaLogger/)
 
-`sf package install --wait 20 --security-type AdminsOnly --package 04t5Y0000015oQjQAI`
+`sf package install --wait 20 --security-type AdminsOnly --package 04t5Y0000015oRNQAY`
 
-`sfdx force:package:install --wait 20 --securitytype AdminsOnly --package 04t5Y0000015oQjQAI`
+`sfdx force:package:install --wait 20 --securitytype AdminsOnly --package 04t5Y0000015oRNQAY`
 
 ---