Dynamic Query Improvements: aggregate function exceptions, Filter Group bulkification, SubQuery dynamic order (#153)

Author: salberski

force-app/main/default/classes/main/standard-soql/SOQL.cls

@@ -163,6 +163,7 @@ public virtual inherited sharing class SOQL implements Queryable {
         SubQuery with(SObjectField field1, SObjectField field2, SObjectField field3, SObjectField field4);
         SubQuery with(SObjectField field1, SObjectField field2, SObjectField field3, SObjectField field4, SObjectField field5);
         SubQuery with(Iterable<SObjectField> fields);
+        SubQuery with(String fields);
         SubQuery with(String relationshipName, Iterable<SObjectField> fields);
         SubQuery with(SubQuery subQuery);
         // WHERE
@@ -171,6 +172,7 @@ public virtual inherited sharing class SOQL implements Queryable {
         //ORDER BY
         SubQuery orderBy(SObjectField field);
         SubQuery orderBy(String relationshipName, SObjectField field);
+        SubQuery orderBy(String field, String direction);
         SubQuery sortDesc();
         SubQuery nullsLast();
         // LIMIT
@@ -186,7 +188,9 @@ public virtual inherited sharing class SOQL implements Queryable {
         // ADD CONDITION
         FilterGroup add(FilterGroup filterGroup);
         FilterGroup add(Filter filter);
+        FilterGroup addAll(List<Filter> filters);
         FilterGroup add(String dynamicCondition);
+        FilterGroup addAll(List<String> dynamicConditions);
         // ORDER
         FilterGroup anyConditionMatching();
         FilterGroup conditionLogic(String order);
@@ -1090,7 +1094,12 @@ public virtual inherited sharing class SOQL implements Queryable {
 
         private Boolean isAggregateFunction(String field) {
             // AVG(), COUNT(), MIN(), MAX(), SUM() or Field aliasing
-            return field.contains('(') && field.contains(')') || field.contains(' ');
+            // Exclude other SOQL Funcions ex. toLabel(), convertCurrency(), FORMAT()
+            Set<String> exceptionFunctions = new Set<String>{ 'toLabel', 'convertCurrency', 'FORMAT' };
+            Pattern exceptionFunctionsRegexPattern = Pattern.compile('(?i)\\b(' + String.join(new List<String>(exceptionFunctions), '|') + ')\\s*\\(');
+            Matcher exceptionFunctionsMatcher = exceptionFunctionsRegexPattern.matcher(field);
+
+            return field.contains('(') && field.contains(')') && !exceptionFunctionsMatcher.find() || field.contains(' ');
         }
 
         public void with(Iterable<SObjectField> fields) {
@@ -1204,6 +1213,11 @@ public virtual inherited sharing class SOQL implements Queryable {
             return this;
         }
 
+        public SubQuery with(String fields) {
+            builder.fields.with(fields);
+            return this;
+        }
+
         public SubQuery with(String relationshipName, Iterable<SObjectField> fields) {
             builder.fields.with(relationshipName, fields);
             return this;
@@ -1234,6 +1248,11 @@ public virtual inherited sharing class SOQL implements Queryable {
             return this;
         }
 
+        public SubQuery orderBy(String field, String direction) {
+            builder.orderBys.newOrderBy().with(field).sortingOrder(direction);
+            return this;
+        }
+
         public SubQuery sortDesc() {
             builder.latestOrderBy.sortDesc();
             return this;
@@ -1349,10 +1368,24 @@ public virtual inherited sharing class SOQL implements Queryable {
             return add(new FilterAdapter(filter));
         }
 
+        public FilterGroup addAll(List<Filter> filters) {
+            for (Filter filter: filters) {
+                add(filter);
+            }
+            return this;
+        }
+
         public FilterGroup add(String dynamicCondition) {
             return add(new StringConditionAdapter(dynamicCondition));
         }
 
+        public FilterGroup addAll(List<String> dynamicConditions) {
+            for (String dynamicCondition: dynamicConditions) {
+                add(dynamicCondition);
+            }
+            return this;
+        }
+
         public FilterGroup add(FilterClause condition) {
             if (condition.hasValue()) {
                 queryConditions.add(condition);

force-app/main/default/classes/main/standard-soql/SOQL_Test.cls

@@ -558,6 +558,17 @@ private class SOQL_Test {
         Assert.areEqual('SELECT CampaignId campaign, AVG(Amount) amount FROM Opportunity GROUP BY CampaignId', soql, 'The generated SOQL should match the expected one.');
     }
 
+    @IsTest
+    static void withStringFieldsAndToLabelFunction() {
+        // Test
+        String soql = SOQL.of(Case.SObjectType)
+            .with('Id, toLabel(Status), Subject')
+            .toString();
+
+        // Verify
+        Assert.areEqual('SELECT Id, toLabel(Status), Subject FROM Case', soql);
+    }
+
     @IsTest
     static void withFieldAlias() {
         // Test
@@ -830,6 +841,21 @@ private class SOQL_Test {
         Assert.areEqual('SELECT Name , (SELECT Id, Name FROM Contacts ORDER BY Name DESC NULLS LAST) FROM Account', soql, 'The generated SOQL should match the expected one.');
     }
 
+    @IsTest
+    static void subQueryOrderByDynamic() {
+        // Test
+        String soql = SOQL.of(Account.SObjectType)
+            .with(Account.Name)
+            .with(SOQL.SubQuery.of('Contacts')
+                .with(Contact.Id, Contact.Name)
+                .orderBy('Name', 'ASC')
+                .nullsLast()
+            ).toString();
+
+        // Verify
+        Assert.areEqual('SELECT Name , (SELECT Id, Name FROM Contacts ORDER BY Name ASC NULLS LAST) FROM Account', soql);
+    }
+
     @IsTest
     static void subQueryOrderByRelated() {
         // Test
@@ -1540,6 +1566,65 @@ private class SOQL_Test {
         Assert.areEqual('Krakow', binding.get('v2'), 'The binding variable should match the expected value.');
     }
 
+    @IsTest
+    static void dynamicFiltersListGroup() {
+        // Setup
+        SOQL.FilterGroup filterGroup = SOQL.FilterGroup;
+
+        filterGroup.addAll(new List<SOQL.Filter> {
+            SOQL.Filter.with(Account.Name).equal('Test'),
+            SOQL.Filter.with(Account.BillingCity).equal('Krakow')
+        });
+
+        // Test
+        SOQL builder = SOQL.of(Account.SObjectType)
+            .whereAre(filterGroup);
+
+        // Verify
+        String soql = builder.toString();
+        Assert.areEqual('SELECT Id FROM Account WHERE (Name = :v1 AND BillingCity = :v2)', soql);
+
+        Map<String, Object> binding = builder.binding();
+        Assert.areEqual('Test', binding.get('v1'));
+        Assert.areEqual('Krakow', binding.get('v2'));
+    }
+
+    @IsTest
+    static void dynamicStringFiltersGroup() {
+        // Setup
+        SOQL.FilterGroup filterGroup = SOQL.FilterGroup;
+
+        filterGroup.add('Name = \'Test\'');
+        filterGroup.add('BillingCity = \'Krakow\'');
+
+        // Test
+        SOQL builder = SOQL.of(Account.SObjectType)
+            .whereAre(filterGroup);
+
+        // Verify
+        String soql = builder.toString();
+        Assert.areEqual('SELECT Id FROM Account WHERE (Name = \'Test\' AND BillingCity = \'Krakow\')', soql);
+    }
+
+    @IsTest
+    static void dynamicStringFiltersListGroup() {
+        // Setup
+        SOQL.FilterGroup filterGroup = SOQL.FilterGroup;
+
+        filterGroup.addAll(new List<String> {
+            'Name = \'Test\'',
+            'BillingCity = \'Krakow\''
+        });
+
+        // Test
+        SOQL builder = SOQL.of(Account.SObjectType)
+            .whereAre(filterGroup);
+
+        // Verify
+        String soql = builder.toString();
+        Assert.areEqual('SELECT Id FROM Account WHERE (Name = \'Test\' AND BillingCity = \'Krakow\')', soql);
+    }
+
     @IsTest
     static void dynamicFiltersGroupOnSoqlInstance() {
         // Test