mirror of
https://github.com/ash-project/ash.git
synced 2024-09-20 13:33:20 +12:00
5967ed3a48
* improvement!: use `%Ash.NotSelected{}` for unselected values * improvement!: default `require_atomic?` to `true` * improvement!: raise errors on unknown generic action arguments * improvement!: default bulk strategy to `:atomic` * improvement!: warnings on `require_atomic?` `true` actions improvement!: revise `Ash.NotSelected` to `Ash.NotLoaded` improvement!: errors on unknown action inputs across the board * doc: clarify wording in notifiers.md closes #889 * improvement!: default `api.authorization.authorize` to `:by_default` * improvement!: require the api when constructing changesets this commit also fixes some work from prior commits around the default value for the `authorize` option * improvement!: code_interface.define_for -> code_interface.api `code_interface.define_for` is now `code_interface.api`. Additionally, it is set automatically if the `api` option is specified on `use Ash.Resource`. * improvement!: remove registries * improvement!: pubsub notifier default to `previous_values?: false` improvement!: requires_original_data? callback defaults to false * improvement!: rename Ash.Calculation -> Ash.Resource.Calculation improvement!: improve `Ash.Query.Calculation.new` signature improvement!: anonymous function calculations now take lists and return lists improvement!: make callback contexts into structs improvement!: pass context to builtin lifecycle hook changes improvement!: calculation arguments are now in the `arguments` key of the context * chore: fix build * improvement!: remove `aggregates` and `calculations` from `Filter.parse` and `Filter.parse_input` * improvement: update spark to 2.0 * improvement!: make picosat_elixir optional with `simple_sat` * improvement!: rename api to domain * docs: add more info to upgrading guide * docs: tweak docs formatting * improvement!: remove `Ash.Changeset.new!` * docs: update docs for `Ash.Changeset.new/1` * improvement!: deprecate `private?: false` in favor of `public?: true` * doc: add upgrade guide for private -> public * improvement: update reactor to 3.0 * improvement!: default `default_accept` is now `[]` * improvement!: `Ash.CiString.new/1` returns `nil` on `nil` input * improvement!(Ash.Reactor): Improve integration with Ash 3.0 changes. * improvement!: clean up and reorganize `Ash` functions this is in preparation of deprecating the functions that are defined on the api improvement!: remove context-based functionality * chore: update docs references from `Ash.Domain` to `Ash` * chore: fix bad merge * chore: fix context access in atomic changes * improvement!: Deprecate calling functions on (domain) api in favor of `Ash` * improvement!: add `attribute_public?` and update `attribute_writable?` behavior * improvement!: update atomic behaviors, default to invalid * chore: update downcase docs * improvement!: changeset.filters -> changeset.filter * improvement!: remove deprecated functions * improvement!: remove and simplify `Ash.Filter.TemplateHelpers` * improvement: import Ash.Expr in modules where it is used improvement: require Ash.QUery in modules where it makes sense * fix!: keyword lists are no longer special cased in ash expressions * improvement: add structs for more context implementations * chore: small tweaks, finish `:all` -> `:*` conversion * chore: update DSL docs for multitenancy.global? * improvement: ensure selects are applied on destroys chore: remove TODOs * chore: some docs changes * improvement!: introduce strict mode to calculations * chore: update tests * improvement: support custom expressions * docs: document custom expressions * chore: fix and test custom expressions and function fragments docs: update relevant docs w/ the changes * improvement!: reverse order of before action & before transaction hooks * improvement!: default read actions are now paginatable * improvement!: require explicit accept lists in default actions * chore: update docs * improvement!: remove Ash.Flow and Ash.Engine * chore: unlock unused deps * chore: don't use unused variable * chore: include ash flow change in upgrade guide * improvement!: standardize various exception keys and names * improvement!: use `Splode` for errors * improvement: update upgrade guide to include Splode * feat: code interface on the domain * improvement: only require primary key if resource has actions or fields improvement: only build schema if resource has actions or fields improvement: verify primary key in its own verifier * improvement: add `resource/1` builtin check * improvement!: move simple_notifiers to an option instead of a DSL builder improvement!: update spark for better autocomplete, configure autocomplete for key functions docs: replace `an domain` with `a domain` * improvement: better code interface documentation * fix: set tenant on query so that root calles to Api.aggreagte work as expected (#929) * chore: fixes from previous improvements * chore: update splode * chore: update splode * improvement!: swap position of sort order and arguments in calculation sorting * improvement!: add `include_nil?` aggregate option, and default it to `false` * improvement: support notifiers within actions * improvement: support specifying multiple filters * improvement: add `sortable?` flags to all fields improvement: support multiple filters on relationships * improvement: support sensitive? on calculations and arguments * improvement: validate resources in inputs to code interface * chore: don't require explicit accept lists when using `default_accept :*` * chore: update spark * chore: update public attribute handling per 3.0 * improvement: update reactor and tests * chore: better error message * chore: fix rebase issue * chore: handle merge issues improvement: don't require domain on relationships if destination has domain * improvement!: errors on unknown inputs for calculations * improvement: always choose to cast atomic * improvement: support casting some embeds atomically * improvement: various 3.0 updates, documented in upgrade.md * chore: Add failing tests for loads with with explicit domains. (#948) Co-authored-by: James Harton <james@harton.nz> * improvement: ensure non-static dynamic domains works * improvement: add Ash.ToTenant protocol * chore: add docs for no ToTenant option * fix: properly construct new query in `build/3` * chore: update simple_sat dependency * chore: don't reselect when missing primary keys * chore: remove IO.inspect * chore: update spark * chore: update spark * improvement: use `Keyword.put_new` in `Ash.Context.to_opts` (#953) * improvement: support bulk and atomic operations in code interfaces --------- Co-authored-by: James Harton <james@harton.nz> Co-authored-by: WIGGLES <55168935+WIGGLES-dev@users.noreply.github.com> Co-authored-by: Dmitry Maganov <vonagam@gmail.com>
209 lines
6 KiB
Elixir
209 lines
6 KiB
Elixir
defmodule Ash.Test.CodeInterfaceTest do
|
|
@moduledoc false
|
|
use ExUnit.Case, async: true
|
|
|
|
alias Ash.Test.Domain, as: Domain
|
|
|
|
defmodule User do
|
|
@moduledoc false
|
|
use Ash.Resource, domain: Domain, data_layer: Ash.DataLayer.Ets
|
|
|
|
ets do
|
|
private?(true)
|
|
end
|
|
|
|
code_interface do
|
|
define :get_user, action: :read, get?: true
|
|
define :get_user_safely, action: :read, get?: true, not_found_error?: false
|
|
define :read_users, action: :read
|
|
define :get_by_id, action: :read, get_by: [:id]
|
|
define :create, args: [{:optional, :first_name}]
|
|
define :hello, args: [:name]
|
|
|
|
define :update, action: :update
|
|
|
|
define_calculation(:full_name, args: [:first_name, :last_name])
|
|
|
|
define_calculation(:full_name_opt,
|
|
calculation: :full_name,
|
|
args: [:first_name, :last_name, {:optional, :separator}]
|
|
)
|
|
|
|
define_calculation(:full_name_record, calculation: :full_name, args: [:_record])
|
|
end
|
|
|
|
actions do
|
|
default_accept :*
|
|
|
|
read :read do
|
|
primary? true
|
|
end
|
|
|
|
create :create
|
|
|
|
update :update
|
|
|
|
read :by_id do
|
|
argument :id, :uuid, allow_nil?: false
|
|
|
|
filter expr(id == ^arg(:id))
|
|
end
|
|
|
|
action :hello, :string do
|
|
argument :name, :string, allow_nil?: false
|
|
|
|
run(fn input, _ ->
|
|
{:ok, "Hello #{input.arguments.name}"}
|
|
end)
|
|
end
|
|
end
|
|
|
|
calculations do
|
|
calculate :full_name, :string, expr(first_name <> ^arg(:separator) <> last_name) do
|
|
public?(true)
|
|
argument :separator, :string, default: " ", allow_nil?: false
|
|
end
|
|
end
|
|
|
|
attributes do
|
|
uuid_primary_key :id
|
|
|
|
attribute :first_name, :string do
|
|
public?(true)
|
|
default "fred"
|
|
end
|
|
|
|
attribute :last_name, :string do
|
|
public?(true)
|
|
end
|
|
end
|
|
end
|
|
|
|
defmodule Domain do
|
|
use Ash.Domain
|
|
|
|
resources do
|
|
resource User do
|
|
define :get_user, action: :read, get?: true
|
|
|
|
define_calculation(:full_name, args: [:first_name, :last_name])
|
|
end
|
|
end
|
|
end
|
|
|
|
describe "generic actions" do
|
|
test "can be invoked" do
|
|
assert "Hello fred" == User.hello!("fred")
|
|
assert {:ok, "Hello george"} == User.hello("george")
|
|
end
|
|
|
|
test "have a helper method to produce inputs" do
|
|
assert %Ash.ActionInput{action: %{name: :hello}, params: %{name: "bob"}} =
|
|
User.input_to_hello("bob")
|
|
end
|
|
|
|
test "have a helper to test authorization" do
|
|
assert {:ok, true} == User.can_hello(nil, "fred")
|
|
assert User.can_hello?(nil, "fred")
|
|
end
|
|
end
|
|
|
|
describe "read actions" do
|
|
test "have a helper methods to produce queries" do
|
|
assert %Ash.Query{action: %{name: :read}} = User.query_to_read_users()
|
|
assert %Ash.Query{action: %{name: :read}} = User.query_to_get_by_id("some uuid")
|
|
end
|
|
|
|
test "have a helper to test authorization" do
|
|
assert {:ok, true} == User.can_read_users(nil)
|
|
assert {:ok, true} == User.can_get_by_id(nil, "some uuid")
|
|
assert User.can_read_users?(nil)
|
|
assert User.can_get_by_id?(nil, "some uuid")
|
|
end
|
|
end
|
|
|
|
describe "read get actions" do
|
|
test "raise on not found by default" do
|
|
assert_raise Ash.Error.Query.NotFound, fn ->
|
|
User.get_user!(Ash.UUID.generate())
|
|
end
|
|
|
|
assert_raise Ash.Error.Query.NotFound, fn ->
|
|
Domain.get_user!(Ash.UUID.generate())
|
|
end
|
|
end
|
|
|
|
test "do not raise on not found if were defined with `not_found_error?: false`" do
|
|
assert nil == User.get_user_safely!(Ash.UUID.generate())
|
|
end
|
|
|
|
test "do not raise on not found if option `not_found_error?: false` is passed" do
|
|
assert nil == User.get_user!(Ash.UUID.generate(), not_found_error?: false)
|
|
assert nil == Domain.get_user!(Ash.UUID.generate(), not_found_error?: false)
|
|
assert nil == User.get_user_safely!(Ash.UUID.generate(), not_found_error?: false)
|
|
end
|
|
|
|
test "raise on not found if option `not_found_error?: true` is passed" do
|
|
assert_raise Ash.Error.Query.NotFound, fn ->
|
|
User.get_user_safely!(Ash.UUID.generate(), not_found_error?: true)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe "create actions" do
|
|
test "have a helper methods to produce changeset" do
|
|
assert %Ash.Changeset{action: %{name: :create}, attributes: %{first_name: "fred"}} =
|
|
User.changeset_to_create()
|
|
|
|
assert %Ash.Changeset{action: %{name: :create}, attributes: %{first_name: "bob"}} =
|
|
User.changeset_to_create("bob")
|
|
end
|
|
|
|
test "have a helper to test authorization" do
|
|
assert {:ok, true} == User.can_create(nil)
|
|
assert {:ok, true} == User.can_create(nil, "bob")
|
|
assert User.can_create?(nil)
|
|
assert User.can_create?(nil, "bob")
|
|
end
|
|
end
|
|
|
|
describe "calculations" do
|
|
test "calculation value can be fetched dynamically" do
|
|
assert {:ok, "Zach Daniel"} =
|
|
Ash.calculate(User, :full_name, refs: %{first_name: "Zach", last_name: "Daniel"})
|
|
end
|
|
|
|
test "the same calculation can be fetched with the calculation interface" do
|
|
assert "Zach Daniel" = User.full_name!("Zach", "Daniel")
|
|
assert "Zach Daniel" = Domain.full_name!("Zach", "Daniel")
|
|
end
|
|
|
|
test "the same calculation can be fetched with the calculation interface with optional" do
|
|
assert "Zach Daniel" = User.full_name_opt!("Zach", "Daniel")
|
|
assert "Zach-Daniel" = User.full_name_opt!("Zach", "Daniel", "-")
|
|
end
|
|
|
|
test "the calculation can accept a record" do
|
|
user =
|
|
User
|
|
|> Ash.Changeset.for_create(:create, %{first_name: "Zach", last_name: "Daniel"})
|
|
|> Ash.create!()
|
|
|
|
assert "Zach Daniel" = User.full_name_record!(user)
|
|
end
|
|
end
|
|
|
|
test "get_by! adds the proper arguments and filters" do
|
|
user =
|
|
User
|
|
|> Ash.Changeset.for_create(:create, %{first_name: "ted", last_name: "Danson"})
|
|
|> Ash.create!()
|
|
|
|
assert User.get_by_id!(user.id).id == user.id
|
|
end
|
|
|
|
test "optional arguments are optional" do
|
|
assert User.create!().first_name == "fred"
|
|
assert User.create!("joe").first_name == "joe"
|
|
end
|
|
end
|