Move extracing of meta logic into build_json_resource_obj

Author: sliverc

CHANGELOG.md

@@ -14,12 +14,12 @@ any parts of the framework not mentioned in the documentation should generally b
 
 * Ability for the user to select `included_serializers` to apply when using `BrowsableAPI`, based on available `included_serializers` defined for the current endpoint.
 * Ability for the user to format serializer properties in URL segments using the `JSON_API_FORMAT_RELATED_LINKS` setting.
-* Ability to render meta_fields of included resources
 
 ### Fixed
 
 * Allow users to overwrite a view's `get_serializer_class()` method when using [related urls](https://django-rest-framework-json-api.readthedocs.io/en/stable/usage.html#related-urls)
 * Correctly resolve the resource type of `ResourceRelatedField(many=True)` fields on plain serializers
+* Render `meta_fields` in included resources
 
 
 ## [4.0.0] - 2020-10-31

example/tests/integration/test_includes.py

@@ -263,17 +263,15 @@ def test_data_resource_not_included_again(single_comment, client):
     assert comment_count == expected_comment_count, "Comment count incorrect"
 
 
-def test_meta_object_added_to_included_resource_on_list(single_entry, client):
-    # Add metadata to included object
+def test_meta_object_added_to_included_resources(single_entry, client):
     response = client.get(
         reverse("entry-detail", kwargs={"pk": single_entry.pk}) + "?include=comments"
     )
-    meta = response.json()["included"][0].get("meta", False)
-    assert meta, "list has no meta object"
+    assert response.json()["included"][0].get("meta")
 
     response = client.get(
         reverse("entry-detail", kwargs={"pk": single_entry.pk})
         + "?include=comments.author"
     )
-    meta = response.json()["included"][0].get("meta", False)
-    assert meta, "detail has no meta object"
+    assert response.json()["included"][0].get("meta")
+    assert response.json()["included"][1].get("meta")

example/tests/unit/test_renderer_class_methods.py

@@ -3,6 +3,7 @@
 
 from rest_framework_json_api import serializers
 from rest_framework_json_api.renderers import JSONRenderer
+from rest_framework_json_api.utils import get_serializer_fields
 
 pytestmark = pytest.mark.django_db
 
@@ -20,10 +21,7 @@ class Meta:
 
 
 def test_build_json_resource_obj():
-    resource = {
-        "pk": 1,
-        "username": "Alice",
-    }
+    resource = {"username": "Alice", "version": "1.0.0"}
 
     serializer = ResourceSerializer(data={"username": "Alice"})
     serializer.is_valid()
@@ -33,11 +31,16 @@ def test_build_json_resource_obj():
         "type": "user",
         "id": "1",
         "attributes": {"username": "Alice"},
+        "meta": {"version": "1.0.0"},
     }
 
     assert (
         JSONRenderer.build_json_resource_obj(
-            serializer.fields, resource, resource_instance, "user"
+            get_serializer_fields(serializer),
+            resource,
+            resource_instance,
+            "user",
+            serializer,
         )
         == output
     )
@@ -47,11 +50,8 @@ def test_can_override_methods():
     """
     Make sure extract_attributes and extract_relationships can be overriden.
     """
-    resource = {
-        "pk": 1,
-        "username": "Alice",
-    }
 
+    resource = {"username": "Alice", "version": "1.0.0"}
     serializer = ResourceSerializer(data={"username": "Alice"})
     serializer.is_valid()
     resource_instance = serializer.save()
@@ -60,6 +60,7 @@ def test_can_override_methods():
         "type": "user",
         "id": "1",
         "attributes": {"username": "Alice"},
+        "meta": {"version": "1.0.0"},
     }
 
     class CustomRenderer(JSONRenderer):
@@ -80,7 +81,11 @@ def extract_relationships(cls, fields, resource, resource_instance):
 
     assert (
         CustomRenderer.build_json_resource_obj(
-            serializer.fields, resource, resource_instance, "user"
+            get_serializer_fields(serializer),
+            resource,
+            resource_instance,
+            "user",
+            serializer,
         )
         == output
     )

rest_framework_json_api/renderers.py

@@ -373,14 +373,11 @@ def extract_included(
                             serializer_resource,
                             nested_resource_instance,
                             resource_type,
+                            serializer,
                             getattr(serializer, "_poly_force_type_resolution", False),
                         )
-                        included_cache[new_item["type"]][
-                            new_item["id"]
-                        ] = utils.format_field_names(new_item)
-                        cls.add_meta_to_included(
-                            included_cache, field, serializer_resource, new_item
-                        )
+                        included_cache[new_item["type"]][new_item["id"]] = new_item
+
                         cls.extract_included(
                             serializer_fields,
                             serializer_resource,
@@ -400,14 +397,11 @@ def extract_included(
                         serializer_data,
                         relation_instance,
                         relation_type,
+                        field,
                         getattr(field, "_poly_force_type_resolution", False),
                     )
-                    included_cache[new_item["type"]][
-                        new_item["id"]
-                    ] = utils.format_field_names(new_item)
-                    cls.add_meta_to_included(
-                        included_cache, field, serializer_data, new_item
-                    )
+                    included_cache[new_item["type"]][new_item["id"]] = new_item
+
                     cls.extract_included(
                         serializer_fields,
                         serializer_data,
@@ -416,14 +410,6 @@ def extract_included(
                         included_cache,
                     )
 
-    @classmethod
-    def add_meta_to_included(cls, included_cache, field, resource, new_item):
-        meta = cls.extract_meta(field, resource)
-        if meta:
-            included_cache[new_item["type"]][new_item["id"]][
-                "meta"
-            ] = utils.format_field_names(meta)
-
     @classmethod
     def extract_meta(cls, serializer, resource):
         """
@@ -464,6 +450,7 @@ def build_json_resource_obj(
         resource,
         resource_instance,
         resource_name,
+        serializer,
         force_type_resolution=False,
     ):
         """
@@ -490,6 +477,11 @@ def build_json_resource_obj(
             resource_data.append(
                 ("links", {"self": resource[api_settings.URL_FIELD_NAME]})
             )
+
+        meta = cls.extract_meta(serializer, resource)
+        if meta:
+            resource_data.append(("meta", utils.format_field_names(meta)))
+
         return OrderedDict(resource_data)
 
     def render_relationship_view(
@@ -596,13 +588,9 @@ def render(self, data, accepted_media_type=None, renderer_context=None):
                         resource,
                         resource_instance,
                         resource_name,
+                        serializer,
                         force_type_resolution,
                     )
-                    meta = self.extract_meta(serializer, resource)
-                    if meta:
-                        json_resource_obj.update(
-                            {"meta": utils.format_field_names(meta)}
-                        )
                     json_api_data.append(json_resource_obj)
 
                     self.extract_included(
@@ -624,13 +612,10 @@ def render(self, data, accepted_media_type=None, renderer_context=None):
                     serializer_data,
                     resource_instance,
                     resource_name,
+                    serializer,
                     force_type_resolution,
                 )
 
-                meta = self.extract_meta(serializer, serializer_data)
-                if meta:
-                    json_api_data.update({"meta": utils.format_field_names(meta)})
-
                 self.extract_included(
                     fields,
                     serializer_data,