Remove resource itself from included_cache (#524)

Author: Beni Keller

CHANGELOG.md

@@ -29,6 +29,7 @@ any parts of the framework not mentioned in the documentation should generally b
 * Do not skip empty one-to-one relationships
 * Allow `HyperlinkRelatedField` to be used with [related urls](https://django-rest-framework-json-api.readthedocs.io/en/stable/usage.html?highlight=related%20links#related-urls)
 * Fixed hardcoded year 2018 in tests ([#539](https://github.com/django-json-api/django-rest-framework-json-api/issues/539))
+* Exclude the requested resource(s) from the included field ([#524](https://github.com/django-json-api/django-rest-framework-json-api/issues/524)) 
 
 ## [2.6.0] - 2018-09-20
 

example/tests/conftest.py

@@ -48,6 +48,13 @@ def multiple_entries(blog_factory, author_factory, entry_factory, comment_factor
     return entries
 
 
+@pytest.fixture
+def single_comment(blog, author, entry_factory, comment_factory):
+    entry = entry_factory(blog=blog, authors=(author,))
+    comment_factory(entry=entry)
+    return comment_factory(entry=entry)
+
+
 @pytest.fixture
 def single_company(art_project_factory, research_project_factory, company_factory):
     company = company_factory(future_projects=(research_project_factory(), art_project_factory()))

example/tests/integration/test_includes.py

@@ -141,3 +141,22 @@ def test_deep_included_data_on_detail(single_entry, client):
     author_bio_count = len([resource for resource in included if resource["type"] == "authorBios"])
     expected_author_bio_count = single_entry.comments.filter(author__bio__isnull=False).count()
     assert author_bio_count == expected_author_bio_count, 'Detail author bio count is incorrect'
+
+
+def test_data_resource_not_included_again(single_comment, client):
+    # This test makes sure that the resource which is in the data field is excluded
+    # from the included field.
+    response = client.get(reverse("comment-detail", kwargs={'pk': single_comment.pk}) +
+                          '?include=entry.comments')
+
+    included = response.json().get('included')
+
+    included_comments = [resource for resource in included if resource["type"] == "comments"]
+    assert single_comment.pk not in [int(x.get('id')) for x in included_comments], \
+        "Resource of the data field duplicated in included"
+
+    comment_count = len(included_comments)
+    expected_comment_count = single_comment.entry.comments.count()
+    # The comment in the data attribute must not be included again.
+    expected_comment_count -= 1
+    assert comment_count == expected_comment_count, "Comment count incorrect"

rest_framework_json_api/renderers.py

@@ -643,6 +643,21 @@ def render(self, data, accepted_media_type=None, renderer_context=None):
         else:
             render_data['data'] = json_api_data
 
+        if included_cache:
+            if isinstance(json_api_data, list):
+                objects = json_api_data
+            else:
+                objects = [json_api_data]
+
+            for object in objects:
+                obj_type = object.get('type')
+                obj_id = object.get('id')
+                if obj_type in included_cache and \
+                   obj_id in included_cache[obj_type]:
+                    del included_cache[obj_type][obj_id]
+                if not included_cache[obj_type]:
+                    del included_cache[obj_type]
+
         if included_cache:
             render_data['included'] = list()
             for included_type in sorted(included_cache.keys()):