Skip to content

Commit d7398fd

Browse files
InsolitaInsolita
committed
Merge branch 'add-relationship-ids-validation'
2 parents c210744 + e272a44 commit d7398fd

File tree

7 files changed

+105
-20
lines changed

7 files changed

+105
-20
lines changed

‎CHANGELOG.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,7 @@
2626

2727
1.3.1
2828
- Add CountForIdentityAction
29-
- remove includes from counter actions
29+
- remove includes from counter actions
30+
31+
1.3.2
32+
- Add validator callback for ability to check allowedRelations for Create and Update Actions

‎src/RelationshipManager.php‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
use yii\web\HttpException;
1919
use yii\web\NotFoundHttpException;
2020
use function array_diff;
21+
use function call_user_func;
2122
use function count;
2223
use function gettype;
2324
use function implode;
@@ -94,12 +95,10 @@ public function attach()
9495
throw new HttpException(422, 'Missing ids for create relationship');
9596
}
9697
if ($this->idValidateCallback !== null) {
97-
$this->idValidateCallback($this->model, $ids);
98+
call_user_func($this->idValidateCallback, $this->model, $ids);
9899
} else {
99100
$this->validateIdType($ids, false);
100101
}
101-
102-
103102
$pkAttribute = $this->resolvePkAttribute($relation);
104103
$alreadyRelatedIds = $relation->select($pkAttribute)->column();
105104
$forLink = array_diff($ids, $alreadyRelatedIds);
@@ -150,7 +149,7 @@ public function delete(bool $unlinkOnly = true):void
150149

151150
$ids = ArrayHelper::getColumn($this->data, 'id');
152151
if ($this->idValidateCallback !== null) {
153-
$this->idValidateCallback($this->model, $ids);
152+
call_user_func($this->idValidateCallback, $this->model, $ids);
154153
} else {
155154
$this->validateIdType($ids, false);
156155
}
@@ -203,8 +202,9 @@ public function patch($unlinkOnly = true):void
203202
if (empty($ids)) {
204203
throw new HttpException(422, 'Missing ids for update relationship');
205204
}
205+
206206
if ($this->idValidateCallback !== null) {
207-
$this->idValidateCallback($this->model, $ids);
207+
call_user_func($this->idValidateCallback, $this->model, $ids);
208208
} else {
209209
$this->validateIdType($ids, false);
210210
}
@@ -257,12 +257,13 @@ protected function patchSingle(ActiveQueryInterface $relation, bool $unlinkOnly)
257257
$newRelationId = $this->data['id'] ?? null;
258258

259259
if ($this->idValidateCallback !== null) {
260-
$this->idValidateCallback($this->model, [$newRelationId]);
260+
call_user_func($this->idValidateCallback, $this->model, [$newRelationId]);
261261
} else {
262262
$this->validateIdType([$newRelationId], true);
263263
}
264264

265265
$relatedModel = $relation->one();
266+
$alreadyRelatedIds = $relatedModel ? $relatedModel->getPrimaryKey(): [];
266267
if (!$newRelationId && $relatedModel) {
267268
$this->model->unlink($this->relationName, $relatedModel, !$unlinkOnly);
268269
Yii::$app->response->setStatusCode(204);

‎src/actions/CreateAction.php‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,17 @@ class CreateAction extends JsonApiAction
3232
* * Configuration for attaching relationships
3333
* Should contains key - relation name and array with
3434
* idType - php type of resource ids for validation
35+
* validator = callback for custom id validation
3536
* Keep it empty for disable this ability
3637
* @see https://jsonapi.org/format/#crud-creating
3738
* @example
3839
* 'allowedRelations' => [
3940
* 'author' => ['idType' => 'integer'],
40-
* 'photos' => ['idType' => 'integer'],
41+
* 'photos' => ['idType' => 'integer', 'validator' => function($model, array $ids) {
42+
* $relatedModels = Relation::find()->where(['id' => $ids])->andWhere([additional conditions])->all();
43+
* if(count($relatedModels) < $ids) {
44+
* throw new HttpException(422, 'Invalid photos ids');
45+
* }],
4146
* ]
4247
**/
4348
public $allowedRelations = [];
@@ -131,12 +136,16 @@ protected function linkRelationships(ActiveRecordInterface $model):void
131136
$relationships = $this->getResourceRelationships();
132137
$relationNames = array_keys($relationships);
133138
foreach ($relationNames as $relationName) {
139+
$options = $this->allowedRelations[$relationName];
134140
$manager = new RelationshipManager(
135141
$model,
136142
$relationName,
137143
$relationships[$relationName]['data'],
138-
$this->allowedRelations[$relationName]['idType']
144+
$options['idType']
139145
);
146+
if (isset($options['validator']) && \is_callable($options['validator'])) {
147+
$manager->setIdValidateCallback($options['validator']);
148+
}
140149
$manager->attach();
141150
}
142151
}

‎src/actions/UpdateAction.php‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,21 @@ class UpdateAction extends JsonApiAction
3232
* Should contains key - relation name and array with
3333
* idType - php type of resource ids for validation
3434
* unlinkOnly = should unlinked relation models be removed
35+
* validator = callback for custom id validation
3536
* Keep it empty for disable this ability
3637
* @see https://jsonapi.org/format/#crud-updating-resource-relationships
3738
* @example
3839
* 'allowedRelations' => [
3940
* 'author' => ['idType' => 'integer', 'unlinkOnly' =>true],
40-
* 'photos' => ['idType' => 'integer', 'unlinkOnly' =>false],
41+
* 'photos' => [
42+
* 'idType' => 'integer',
43+
* 'unlinkOnly' =>false,
44+
* 'validator' => function($model, array $ids) {
45+
* $relatedModels = Relation::find()->where(['id' => $ids])->andWhere([additional conditions])->all();
46+
* if(count($relatedModels) < $ids) {
47+
* throw new HttpException(422, 'Invalid photos ids');
48+
* }
49+
* }],
4150
* ]
4251
**/
4352
public $allowedRelations = [];
@@ -123,15 +132,19 @@ private function linkRelationships(ActiveRecord $model):void
123132
{
124133
$relationships = $this->getResourceRelationships();
125134
$relationNames = array_keys($relationships);
126-
Yii::warning(\print_r($relationships, true), __METHOD__);
127135
foreach ($relationNames as $relationName) {
136+
$options = $this->allowedRelations[$relationName];
128137
$manager = new RelationshipManager(
129138
$model,
130139
$relationName,
131140
$relationships[$relationName]['data'],
132-
$this->allowedRelations[$relationName]['idType']
141+
$options['idType']
133142
);
134-
$manager->patch($this->allowedRelations[$relationName]['unlinkOnly']);
143+
144+
if (isset($options['validator']) && \is_callable($options['validator'])) {
145+
$manager->setIdValidateCallback($options['validator']);
146+
}
147+
$manager->patch($options['unlinkOnly']);
135148
}
136149
}
137150
}

‎tests/codeception/suites/api/ApiPostCest.php‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -362,6 +362,34 @@ public function testUpdateWithLinkRelationship(ApiTester $I)
362362
['post_id'=>null, 'user_id' => 3, 'message' => 'Third comment333', 'created_at'=>'2020-03-04 01:02:03']
363363
);
364364

365+
$badComment = $I->haveInDatabase(
366+
'public.comments',
367+
['post_id'=>null, 'user_id' => 3, 'message' => 'Very old comment', 'created_at'=>'2018-03-04 01:02:03']
368+
);
369+
370+
$I->sendPATCH('/posts2/12', [
371+
'data' => [
372+
'type'=>'posts',
373+
'attributes'=>[
374+
'name'=>'My changed post with linked comments',
375+
], 'relationships'=>[
376+
'comments' => [
377+
'data' => [
378+
['id'=> $id1, 'type' => 'comments'],
379+
['id'=> $badComment, 'type' => 'comments'],
380+
]
381+
]
382+
]
383+
]
384+
]);
385+
$I->seeResponseCodeIs(422);
386+
$I->seeResponseContainsJson([
387+
'errors'=>['detail' => 'Old comments cannot be linked to this post']
388+
]);
389+
$I->dontSeeInDatabase('public.comments', ['post_id' => 12, 'id' => $id1]);
390+
$I->dontSeeInDatabase('public.comments', ['post_id' => 12, 'id' => $badComment]);
391+
392+
365393
$I->sendPATCH('/posts2/12', [
366394
'data' => [
367395
'type'=>'posts',

‎tests/codeception/suites/unit/RelationsPatcherTest.php‎

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
use app\models\Comment;
33
use app\models\Post;
44
use insolita\fractal\RelationshipManager;
5-
use yii\base\NotSupportedException;
65

76
class RelationsPatcherTest extends \Codeception\Test\Unit
87
{
@@ -21,8 +20,9 @@ public function testPatchMultipleWithAppendData()
2120
verify($comments)->notEmpty();
2221
$newComments = array_merge($comments, $comments2);
2322
$service = new RelationshipManager($model, 'comments', array_map(function($id) {
24-
return ['id'=>$id];
25-
}, $newComments));
23+
return ['id' => $id];
24+
},
25+
$newComments));
2626
$service->patch();
2727
$model->refresh();
2828
$model2->refresh();
@@ -39,8 +39,9 @@ public function testPatchMultipleWithReplaceData()
3939
verify($comments2)->notEmpty();
4040
verify($comments)->notEmpty();
4141
$service = new RelationshipManager($model, 'comments', array_map(function($id) {
42-
return ['id'=>$id];
43-
}, $comments2));
42+
return ['id' => $id];
43+
},
44+
$comments2));
4445
$service->patch();
4546
$model->refresh();
4647
$model2->refresh();
@@ -65,7 +66,6 @@ public function testDeleteUnlinkOnly()
6566
expect($deleted->post_id)->null();
6667
}
6768

68-
6969
public function testDelete()
7070
{
7171
$model = Post::findOne(11);
@@ -79,4 +79,22 @@ public function testDelete()
7979
$deleted = Comment::findOne($comments[0]);
8080
expect($deleted)->null();
8181
}
82+
83+
public function testPatchWithValidateCallback()
84+
{
85+
$this->expectException(\yii\web\HttpException::class);
86+
$model = Post::findOne(11);
87+
$comments = Comment::find()->where(['!=', 'post_id', 11])->select(['id'])->limit(5)->asArray()->all();
88+
verify($comments)->notEmpty();
89+
$service = new RelationshipManager($model, 'comments', $comments);
90+
$service->setIdValidateCallback(function($model, $ids) {
91+
$comments = Comment::find()->where(['id' => $ids])->all();
92+
foreach ($comments as $comment) {
93+
if ($comment->user_id < 3) {
94+
throw new \yii\web\HttpException(422, 'Comment ' . $comment->id . ' cannot be linked to this post');
95+
}
96+
}
97+
});
98+
$service->patch();
99+
}
82100
}

‎tests/testapp/controllers/PostController.php‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@
77

88
namespace app\controllers;
99

10+
use app\models\Comment;
1011
use app\models\Post;
1112
use app\transformers\PostTransformer;
1213
use app\transformers\PostWithRelationsTransformer;
14+
use DateTime;
1315
use insolita\fractal\actions\CountAction;
1416
use insolita\fractal\actions\CreateAction;
1517
use insolita\fractal\actions\CreateRelationshipAction;
@@ -28,7 +30,10 @@
2830
use yii\data\ActiveDataFilter;
2931
use yii\filters\auth\CompositeAuth;
3032
use yii\filters\auth\HttpBearerAuth;
33+
use yii\helpers\StringHelper;
3134
use yii\web\ForbiddenHttpException;
35+
use yii\web\HttpException;
36+
use yii\web\NotFoundHttpException;
3237
use const SORT_ASC;
3338
use const SORT_DESC;
3439

@@ -186,7 +191,15 @@ public function actions()
186191
'checkAccess' => [$this, 'checkAccess'],
187192
'scenario' => $this->updateScenario,
188193
'allowedRelations' => [
189-
'comments' => ['idType' => 'integer', 'unlinkOnly' => true],
194+
'comments' => ['idType' => 'integer', 'unlinkOnly' => true, 'validator' => function($model, $ids) {
195+
$comments = Comment::findAll(['id' => $ids]);
196+
foreach ($comments as $comment) {
197+
$date =DateTime::createFromFormat('Y-m-d H:i:s', $comment->created_at);
198+
if((int) $date->format('Y') < 2020) {
199+
throw new HttpException(422, 'Old comments cannot be linked to this post');
200+
}
201+
}
202+
}],
190203
],
191204
];
192205
$actions['list-with-join'] = [

0 commit comments

Comments
 (0)