toIdsOf mocking fix (#196) (#197)

Signed-off-by: Piotr PG Gajek <[email protected]>

Author: pgajek2

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

@@ -3,7 +3,7 @@
  * Licensed under the MIT License (https://github.com/beyond-the-cloud-dev/soql-lib/blob/main/LICENSE)
  *
  * v6.0.0
- * 
+ *
  * PMD False Positives:
  * - ExcessivePublicCount: It is a library class and exposes all necessary methods to construct a query
  * - ExcessiveClassLength: It is a library and we tried to put everything into ONE class
@@ -382,7 +382,7 @@ public virtual inherited sharing class SOQL implements Queryable {
 
     @TestVisible
     private static Mockable mock(String mockId) {
-        if (!SOQL.queryIdToMock.containsKey(mockId)) {   
+        if (!SOQL.queryIdToMock.containsKey(mockId)) {
             SOQL.queryIdToMock.put(mockId, new List<SoqlMock>());
         }
         SOQL.queryIdToMock.get(mockId).add(new SoqlMock());
@@ -1131,13 +1131,13 @@ public virtual inherited sharing class SOQL implements Queryable {
 
         public override String toString() {
             List<String> queryParts = new List<String>();
-    
+
             for (QueryClause clause : this.clauses) {
                 if (clause != null) {
                     queryParts.add(clause.toString());
                 }
             }
-            
+
             return String.join(queryParts, ' ').trim();
         }
     }
@@ -2393,7 +2393,8 @@ public virtual inherited sharing class SOQL implements Queryable {
         }
 
         public List<SObject> get(SoqlFields fields, SoqlSubQueries subQueries) {
-            if (this.useLegacyMockingBehavior || this.mockedRecords.isEmpty()) {
+            // AggregateResult can be mocked only with Id field for toIdsOf, toValueOf
+            if (this.useLegacyMockingBehavior || this.mockedRecords.isEmpty() || this.mockedRecords[0]?.getSObjectType() == AggregateResult.SObjectType) {
                 return this.mockedRecords;
             }
 
@@ -2851,4 +2852,4 @@ public virtual inherited sharing class SOQL implements Queryable {
             return Id.valueOf(prefix + '0000' + randomPart);
         }
     }
-}
+}

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

@@ -3,7 +3,7 @@
  * Licensed under the MIT License (https://github.com/beyond-the-cloud-dev/soql-lib/blob/main/LICENSE)
  *
  * v6.0.0
- * 
+ *
  * PMD False Positives:
  * - CyclomaticComplexity: It is a library and we tried to put everything into ONE test class
  * - CognitiveComplexity: It is a library and we tried to put everything into ONE test class
@@ -3893,7 +3893,7 @@ private class SOQL_Test {
         SOQL.mock('mockingQuery').thenReturn(1);
         SOQL.mock('mockingQuery').thenReturn(2);
         SOQL.mock('mockingQuery').thenReturn(3);
-        
+
         // Test
         Integer result1 = SOQL.of(Account.SObjectType).mockId('mockingQuery').count().toInteger();
         Integer result2 = SOQL.of(Account.SObjectType).mockId('mockingQuery').count().toInteger();
@@ -3913,7 +3913,7 @@ private class SOQL_Test {
         SOQL.mock('mockingQuery').thenReturn(new Map<String, Object>{ 'LeadSource' => 'Web',  'total' => 10});
         SOQL.mock('mockingQuery').thenReturn(new Map<String, Object>{ 'LeadSource' => 'Phone', 'total' => 5});
         SOQL.mock('mockingQuery').thenReturn(new Map<String, Object>{ 'LeadSource' => 'Email', 'total' => 3});
-        
+
         // Test
         List<SOQL.AggregateResultProxy> result1 = SOQL.of(Lead.SObjectType)
             .with(Lead.LeadSource)
@@ -3974,6 +3974,18 @@ private class SOQL_Test {
         Assert.areEqual(acc.Id, accountId, 'The returned Id should match the expected one.');
     }
 
+    @IsTest
+    static void toIdWithMocking() {
+        // Setup
+        SOQL.mock('mockingQuery').thenReturn(new Account(Name = 'Test 1'));
+
+        // Test
+        Id accountId = SOQL.of(Account.SObjectType).mockId('mockingQuery').toId();
+
+        // Verify
+        Assert.isNotNull(accountId, 'The returned Id should match the expected one.');
+    }
+
     @IsTest
     static void toIds() {
         // Setup
@@ -3986,6 +3998,21 @@ private class SOQL_Test {
         Assert.areEqual(accounts.size(), accountIds.size(), 'The size of the returned set should be equal to the size of the inserted accounts.');
     }
 
+    @IsTest
+    static void toIdsWithMocking() {
+        // Setup
+        SOQL.mock('mockingQuery').thenReturn(new List<SObject>{
+            new Account(Name = 'Test 1'),
+            new Account(Name = 'Test 2')
+        });
+
+        // Test
+        Set<Id> accountIds = SOQL.of(Account.SObjectType).mockId('mockingQuery').toIds();
+
+        // Verify
+        Assert.areEqual(2, accountIds.size(), 'The size of the returned set should be equal to the size of the mocked accounts.');
+    }
+
     @IsTest
     static void toIdsOf() {
         // Setup
@@ -3998,6 +4025,30 @@ private class SOQL_Test {
         Assert.areEqual(accounts.size(), parentIds.size(), 'The size of the returned set should be equal to the size of the inserted accounts.');
     }
 
+    @IsTest
+    static void toIdsOfWithMocking() {
+        // Setup
+        SOQL.mock('mockingQuery').thenReturn(
+            (List<AggregateResult>) JSON.deserialize(
+                JSON.serialize(new List<Map<String, Object>>{
+                    new Map<String, Object>{
+                        'Id' => SOQL.IdGenerator.get(Account.SObjectType)
+                    },
+                    new Map<String, Object>{
+                        'Id' => SOQL.IdGenerator.get(Account.SObjectType)
+                    }
+                }),
+                List<AggregateResult>.class
+            )
+        );
+
+        // Test
+        Set<Id> parentIds = SOQL.of(Account.SObjectType).mockId('mockingQuery').toIdsOf(Account.ParentId);
+
+        // Verify
+        Assert.areEqual(2, parentIds.size(), 'The size of the returned set should be equal to the size of the mocked accounts.');
+    }
+
     @IsTest
     static void toIdsOfRelationshipField() {
         // Setup
@@ -4010,6 +4061,25 @@ private class SOQL_Test {
         Assert.areEqual(1, createdByIds.size(), 'The size of the returned set should be 1, because the same user inserted the accounts.');
     }
 
+    @IsTest
+    static void toIdsOfRelationshipFieldWithMocking() {
+        // Setup
+        SOQL.mock('mockingQuery').thenReturn(
+            (AggregateResult) JSON.deserialize(
+                JSON.serialize(new Map<String, Object>{
+                    'Id' => SOQL.IdGenerator.get(User.SObjectType)
+                }),
+                AggregateResult.class
+            )
+        );
+
+        // Test
+        Set<Id> createdByIds = SOQL.of(Account.SObjectType).mockId('mockingQuery').toIdsOf('Parent', Account.CreatedById);
+
+        // Verify
+        Assert.areEqual(1, createdByIds.size(), 'The size of the returned set should be 1, because the same user inserted the accounts.');
+    }
+
     @IsTest
     static void doExist() {
         // Setup
@@ -4488,7 +4558,7 @@ private class SOQL_Test {
             new Account(Name = 'Test 1'),
             new Account(Name = 'Test 2')
         });
-        
+
         // Test
         try {
             Test.startTest();
@@ -4559,9 +4629,9 @@ private class SOQL_Test {
 
         // Test
         Set<Id> accountIds = new SOQL.Converter('Account').transform(accounts).toIdsOf(Account.ParentId);
-       
+
         // Verify
-        Assert.areEqual(accounts.size(), accountIds.size(), 'The size of the returned set should be equal to the size of the inserted accounts.');        
+        Assert.areEqual(accounts.size(), accountIds.size(), 'The size of the returned set should be equal to the size of the inserted accounts.');
     }
 
     @IsTest
@@ -4574,9 +4644,9 @@ private class SOQL_Test {
 
         // Test
         Set<Id> accountIds = new SOQL.Converter('Account').transform(accounts).toIdsOf('Parent', Account.Id);
-       
+
         // Verify
-        Assert.areEqual(accounts.size(), accountIds.size(), 'The size of the returned set should be equal to the size of the inserted accounts.');        
+        Assert.areEqual(accounts.size(), accountIds.size(), 'The size of the returned set should be equal to the size of the inserted accounts.');
     }
 
     @IsTest
@@ -4589,7 +4659,7 @@ private class SOQL_Test {
 
         // Test
         Set<String> accountNames = new SOQL.Converter('Account').transform(accounts).toValuesOf(Account.Name);
-        
+
         // Verify
         Assert.areEqual(accounts.size(), accountNames.size(), 'The size of the returned set should be equal to the size of the inserted accounts.');
         Assert.isTrue(accountNames.contains('Test 1'), 'The returned set should contain the account name "Test 1".');

website/docs/soql/advanced/mocking.md

@@ -47,7 +47,7 @@ SOQL.mock('testQuery').thenReturn(new Account(Name = 'Third Call'));
 // First execution returns "First Call", then removes that mock
 Account result1 = SOQL.of(Account.SObjectType).mockId('testQuery').toObject();
 
-// Second execution returns "Second Call", then removes that mock  
+// Second execution returns "Second Call", then removes that mock
 Account result2 = SOQL.of(Account.SObjectType).mockId('testQuery').toObject();
 
 // Third execution returns "Third Call", but do not removes that mock - it's the last mock on the stack
@@ -376,3 +376,52 @@ public class ExampleControllerTest {
     }
 }
 ```
+
+# toIdsOf, toValuesOf
+
+We are using field aliasing: https://salesforce.stackexchange.com/questions/393308/get-a-list-of-one-column-from-a-soql-result
+
+It’s approximately 2x more efficient than a standard for loop. Because of this, mocking works differently for the following methods:
+
+- `toIdsOf(SObjectField field)`
+- `toIdsOf(String relationshipName, SObjectField field)`
+- `toValuesOf(SObjectField fieldToExtract)`
+- `toValuesOf(String relationshipName, SObjectField targetKeyField)`
+
+```apex title="ExampleController.cls"
+public with sharing class ExampleController {
+    public Set<String> getAccountNames() {
+        return SOQL.of(Account.SObjectType)
+            .mockId('ExampleController.getAccountNames')
+            .toValuesOf(Account.Name);
+    }
+}
+```
+
+```apex title="ExampleControllerTest.cls"
+@IsTest
+public class ExampleControllerTest {
+    @IsTest
+    static void getAccountByName() {
+         SOQL.mock('mockingQuery').thenReturn(
+            (List<AggregateResult>) JSON.deserialize(
+                JSON.serialize(new List<Map<String, Object>>{
+                    new Map<String, Object>{
+                        'Id' => 'Account Name 1'
+                    },
+                    new Map<String, Object>{
+                        'Id' => 'Account Name 2'
+                    }
+                }),
+                List<AggregateResult>.class
+            )
+        );
+
+        Test.startTest();
+        Set<String> result = ExampleController.getAccountNames();
+        Test.stopTest();
+
+        Assert.areEqual(2, result.size());
+    }
+}
+```