defmodule Ash.Actions.Read do @moduledoc false alias Ash.Actions.{Helpers, Load} alias Ash.Engine alias Ash.Engine.Request alias Ash.Error.Invalid.{LimitRequired, PaginationRequired} alias Ash.Error.Query.NoReadAction alias Ash.Filter alias Ash.Query.Aggregate require Logger require Ash.Query def unpaginated_read(query, action \\ nil, opts \\ []) do action = cond do action && is_atom(action) -> Ash.Resource.Info.action(query.resource, action) action -> action true -> Ash.Resource.Info.primary_action!(query.resource, :read) end cond do !action -> {:error, NoReadAction.exception(resource: query.resource, when: "reading")} action.pagination -> opts = Keyword.put(opts, :page, false) run(query, %{action | pagination: false}, opts) true -> run(query, action, opts) end end @spec run(Ash.Query.t(), Ash.Resource.Actions.action(), Keyword.t()) :: {:ok, Ash.Page.page() | list(Ash.Resource.record())} | {:ok, Ash.Page.page() | list(Ash.Resource.record()), Ash.Query.t()} | {:error, term} def run(query, action, opts \\ []) do authorize? = if opts[:authorize?] == false do false else opts[:authorize?] || Keyword.has_key?(opts, :actor) end query = if opts[:tenant] do Ash.Query.set_tenant(query, opts[:tenant]) else query end action = cond do action && is_atom(action) -> Ash.Resource.Info.action(query.resource, action) action -> action true -> Ash.Resource.Info.primary_action!(query.resource, :read) end opts = Keyword.put(opts, :authorize?, authorize?) opts = Keyword.merge(opts, Map.get(query.context, :override_api_params) || []) engine_opts = opts |> Keyword.take([:verbose?, :actor, :authorize?]) |> Keyword.put(:transaction?, action.transaction?) query = %{query | action: action} original_query = query query = if query.__validated_for_action__ == action.name do query else Ash.Query.for_read(query, action.name, %{}, actor: engine_opts[:actor]) end initial_limit = query.limit initial_offset = query.offset with %{valid?: true} <- query, :ok <- validate_multitenancy(query, opts), %{errors: []} = query <- query_with_initial_data(query, opts), {:ok, query, page_opts} <- paginate(query, action, opts), page_opts <- page_opts && Keyword.delete(page_opts, :filter), {:ok, requests} <- requests(query, action, initial_limit, initial_offset, opts), {:ok, %{data: %{data: data} = all_data}} <- Engine.run( requests, query.api, engine_opts ), data_with_loads <- Load.attach_loads(data, all_data), data_with_aggregates <- add_aggregate_values( data_with_loads, query.aggregates, query.resource, Map.get(all_data, :aggregate_values) || %{}, Map.get(all_data, :aggregates_in_query) || [] ), {:ok, with_calculations} <- add_calculation_values( Map.get(all_data, :ultimate_query) || query, data_with_aggregates, Map.get(all_data, :calculations_at_runtime) || [] ) do with_calculations |> add_tenant(query) |> add_page( action, Map.get(all_data, :count), query.sort, original_query, Keyword.put(opts, :page, page_opts) ) |> add_query(Map.get(all_data, :ultimate_query), opts) else %Ash.Query{errors: errors} = query -> {:error, Ash.Error.to_error_class(errors, query: query)} {:error, %Ash.Engine.Runner{errors: errors}} -> {:error, Ash.Error.to_error_class(errors, query: query)} {:error, error} -> {:error, Ash.Error.to_error_class(error, query: query)} end end defp validate_multitenancy(query, opts) do if is_nil(Ash.Resource.Info.multitenancy_strategy(query.resource)) || Ash.Resource.Info.multitenancy_global?(query.resource) || query.tenant || opts[:initial_data] do :ok else {:error, "Queries against the #{inspect(query.resource)} resource require a tenant to be specified"} end end defp add_tenant(data, query) do if Ash.Resource.Info.multitenancy_strategy(query.resource) do Enum.map(data, fn item -> %{item | __metadata__: Map.put(item.__metadata__, :tenant, query.tenant)} end) else data end end defp add_query(result, query, opts) do if opts[:return_query?] do {:ok, result, query} else {:ok, result} end end @doc false def add_page(data, action, count, sort, original_query, opts) do if opts[:page] && action.pagination && !opts[:initial_data] do to_page(data, action, count, sort, original_query, opts) else data end end @doc false def to_page(data, action, count, sort, original_query, opts) do page_opts = opts[:page] {data, rest} = if opts[:page][:limit] do Enum.split(data, opts[:page][:limit]) else {data, []} end more? = not Enum.empty?(rest) if page_opts[:offset] do if action.pagination.keyset? do data |> Ash.Page.Keyset.data_with_keyset(original_query.resource, sort) |> Ash.Page.Offset.new(count, original_query, more?, opts) else Ash.Page.Offset.new(data, count, original_query, more?, opts) end else cond do action.pagination.offset? && action.pagination.keyset? -> data |> Ash.Page.Keyset.data_with_keyset(original_query.resource, sort) |> Ash.Page.Offset.new(count, original_query, more?, opts) action.pagination.offset? -> Ash.Page.Offset.new(data, count, original_query, more?, opts) true -> Ash.Page.Keyset.new(data, count, sort, original_query, more?, opts) end end end defp filter_requests(query, opts) do authorizing? = if opts[:authorize?] == false do false else Keyword.has_key?(opts, :actor) || opts[:authorize?] end if not Keyword.has_key?(opts, :initial_data) && authorizing? do Filter.read_requests(query.api, query.filter) else {:ok, []} end end defp query_with_initial_data(query, opts) do case Keyword.fetch(opts, :initial_data) do :error -> query {:ok, nil} -> Ash.Query.filter(query, false) {:ok, []} -> Ash.Query.filter(query, false) {:ok, [record]} -> pkey_value = record |> Map.take(Ash.Resource.Info.primary_key(query.resource)) |> Map.to_list() Ash.Query.filter(query, ^pkey_value) {:ok, %{} = record} -> pkey_value = record |> Map.take(Ash.Resource.Info.primary_key(query.resource)) |> Map.to_list() Ash.Query.filter(query, ^pkey_value) {:ok, records} when is_list(records) -> pkey = Ash.Resource.Info.primary_key(query.resource) pkey_value = Enum.map(records, fn record -> record |> Map.take(pkey) |> Map.to_list() end) filter = [or: pkey_value] Ash.Query.filter(query, ^filter) end end defp requests(query, action, initial_limit, initial_offset, opts) do request = Request.new( resource: query.resource, api: query.api, query: Request.resolve([], fn _ -> multitenancy_attribute = Ash.Resource.Info.multitenancy_attribute(query.resource) {query, before_notifications} = if multitenancy_attribute && query.tenant do {m, f, a} = Ash.Resource.Info.multitenancy_parse_attribute(query.resource) attribute_value = apply(m, f, [query.tenant | a]) Ash.Query.filter(query, [{multitenancy_attribute, attribute_value}]) else query end |> run_before_action() {query, load_requests} = Load.requests(query) case Filter.run_other_data_layer_filters( query.api, query.resource, query.filter ) do {:ok, filter} -> case Ash.Actions.Sort.process( query.resource, query.sort, query.aggregates, query.context ) do {:ok, sort} -> {:ok, %{query | filter: filter, sort: sort}, %{requests: load_requests, notifications: before_notifications}} {:error, error} -> {:error, error} end {:error, error} -> {:error, error} end end), action: action, authorize?: not Keyword.has_key?(opts, :initial_data), data: data_field( opts, initial_limit, initial_offset, query ), path: [:data], name: "#{action.type} - `#{action.name}`" ) {:ok, [request]} end defp data_field( params, initial_limit, initial_offset, initial_query ) do Request.resolve( [[:data, :query]], fn %{data: %{query: ash_query}} = data -> used_calculations = ash_query.filter |> Ash.Filter.used_calculations( ash_query.resource, [], ash_query.calculations, ash_query.aggregates ) can_be_in_query? = not Keyword.has_key?(params, :initial_data) authorizing? = if params[:authorize?] == false do false else params[:authorize?] || Keyword.has_key?(params, :actor) end filter_requests = filter_requests(ash_query, params) {calculations_in_query, calculations_at_runtime} = if Ash.DataLayer.data_layer_can?(ash_query.resource, :expression_calculation) && !params[:initial_data] do Enum.split_with(ash_query.calculations, fn {_name, calculation} -> Enum.find(used_calculations, &(&1.name == calculation.name)) || calculation.name in Enum.map(ash_query.sort || [], &elem(&1, 0)) || (:erlang.function_exported(calculation.module, :expression, 2) && !calculation.allow_async?) end) else {[], ash_query.calculations} end {aggregate_auth_requests, aggregate_value_requests, aggregates_in_query} = Aggregate.requests( ash_query, can_be_in_query?, authorizing?, Enum.map(calculations_in_query, &elem(&1, 1)) ) cond do match?({:error, _error}, filter_requests) -> filter_requests # if aggregate auth requests is not empty but we have not received the data from # those requests, we should ask the engine to run the aggregate value requests !Enum.empty?(aggregate_auth_requests) && !data[:aggregate] -> {:requests, Enum.map(aggregate_auth_requests, &{&1, :authorization_filter})} !match?({:ok, []}, filter_requests) && !data[:filter] -> {:ok, filter_requests} = filter_requests {:requests, Enum.map(filter_requests, &{&1, :authorization_filter})} true -> if params[:initial_data] do {:ok, params[:initial_data], %{ requests: aggregate_value_requests, extra_data: %{ aggregates_in_query: aggregates_in_query, calculations_at_runtime: calculations_at_runtime } }} else query = initial_query |> Ash.Query.unset([:filter, :aggregates, :sort, :limit, :offset]) |> Ash.Query.data_layer_query(only_validate_filter?: true) ash_query = if ash_query.select || calculations_at_runtime == %{} do ash_query else to_select = ash_query.resource |> Ash.Resource.Info.attributes() |> Enum.map(& &1.name) Ash.Query.select(ash_query, to_select) end ash_query = Enum.reduce(calculations_at_runtime, ash_query, fn {_, calculation}, ash_query -> if calculation.select do Ash.Query.select(ash_query, calculation.select || []) else ash_query end end) {:ok, filter_requests} = filter_requests with %{valid?: true} <- ash_query, {:ok, query} <- query, {:ok, filter} <- filter_with_related(Enum.map(filter_requests, & &1.path), ash_query, data), filter <- update_aggregate_filters(filter, data), {:ok, query} <- Ash.DataLayer.set_context( ash_query.resource, query, Map.put(ash_query.context, :action, ash_query.action) ), {:ok, query} <- Ash.DataLayer.select( query, Helpers.attributes_to_select(ash_query), ash_query.resource ), {:ok, query} <- add_aggregates( query, ash_query, aggregates_in_query, Map.get(data, :aggregate, %{}) ), {:ok, query} <- add_calculations( query, ash_query, Enum.map(calculations_in_query, &elem(&1, 1)) ), {:ok, query} <- Ash.DataLayer.filter( query, filter, ash_query.resource ), {:ok, query} <- Ash.DataLayer.sort(query, ash_query.sort, ash_query.resource), {:ok, query} <- Ash.DataLayer.distinct(query, ash_query.distinct, ash_query.resource), {:ok, count} <- fetch_count( ash_query, query, ash_query.resource, ash_query.action, initial_limit, initial_offset, params ), {:ok, query} <- Ash.DataLayer.limit(query, ash_query.limit, ash_query.resource), {:ok, query} <- Ash.DataLayer.offset(query, ash_query.offset, ash_query.resource), {:ok, query} <- set_tenant(query, ash_query), {:ok, results} <- run_query(ash_query, query), {:ok, results, after_notifications} <- run_after_action(initial_query, results), {:ok, count} <- maybe_await(count) do if params[:return_query?] do ultimate_query = ash_query |> Ash.Query.unset(:filter) |> Ash.Query.filter(filter) {:ok, results, %{ notifications: after_notifications, requests: aggregate_value_requests, extra_data: %{ ultimate_query: ultimate_query, count: count, calculations_at_runtime: calculations_at_runtime, aggregates_in_query: aggregates_in_query } }} else {:ok, results, %{ notifications: after_notifications, requests: aggregate_value_requests, extra_data: %{ count: count, calculations_at_runtime: calculations_at_runtime, aggregates_in_query: aggregates_in_query } }} end else %{valid?: false} = query -> {:error, query} other -> other end end end end ) end defp update_aggregate_filters(filter, data) do Filter.update_aggregates(filter, fn aggregate, ref -> case data[:aggregate][ref.relationship_path ++ aggregate.relationship_path][ :authorization_filter ] do nil -> aggregate authorization_filter -> %{aggregate | authorization_filter: authorization_filter} end end) end defp maybe_await(%Task{} = task) do Task.await(task) end defp maybe_await(other), do: other defp fetch_count(ash_query, query, resource, action, initial_limit, initial_offset, opts) do if action.pagination && opts[:page] && (opts[:page][:count] == true || (opts[:page][:count] != false and action.pagination.countable == :by_default)) do if Ash.DataLayer.in_transaction?(resource) || !Ash.DataLayer.can?(:async_engine, resource) do case do_fetch_count(ash_query, query, initial_limit, initial_offset) do {:ok, count} -> {:ok, {:ok, count}} {:error, error} -> {:error, error} end else {:ok, Task.async(fn -> do_fetch_count(ash_query, query, initial_limit, initial_offset) end)} end else {:ok, {:ok, nil}} end end defp do_fetch_count(ash_query, query, initial_limit, initial_offset) do with {:ok, query} <- Ash.DataLayer.limit(query, initial_limit, ash_query.resource), {:ok, query} <- Ash.DataLayer.offset(query, initial_offset, ash_query.resource), {:ok, %{count: count}} <- run_count_query(ash_query, query) do {:ok, count} end end defp run_before_action(query) do query.before_action |> Enum.reduce({query, []}, fn before_action, {query, notifications} -> case before_action.(query) do {query, new_notifications} -> {query, notifications ++ new_notifications} query -> {query, notifications} end end) end defp run_after_action(query, results) do query.after_action |> Enum.reduce_while({query, {:ok, results, []}}, fn after_action, {query, {:ok, results, notifications}} -> case after_action.(query, results) do {:ok, results} -> {:cont, {query, {:ok, results, notifications}}} {:ok, results, new_notifications} -> {:cont, {query, {:ok, results, notifications ++ new_notifications}}} {:error, error} -> {:halt, {query, {:error, error}}} end end) |> elem(1) end defp set_tenant(query, ash_query) do if Ash.Resource.Info.multitenancy_strategy(ash_query.resource) == :context && ash_query.tenant do Ash.DataLayer.set_tenant(ash_query.resource, query, ash_query.tenant) else {:ok, query} end end def page_opts(action, opts) do cond do !(action.pagination && action.pagination.default_limit) -> opts[:page] Keyword.keyword?(opts[:page]) && !Keyword.has_key?(opts[:page], :limit) -> Keyword.put(opts[:page], :limit, action.pagination.default_limit) is_nil(opts[:page]) -> [limit: action.pagination.default_limit] true -> opts[:page] end end defp paginate(starting_query, action, opts) do page_opts = page_opts(action, opts) cond do action.pagination == false && page_opts -> {:error, "Pagination is not supported"} action.pagination == false -> {:ok, starting_query, opts[:page]} page_opts == false -> if action.pagination.required? do {:error, PaginationRequired.exception([])} else {:ok, starting_query, false} end page_opts[:limit] || is_nil(page_opts) || page_opts == [] -> case do_paginate(starting_query, action.pagination, opts) do {:ok, query} -> {:ok, query, page_opts} {:error, error} -> {:error, error} end action.pagination.required? -> {:error, LimitRequired.exception([])} true -> {:error, LimitRequired.exception([])} end end defp do_paginate(query, pagination, opts) do paginated = cond do opts[:page][:before] || opts[:page][:after] -> keyset_pagination(query, pagination, opts[:page]) opts[:page][:offset] -> limit_offset_pagination(query, pagination, opts[:page]) pagination.offset? && pagination.keyset? -> keyset_pagination(query, pagination, opts[:page]) pagination.offset? -> limit_offset_pagination(query, pagination, opts[:page]) true -> keyset_pagination(query, pagination, opts[:page]) end case paginated do {:ok, paginated} -> if opts[:page][:filter] do {:ok, Ash.Query.filter(paginated, ^opts[:page][:filter])} else {:ok, paginated} end {:error, error} -> {:error, error} end end defp keyset_pagination(query, pagination, opts) do sorted = if Ash.Actions.Sort.sorting_on_identity?(query) do query else Ash.Query.sort(query, Ash.Resource.Info.primary_key(query.resource)) end limited = Ash.Query.limit(sorted, limit(opts[:limit], query.limit, pagination) + 1) if opts[:before] || opts[:after] do after_or_before = if opts[:before] do :before else :after end case Ash.Page.Keyset.filter( query.resource, opts[:before] || opts[:after], sorted.sort, after_or_before ) do {:ok, filter} -> {:ok, Ash.Query.filter(limited, ^filter)} {:error, error} -> {:error, error} end else {:ok, limited} end end defp limit(page_size, query_limit, pagination) do max_page_size = pagination && pagination.max_page_size [page_size, query_limit, max_page_size] |> Enum.filter(&is_integer/1) |> Enum.min() end defp limit_offset_pagination(query, pagination, opts) do limited = Ash.Query.limit(query, limit(opts[:limit], query.limit, pagination) + 1) with_offset = cond do opts[:offset] && query.offset -> Ash.Query.offset(limited, max(opts[:offset], query.offset)) opts[:offset] -> Ash.Query.offset(limited, opts[:offset]) true -> limited end {:ok, with_offset} end defp run_query( %{ resource: destination_resource, context: %{ data_layer: %{ lateral_join_source: {root_data, path} } } } = ash_query, query ) do query |> Ash.DataLayer.run_query_with_lateral_join( root_data, destination_resource, path ) |> Helpers.select(ash_query) end defp run_query(%{resource: resource} = ash_query, query) do query |> Ash.DataLayer.run_query(resource) |> Helpers.select(ash_query) end @doc false def run_count_query( %{ resource: destination_resource, context: %{ data_layer: %{lateral_join_source: {root_data, path}} } }, query ) do case Ash.Query.Aggregate.new(destination_resource, :count, :count, [], nil, nil) do {:ok, aggregate} -> Ash.DataLayer.run_aggregate_query_with_lateral_join( query, [aggregate], root_data, destination_resource, path ) {:error, error} -> {:error, error} end end def run_count_query(ash_query, query) do case Ash.Query.Aggregate.new(ash_query.resource, :count, :count, [], nil, nil) do {:ok, aggregate} -> Ash.DataLayer.run_aggregate_query(query, [aggregate], ash_query.resource) {:error, error} -> {:error, error} end end defp add_calculation_values(query, results, calculations) do {can_be_runtime, require_query} = calculations |> Enum.map(&elem(&1, 1)) |> Enum.split_with(fn calculation -> :erlang.function_exported(calculation.module, :calculate, 3) end) can_be_runtime |> Enum.reduce_while({:ok, %{}, require_query}, fn calculation, {:ok, calculation_results, require_query} -> case calculation.module.calculate(results, calculation.opts, calculation.context) do results when is_list(results) -> {:cont, {:ok, Map.put(calculation_results, calculation, results), require_query}} :unknown -> {:cont, {:ok, calculation_results, [calculation | require_query]}} {:ok, results} -> {:cont, {:ok, Map.put(calculation_results, calculation, results), require_query}} {:error, error} -> {:halt, {:error, error}} end end) |> case do {:ok, calculation_results, require_query} -> Enum.reduce(calculation_results, results, fn {calculation, values}, records -> if calculation.load do :lists.zipwith( fn record, value -> Map.put(record, calculation.name, value) end, records, values ) else :lists.zipwith( fn record, value -> %{record | calculations: Map.put(record.calculations, calculation.name, value)} end, records, values ) end end) |> run_calculation_query(require_query, query) {:error, error} -> {:error, error} end end defp run_calculation_query(results, [], _), do: {:ok, results} defp run_calculation_query(results, calculations, query) do pkey = Ash.Resource.Info.primary_key(query.resource) pkey_filter = results |> List.wrap() |> Enum.map(fn result -> result |> Map.take(pkey) |> Map.to_list() end) with query <- Ash.Query.unset(query, [:filter, :aggregates, :sort, :limit, :offset, :load]), query <- Ash.Query.filter(query, ^[or: pkey_filter]), {:ok, data_layer_query} <- Ash.Query.data_layer_query(query), {:ok, data_layer_query} <- add_calculations(data_layer_query, query, calculations), {:ok, calculation_results} <- Ash.DataLayer.run_query( data_layer_query, query.resource ) do results_with_calculations = results |> Enum.map(fn result -> result_pkey = Map.take(result, pkey) match = Enum.find(calculation_results, &(Map.take(&1, pkey) == result_pkey)) if match do Enum.reduce(calculations, result, fn calculation, result -> if calculation.load do Map.put(result, calculation.load, Map.get(match, calculation.load)) else Map.update!(result, :calculations, fn calculations -> Map.put( calculations, calculation.name, Map.get(match, :calculations)[calculation.name] ) end) end end) else result end end) {:ok, results_with_calculations} end end defp add_aggregate_values(results, aggregates, resource, aggregate_values, aggregates_in_query) do keys_to_aggregates = Enum.reduce(aggregate_values, %{}, fn {_name, keys_to_values}, acc -> Enum.reduce(keys_to_values, acc, fn {pkey, values}, acc -> Map.update(acc, pkey, values, &Map.merge(&1, values)) end) end) pkey = Ash.Resource.Info.primary_key(resource) loaded = aggregates |> Enum.map(fn {_, aggregate} -> aggregate.load end) |> Enum.reject(&is_nil/1) Enum.map(results, fn result -> aggregate_values = Map.get(keys_to_aggregates, Map.take(result, pkey), %{}) aggregate_values = aggregates |> Enum.reject(fn {name, _aggregate} -> Enum.find(aggregates_in_query, &(&1.name == name)) end) |> Enum.reduce(aggregate_values, fn {_, aggregate}, aggregate_values -> Map.put_new(aggregate_values, aggregate.name, aggregate.default_value) end) {top_level, nested} = Map.split(aggregate_values || %{}, loaded) Map.merge(%{result | aggregates: Map.merge(result.aggregates, nested)}, top_level) end) end defp add_calculations(data_layer_query, query, calculations_to_add) do calculations = Enum.reduce_while(calculations_to_add, {:ok, []}, fn calculation, {:ok, calculations} -> if Ash.DataLayer.data_layer_can?(query.resource, :expression_calculation) do expression = calculation.module.expression(calculation.opts, calculation.context) case Ash.Filter.hydrate_refs(expression, %{ resource: query.resource, aggregates: query.aggregates, calculations: query.calculations, public?: false }) do {:ok, expression} -> {:cont, {:ok, [{calculation, expression} | calculations]}} {:error, error} -> {:halt, {:error, error}} end else {:halt, {:error, "Expression calculations are not supported"}} end end) case calculations do {:ok, calculations} -> Ash.DataLayer.add_calculations( data_layer_query, calculations, query.resource ) {:error, error} -> {:error, error} end end defp add_aggregates(data_layer_query, query, aggregates_to_add, aggregate_filters) do aggregates_to_add = Enum.into(aggregates_to_add, %{}, fn aggregate -> {aggregate.name, aggregate} end) aggregates = aggregates_to_add |> Enum.reduce({aggregates_to_add, aggregate_filters}, fn {name, aggregate}, {aggregates, aggregate_filters} -> case Map.fetch(aggregate_filters, aggregate.relationship_path) do {:ok, %{authorization_filter: filter}} -> {Map.put(aggregates, name, %{aggregate | authorization_filter: filter}), Map.delete(aggregates, aggregate.relationship_path)} :error -> {aggregates, aggregate_filters} end end) |> elem(0) Ash.DataLayer.add_aggregates(data_layer_query, Map.values(aggregates), query.resource) end defp filter_with_related(relationship_filter_paths, ash_query, data) do Enum.reduce_while(relationship_filter_paths, {:ok, ash_query.filter}, fn path, {:ok, filter} -> case get_in(data, path ++ [:authorization_filter]) do nil -> {:cont, {:ok, filter}} authorization_filter -> add_authorization_filter(filter, authorization_filter) end end) end defp add_authorization_filter(filter, authorization_filter) do case Ash.Filter.add_to_filter(filter, authorization_filter) do {:ok, new_filter} -> {:cont, {:ok, new_filter}} {:error, error} -> {:halt, {:error, error}} end end end