fix: serialization of non-model dict objects (fixes django-json-api#155 django-json-api#722 django-json-api#1126)

Author: axieum

rest_framework_json_api/renderers.py

@@ -459,10 +459,7 @@ def build_json_resource_obj(
             resource_name = utils.get_resource_type_from_instance(resource_instance)
         resource_data = [
             ("type", resource_name),
-            (
-                "id",
-                encoding.force_str(resource_instance.pk) if resource_instance else None,
-            ),
+            ("id", utils.get_resource_id_from_instance(resource_instance)),
             ("attributes", cls.extract_attributes(fields, resource)),
         ]
         relationships = cls.extract_relationships(fields, resource, resource_instance)

rest_framework_json_api/utils.py

@@ -308,6 +308,19 @@ def get_resource_type_from_serializer(serializer):
     )
 
 
+def get_resource_id_from_instance(instance):
+    """Returns the resource identifier for a given instance (`id` takes priority over `pk`)."""
+    if not instance:
+        return None
+    elif hasattr(instance, "id"):
+        return encoding.force_str(instance.id)
+    elif hasattr(instance, "pk"):
+        return encoding.force_str(instance.pk)
+    elif isinstance(instance, dict):
+        return instance.get("id", instance.get("pk", None))
+    return None
+
+
 def get_included_resources(request, serializer=None):
     """Build a list of included resources."""
     include_resources_param = request.query_params.get("include") if request else None

tests/test_views.py

@@ -183,6 +183,28 @@ def test_patch(self, client):
             }
         }
 
+    @pytest.mark.urls(__name__)
+    def test_post_with_missing_id(self, client):
+        data = {
+            "data": {
+                "id": None,
+                "type": "custom",
+                "attributes": {"body": "hello"},
+            }
+        }
+
+        url = reverse("custom")
+
+        response = client.post(url, data=data)
+        assert response.status_code == status.HTTP_200_OK
+        assert response.json() == {
+            "data": {
+                "type": "custom",
+                "id": None,
+                "attributes": {"body": "hello"},
+            }
+        }
+
 
 # Routing setup
 
@@ -211,6 +233,10 @@ def patch(self, request, *args, **kwargs):
         serializer = CustomModelSerializer(CustomModel(request.data))
         return Response(status=status.HTTP_200_OK, data=serializer.data)
 
+    def post(self, request, *args, **kwargs):
+        serializer = CustomModelSerializer(request.data)
+        return Response(status=status.HTTP_200_OK, data=serializer.data)
+
 
 router = SimpleRouter()
 router.register(r"basic_models", BasicModelViewSet, basename="basic-model")