Ensure ?include_totals are handled on GET /users and GET /roles requests for Management API (#476)

Author: Evan Sims

src/API/Management/Roles.php

@@ -28,8 +28,11 @@ class Roles extends GenericResource
      */
     public function getAll(array $params = [])
     {
+        $params = $this->normalizePagination( $params );
+        $params = $this->normalizeIncludeTotals( $params );
+
         return $this->apiClient->method('get')
-            ->withDictParams($this->normalizePagination( $params ))
+            ->withDictParams($params)
             ->addPath('roles')
             ->call();
     }

src/API/Management/Users.php

@@ -142,6 +142,7 @@ public function getAll(array $params = [], $fields = null, $include_fields = nul
         }
 
         $params = $this->normalizePagination( $params, $page, $per_page );
+        $params = $this->normalizeIncludeTotals( $params );
 
         return $this->apiClient->method('get')
             ->addPath('users')

tests/unit/API/Management/RolesMockedTest.php

@@ -529,7 +529,10 @@ public function testThatGetUsersRequestWithEmptyRoleIdThrowsException()
      */
     public function testThatGetUsersRequestIsFormattedProperly()
     {
-        $api = new MockManagementApi( [ new Response( 200, self::$headers ) ] );
+        $api = new MockManagementApi( [
+            new Response( 200, self::$headers ),
+            new Response( 200, self::$headers )
+        ] );
 
         $api->call()->roles()->getUsers( '__test_role_id__', [ 'per_page' => 6, 'include_totals' => 1 ] );
 
@@ -543,9 +546,15 @@ public function testThatGetUsersRequestIsFormattedProperly()
         $this->assertEquals( 'Bearer __api_token__', $headers['Authorization'][0] );
         $this->assertEquals( self::$expectedTelemetry, $headers['Auth0-Client'][0] );
 
-        $query = $api->getHistoryQuery();
-        $this->assertStringContainsString( 'page=6', $query );
-        $this->assertStringContainsString( 'include_totals=true', $query );
+        $query = '&' . $api->getHistoryQuery();
+        $this->assertStringContainsString( '&per_page=6', $query );
+        $this->assertStringContainsString( '&include_totals=true', $query );
+
+        $api->call()->roles()->getUsers( '__test_role_id__', [ 'per_page' => 12 ] );
+
+        $query = '&' . $api->getHistoryQuery();
+        $this->assertStringContainsString( '&per_page=12', $query );
+        $this->assertStringContainsString( '&include_totals=false', $query );
     }
 
     /**

tests/unit/API/Management/UsersMockedTest.php

@@ -205,7 +205,10 @@ public function testThatGetAllUsersRequestIsFormattedProperly()
         $api->call()->users()->getAll();
 
         $this->assertEquals( 'GET', $api->getHistoryMethod() );
-        $this->assertEquals( 'https://api.test.local/api/v2/users', $api->getHistoryUrl() );
+        $this->assertStringStartsWith( 'https://api.test.local/api/v2/users', $api->getHistoryUrl() );
+
+        $query = '&'.$api->getHistoryQuery();
+        $this->assertStringContainsString( '&include_totals=false', $query );
 
         $headers = $api->getHistoryHeaders();
         $this->assertEquals( 'Bearer __api_token__', $headers['Authorization'][0] );
@@ -225,8 +228,8 @@ public function testThatGetAllUsersAdditionalParamsAreSent()
 
         $api->call()->users()->getAll( [ '__test_parameter__' => '__test_value__' ] );
 
-        $query = $api->getHistoryQuery();
-        $this->assertEquals( '__test_parameter__=__test_value__', $query );
+        $query = '&'.$api->getHistoryQuery();
+        $this->assertStringContainsString( '&__test_parameter__=__test_value__', $query );
     }
 
     /**
@@ -242,8 +245,8 @@ public function testThatGetAllUsersFieldsParamDoesNotOverwrite()
 
         $api->call()->users()->getAll( [ 'fields' => 'field1,field2' ], 'field3' );
 
-        $query = $api->getHistoryQuery();
-        $this->assertEquals( 'fields=field1,field2', $query );
+        $query = '&'.$api->getHistoryQuery();
+        $this->assertStringContainsString( '&fields=field1,field2', $query );
     }
 
     /**
@@ -262,13 +265,13 @@ public function testThatGetAllUsersFieldsAreFormattedCorrectly()
 
         $api->call()->users()->getAll( [ 'fields' => 'field1,field2' ] );
 
-        $query = $api->getHistoryQuery();
-        $this->assertEquals( 'fields=field1,field2', $query );
+        $query = '&'.$api->getHistoryQuery();
+        $this->assertStringContainsString( '&fields=field1,field2', $query );
 
         $api->call()->users()->getAll( [ 'fields' => [ 'field1', 'field2' ] ] );
 
-        $query = $api->getHistoryQuery();
-        $this->assertEquals( 'fields=field1,field2', $query );
+        $query = '&'.$api->getHistoryQuery();
+        $this->assertStringContainsString( '&fields=field1,field2', $query );
     }
 
     /**