@W-19435408 - Introduce new Instrumentation to improve adoption knowledge (Part 2)

force-app/main/adapter/in/sobjects/contact/ContactAdapter.cls

@@ -593,6 +593,13 @@ public inherited sharing class ContactAdapter extends fflib_SObjects2 {
             Address__c contactAddress = contactAddressesToInsertByContact.get(contact);
             contact.Current_Address__c = contactAddress.Id;
         }
+
+        SfdoInstrumentationService.getInstance().log(
+            SfdoInstrumentationEnum.Feature.Addresses, 
+            SfdoInstrumentationEnum.Component.TriggerAction, 
+            SfdoInstrumentationEnum.Action.Dml_Insert,
+            new Map<String, String>{ 'SourceClass' => 'ContactAdapter' },
+            contactAddressesToInsertByContact.size());
     }
 
     private void updateContactAddressFromExistingAddress(Contact contact, Address__c existingAddressFromContact) {

force-app/main/default/classes/BDI_DataImportService.cls

@@ -379,6 +379,7 @@ global with sharing class BDI_DataImportService {
             sfdoInstrumentationEnum.Feature.GiftEntry,
             sfdoInstrumentationEnum.Component.Page,
             sfdoInstrumentationEnum.Action.Save,
+            new Map<String, String>{ 'SourceClass' => 'BDI_DataImportService' },
             insertedGifts);
     }
 

force-app/main/default/classes/BDI_DataImport_TEST.cls

@@ -1949,10 +1949,10 @@ public with sharing class BDI_DataImport_TEST {
         ID ApexJobId = Database.executeBatch(bdi, 10);
         Test.stopTest();
 
-        System.assertEquals(2, mockService.value, 'The instrumentation service should have indicated two new Gifts were inserted');
         System.assertEquals(sfdoInstrumentationEnum.Feature.GiftEntry, mockService.feature,
             'The instrumentation service should have indicated GiftEntry');
-    }
+        System.assertEquals(2, mockService.value, 'The instrumentation service should have indicated two new Gifts were inserted');
+        }
 
     /*********************************************************************************************************
     * @description When the Data Import Service has been mocked to simulate coming in through the UI, verify
@@ -1963,6 +1963,9 @@ public with sharing class BDI_DataImport_TEST {
     private static void shouldNotInstrumentNewDonationsWhenNotThroughUserInterface() {
         SfdoInstrumentationMock_TEST.MockService mockService = SfdoInstrumentationMock_TEST.injectMockedInstrumentationService();
 
+        // SfdoInstrumentationService.instance = null; // reset instrumentation
+        // UTIL_UnitTestData_TEST.turnOffAutomaticHHNaming(); // prevent this from running its instrumentation
+
         List<DataImport__c> dataImports = new List<DataImport__c>();
         dataImports.add(newDI('c1', 'C1', 100));
         insert dataImports;
@@ -1973,7 +1976,9 @@ public with sharing class BDI_DataImport_TEST {
         ID ApexJobId = Database.executeBatch(bdi, 10);
         Test.stopTest();
 
-        System.assertEquals(null, mockService.value, 'The instrumentation service should have indicated two new Gifts were inserted');
+        for (SfdoInstrumentationMock_TEST.LastCallData callData : mockService.lastCallStack) {
+            System.assertNotEquals(SfdoInstrumentationEnum.Feature.DataImportEngine, callData.feature, 'The BDI instrumentation should have executed');
+        }
     }
 
     /*********************************************************************************************************

force-app/main/default/classes/Callable_API.cls

@@ -96,15 +96,15 @@ global with sharing class Callable_API implements System.Callable {
                 String oppStage = paramService.getString(CallableApiParameters.PARAM_OPPORTUNITY_STAGE);
                 return OPP_StageMappingUtil.determineOppStateFromOppStage(oppStage);
 
-            } when 'crlp.getdefinitionsforrolluptype' {
+            } when 'crlp.getdefinitionsforrolluptype' { // internal use only, deprecated
                 String rollupType = paramService.getString(CallableApiParameters.PARAM_ROLLUP_TYPE);
 
                 CRLP_ApiService crlpApiSvc = new CRLP_ApiService();
                 List<CRLP_Rollup> response = crlpApiSvc.getRollupDefinitions(rollupType);
 
                 return JSON.serialize(response, true);
 
-            } when 'crlp.executerollups' {
+            } when 'crlp.executerollups' { // internal use only, deprecated
                 Id parentId = paramService.getString(CallableApiParameters.PARAM_ROLLUP_PARENTID);
                 String rollupType = paramService.getString(CallableApiParameters.PARAM_ROLLUP_TYPE);
                 List<CRLP_Rollup> rollupDefs = paramService.getRollupDefinitions(CallableApiParameters.PARAM_ROLLUP_DEFS);
@@ -120,7 +120,7 @@ global with sharing class Callable_API implements System.Callable {
                 CRLP_ApiService crlpApiSvc = new CRLP_ApiService();
                 return crlpApiSvc.isCrlpEnabled();
 
-            } when 'err.dispatchaction' {
+            } when 'err.dispatchaction' { // internal use only
                 // This method is to be used only by Salesforce.org apps and is subject to change at any time. Do NOT call this method.
                 // If you do so, your functionality can break without any warning or liability from Salesforce.
 

force-app/main/default/classes/ContactMergeService.cls

@@ -195,6 +195,7 @@ public class ContactMergeService {
             SfdoInstrumentationEnum.Feature.ContactMerge, 
             SfdoInstrumentationEnum.Component.Page, 
             SfdoInstrumentationEnum.Action.ContactMergeResultCount, 
+            new Map<String, String>{ 'SourceClass' => 'ContactMergeService' },
             losers.size() + 1);
 
         successfulMerge = true;

force-app/main/default/classes/EP_EngagementPlans_TDTM.cls

@@ -132,6 +132,7 @@ public with sharing class EP_EngagementPlans_TDTM extends TDTM_Runnable {
                 SfdoInstrumentationEnum.Feature.EngagementPlans,
                 SfdoInstrumentationEnum.Component.TriggerAction,
                 SfdoInstrumentationEnum.Action.Create,
+                new Map<String, String>{ 'SourceClass' => 'EP_EngagementPlans_TDTM' },
                 engagementPlans.size());
         }
 

force-app/main/default/classes/HH_Container_LCTRL.cls

@@ -434,6 +434,7 @@ public with sharing class HH_Container_LCTRL {
                 SfdoInstrumentationEnum.Feature.ManageHousehold, 
                     SfdoInstrumentationEnum.Component.Page, 
                     SfdoInstrumentationEnum.Action.HouseholdMemberAdded, 
+                    new Map<String, String>{ 'SourceClass' => 'HH_Container_LCTRL' },
                     listInsert.size());
         }
     }
@@ -515,6 +516,7 @@ public with sharing class HH_Container_LCTRL {
             SfdoInstrumentationEnum.Feature.ManageHousehold, 
             SfdoInstrumentationEnum.Component.Page, 
             SfdoInstrumentationEnum.Action.HouseholdMerged, 
+            new Map<String, String>{ 'SourceClass' => 'HH_Container_LCTRL' },
             listHHMerge.size());
     }
 
@@ -570,7 +572,9 @@ public with sharing class HH_Container_LCTRL {
                     SfdoInstrumentationService.getInstance().log(
                         SfdoInstrumentationEnum.Feature.ManageHousehold, 
                         SfdoInstrumentationEnum.Component.Page, 
-                        SfdoInstrumentationEnum.Action.HouseholdNamingSettingsUpdated, 1);
+                        SfdoInstrumentationEnum.Action.HouseholdNamingSettingsUpdated,
+                        new Map<String, String>{ 'SourceClass' => 'HH_Container_LCTRL' },
+                        1);
                     originalHouseholdCustomNameSetting = (String) hh.get('npo02__SYSTEM_CUSTOM_NAMING__c');
                 }
             }

force-app/main/default/classes/HH_Container_TEST.cls

@@ -398,7 +398,7 @@ private class HH_Container_TEST {
         Contact[] hhContactsToRemove = new Contact[0];
         Account[] accountsToMerge = new Account[] { accounts[1], accounts[2] };
 
-        System.assertEquals(null, SfdoInstrumentationService.instance, 'The Instrumentation Service Instance should not have been instantiated yet');
+        SfdoInstrumentationService.instance = null;
 
         Test.startTest();
         accounts[0].npo02__SYSTEM_CUSTOM_NAMING__c = 'npo02__Formal_Greeting__c';

force-app/main/default/classes/LVL_LevelAssignBATCH_TEST.cls

@@ -44,6 +44,9 @@ private class LVL_LevelAssignBATCH_TEST {
     private static Level__c lvlPlatinum { get; set; }
     private static Level__c lvlAcctZinc { get; set; }
 
+    private static final Integer CONTACT_COUNT = 8;
+    private static final Integer ACCOUNT_COUNT = 2;
+
     /*********************************************************************************************************
     * @description creates Bronze, Silver, and Gold Level records for test code to use.
     */
@@ -161,7 +164,7 @@ private class LVL_LevelAssignBATCH_TEST {
     private static DateTime dtCon6Modified { get; set;  }
 
     private static void createTestContacts(String uniqueCounter) {
-        contacts = UTIL_UnitTestData_TEST.createMultipleTestContacts(8);
+        contacts = UTIL_UnitTestData_TEST.createMultipleTestContacts(CONTACT_COUNT);
         for (Contact c : contacts) {
             c.LastName += uniqueCounter;
         }
@@ -199,7 +202,7 @@ private class LVL_LevelAssignBATCH_TEST {
     */
     private static List<Account> accounts { get; set; }
     private static void createTestAccounts(String uniqueCounter) {
-        accounts = UTIL_UnitTestData_TEST.createMultipleTestAccounts(2, null);
+        accounts = UTIL_UnitTestData_TEST.createMultipleTestAccounts(ACCOUNT_COUNT, null);
         for (Account a : accounts) {
             a.Name += uniqueCounter;
         }
@@ -232,6 +235,16 @@ private class LVL_LevelAssignBATCH_TEST {
 
         verifyContactLevels();
 
+        System.assertEquals(SfdoInstrumentationEnum.Feature.EngagementPlans.name(), SfdoInstrumentationService.lastCallData.lastFeatureName,
+            'The Instrumentation LastFeatureName should be EngagementPlans');
+        System.assertEquals(1, SfdoInstrumentationService.lastCallData.lastValue,
+            'The Instrumentation LastValue should be 1');
+        // System.assertEquals(true, new Map<String, String>{ 'SourceClass' => 'LVL_LevelAssign_BATCH', 'Target Object' => 'Contact' }, SfdoInstrumentationService.lastCallData.lastContext,
+        System.assertEquals('LVL_LevelAssign_BATCH', SfdoInstrumentationService.lastCallData.lastContext.get('SourceClass'),
+            'The Instrumentation LastContext should be LVL_Batch');
+        System.assertEquals('Contact', SfdoInstrumentationService.lastCallData.lastContext.get('Target Object'),
+            'The Instrumentation LastContext should be Contact');
+
         Levels_Settings__c levelSettings = Levels_Settings__c.getInstance();
         System.assertEquals(null, levelSettings.LastJobStartTimeAccount__c,
             'The LastJobStartTimeAccount__c should not be populated');
@@ -262,6 +275,17 @@ private class LVL_LevelAssignBATCH_TEST {
         Database.executeBatch(batch);
         Test.stopTest();
 
+        System.assertEquals(SfdoInstrumentationEnum.Feature.Levels.name(), SfdoInstrumentationService.lastCallData.lastFeatureName,
+            'The Instrumentation LastFeatureName should be Levels');
+        System.assertEquals(SfdoInstrumentationEnum.Component.Batch.name(), SfdoInstrumentationService.lastCallData.lastComponentName,
+            'The Instrumentation LastComponentName should be Batch');
+        System.assertEquals(CONTACT_COUNT-1, SfdoInstrumentationService.lastCallData.lastValue,
+            'The Instrumentation LastValue should be 7');
+        System.assertEquals('LVL_LevelAssign_BATCH', SfdoInstrumentationService.lastCallData.lastContext.get('SourceClass'),
+            'The Instrumentation LastContext should be LVL_Batch');
+        System.assertEquals('Contact', SfdoInstrumentationService.lastCallData.lastContext.get('Target Object'),
+            'The Instrumentation LastContext should be Contact');
+
         Contact conZero = [SELECT Id, npo02__LastMembershipLevel__c FROM Contact WHERE Id = :contacts[0].Id];
         System.assertEquals(null, conZero.npo02__LastMembershipLevel__c);
     }

force-app/main/default/classes/LVL_LevelAssign_BATCH.cls

@@ -163,9 +163,22 @@ public without sharing class LVL_LevelAssign_BATCH implements Database.Batchable
             } // ladder
         } // scope
 
+        SfdoInstrumentationService.getInstance().log(
+            SfdoInstrumentationEnum.Feature.Levels, 
+            SfdoInstrumentationEnum.Component.Batch, 
+            SfdoInstrumentationEnum.Action.Dml_Update,
+            new Map<String, String>{ 'Target Object' => sObjectName, 'SourceClass' => 'LVL_LevelAssign_BATCH' },
+            recordsById.size());
+
         update recordsById.values();
         if (!newEngagementPlans.isEmpty()) {
             insert newEngagementPlans;
+            SfdoInstrumentationService.getInstance().log(
+                SfdoInstrumentationEnum.Feature.EngagementPlans, 
+                SfdoInstrumentationEnum.Component.Batch, 
+                SfdoInstrumentationEnum.Action.Dml_Insert,
+                new Map<String, String>{ 'Target Object' => sObjectName, 'SourceClass' => 'LVL_LevelAssign_BATCH' },
+                newEngagementPlans.size());
         }
         if (!errorsCreatingEngagementPlans.isEmpty()) {
             insert errorsCreatingEngagementPlans;

force-app/main/default/classes/RD2_ApiService.cls

@@ -68,6 +68,7 @@ public inherited sharing class RD2_ApiService {
             SfdoInstrumentationEnum.Feature.EnhancedRecurringDonations,
             SfdoInstrumentationEnum.Component.API,
             SfdoInstrumentationEnum.Action.QuerySchedules,
+            new Map<String, String>{ 'SourceClass' => 'RD2_ApiService' },
             schedulesByRdId.size());
 
         return JSON.serialize(schedulesByRdId);
@@ -223,6 +224,7 @@ public inherited sharing class RD2_ApiService {
             SfdoInstrumentationEnum.Feature.EnhancedRecurringDonations,
             SfdoInstrumentationEnum.Component.API,
             SfdoInstrumentationEnum.Action.QueryInstallments,
+            new Map<String, String>{ 'SourceClass' => 'RD2_ApiService' },
             installmentsByRdId.size());
 
         return JSON.serialize(installmentsByRdId);
@@ -281,6 +283,7 @@ public inherited sharing class RD2_ApiService {
             SfdoInstrumentationEnum.Feature.EnhancedRecurringDonations,
             SfdoInstrumentationEnum.Component.API,
             SfdoInstrumentationEnum.Action.Pause,
+            new Map<String, String>{ 'SourceClass' => 'RD2_ApiService' },
             Limits.getDmlRows() - startingDmlRows);
 
         return response;

force-app/main/default/classes/RD2_OpportunityEvaluation_BATCH.cls

@@ -291,7 +291,8 @@ public without sharing class RD2_OpportunityEvaluation_BATCH
                 new Map<String, Object>{ 
                     'RD Records Processed' => recordsProcessed, 
                     'RD Records Failed' => recordsFailed, 
-                    'Opportunity Records Created ' => recordsCreated 
+                    'Opportunity Records Created ' => recordsCreated,
+                    'SourceClass' => 'RD2_OpportunityEvaluation_BATCH'
                 },
                 recordsCreated
             );

force-app/main/default/classes/RD2_RecurringDonations_TDTM.cls

@@ -150,6 +150,7 @@ public class RD2_RecurringDonations_TDTM extends TDTM_Runnable {
                 SfdoInstrumentationEnum.Feature.EnhancedRecurringDonations,
                 SfdoInstrumentationEnum.Component.TriggerAction,
                 SfdoInstrumentationEnum.Action.Create,
+                new Map<String, String>{ 'SourceClass' => 'RD2_RecurringDonations_TDTM' },
                 rds.size());
         }
 

force-app/main/default/classes/RD_RecurringDonations_TDTM.cls

@@ -122,6 +122,7 @@ public class RD_RecurringDonations_TDTM extends TDTM_Runnable {
                 SfdoInstrumentationEnum.Feature.LegacyRecurringDonations,
                 SfdoInstrumentationEnum.Component.TriggerAction,
                 SfdoInstrumentationEnum.Action.Create,
+                new Map<String, String>{ 'SourceClass' => 'RD_RecurringDonations_TDTM' },
                 newlist.size());
         }
 

force-app/main/default/classes/STG_PanelRDHealthCheck_TEST.cls

@@ -49,6 +49,11 @@ private class STG_PanelRDHealthCheck_TEST {
      */
     @IsTest
     private static void shouldValidateLegacyRecurringDonationsConfig() {
+        if (isRD2MetadataDeployed()) {
+            // don't run this if RD2 metadata is already deployed
+            return;
+        }
+
         configureLegacyRDSettings();
 
         STG_PanelHealthCheck_CTRL ctrl = new STG_PanelHealthCheck_CTRL();
@@ -69,6 +74,11 @@ private class STG_PanelRDHealthCheck_TEST {
      */
     @IsTest
     private static void shouldValidateLegacyWithCustomInstallmentPeriods() {
+        if (isRD2MetadataDeployed()) {
+            // don't run this if RD2 metadata is already deployed
+            return;
+        }
+
         npe03__Custom_Installment_Settings__c customInstallment = new npe03__Custom_Installment_Settings__c(
             npe03__Increment__c = 'Weeks',
             npe03__Value__c = 2,
@@ -146,6 +156,7 @@ private class STG_PanelRDHealthCheck_TEST {
     @IsTest
     private static void shouldValidateLegacyPeriodPicklistEntries() {
         if (isRD2MetadataDeployed()) {
+            // don't run this if RD2 metadata is already deployed
             return;
         }