remove full linkage for post requests

Author: tuyakhov

src/ResourceInterface.php

@@ -19,10 +19,10 @@ public function getResourceAttributes(array $fields = []);
 
  /**
  * The "relationships" member of the resource object describing relationships between the resource and other JSON API resources.
- * @param null|array $linked specific resource linkage that a client has requested.
+ * @param array $linked specific resource linkage that a client has requested.
  * @return ResourceIdentifierInterface[] represent references from the resource object in which it’s defined to other resource objects.
  */
- public function getResourceRelationships(array $linked = null);
+ public function getResourceRelationships(array $linked = []);
 
  public function setResourceRelationship($name, $relationship);
 

src/ResourceTrait.php

@@ -51,20 +51,18 @@ public function getResourceAttributes(array $fields = [])
  }
 
  /**
- * @param null|array $linked
+ * @param array $linked
  * @return array
  */
- public function getResourceRelationships(array $linked = null)
+ public function getResourceRelationships(array $linked = [])
  {
  $fields = [];
  if ($this instanceof Arrayable) {
  $fields = $this->extraFields();
  }
  $resolvedFields = $this->resolveFields($fields);
  $keys = array_keys($resolvedFields);
- if ($linked === null) {
- $linked = $keys;
- }
+
  $relationships = array_fill_keys($keys, null);
  $linkedFields = array_intersect($keys, $linked);
 

src/Serializer.php

@@ -102,23 +102,31 @@ public function serialize($data)
  }
 
  /**
+ * @param array $included
  * @param ResourceInterface $model
  * @return array
  */
- protected function serializeModel(ResourceInterface $model, array $included = null)
+ protected function serializeModel(ResourceInterface $model, array $included = [])
  {
  $fields = $this->getRequestedFields();
  $type = $this->pluralize ? Inflector::pluralize($model->getType()) : $model->getType();
  $fields = isset($fields[$type]) ? $fields[$type] : [];
 
+ $topLevel = array_map(function($item) {
+ if (($pos = strrpos($item, '.')) !== false) {
+ return substr($item, 0, $pos);
+ }
+ return $item;
+ }, $included);
+
  $attributes = $model->getResourceAttributes($fields);
  $attributes = array_combine($this->prepareMemberNames(array_keys($attributes)), array_values($attributes));
 
  $data = array_merge($this->serializeIdentifier($model), [
  'attributes' => $attributes,
  ]);
 
- $relationships = $model->getResourceRelationships($included);
+ $relationships = $model->getResourceRelationships($topLevel);
  if (!empty($relationships)) {
  foreach ($relationships as $name => $items) {
  $relationship = [];
@@ -161,19 +169,9 @@ protected function serializeResource(ResourceInterface $resource)
  if ($this->request->getIsHead()) {
  return null;
  } else {
- $included = $topLevel = $this->getIncluded();
-
- if ($included !== null) {
- $topLevel = array_map(function($item) {
- if (($pos = strrpos($item, '.')) !== false) {
- return substr($item, 0, $pos);
- }
- return $item;
- }, $included);
- }
-
+ $included = $this->getIncluded();
  $data = [
- 'data' => $this->serializeModel($resource, $topLevel)
+ 'data' => $this->serializeModel($resource, $included)
  ];
 
  $relatedResources = $this->serializeIncluded($resource, $included);
@@ -210,37 +208,31 @@ protected function serializeIdentifier(ResourceIdentifierInterface $identifier)
 
  /**
  * @param ResourceInterface|array $resources
- * @param null|array $included
+ * @param array $included
+ * @param true $assoc
  * @return array
  */
- protected function serializeIncluded($resources, array $included = null)
+ protected function serializeIncluded($resources, array $included = [], $assoc = false)
  {
  $resources = is_array($resources) ? $resources : [$resources];
  $data = [];
 
- if ($included === null) {
- return [];
- }
-
  $inclusion = [];
- $linked = [];
  foreach ($included as $path) {
  if (($pos = strrpos($path, '.')) === false) {
- $linked[] = $path;
  $inclusion[$path] = [];
  continue;
  }
  $name = substr($path, $pos + 1);
  $key = substr($path, 0, $pos);
  $inclusion[$key][] = $name;
- $linked[] = $key;
  }
 
  foreach ($resources as $resource) {
  if (!$resource instanceof ResourceInterface) {
  continue;
  }
- $relationships = $resource->getResourceRelationships($linked);
+ $relationships = $resource->getResourceRelationships(array_keys($inclusion));
  foreach ($relationships as $name => $relationship) {
  if ($relationship === null) {
  continue;
@@ -249,18 +241,21 @@ protected function serializeIncluded($resources, array $included = null)
  $relationship = [$relationship];
  }
  foreach ($relationship as $model) {
- if ($model instanceof ResourceInterface) {
- $uniqueKey = $model->getType() . '/' . $model->getId();
+ if (!$model instanceof ResourceInterface) {
+ continue;
+ }
+ $uniqueKey = $model->getType() . '/' . $model->getId();
+ if (!isset($data[$uniqueKey])) {
  $data[$uniqueKey] = $this->serializeModel($model, $inclusion[$name]);
-  if (!empty($inclusion[$name])) {
-  $data = array_merge($data, $this->serializeIncluded($model, $inclusion[$name]));
- }
+ }
+ if (!empty($inclusion[$name])) {
+ $data = array_merge($data, $this->serializeIncluded($model, $inclusion[$name], true));
  }
  }
  }
  }
 
- return array_values($data);
+ return $assoc ? $data : array_values($data);
  }
 
  /**
@@ -359,9 +354,6 @@ protected function getRequestedFields()
  protected function getIncluded()
  {
  $include = $this->request->get($this->expandParam);
- if (!$this->request->isGet) {
- return null;
- }
  return is_string($include) ? array_map($this->formatMemberName, preg_split('/\s*,\s*/', $include, -1, PREG_SPLIT_NO_EMPTY)) : [];
  }
 

tests/SerializerTest.php

@@ -81,25 +81,28 @@ public function testSerializeModelData()
  'related' => ['href' => 'http://example.com/resource/123/extra-field1'],
  ]
  ];
- $expected = [
- 'data' => [
- 'id' => '123',
- 'type' => 'resource-models',
- 'attributes' => [
- 'first-name' => 'Bob',
- ],
- 'relationships' => [
- 'extra-field1' => [
- 'links' => $relationship['links']
- ]
- ],
- 'links' => [
- 'self' => ['href' => 'http://example.com/resource/123']
+ $resource = [
+ 'id' => '123',
+ 'type' => 'resource-models',
+ 'attributes' => [
+ 'first-name' => 'Bob',
+ ],
+ 'relationships' => [
+ 'extra-field1' => [
+ 'links' => $relationship['links']
  ]
+ ],
+ 'links' => [
+ 'self' => ['href' => 'http://example.com/resource/123']
  ]
  ];
+ $expected = [
+ 'data' => $resource
+ ];
  $this->assertSame($expected, $serializer->serialize($model));
  $_POST[$serializer->request->methodParam] = 'POST';
+ \Yii::$app->request->setQueryParams(['include' => 'extra-field1']);
+ $expected['included'][] = $resource;
  $expected['data']['relationships']['extra-field1'] = $relationship;
  $this->assertSame($expected, $serializer->serialize($model));
  }
@@ -264,10 +267,12 @@ public function testIncludedDuplicates()
  $model = new ResourceModel();
  ResourceModel::$fields = ['field1', 'field2'];
  ResourceModel::$extraFields = ['extraField1', 'extraField2'];
+ $relationship = new ResourceModel();
+ $relationship->extraField1 = new ResourceModel();
+ $model->extraField2 = $relationship;
  $model->extraField1 = new ResourceModel();
- $model->extraField2 = new ResourceModel();
 
- \Yii::$app->request->setQueryParams(['include' => 'extra-field1,extra-field2']);
+ \Yii::$app->request->setQueryParams(['include' => 'extra-field1,extra-field2.extra-field1']);
  $this->assertSame([
  'data' => $compoundModel,
  'included' => [
@@ -280,7 +285,7 @@ public function testIncludedDuplicates()
  $includedModel
  ],
  'links' => [
- 'self' => ['href' => '/index.php?r=&include=extra-field1%2Cextra-field2&page=1']
+ 'self' => ['href' => '/index.php?r=&include=extra-field1%2Cextra-field2.extra-field1&page=1']
  ],
  'meta' => [
  'total-count' => 1,

tests/actions/CreateActionTest.php

@@ -44,7 +44,7 @@ public function testSuccess()
 
  $this->assertInstanceOf(ResourceModel::className(), $model = $action->run());
  $this->assertFalse($model->hasErrors());
- $relationships = $model->getResourceRelationships();
+ $relationships = $model->getResourceRelationships(['extra_field1']);
  $this->assertArrayHasKey('extra_field1', $relationships);
  $this->assertInstanceOf(ResourceModel::className(), $relationships['extra_field1']);
  $this->assertEquals(124, $relationships['extra_field1']->id);

tests/actions/UpdateActionTest.php

@@ -49,7 +49,7 @@ public function testSuccess()
  $this->assertInstanceOf(ResourceModel::className(), $model = $action->run(1));
  $this->assertFalse($model->hasErrors());
  $this->assertEquals('test', $model->field1);
- $relationships = $model->getResourceRelationships();
+ $relationships = $model->getResourceRelationships(['extra_field1']);
  $this->assertArrayHasKey('extra_field1', $relationships);
  $this->assertInstanceOf(ResourceModel::className(), $relationships['extra_field1']);
  $this->assertEquals(124, $relationships['extra_field1']->id);