Recurring Donations Batch Filtering

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

@@ -92,6 +92,22 @@ public abstract class CRLP_Batch_Base {
  private set;
  }
 
+ /** @description Whether Recurring Donation Batch filtering is enabled */
+ protected Boolean isRdBatchFilterEnabled {
+ get {
+ return isRdBatchFilterEnabled;
+ }
+ private set;
+ }
+
+ /** @description When filtering, the number of days since being modified to include */
+ protected Integer rdBatchFilterDateRange {
+ get {
+ return rdBatchFilterDateRange;
+ }
+ private set;
+ }
+
  /** @description The customizable rollup custom settings */
  protected Customizable_Rollup_Settings__c customizableRollupSettings;
 
@@ -140,6 +156,9 @@ public abstract class CRLP_Batch_Base {
  this.statefulCacheOfRollupsToBeProcessed = CRLP_Rollup_SEL.getRollupDefinitionsToUse(this.jobType, this.jobFilter);
  this.isScheduledJob = System.isScheduled();
  this.customizableRollupSettings = UTIL_CustomSettingsFacade.getCustomizableRollupSettings();
+ this.isRdBatchFilterEnabled = (this.jobType == CRLP_RollupProcessingOptions.RollupType.RecurringDonations) 
+ && UTIL_CustomSettingsFacade.getRecurringDonationsSettings().Enable_Opportunity_Batch_Filter__c;
+ this.rdBatchFilterDateRange = UTIL_CustomSettingsFacade.getRecurringDonationsSettings().Batch_Filter_Date_Range__c.intValue();
 
  this.detailObjectType = CRLP_Rollup_SVC.getDetailObjectType(jobType);
  this.keyField = CRLP_Rollup_SVC.getParentFieldNameForQuery(jobType);
@@ -484,6 +503,9 @@ public abstract class CRLP_Batch_Base {
  when ContactHardCredit {
  return base.customizableRollupSettings.ContactHardCreditNonSkew_Incremental__c;
  }
+ when RecurringDonations {
+ return base.isRdBatchFilterEnabled;
+ }
  when else {
  return false;
  }
@@ -502,7 +524,11 @@ public abstract class CRLP_Batch_Base {
  Integer maxDaysAgo {
  get {
  if (maxDaysAgo == null) {
- maxDaysAgo = getMaxIntegerValueFromRollupsForType(CRLP_Operation.TimeBoundOperationType.Days_Back);
+ if (base.isRdBatchFilterEnabled) {
+ maxDaysAgo = base.rdBatchFilterDateRange;
+ } else {
+ maxDaysAgo = getMaxIntegerValueFromRollupsForType(CRLP_Operation.TimeBoundOperationType.Days_Back);
+ }
  }
  return maxDaysAgo;
  }
@@ -560,7 +586,9 @@ public abstract class CRLP_Batch_Base {
  Integer overrideForLastNDaysValue {
  get {
  if (overrideForLastNDaysValue == null) {
- if (base.customizableRollupSettings.Rollups_IncrementalLastNDays_ValOverride__c != null) {
+ if (base.isRdBatchFilterEnabled) {
+ overrideForLastNDaysValue = base.rdBatchFilterDateRange;
+ } else if (base.customizableRollupSettings.Rollups_IncrementalLastNDays_ValOverride__c != null) {
  overrideForLastNDaysValue = (Integer) base.customizableRollupSettings.Rollups_IncrementalLastNDays_ValOverride__c;
  }
  }

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

@@ -554,6 +554,44 @@ private class CRLP_Batch_Base_TEST {
  'Recurring Donation Nonskew query should not include inner join');
  }
 
+ /**
+ * @description Confirms RD NonSkew query with Batch Filter enabled includes an inner join
+ */
+ @isTest
+ private static void recurringDonationRollupGeneratesIncrementalModeJoinQuery() {
+ CRLP_RollupProcessingOptions.RollupType jobType =
+ CRLP_RollupProcessingOptions.RollupType.RecurringDonations;
+ String userDefinedLastNDaysFieldOverride = 'LastModifiedDate';
+ Integer userDefinedLastNDaysValueOverride = 20;
+ Integer oppFilterDateRange = RD2_OpportunityEvaluation_TEST.OPP_FILTER_DATE_RANGE;
+ configureIncrementalFieldOverrides(
+ jobType,
+ userDefinedLastNDaysFieldOverride,
+ userDefinedLastNDaysValueOverride);
+
+ CRLP_RollupProcessingOptions.RollupTypeFilter typeFilter =
+ CRLP_RollupProcessingOptions.RollupTypeFilter.All;
+ CRLP_Batch_Base_NonSkew rdBatchJob = new CRLP_RD_BATCH(typeFilter);
+ rdBatchJob.isScheduledJob = true;
+
+ CRLP_Batch_Base.BatchQueryBuilder queryBuilder =
+ new CRLP_Batch_Base.BatchQueryBuilder(rdBatchJob, null, null, null);
+
+ String query = queryBuilder.buildQuery();
+ String generatedWhereClause = queryBuilder.getMainQueryInnerJoinFilter();
+
+ System.assertEquals(2, query.countMatches('SELECT'),
+ 'Recurring Donation Filtered query should include inner join');
+
+ System.assert(generatedWhereClause.contains('FROM'));
+ System.assert(generatedWhereClause.contains('WHERE'), 'The incremental mode ' +
+ 'where clause for the inner join should contain a where filter on the Opportunities.');
+ System.assert(generatedWhereClause.contains('LAST_N_DAYS:' + oppFilterDateRange), 
+ 'Where clause should use Opp Date Range Setting, not Rollup Override value: ' + oppFilterDateRange);
+ System.assert(!batchStartOuterQueryContainsOrderByAndLimit(queryBuilder.buildQuery()),
+ 'The outer query should not contain "ORDER BY" or "LIMIT".');
+ }
+
  /**
  * @description For Account-Contact-Soft-Credit rollups, validate that the FieldsToCheckForNonZero property
  * returns back a single instance of a numeric field based on the mocked rollups configured for this
@@ -693,6 +731,9 @@ private class CRLP_Batch_Base_TEST {
  settings.ContactHardCreditNonSkew_Incremental__c = isIncrementalMode;
  CRLP_RollupContact_TEST.mockRollupCMTValues();
  }
+ when RecurringDonations {
+ RD2_OpportunityEvaluation_TEST.configureRecurringDonationsOppFilter();
+ }
  }
  return settings;
  }

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

@@ -201,11 +201,21 @@ public without sharing class RD2_OpportunityEvaluation_BATCH
  */
  @TestVisible
  private String getRDBatchQuery() {
+ Boolean rdBatchFilterOn = getOpportunityModifiedFilterEnabled();
+ String rdFilterWhereClause;
+ if (rdBatchFilterOn) {
+ Integer dateRange = getOpportunityModifiedDateRange();
+ Date earliestModifiedDate = currentDate.addDays(-dateRange);
+ rdFilterWhereClause = 'Id IN (SELECT npe03__Recurring_Donation__c' 
+ + 'FROM Opportunity WHERE LastModifiedDate > :earliestModifiedDate)';
+ }
+
  return new UTIL_Query()
  .withFrom(npe03__Recurring_Donation__c.SObjectType)
  .withSelectFields(
  new Set<String>{ 'Id' }
  )
+ .withWhere(rdFilterWhereClause)
  .build();
  }
 
@@ -247,6 +257,19 @@ public without sharing class RD2_OpportunityEvaluation_BATCH
  return configValue.intValue();
  }
 
+ private Integer getOpportunityModifiedDateRange() {
+ Integer dateRange = UTIL_CustomSettingsFacade.getRecurringDonationsSettings().Batch_Filter_Date_Range__c.intValue();
+ if (dateRange == null) {
+ dateRange = 30;
+ }
+ return dateRange;
+ }
+
+ private Boolean getOpportunityModifiedFilterEnabled() {
+ Boolean filterEnabled = UTIL_CustomSettingsFacade.getRecurringDonationsSettings().Enable_Opportunity_Batch_Filter__c;
+ return filterEnabled;
+ }
+
  /**
  * @description Custom batch exception
  */

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

@@ -45,6 +45,7 @@ public with sharing class RD2_OpportunityEvaluation_TEST {
  private static final Date START_DATE = Date.newInstance(2019, 9, 15);
  private static final Integer MONTHS_TO_DEC = START_DATE.monthsBetween(Date.newInstance(2019, 12, 15));
  private static final Integer MONTHS_TO_YEAR_END = START_DATE.monthsBetween(Date.newInstance(2020, 1, 1));
+ public static final Integer OPP_FILTER_DATE_RANGE = 10;
 
  /****
  * @description Creates data required for unit tests
@@ -91,6 +92,35 @@ public with sharing class RD2_OpportunityEvaluation_TEST {
  System.assertEquals(null, actuaException, 'An exception is expected because Enhanced RD is not enabled');
  }
 
+ /**
+ * @description Verifies Recurring Donations with unmodified Opportunities are not processed
+ */
+ @IsTest
+ private static void shouldNotProcessRDsWithUnmodifiedOpps() {
+ RD2_EnablementService_TEST.setRecurringDonations2Enabled();
+ configureRecurringDonationsOppFilter();
+ final Date batchRunDate = Date.today().addDays(OPP_FILTER_DATE_RANGE);
+ RD2_ScheduleService.currentDate = batchRunDate;
+
+ npe03__Recurring_Donation__c rd = getRecurringDonationBuilder()
+ .withStatusClosed()
+ .build();
+ insert rd;
+
+ Opportunity oldOpp = TEST_OpportunityBuilder.getOpportunityBuilder(rd)
+ .withClosedWonStage()
+ .withCloseDate(START_DATE)
+ .build();
+ insert oldOpp;
+
+ runBatch(new RD2_OpportunityEvaluation_BATCH(batchRunDate));
+
+ assertBatchJobIteration(0);
+
+ List<Opportunity> opps = oppGateway.getRecords(rd);
+ System.assertEquals(1, opps.size(), 'No new Opp should be created: ' + opps);
+ }
+
  /**
  * @description Verifies closed Recurring Donations are processed in the Opp evaluation batch
  */
@@ -1439,4 +1469,20 @@ public with sharing class RD2_OpportunityEvaluation_TEST {
 
  return rdGateway.getRecord(rd.Id);
  }
+
+ /***
+ * @description Stubs custom settings configuration to enable Filtered Recurring Donations Batch
+ * @return none
+ */
+ public static void configureRecurringDonationsOppFilter() {
+ UTIL_CustomSettingsFacade.getRecurringDonationsSettingsForTest(
+ new npe03__Recurring_Donations_Settings__c(
+ IsRecurringDonations2Enabled__c = true,
+ npe03__Open_Opportunity_Behavior__c = RD2_Constants.CloseActions.Mark_Opportunities_Closed_Lost.name(),
+ Enable_Opportunity_Batch_Filter__c = true,
+ Batch_Filter_Date_Range__c = OPP_FILTER_DATE_RANGE
+ )
+ );
+ }
+
 }

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

@@ -645,6 +645,9 @@ public without sharing class UTIL_CustomSettingsFacade {
  settings.UseFiscalYearForRecurringDonationValue__c = false;
  settings.EnableChangeLog__c = false;
 
+ settings.Enable_Opportunity_Batch_Filter__c = false;
+ settings.Batch_Filter_Date_Range__c = 30;
+
  List<RecordType> oppRecordTypes = [SELECT Id FROM RecordType WHERE SObjectType = 'Opportunity' AND IsActive = true];
  if (oppRecordTypes.size() > 0) {
  settings.npe03__Record_Type__c = oppRecordTypes[0].id;
@@ -915,6 +918,8 @@ public without sharing class UTIL_CustomSettingsFacade {
  recurringDonationsSettings.StatusAutomationDaysForClosed__c = settings.StatusAutomationDaysForClosed__c;
  recurringDonationsSettings.StatusAutomationLapsedValue__c = settings.StatusAutomationLapsedValue__c;
  recurringDonationsSettings.StatusAutomationClosedValue__c = settings.StatusAutomationClosedValue__c;
+ recurringDonationsSettings.Batch_Filter_Date_Range__c = settings.Batch_Filter_Date_Range__c;
+ recurringDonationsSettings.Enable_Opportunity_Batch_Filter__c = settings.Enable_Opportunity_Batch_Filter__c;
 
  orgRecurringDonationsSettings = recurringDonationsSettings;
 

force-app/main/default/objects/npe03__Recurring_Donations_Settings__c/fields/Batch_Filter_Date_Range__c.field-meta.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
+ <fullName>Batch_Filter_Date_Range__c</fullName>
+ <defaultValue>30</defaultValue>
+ <description>When "Enable Opportunity Last Modified Batch Filter" is checked, this field determines the amount of days after being modified that an Opportunity should be included in Recurring Donation Batch jobs.</description>
+ <externalId>false</externalId>
+ <inlineHelpText>When "Enable Opportunity Last Modified Batch Filter" is checked, this field determines the amount of days after being modified that an Opportunity should be included in Recurring Donation Batch jobs.</inlineHelpText>
+ <label>Batch Filter Date Range</label>
+ <precision>18</precision>
+ <required>false</required>
+ <scale>0</scale>
+ <trackTrending>false</trackTrending>
+ <type>Number</type>
+ <unique>false</unique>
+</CustomField>

force-app/main/default/objects/npe03__Recurring_Donations_Settings__c/fields/Enable_Opportunity_Batch_Filter__c.field-meta.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CustomField xmlns="http://soap.sforce.com/2006/04/metadata">
+ <fullName>Enable_Opportunity_Batch_Filter__c</fullName>
+ <defaultValue>false</defaultValue>
+ <description>When checked, Recurring Donation nightly batch jobs limit the number of Donations selected for recalculation by looking for recently updated Opportunities on those Recurring Donations. This helps to improve nightly job performance.</description>
+ <externalId>false</externalId>
+ <inlineHelpText>When checked, Recurring Donation nightly batch jobs limit the number of Donations selected for recalculation by looking for recently updated Opportunities on those Recurring Donations. This helps to improve nightly job performance.</inlineHelpText>
+ <label>Enable Opportunity Modified Batch Filter</label>
+ <trackTrending>false</trackTrending>
+ <type>Checkbox</type>
+</CustomField>