chore: add test on queryHandler

ForestAdmin · Dec 19, 2024 · f6da0cc · f6da0cc
1 parent fe33e63
commit f6da0cc
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 4 deletions.
diff --git a/packages/Agent/src/Utils/Traits/QueryHandler.php b/packages/Agent/src/Utils/Traits/QueryHandler.php
@@ -17,7 +17,7 @@
 
 trait QueryHandler
 {
-    private function executeQuery(string $query, string $connectionName, Permissions $permissions, Caller $caller, ?array $requestContextVariables = []): array
+    protected function executeQuery(string $query, string $connectionName, Permissions $permissions, Caller $caller, ?array $requestContextVariables = []): array
     {
         $query = preg_replace('/\s+/', ' ', trim($query));
         [$query, $contextVariables] = $this->injectContextVariables($query, $caller, $permissions, $requestContextVariables);
@@ -29,7 +29,7 @@ private function executeQuery(string $query, string $connectionName, Permissions
         return $rootDatasource->executeNativeQuery($connectionName, $query, $contextVariables);
     }
 
-    private function injectContextVariables(string $query, Caller $caller, Permissions $permissions, ?array $requestContextVariables = []): array
+    protected function injectContextVariables(string $query, Caller $caller, Permissions $permissions, ?array $requestContextVariables = []): array
     {
         $user = $permissions->getUserData($caller->getId());
         $team = $permissions->getTeam($caller->getRenderingId());
@@ -41,7 +41,7 @@ private function injectContextVariables(string $query, Caller $caller, Permissio
         );
     }
 
-    private function parseQuerySegment(CollectionContract $collection, Permissions $permissions, Caller $caller): ?ConditionTree
+    protected function parseQuerySegment(CollectionContract $collection, Permissions $permissions, Caller $caller): ?ConditionTree
     {
         if (! $this->request->get('segmentQuery')) {
             return null;

diff --git a/tests/Agent/Routes/Resources/ListingTest.php b/tests/Agent/Routes/Resources/ListingTest.php
@@ -7,6 +7,7 @@
 use ForestAdmin\AgentPHP\Agent\Utils\ForestSchema\SchemaEmitter;
 use ForestAdmin\AgentPHP\DatasourceToolkit\Collection;
 use ForestAdmin\AgentPHP\DatasourceToolkit\Components\Caller;
+use ForestAdmin\AgentPHP\DatasourceToolkit\Components\Query\ConditionTree\Nodes\ConditionTreeLeaf;
 use ForestAdmin\AgentPHP\DatasourceToolkit\Components\Query\ConditionTree\Operators;
 use ForestAdmin\AgentPHP\DatasourceToolkit\Components\Query\Filters\PaginatedFilter;
 use ForestAdmin\AgentPHP\DatasourceToolkit\Components\Query\Projection\Projection;
@@ -20,7 +21,6 @@
 use function ForestAdmin\config;
 
 use GuzzleHttp\Psr7\Response;
-
 use Prophecy\Argument;
 use Prophecy\Prophet;
 use Symfony\Component\HttpKernel\Exception\HttpException;
@@ -109,13 +109,19 @@
                     'id'   => 44,
                     'name' => 'Operations',
                 ],
+                'segments' => [
+                    'User' => [
+                        '34dbebc45335faf1d984967d9a4fc672dbd7fc7d',
+                    ],
+                ],
             ]
         ),
         config('permissionExpiration')
     );
 
     $listing = \Mockery::mock(Listing::class)
         ->makePartial()
+        ->shouldAllowMockingProtectedMethods()
         ->shouldReceive('checkIp')
         ->getMock();
 
@@ -380,3 +386,59 @@
         ->toThrow(ForestException::class, "🌳🌳🌳 The given operator 'Shorter_Than' is not supported by the column: id. The allowed operators are: [Equal, Blank, In]");
 
 });
+
+test('when request has segment - should throw if there is no connectionName', function () use ($before) {
+    $_GET['filename'] = 'export-users';
+    $_GET['header'] = 'id,first_name,last_name,birthday,active';
+    $_POST['segmentName'] = 'User segment';
+    $_POST['segmentQuery'] = 'SELECT id FROM users WHERE id = 1;';
+    $data = [];
+
+    $listing = $before($this, ['listing' => $data]);
+
+    expect(fn () => $listing->handleRequest(['collectionName' => 'User']))
+        ->toThrow(ForestException::class, "🌳🌳🌳 'connectionName' parameter is mandatory");
+});
+
+test('when request has segment - return a response 200', function () use ($before) {
+    $_GET['filename'] = 'export-users';
+    $_GET['header'] = 'id,first_name,last_name,birthday,active';
+    $_POST['connectionName'] = 'EloquentDatasource';
+    $_POST['segmentName'] = 'User segment';
+    $_POST['segmentQuery'] = 'SELECT id FROM users WHERE id = 1;';
+    $data = [
+        [
+            'id'         => 1,
+            'first_name' => 'John',
+            'last_name'  => 'Doe',
+            'birthday'   => '1980-01-01',
+            'active'     => true,
+        ],
+    ];
+
+    $listing = $before($this, ['listing' => $data]);
+    $listing->shouldReceive('parseQuerySegment')
+        ->andReturn(new ConditionTreeLeaf('id', Operators::IN, [1]));
+
+    expect($listing->handleRequest(['collectionName' => 'User']))
+        ->toBeArray()
+        ->toEqual(
+            [
+                'name'    => 'User',
+                'content' => [
+                    'data'     => [
+                        [
+                            'type'          => 'User',
+                            'id'            => '1',
+                            'attributes'    => [
+                                'first_name' => 'John',
+                                'last_name'  => 'Doe',
+                                'birthday'   => '1980-01-01',
+                                'active'     => true,
+                            ],
+                        ],
+                    ],
+                ],
+            ]
+        );
+});