resolve view includes with eager loading for optimize queries with nested includes

Author: Insolita

src/actions/HasIncludes.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace insolita\fractal\actions;
+
+use League\Fractal\TransformerAbstract;
+use Yii;
+use yii\db\ActiveQueryInterface;
+use function explode;
+use function in_array;
+
+trait HasIncludes
+{
+    /**
+     * Eager loading for included relations
+     * @param \yii\db\ActiveQueryInterface|\yii\db\ActiveQuery $query
+     * @return \yii\db\ActiveQueryInterface
+     */
+    protected function prepareIncludeQuery(ActiveQueryInterface  $query):ActiveQueryInterface
+    {
+        if (!Yii::$app->request->isGet) {
+            return $query;
+        }
+        if (!$this->transformer instanceof TransformerAbstract) {
+            return $query;
+        }
+        $defaultIncludes = $this->transformer->getDefaultIncludes();
+        $allowedIncludes = $this->transformer->getAvailableIncludes();
+        $requestedIncludes = $this->controller->manager->getRequestedIncludes();
+        $validIncludes = array_filter($requestedIncludes, function ($value) use ($allowedIncludes) {
+            $baseRelation = explode('.', $value)[0];
+            return in_array($baseRelation, $allowedIncludes, true);
+        });
+        $include = array_merge($defaultIncludes, $validIncludes);
+        //@TODO: ?validate if included relations existed ?
+        return empty($include)? $query : $query->with($include);
+    }
+}

src/actions/JsonApiAction.php

@@ -26,6 +26,7 @@
 class JsonApiAction extends Action
 {
     use HasResourceBodyParams;
+    use HasIncludes;
     /**
      * @var \insolita\fractal\JsonApiController $controller
      */
@@ -106,9 +107,11 @@ protected function findModel($id)
         $condition = $this->findModelCondition($id);
 
         if (!empty($condition)) {
-            $model = $modelClass::findOne($condition);
+            $query = $this->prepareIncludeQuery($modelClass::find());
+            $model = $query->where($condition)->limit(1)->one();
         }
 
+
         if (isset($model)) {
             return $model;
         }

src/actions/ListAction.php

@@ -5,12 +5,9 @@
 use insolita\fractal\exceptions\ValidationException;
 use insolita\fractal\providers\CursorActiveDataProvider;
 use insolita\fractal\providers\JsonApiActiveDataProvider;
-use League\Fractal\TransformerAbstract;
 use Yii;
 use yii\base\InvalidConfigException;
 use yii\db\ActiveQueryInterface;
-use function array_intersect;
-use function array_merge;
 
 /**
  * Handler for routes GET /resource
@@ -93,24 +90,6 @@ protected function prepareDataFilter($requestParams)
         return null;
     }
 
-    /**
-     * Eager loading for included relations
-     * @param \yii\db\ActiveQueryInterface|\yii\db\ActiveQuery $query
-     * @return \yii\db\ActiveQueryInterface
-     */
-    protected function prepareIncludeQuery(ActiveQueryInterface  $query):ActiveQueryInterface
-    {
-        if (!$this->transformer instanceof TransformerAbstract) {
-            return $query;
-        }
-        $defaultIncludes = $this->transformer->getDefaultIncludes();
-        $allowedIncludes = $this->transformer->getAvailableIncludes();
-        $requestedIncludes = $this->controller->manager->getRequestedIncludes();
-        $include = array_merge($defaultIncludes, array_intersect($allowedIncludes, $requestedIncludes));
-        //@TODO: ?validate if included relations existed ?
-        return empty($include)? $query : $query->with($include);
-    }
-
     /**
      * Add condition for parent model restriction if needed
      * @param \yii\db\ActiveQueryInterface $query
@@ -148,9 +127,9 @@ protected function makeDataProvider()
 
         /* @var $modelClass \yii\db\BaseActiveRecord */
         $modelClass = $this->modelClass;
+        $query = $this->prepareParentQuery($modelClass::find());
+        $query = $this->prepareIncludeQuery($query);
 
-        $query = $this->prepareIncludeQuery($modelClass::find());
-        $query = $this->prepareParentQuery($query);
 
         if (!empty($filter)) {
             $query->andWhere($filter);

src/actions/ViewAction.php

@@ -34,6 +34,7 @@ public function run($id)
     {
         $model = $this->isParentRestrictionRequired() ? $this->findModelForParent($id) : $this->findModel($id);
 
+
         if ($this->checkAccess) {
             call_user_func($this->checkAccess, $this->id, $model);
         }

tests/testapp/config/api.php

@@ -93,10 +93,12 @@
                 'DELETE /categories/<categoryId:\d+>/posts/<id:\d+>' => 'post/delete-for-category',
                 'OPTIONS /posts' => 'post/options',
                 'GET,HEAD /posts' => 'post/list',
+                'GET,HEAD /comments' => 'comment/list',
                 'POST /posts' => 'post/create',
                 'POST /posts2' => 'post/create2',
                 'POST /comments' => 'comment/create',
                 'GET,HEAD /posts/<id:\d+>' => 'post/view',
+                'GET,HEAD /comments/<id:\d+>' => 'comment/view',
                 'GET,HEAD /posts/<id:\d+>/relationships/author' => 'post/related-author',
                 'GET,HEAD /posts/<id:\d+>/relationships/category' => 'post/related-category',
                 'DELETE /posts/<id:\d+>/relationships/category' => 'post/delete-related-category',

tests/testapp/controllers/CommentController.php

@@ -1,10 +1,10 @@
 <?php
 
-namespace testapp\controllers;
+namespace app\controllers;
 
 use app\models\Comment;
 use insolita\fractal\ActiveJsonApiController;
-use testapp\transformers\CommentTransformer;
+use app\transformers\CommentTransformer;
 
 class CommentController extends ActiveJsonApiController
 {

tests/testapp/models/Comment.php

@@ -52,11 +52,11 @@ public function rules()
 
     public function getUser()
     {
-        return $this->hasOne(User::class, ['user_id' => 'id']);
+        return $this->hasOne(User::class, ['id' => 'user_id']);
     }
 
     public function getPost()
     {
-        return $this->hasOne(Post::class, ['post_id'=>'id']);
+        return $this->hasOne(Post::class, ['id'=>'post_id']);
     }
 }

tests/testapp/transformers/CommentTransformer.php

@@ -1,14 +1,22 @@
 <?php
 
-namespace testapp\transformers;
+namespace app\transformers;
 
 use app\models\Comment;
 use League\Fractal\TransformerAbstract;
 
 class CommentTransformer extends TransformerAbstract
 {
+    public $availableIncludes = ['post'];
+
     public function transform(Comment $comment):array
     {
         return $comment->getAttributes();
     }
+
+    public function includePost(Comment $comment)
+    {
+        $transformer = new PostTransformer();
+        return $this->item($comment->post, $transformer, 'posts');
+    }
 }

tests/tests_phpstorm/comments.http

@@ -0,0 +1,27 @@
+### Index
+GET http://127.0.0.1:8400/comments?page[size]=5
+Accept: application/vnd.api+json
+
+### Index with include
+GET http://127.0.0.1:8400/comments?page[size]=2&include=post
+Accept: application/vnd.api+json
+
+### Index with bad include
+GET http://127.0.0.1:8400/comments?page[size]=2&include=tags
+Accept: application/vnd.api+json
+
+### Index with include nested
+GET http://127.0.0.1:8400/comments?page[size]=2&include=post,post.author
+Accept: application/vnd.api+json
+
+### Index with bad nested include
+GET http://127.0.0.1:8400/comments?page[size]=2&include=post,post.tags
+Accept: application/vnd.api+json
+
+### View with include
+GET http://127.0.0.1:8400/comment/2?include=post
+Accept: application/vnd.api+json
+
+### View with include nested
+GET http://127.0.0.1:8400/comment/2?include=post.author,post.category
+Accept: application/vnd.api+json