Packages
ash_json_api
1.6.6
1.7.1
1.7.0
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0-rc.2
1.6.0-rc.1
1.6.0-rc.0
1.5.1
1.5.0
1.4.45
1.4.44
1.4.43
1.4.42
1.4.41
1.4.40
1.4.39
1.4.38
1.4.37
1.4.36
1.4.35
1.4.34
1.4.33
1.4.32
1.4.31
1.4.30
1.4.29
1.4.28
1.4.27
1.4.26
1.4.25
1.4.24
1.4.23
1.4.22
1.4.21
1.4.20
1.4.19
1.4.18
1.4.17
1.4.16
1.4.15
1.4.13
1.4.12
1.4.11
1.4.10
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.8
1.3.7
1.3.6
1.3.5
1.3.4
retired
1.3.3
1.3.2
1.3.1
1.3.0
1.2.2
1.2.1
1.2.0
1.1.2
1.1.1
1.1.0
1.0.0
1.0.0-rc.6
1.0.0-rc.5
1.0.0-rc.4
1.0.0-rc.3
1.0.0-rc.2
1.0.0-rc.1
1.0.0-rc.0
0.34.2
0.34.1
0.34.0
0.33.1
0.33.0
0.32.1
0.32.0
0.31.3
0.31.2
retired
0.31.1
0.31.0
0.30.1
0.30.0-rc.4
0.30.0-rc.3
0.30.0-rc.2
0.30.0-rc.1
0.30.0-rc.0
0.29.1
0.29.0
0.28.6
0.28.5
0.28.4
0.28.3
0.28.2
0.28.1
0.28.0
0.27.6
0.27.5
0.27.1
0.27.0
0.25.0
0.24.4
0.24.2
0.24.1
0.24.0
0.23.0
0.22.0
0.21.0
0.20.0
0.19.0
0.18.0
0.17.0
0.16.0
0.15.0
0.14.0
0.13.0
0.12.0
0.11.1
0.10.0
0.9.0
0.8.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.4
0.2.3
0.2.1
0.2.0
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
The JSON:API extension for the Ash Framework.
Current section
Files
Jump to
Current section
Files
lib/ash_json_api/includes/includer.ex
# SPDX-FileCopyrightText: 2019 ash_json_api contributors <https://github.com/ash-project/ash_json_api/graphs/contributors>
#
# SPDX-License-Identifier: MIT
defmodule AshJsonApi.Includes.Includer do
@moduledoc false
alias AshJsonApi.Request
@spec get_includes(record_or_records :: struct | list(struct) | nil, Request.t()) ::
{struct | list(struct), list(struct)}
def get_includes(nil, _) do
{nil, []}
end
def get_includes(record_or_records, %Request{includes: includes}) when includes == %{},
do: {record_or_records, []}
def get_includes(records, %Request{includes_keyword: includes_keyword})
when is_list(records) do
{records, includes_map} = get_includes_map(records, includes_keyword)
{records, Map.values(includes_map)}
end
def get_includes(%{results: results} = paginator, request) do
{records, includes} = get_includes(results, request)
{%{paginator | results: records}, includes}
end
def get_includes(record, request) do
{[record], includes} = get_includes([record], request)
{record, includes}
end
defp get_includes_map(preloaded, includes_keyword, includes_map \\ %{})
defp get_includes_map(related, [], includes_map), do: {related, includes_map}
defp get_includes_map(preloaded, %Ash.Query{load: load}, includes_map),
do: get_includes_map(preloaded, load, includes_map)
defp get_includes_map(preloaded, includes_keyword, includes_map) do
includes_keyword
|> Enum.reduce({preloaded, includes_map}, fn
{relationship, further}, {preloaded_without_linkage, includes_map} ->
linkage_only? =
case further do
%{__linkage_only__: true} -> true
_ -> false
end
{related, includes_map} =
preloaded
|> Enum.flat_map(fn record ->
record
|> Map.get(relationship, [])
|> extract_records_from_relationship()
end)
|> get_includes_map(further, includes_map)
preloaded_with_linkage =
Enum.map(
preloaded_without_linkage,
fn record ->
relationship_value = Map.get(record, relationship, [])
related = extract_records_from_relationship(relationship_value)
# Store both the extracted records and the original value (which might be a Page)
record
|> add_linkage(relationship, related)
|> add_page_info(relationship, relationship_value)
end
)
includes_map =
if linkage_only? do
includes_map
else
related
|> List.wrap()
|> Enum.reduce(includes_map, fn related_item, includes_map ->
type = AshJsonApi.Resource.Info.type(related_item)
id = AshJsonApi.Resource.encode_primary_key(related_item)
case Map.fetch(includes_map, {type, id}) do
{:ok, _} ->
Map.update!(includes_map, {type, id}, fn existing ->
merge_linkages(existing, related_item)
end)
:error ->
Map.put(includes_map, {type, id}, Map.put_new(related_item, :__linkage__, %{}))
end
end)
end
{preloaded_with_linkage, includes_map}
end)
end
# Extract records from relationship value, handling both plain lists and Page structs
defp extract_records_from_relationship(%{__struct__: struct, results: results})
when struct in [Ash.Page.Offset, Ash.Page.Keyset] do
List.wrap(results)
end
defp extract_records_from_relationship(value) do
List.wrap(value)
end
defp add_linkage(record, relationship, related) do
record
|> Map.put_new(:__linkage__, %{})
|> Map.update!(:__linkage__, fn linkage ->
Map.put(linkage, relationship, related)
end)
end
# Store pagination info for relationships that were paginated
defp add_page_info(record, relationship, %{__struct__: struct} = page)
when struct in [Ash.Page.Offset, Ash.Page.Keyset] do
record
|> Map.put_new(:__pagination__, %{})
|> Map.update!(:__pagination__, fn pagination_info ->
Map.put(pagination_info, relationship, page)
end)
end
defp add_page_info(record, _relationship, _value), do: record
defp merge_linkages(record, to_merge) do
linkage_to_merge = Map.get(to_merge, :__linkage__, %{})
record
|> Map.update!(:__linkage__, fn linkage ->
Map.merge(linkage, linkage_to_merge, fn _key, a, b ->
a ++ b
end)
end)
end
end