Skip to content

Commit e9e2eca

Browse files
jamessimonejamessimone
committed
Updated Cursor to allow for multiple fetches in a single transaction (will still throw if you perform more than 10 fetches in a single transaction). Fixed a bug where passing in more than the max chunk size also threw by defaulting to the max chunk size for those cases. Added generic SObjectRepository
1 parent 800329a commit e9e2eca

File tree

9 files changed

+150
-8
lines changed

9 files changed

+150
-8
lines changed

‎force-app/repository/AggregateRepository.cls‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ public without sharing virtual class AggregateRepository extends Repository impl
9898
public virtual Integer count(List<Query> queries) {
9999
this.isNumberCountQuery = true;
100100
String finalQuery = this.getFinalQuery(queries);
101-
System.debug(System.LoggingLevel.DEBUG, 'count query:\n' + finalQuery);
101+
this.logQuery('count query:\n' + finalQuery);
102102
Integer recordCount = Database.countQueryWithBinds(finalQuery, this.bindVars, this.accessLevel);
103103
System.debug(System.LoggingLevel.FINER, 'number of results: ' + recordCount);
104104
this.clearState();

‎force-app/repository/Cursor.cls‎

Lines changed: 49 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
@SuppressWarnings('PMD.EmptyCatchBlock,PMD.EmptyStatementBlock')
22
public virtual without sharing class Cursor {
3+
private static final Integer MAX_FETCH_SIZE = 2000;
4+
private static final Integer MAX_FETCHES_PER_TRANSACTION = Limits.getLimitFetchCallsOnApexCursor();
5+
6+
private Integer fetchesPerTransaction = 1;
37
private final Database.Cursor cursor;
48

59
public Cursor(String finalQuery, Map<String, Object> bindVars, System.AccessLevel accessLevel) {
@@ -13,22 +17,64 @@ public virtual without sharing class Cursor {
1317
}
1418
}
1519

20+
public Cursor setFetchesPerTransaction(Integer possibleFetchesPerTransaction) {
21+
// Handle accidental round downs from Integer division
22+
if (possibleFetchesPerTransaction == 0) {
23+
return this;
24+
}
25+
if (possibleFetchesPerTransaction > MAX_FETCHES_PER_TRANSACTION) {
26+
System.debug(
27+
System.LoggingLevel.DEBUG,
28+
'Fetches per transaction: ' +
29+
possibleFetchesPerTransaction +
30+
' exceeded platform max fetches per transaction: ' +
31+
MAX_FETCHES_PER_TRANSACTION +
32+
', defaulting to platform max'
33+
);
34+
possibleFetchesPerTransaction = MAX_FETCHES_PER_TRANSACTION;
35+
}
36+
this.fetchesPerTransaction = possibleFetchesPerTransaction;
37+
return this;
38+
}
39+
1640
protected Cursor() {
1741
}
1842

1943
public virtual List<SObject> fetch(Integer start, Integer advanceBy) {
2044
if (this.getNumRecords() == 0) {
21-
System.debug(System.LoggingLevel.WARN, 'Bypassing fetch call, no records to fetch');
45+
System.debug(System.LoggingLevel.DEBUG, 'Bypassing fetch call, no records to fetch');
2246
return new List<SObject>();
2347
}
24-
return this.cursor?.fetch(start, this.getAdvanceBy(start, advanceBy)) ?? new List<SObject>();
48+
Integer localFetchesMade = 0;
49+
Integer localStart = start;
50+
List<SObject> results = new List<SObject>();
51+
while (localFetchesMade < this.fetchesPerTransaction) {
52+
results.addAll(this.cursor?.fetch(start, this.getAdvanceBy(start, advanceBy)) ?? new List<SObject>());
53+
localStart += advanceBy;
54+
localFetchesMade++;
55+
}
56+
return results;
2557
}
2658

2759
public virtual Integer getNumRecords() {
2860
return this.cursor?.getNumRecords() ?? 0;
2961
}
3062

3163
protected Integer getAdvanceBy(Integer start, Integer advanceBy) {
32-
return Math.min(advanceBy, this.getNumRecords() - start);
64+
Integer possibleFetchSize = Math.min(advanceBy, this.getNumRecords() - start);
65+
if (possibleFetchSize > MAX_FETCH_SIZE) {
66+
System.debug(
67+
System.LoggingLevel.DEBUG,
68+
'Fetch size: ' +
69+
possibleFetchSize +
70+
' exceeded platform max fetch size of ' +
71+
MAX_FETCH_SIZE +
72+
', defaulting to max fetch size'
73+
);
74+
possibleFetchSize = MAX_FETCH_SIZE;
75+
} else if (possibleFetchSize < 0) {
76+
possibleFetchSize = 0;
77+
}
78+
return possibleFetchSize;
3379
}
3480
}

‎force-app/repository/CursorTest.cls‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,38 @@ private class CursorTest {
1111
Assert.areEqual(UserInfo.getUserId(), cursor.fetch(0, 1000).get(0).Id);
1212
Assert.areEqual(1, System.Limits.getApexCursorRows());
1313
}
14+
15+
@IsTest
16+
static void itCapsMaxFetchSize() {
17+
List<Account> accounts = new List<Account>();
18+
for (Integer i = 0; i < 2001; i++) {
19+
accounts.add(new Account(Name = 'Fetch ' + i));
20+
}
21+
insert accounts;
22+
23+
Integer oneMoreThanMaxFetch = 2001;
24+
Exception ex;
25+
try {
26+
new Cursor('SELECT Id FROM Account', new Map<String, Object>(), System.AccessLevel.SYSTEM_MODE)
27+
.fetch(0, oneMoreThanMaxFetch);
28+
} catch (System.InvalidParameterValueException e) {
29+
ex = e;
30+
}
31+
32+
Assert.areEqual(null, ex?.getMessage());
33+
}
34+
35+
@IsTest
36+
static void itFetchesMultipleTimesPerTransaction() {
37+
insert new List<Account>{ new Account(Name = 'One'), new Account(Name = 'Two') };
38+
39+
Cursor cursor = new Cursor('SELECT Id FROM Account', new Map<String, Object>(), System.AccessLevel.SYSTEM_MODE)
40+
.setFetchesPerTransaction(2);
41+
List<SObject> results = cursor.fetch(0, 1);
42+
43+
Assert.areEqual(2, results.size());
44+
results = cursor.fetch(2, 1);
45+
Assert.areEqual(0, results.size());
46+
Assert.areEqual(2, cursor.getNumRecords());
47+
}
1448
}

‎force-app/repository/IRepository.cls‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
@SuppressWarnings('PMD.AvoidBooleanMethodParameters,PMD.ExcessiveParameterList')
22
public interface IRepository extends IDML {
33
Cursor getCursor(List<Query> queries);
4+
45
Database.QueryLocator getQueryLocator(List<Query> queries);
56
Database.QueryLocator getQueryLocator(List<Query> queries, Boolean shouldAddChildFields);
7+
68
List<SObject> get(Query query);
79
List<SObject> get(List<Query> queries);
810
List<SObject> getAll();
@@ -12,17 +14,23 @@ public interface IRepository extends IDML {
1214
List<List<SObject>> getSosl(String searchTerm, List<Query> queries, List<AdditionalSoslObject> additionalSoslObjects);
1315
IRepository setSearchGroup(SearchGroup searchGroup);
1416

17+
IRepository setShouldPrintBindVars(Boolean shouldPrintBindVars);
1518
IRepository clearBindVars();
1619
IRepository setAccessLevel(System.AccessLevel accessLevel);
1720
IRepository setLimit(Integer limitAmount);
21+
1822
IRepository addSortOrder(Schema.SObjectField fieldToken, RepositorySortOrder sortOrder);
1923
IRepository addSortOrder(List<Schema.SObjectField> fieldChain, RepositorySortOrder sortOrder);
2024

2125
IRepository addBaseFields(List<Schema.SObjectField> fields);
26+
2227
IRepository addFunctionBaseField(SelectFunction selectFunction, Schema.SObjectField field);
2328
IRepository addFunctionBaseFields(SelectFunction selectFunction, List<Schema.SObjectField> fields);
2429
IRepository addFunctionBaseFields(SelectFunction selectFunction, Map<Schema.SObjectField, String> fieldsToAliases);
30+
31+
IRepository addParentFields(Schema.SObjectField relationshipField, List<Schema.SObjectField> parentFields);
2532
IRepository addParentFields(List<Schema.SObjectField> relationshipFields, List<Schema.SObjectField> parentFields);
33+
2634
IRepository addChildFields(Schema.SObjectField childFieldToken, List<SObjectField> childFields);
2735
IRepository addChildFields(Schema.SObjectField childFieldToken, IRepository childRepo);
2836
IRepository addChildFields(

‎force-app/repository/Repository.cls‎

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ public virtual without sharing class Repository implements IRepository {
1212
protected System.AccessLevel accessLevel = System.AccessLevel.SYSTEM_MODE;
1313
protected final Map<String, RepositorySortOrder> fieldToSortOrder = new Map<String, RepositorySortOrder>();
1414

15+
private Boolean shouldPrintBindVars = false;
1516
private Boolean baseSelectUsed = false;
1617
private Boolean isSosl = false;
1718
private Boolean shouldAddChildFields = true;
@@ -28,7 +29,7 @@ public virtual without sharing class Repository implements IRepository {
2829
// SOQL
2930
public virtual Cursor getCursor(List<Query> queries) {
3031
String finalQuery = this.getFinalQuery(queries);
31-
System.debug(System.LoggingLevel.DEBUG, 'cursor query:\n' + finalQuery);
32+
this.logQuery('cursor query:\n' + finalQuery);
3233
Cursor cursor = new Cursor(finalQuery, this.bindVars, this.accessLevel);
3334
this.clearState();
3435
this.bindVars.clear();
@@ -44,7 +45,7 @@ public virtual without sharing class Repository implements IRepository {
4445
Boolean originalValue = this.shouldAddChildFields;
4546
this.shouldAddChildFields = shouldAddChildFields;
4647
String finalQuery = this.getFinalQuery(queries);
47-
System.debug(System.LoggingLevel.DEBUG, 'query locator query:\n' + finalQuery);
48+
this.logQuery('query locator query:\n' + finalQuery);
4849
Database.QueryLocator locator = Database.getQueryLocatorWithBinds(
4950
this.getFinalQuery(queries),
5051
this.bindVars,
@@ -120,6 +121,10 @@ public virtual without sharing class Repository implements IRepository {
120121
return this;
121122
}
122123

124+
public Repository addParentFields(Schema.SObjectField parentType, List<Schema.SObjectField> parentFields) {
125+
return this.addParentFields(new List<Schema.SObjectField>{ parentType }, parentFields);
126+
}
127+
123128
public Repository addParentFields(List<Schema.SObjectField> parentTypes, List<Schema.SObjectField> parentFields) {
124129
this.selectFields.addAll(this.getParentFields(parentTypes, parentFields));
125130
return this;
@@ -224,6 +229,11 @@ public virtual without sharing class Repository implements IRepository {
224229
return this;
225230
}
226231

232+
public Repository setShouldPrintBindVars(Boolean shouldPrintBindVars) {
233+
this.shouldPrintBindVars = shouldPrintBindVars;
234+
return this;
235+
}
236+
227237
protected virtual Set<String> addSelectFields() {
228238
this.baseSelectUsed = true;
229239
return this.addSelectFields(this.queryFields);
@@ -308,7 +318,7 @@ public virtual without sharing class Repository implements IRepository {
308318
}
309319

310320
private List<SObject> performQuery(String finalQuery) {
311-
System.debug(System.LoggingLevel.DEBUG, 'performQuery query:\n' + finalQuery);
321+
this.logQuery('performQuery query:\n' + finalQuery);
312322
List<SObject> results = Database.queryWithBinds(finalQuery, this.bindVars, this.accessLevel);
313323
this.clearState();
314324
System.debug(System.LoggingLevel.FINER, 'number of results: ' + results.size() + '\nresults: \n' + results);
@@ -360,7 +370,7 @@ public virtual without sharing class Repository implements IRepository {
360370
' RETURNING ' +
361371
this.formatAdditionalSoslObjects(orderedSearchObjects);
362372

363-
System.debug(System.LoggingLevel.DEBUG, 'search query:\n' + searchQuery);
373+
this.logQuery('search query:\n' + searchQuery);
364374
List<List<SObject>> results = Search.query(searchQuery, this.accessLevel);
365375
System.debug(System.LoggingLevel.FINER, 'number of results: ' + results.size() + '\nresults: \n' + results);
366376
this.clearState();
@@ -388,6 +398,13 @@ public virtual without sharing class Repository implements IRepository {
388398
return String.join(objectsPreJoin, ',');
389399
}
390400

401+
protected void logQuery(String logString) {
402+
if (this.shouldPrintBindVars) {
403+
logString += '\n\nBind vars: ' + JSON.serializePretty(this.bindVars);
404+
}
405+
System.debug(System.LoggingLevel.DEBUG, logString);
406+
}
407+
391408
// DML
392409
public Database.SaveResult doInsert(SObject record) {
393410
return this.dml.doInsert(record);

‎force-app/repository/SObjectRepository.cls‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
public without sharing class SObjectRepository extends FieldLevelHistoryRepo {
2+
public SObjectRepository(
3+
Schema.SObjectType repoType,
4+
List<Schema.SObjectField> queryFields,
5+
RepoFactory repoFactory
6+
) {
7+
super(repoType, queryFields, repoFactory);
8+
}
9+
}

‎force-app/repository/SObjectRepository.cls-meta.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<apiVersion>64.0</apiVersion>
4+
<status>Active</status>
5+
</ApexClass>

‎force-app/repository/SObjectRepositoryTest.cls‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
@IsTest
2+
private class SObjectRepositoryTest {
3+
@IsTest
4+
static void queriesWithGenericRepo() {
5+
Account acc = new Account(Name = SObjectRepositoryTest.class.getName() + System.now().getTime());
6+
insert acc;
7+
8+
List<SObject> results = new SObjectRepository(
9+
Schema.Account.SObjectType,
10+
new List<Schema.SObjectField>(),
11+
new RepoFactory()
12+
)
13+
.getAll();
14+
15+
Assert.areEqual(1, results.size());
16+
Assert.areEqual(acc.Id, results[0].Id);
17+
}
18+
}

‎force-app/repository/SObjectRepositoryTest.cls-meta.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<apiVersion>64.0</apiVersion>
4+
<status>Active</status>
5+
</ApexClass>

0 commit comments

Comments
 (0)