AshJsonApi - includes & default_fields

MartinVolerich

Having received great answers to my questions about json_api endpoints, I have just come across a situation where I am requesting “included” resources using the Swagger / OpenAPI UI, which will respond with the public attributes or any “default_fields” set in the related resource’s json_api block.

But… when I also add a “default_fields” line to the parent resource (in the domain’s json_api base_routes, I find that I’m correctly receiving those default_fields, but… it has the unexpected/unwanted side effect of no longer returning the public fields (or default_fields) of the related included resource.

Is this a bug? Or is there something else I can or should configure to get this to work?

Thanks
Martin

6 comments

/ash #ash-json-api

0 258 6

2024-12-04 15:50:12 UTC

First 6 of 6 Posts

zachdaniel

Creator of Ash

This sounds like a bug. Please work up a reproduction or failing test and submit an issue

Post #1

MartinVolerich

Will do. What are the guidelines and best practices for doing that on this project (and I assume that this is scoped to AshJsonApi)?

Also I was stepping through the code yesterday (using pry) to see what is taking place and am happy to continue digging into this further to get a sense of what needs to be changed. Would that be helpful?

Martin

Post #2

zachdaniel

Creator of Ash

Ideally a test in a relevant test file, there is a test somewhere for inclusion of related resources IIRC. Barring that, a separate repo with a minimal reproduction.

As for this issue, it sounds like there is some kind of mishandling of fields somewhere, like we’re passing it down when rendering related resources, or we’re using the source resource when determining default fields instead of the destination resource. My instinct is a problem somewhere in the serializer.

Post #3

MartinVolerich

I found where the problem lies (for this case).

The situation is that I am including a related resource (in this case “Product”) in the GET and relying on the public of default_fields set for that resource.

If I set the default_fields for the main “base” resource (in my case “Survey”) in the base_route, then the included resource isn’t queried for its fields.

However if I set the default_fields for the main “base” resource in the resource module itself (inside the json_api block), then the other related resources is asked for it’s fields.

The problem is due to the logic at line 675 of the AshJsonApi.Serializer where fields is determined to be one of three lists.

fields =
Map.get(request.fields, resource) || Map.get(request.route, :default_fields) ||
default_attributes(resource)

If I manually swap the second and third parts then the default_fields on the route itself isn’t used when there are default fields set for the resource. And of course default_attributes has logic that will look to the explicit default_fields or the public attributes.

So a workaround is to just set the fields to be used as defaults in the resource and not in the route (in this case), but I’d be interested to hear what approach makes most sense.

FWIW, I’ll also post this in the issues list for the project.

Thanks
Martin

Post #4

zachdaniel

Creator of Ash

Ah, right you are. This is a simple fix, which is that we should only be using the default fields from the route for the top level resource, not for included resources.

Post #5