Fixes Set handling in filterWhere (#44)

jamessimone · web-flow · commit 269a787b8d51 · 2023-09-18T10:47:39.000-04:00
* Fixes #43 by upgrading SOQl.cls to API version 58, where Set<T> always implements Iterable<T> to simplify string joining for Set operators * Bumped all metadata to API v58.0 (Summer '23 release) * Updated all references to classes & enums in the Schema & System namespaces to explicitly include the namespaces
diff --git a/README.md b/README.md
@@ -2,38 +2,38 @@
 
 A dynamic SOQL query & SOSL search library for Salesforce Apex
 
-## Unlocked Package - no namespace - v3.1.1
+## Unlocked Package - no namespace - v3.1.2
 
-[![Install Unlocked Package in a Sandbox](./images/btn-install-unlocked-package-sandbox.png)](https://test.salesforce.com/packaging/installPackage.apexp?p0=04t5Y000001TsMOQA0)
-[![Install Unlocked Package in Production](./images/btn-install-unlocked-package-production.png)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t5Y000001TsMOQA0)
+[![Install Unlocked Package in a Sandbox](./images/btn-install-unlocked-package-sandbox.png)](https://test.salesforce.com/packaging/installPackage.apexp?p0=04t5Y000001TsbQQAS)
+[![Install Unlocked Package in Production](./images/btn-install-unlocked-package-production.png)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t5Y000001TsbQQAS)
 
 Install with SF CLI:
 
 ```shell
-sf package install --apex-compile package --wait 20 --security-type AdminsOnly --package 04t5Y000001TsMOQA0
+sf package install --apex-compile package --wait 20 --security-type AdminsOnly --package 04t5Y000001TsbQQAS
 ```
 
 Install with SFDX CLI:
 
 ```shell
-sfdx force:package:install --apexcompile package --wait 20 --securitytype AdminsOnly --package 04t5Y000001TsMOQA0
+sfdx force:package:install --apexcompile package --wait 20 --securitytype AdminsOnly --package 04t5Y000001TsbQQAS
 ```
 
-## Unlocked Package - `Nebula` namespace - v3.1.1
+## Unlocked Package - `Nebula` namespace - v3.1.2
 
-[![Install Unlocked Package in a Sandbox](./images/btn-install-unlocked-package-sandbox.png)](https://test.salesforce.com/packaging/installPackage.apexp?p0=04t5Y000001TsMTQA0)
-[![Install Unlocked Package in Production](./images/btn-install-unlocked-package-production.png)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t5Y000001TsMTQA0)
+[![Install Unlocked Package in a Sandbox](./images/btn-install-unlocked-package-sandbox.png)](https://test.salesforce.com/packaging/installPackage.apexp?p0=04t5Y000001TsbVQAS)
+[![Install Unlocked Package in Production](./images/btn-install-unlocked-package-production.png)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t5Y000001TsbVQAS)
 
 Install with SF CLI:
 
 ```shell
-sf package install --apex-compile package --wait 20 --security-type AdminsOnly --package 04t5Y000001TsMTQA0
+sf package install --apex-compile package --wait 20 --security-type AdminsOnly --package 04t5Y000001TsbVQAS
 ```
 
 Install with SFDX CLI:
 
 ```shell
-sfdx force:package:install --apexcompile package --wait 20 --securitytype AdminsOnly --package 04t5Y000001TsMTQA0
+sfdx force:package:install --apexcompile package --wait 20 --securitytype AdminsOnly --package 04t5Y000001TsbVQAS
 ```
 
 ## Features
diff --git a/nebula-query-and-search/main/classes/AggregateQuery.cls b/nebula-query-and-search/main/classes/AggregateQuery.cls
@@ -202,7 +202,7 @@ global class AggregateQuery extends SOQL {
       super.doGetLimitCountString() +
       super.doGetOffetString();
 
-    System.debug(LoggingLevel.FINEST, this.query);
+    System.debug(System.LoggingLevel.FINEST, this.query);
     return this.query;
   }
 
diff --git a/nebula-query-and-search/main/classes/AggregateQuery.cls-meta.xml b/nebula-query-and-search/main/classes/AggregateQuery.cls-meta.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
-    <apiVersion>57.0</apiVersion>
+    <apiVersion>58.0</apiVersion>
     <status>Active</status>
 </ApexClass>
diff --git a/nebula-query-and-search/main/classes/Query.cls b/nebula-query-and-search/main/classes/Query.cls
@@ -332,7 +332,7 @@ global class Query extends SOQL {
     // If additional builder methods are later called, the builder methods will set hasChanged = true
     this.hasChanged = false;
 
-    System.debug(LoggingLevel.FINEST, this.query);
+    System.debug(System.LoggingLevel.FINEST, this.query);
     return this.query;
   }
 
@@ -361,7 +361,7 @@ global class Query extends SOQL {
       super.doGetLimitCountString() +
       ')';
 
-    System.debug(LoggingLevel.FINEST, childQuery);
+    System.debug(System.LoggingLevel.FINEST, childQuery);
     return childQuery;
   }
 
@@ -378,7 +378,7 @@ global class Query extends SOQL {
       super.doGetLimitCountString() +
       ')';
 
-    System.debug(LoggingLevel.FINEST, subquery);
+    System.debug(System.LoggingLevel.FINEST, subquery);
     return subquery;
   }
 
@@ -391,7 +391,7 @@ global class Query extends SOQL {
 
     String searchQuery = this.getSObjectType() + sobjectTypeOptions;
 
-    System.debug(LoggingLevel.FINEST, searchQuery);
+    System.debug(System.LoggingLevel.FINEST, searchQuery);
     return searchQuery;
   }
 
diff --git a/nebula-query-and-search/main/classes/Query.cls-meta.xml b/nebula-query-and-search/main/classes/Query.cls-meta.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
-    <apiVersion>57.0</apiVersion>
+    <apiVersion>58.0</apiVersion>
     <status>Active</status>
 </ApexClass>
diff --git a/nebula-query-and-search/main/classes/RecordSearch.cls b/nebula-query-and-search/main/classes/RecordSearch.cls
@@ -94,7 +94,7 @@ global class RecordSearch extends SOSL {
     // If additional builder methods are later called, the builder methods will set hasChanged = true
     this.hasChanged = false;
 
-    System.debug(LoggingLevel.FINEST, this.searchQuery);
+    System.debug(System.LoggingLevel.FINEST, this.searchQuery);
     return this.searchQuery;
   }
 
diff --git a/nebula-query-and-search/main/classes/RecordSearch.cls-meta.xml b/nebula-query-and-search/main/classes/RecordSearch.cls-meta.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
-    <apiVersion>57.0</apiVersion>
+    <apiVersion>58.0</apiVersion>
     <status>Active</status>
 </ApexClass>
diff --git a/nebula-query-and-search/main/classes/SOQL.cls b/nebula-query-and-search/main/classes/SOQL.cls
@@ -410,7 +410,7 @@ global abstract class SOQL implements Comparable {
     private final String isoCurrency;
 
     public IsoCurrency(String isoCode, Decimal currencyAmount) {
-      if (!UserInfo.isMultiCurrencyOrganization()) {
+      if (!System.UserInfo.isMultiCurrencyOrganization()) {
         throw new SOQLException('IsoCurrency is only supported in multi-currency orgs');
       }
       this.isoCurrency = isoCode + currencyAmount;
@@ -522,7 +522,7 @@ global abstract class SOQL implements Comparable {
       Integer lastFieldIndex = fields.size() - 1;
       List<String> queryFieldPieces = new List<String>();
       for (Integer i = 0; i < fields.size(); i++) {
-        SObjectField field = fields[i];
+        Schema.SObjectField field = fields[i];
         // If any field in the chain is not accessible, then the user cant access the data, so return an empty list
         if (!field.getDescribe().isAccessible()) {
           return null;
@@ -619,10 +619,8 @@ global abstract class SOQL implements Comparable {
     private String formatObjectForQueryString(Object valueToFormat) {
       if (valueToFormat == null) {
         return null;
-      } else if (valueToFormat instanceof List<Object>) {
-        return this.convertListToQueryString((List<Object>) valueToFormat);
-      } else if (valueToFormat instanceof Set<Object>) {
-        return this.convertSetToQueryString(valueToFormat);
+      } else if (valueToFormat instanceof Iterable<Object>) {
+        return this.convertIterableToQueryString((Iterable<Object>) valueToFormat);
       } else if (valueToFormat instanceof Map<Object, Object>) {
         return this.convertMapToQueryString(valueToFormat);
       } else if (valueToFormat instanceof Date) {
@@ -653,26 +651,19 @@ global abstract class SOQL implements Comparable {
       return input;
     }
 
-    private String convertListToQueryString(List<Object> valueList) {
+    private String convertIterableToQueryString(Iterable<Object> valueIterable) {
       List<String> parsedValueList = new List<String>();
-      for (Object value : valueList) {
+      Iterator<Object> valueIterator = valueIterable.iterator();
+      while (valueIterator.hasNext()) {
+        Object value = valueIterator.next();
         parsedValueList.add(this.formatObjectForQueryString(value));
       }
       return '(' + String.join(parsedValueList, ', ') + ')';
     }
 
-    private String convertSetToQueryString(Object valueSet) {
-      String unformattedString = String.valueOf(valueSet).replace('{', '').replace('}', '');
-      List<String> parsedValueList = new List<String>();
-      for (String collectionItem : unformattedString.split(',')) {
-        parsedValueList.add(this.formatObjectForQueryString(collectionItem));
-      }
-      return '(' + String.join(parsedValueList, ', ') + ')';
-    }
-
     private String convertMapToQueryString(Object valueMap) {
       Map<String, Object> untypedMap = (Map<String, Object>) Json.deserializeUntyped(Json.serialize(valueMap));
-      return this.convertSetToQueryString(untypedMap.keySet());
+      return this.convertIterableToQueryString(untypedMap.keySet());
     }
   }
 }
diff --git a/nebula-query-and-search/main/classes/SOQL.cls-meta.xml b/nebula-query-and-search/main/classes/SOQL.cls-meta.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
-    <apiVersion>57.0</apiVersion>
+    <apiVersion>58.0</apiVersion>
     <status>Active</status>
 </ApexClass>
diff --git a/nebula-query-and-search/main/classes/SOSL.cls-meta.xml b/nebula-query-and-search/main/classes/SOSL.cls-meta.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
-    <apiVersion>57.0</apiVersion>
+    <apiVersion>58.0</apiVersion>
     <status>Active</status>
 </ApexClass>
diff --git a/nebula-query-and-search/tests/classes/AggregateQuery_Tests.cls b/nebula-query-and-search/tests/classes/AggregateQuery_Tests.cls
@@ -59,13 +59,13 @@ private class AggregateQuery_Tests {
   static void it_should_cache_results() {
     AggregateQuery aggregateQuery = new AggregateQuery(Schema.Opportunity.SObjectType);
     aggregateQuery.cacheResults();
-    System.assertEquals(0, Limits.getQueries());
+    System.assertEquals(0, System.Limits.getQueries());
 
     for (Integer i = 0; i < 3; i++) {
       aggregateQuery.getResults();
     }
 
-    System.assertEquals(1, Limits.getQueries());
+    System.assertEquals(1, System.Limits.getQueries());
   }
 
   @IsTest
diff --git a/nebula-query-and-search/tests/classes/AggregateQuery_Tests.cls-meta.xml b/nebula-query-and-search/tests/classes/AggregateQuery_Tests.cls-meta.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
-    <apiVersion>57.0</apiVersion>
+    <apiVersion>58.0</apiVersion>
     <status>Active</status>
 </ApexClass>
diff --git a/nebula-query-and-search/tests/classes/Query_Tests.cls b/nebula-query-and-search/tests/classes/Query_Tests.cls
@@ -18,6 +18,18 @@ private class Query_Tests {
     List<Account> accounts = simpleAccountQuery.getResults();
   }
 
+  @IsTest
+  static void it_should_correctly_represent_sets_in_query_filters() {
+    String expectedName = 'someName';
+    String expectedQueryString = 'SELECT Id, Name FROM Account WHERE Name IN (\'' + expectedName + '\')';
+
+    String actualQuery = new Query(Schema.Account.SObjectType)
+      .filterWhere(Schema.Account.Name, SOQL.Operator.IS_IN, new Set<String>{ expectedName })
+      .getQuery();
+
+    System.Assert.areEqual(expectedQueryString, actualQuery);
+  }
+
   @IsTest
   static void it_should_return_results_for_an_advanced_query() {
     Datetime now = System.now();
@@ -31,11 +43,11 @@ private class Query_Tests {
       ' AND LastModifiedDate <= ' +
       now.format('yyyy-MM-dd\'T\'HH:mm:ss\'Z\'', 'Greenwich Mean Time') +
       ' AND Profile.Id != \'' +
-      UserInfo.getProfileId() +
+      System.UserInfo.getProfileId() +
       '\'' +
       ' ORDER BY Profile.CreatedBy.LastModifiedDate ASC NULLS FIRST, Name ASC NULLS FIRST, Email ASC NULLS FIRST' +
       ' LIMIT 100 OFFSET 1 FOR VIEW';
-    List<SObjectField> fieldsToQuery = new List<SObjectField>{ Schema.User.IsActive, Schema.User.Alias };
+    List<Schema.SObjectField> fieldsToQuery = new List<Schema.SObjectField>{ Schema.User.IsActive, Schema.User.Alias };
 
     Query userQuery = new Query(Schema.User.SObjectType)
       .addFields(fieldsToQuery)
@@ -47,7 +59,7 @@ private class Query_Tests {
       .includeFormattedValues()
       .usingScope(SOQL.Scope.MINE)
       .filterWhere(Schema.User.IsActive, SOQL.Operator.EQUALS, true)
-      .filterWhere(new SOQL.QueryField(Schema.User.SObjectType, 'Profile.Id'), SOQL.Operator.NOT_EQUAL_TO, UserInfo.getProfileId())
+      .filterWhere(new SOQL.QueryField(Schema.User.SObjectType, 'Profile.Id'), SOQL.Operator.NOT_EQUAL_TO, System.UserInfo.getProfileId())
       .filterWhere(Schema.User.LastModifiedDate, SOQL.Operator.LESS_THAN_OR_EQUAL_TO, now)
       .filterWhere(Schema.User.LastLoginDate, SOQL.Operator.GREATER_THAN_OR_EQUAL_TO, new SOQL.DateLiteral(SOQL.RelativeDateLiteral.LAST_N_DAYS, 3))
       .filterWhere(Schema.User.CreatedDate, SOQL.Operator.LESS_THAN_OR_EQUAL_TO, new SOQL.DateLiteral(SOQL.FixedDateLiteral.LAST_WEEK))
@@ -118,7 +130,7 @@ private class Query_Tests {
       ' END' +
       ' FROM Task';
 
-    Test.startTest();
+    System.Test.startTest();
 
     Map<Schema.SObjectType, List<Schema.SObjectField>> fieldsBySObjectType = new Map<Schema.SObjectType, List<Schema.SObjectField>>();
 
@@ -133,7 +145,7 @@ private class Query_Tests {
     // Query the task object
     Query taskQuery = new Query(Schema.Task.SObjectType).addPolymorphicFields(Schema.Task.WhoId, fieldsBySObjectType);
 
-    Test.stopTest();
+    System.Test.stopTest();
 
     System.assertEquals(expectedQuery, taskQuery.getQuery());
   }
@@ -232,7 +244,7 @@ private class Query_Tests {
   @IsTest
   static void it_should_return_results_when_filtering_with_iso_currency() {
     // If multi-currency isn't enabled, then we cannot use IsoCurrency, so skip running this test
-    if (!UserInfo.isMultiCurrencyOrganization()) {
+    if (!System.UserInfo.isMultiCurrencyOrganization()) {
       return;
     }
 
@@ -249,20 +261,20 @@ private class Query_Tests {
     Query userQuery = new Query(Schema.User.SObjectType).limitTo(1);
 
     // First, verify that caching is not enabled by default
-    System.assertEquals(0, Limits.getQueries());
+    System.assertEquals(0, System.Limits.getQueries());
     for (Integer i = 0; i < loops; i++) {
       userQuery.getResults();
     }
-    System.assertEquals(loops, Limits.getQueries());
+    System.assertEquals(loops, System.Limits.getQueries());
 
-    Test.startTest();
+    System.Test.startTest();
 
     userQuery.cacheResults();
     for (Integer i = 0; i < loops; i++) {
       userQuery.getResults();
     }
-    System.assertEquals(1, Limits.getQueries());
+    System.assertEquals(1, System.Limits.getQueries());
 
-    Test.stopTest();
+    System.Test.stopTest();
   }
 }
diff --git a/nebula-query-and-search/tests/classes/Query_Tests.cls-meta.xml b/nebula-query-and-search/tests/classes/Query_Tests.cls-meta.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
-    <apiVersion>57.0</apiVersion>
+    <apiVersion>58.0</apiVersion>
     <status>Active</status>
 </ApexClass>
diff --git a/nebula-query-and-search/tests/classes/RecordSearch_Tests.cls b/nebula-query-and-search/tests/classes/RecordSearch_Tests.cls
diff --git a/nebula-query-and-search/tests/classes/RecordSearch_Tests.cls-meta.xml b/nebula-query-and-search/tests/classes/RecordSearch_Tests.cls-meta.xml
diff --git a/package.json b/package.json
diff --git a/sfdx-project.json b/sfdx-project.json

Original file line number	Diff line number	Diff line change
`@@ -202,7 +202,7 @@ global class AggregateQuery extends SOQL {`
`202`	`202`	`super.doGetLimitCountString() +`
`203`	`203`	`super.doGetOffetString();`
`204`	`204`
`205`		`- System.debug(LoggingLevel.FINEST, this.query);`
	`205`	`+ System.debug(System.LoggingLevel.FINEST, this.query);`
`206`	`206`	`return this.query;`
`207`	`207`	`}`
`208`	`208`
Original file line number	Diff line number	Diff line change
`@@ -332,7 +332,7 @@ global class Query extends SOQL {`
`332`	`332`	`// If additional builder methods are later called, the builder methods will set hasChanged = true`
`333`	`333`	`this.hasChanged = false;`
`334`	`334`
`335`		`- System.debug(LoggingLevel.FINEST, this.query);`
	`335`	`+ System.debug(System.LoggingLevel.FINEST, this.query);`
`336`	`336`	`return this.query;`
`337`	`337`	`}`
`338`	`338`
`@@ -361,7 +361,7 @@ global class Query extends SOQL {`
`361`	`361`	`super.doGetLimitCountString() +`
`362`	`362`	`')';`
`363`	`363`
`364`		`- System.debug(LoggingLevel.FINEST, childQuery);`
	`364`	`+ System.debug(System.LoggingLevel.FINEST, childQuery);`
`365`	`365`	`return childQuery;`
`366`	`366`	`}`
`367`	`367`
`@@ -378,7 +378,7 @@ global class Query extends SOQL {`
`378`	`378`	`super.doGetLimitCountString() +`
`379`	`379`	`')';`
`380`	`380`
`381`		`- System.debug(LoggingLevel.FINEST, subquery);`
	`381`	`+ System.debug(System.LoggingLevel.FINEST, subquery);`
`382`	`382`	`return subquery;`
`383`	`383`	`}`
`384`	`384`
`@@ -391,7 +391,7 @@ global class Query extends SOQL {`
`391`	`391`
`392`	`392`	`String searchQuery = this.getSObjectType() + sobjectTypeOptions;`
`393`	`393`
`394`		`- System.debug(LoggingLevel.FINEST, searchQuery);`
	`394`	`+ System.debug(System.LoggingLevel.FINEST, searchQuery);`
`395`	`395`	`return searchQuery;`
`396`	`396`	`}`
`397`	`397`
Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,7 @@ global class RecordSearch extends SOSL {`
`94`	`94`	`// If additional builder methods are later called, the builder methods will set hasChanged = true`
`95`	`95`	`this.hasChanged = false;`
`96`	`96`
`97`		`- System.debug(LoggingLevel.FINEST, this.searchQuery);`
	`97`	`+ System.debug(System.LoggingLevel.FINEST, this.searchQuery);`
`98`	`98`	`return this.searchQuery;`
`99`	`99`	`}`
`100`	`100`