ash/CHANGELOG.md

318 lines
14 KiB
Markdown
Raw Normal View History

2024-05-11 04:25:49 +12:00
# Changelog
<!-- changelog -->
2024-05-24 10:35:01 +12:00
## [v3.0.6](https://github.com/ash-project/ash/compare/v3.0.5...v3.0.6) (2024-05-23)
### Bug Fixes:
* improve non-atomic-upgrade policy handling
* ensure we have a primary key for certain kinds of calculations:
* handle subquery-requiring calculations in `calculate/2`
* mixup between atomic upsert vs update capability of datalayers (#1198)
2024-05-24 03:06:47 +12:00
## [v3.0.5](https://github.com/ash-project/ash/compare/v3.0.4...v3.0.5) (2024-05-23)
### Bug Fixes:
* only use `Mix.deps_tree` if defined
### Improvements:
* add `atomic_upgrade?` flag to update/destroy actions
* do not do atomic upgrade by default unless `require_atomic?` is `true`
* allow configuring the read action used by atomic upgrades
2024-05-23 10:52:29 +12:00
## [v3.0.4](https://github.com/ash-project/ash/compare/v3.0.3...v3.0.4) (2024-05-22)
### Features:
* Ash.Reactor: Add `bulk_update` step type. (#1185)
* allow retrieving the count of paginated relationships (#1183)
* Ash.Reactor: Add `bulk_create` step type.
### Bug Fixes:
* ensure that all notifications are sent for bulk destroy/update
* properly hydrate and scope sorts
* handle list of atomic conditions (#1194) (#1195)
* handle nil value for old_values (#1191)
* allow all strategies for bulk actions in code interfaces by default
* use `Ash.Sort.parse_input/3` in `Ash.Query.sort_input/2`
* improve Ash.Domain.Info typespecs
* make Ash.Resource.Validation.Changing work correctly in atomics (#1178)
* check the where condition before checking validation atomicity (#1177)
* handle `nil` notification results better
* don't emit after batch notifications if `notify?: false`
* prefer resource domain over option domain (#1176)
* don't require domain for empty stream bulk update and destroy (#1175)
* only return valid non nil values items from generator (#1121)
* properly validate input action on bulk destroy
* allow setting `authorize?: false`
* honor `get?` for bulk update/bulk destroy
### Improvements:
* support anonymous aggregates and calculations in queries
* Implement `show_sensitive?` config (#1180)
* support `filter_input` and `sort_input` in `Ash.Query.build/2`
* add `template_requires_actor` check for changesets
* don't use queries for streaming if they have hooks
* consider `from: nil` in `changing_attributes/1` check
2024-05-23 09:48:34 +12:00
## [3.0.3](https://github.com/ash-project/ash/compare/v3.0.2...3.0.3) (2024-05-22)
### Features:
* Ash.Reactor: Add `bulk_update` step type. (#1185)
* allow retrieving the count of paginated relationships (#1183)
* Ash.Reactor: Add `bulk_create` step type.
### Bug Fixes:
* properly hydrate and scope sorts
* handle list of atomic conditions (#1194) (#1195)
* handle nil value for old_values (#1191)
* allow all strategies for bulk actions in code interfaces by default
* use `Ash.Sort.parse_input/3` in `Ash.Query.sort_input/2`
* improve Ash.Domain.Info typespecs
* make Ash.Resource.Validation.Changing work correctly in atomics (#1178)
* check the where condition before checking validation atomicity (#1177)
* handle `nil` notification results better
* don't emit after batch notifications if `notify?: false`
* prefer resource domain over option domain (#1176)
* don't require domain for empty stream bulk update and destroy (#1175)
* only return valid non nil values items from generator (#1121)
* properly validate input action on bulk destroy
* allow setting `authorize?: false`
* honor `get?` for bulk update/bulk destroy
### Improvements:
* support anonymous aggregates and calculations in queries
* Implement `show_sensitive?` config (#1180)
* support `filter_input` and `sort_input` in `Ash.Query.build/2`
* add `template_requires_actor` check for changesets
* don't use queries for streaming if they have hooks
* consider `from: nil` in `changing_attributes/1` check
2024-05-16 09:50:39 +12:00
## [v3.0.2](https://github.com/ash-project/ash/compare/v3.0.1...v3.0.2) (2024-05-15)
### Improvements:
* [Ash.Expr] add pattern matching for clarity on values accepted by `ref/1` and `ref/2`
* [Ash.Expr] add `can_return_nil?/1` callback to Ash expressions, allowing for various optimizations
* [Ash.Type.NewType] raise argument error on unknown options in `Ash.Type.NewType`. Helps with typos & misunderstandings
* [embedded resources] use the `source` configuration for attributes in embedded resources (it was previously just ignored)
* [Ash.Policy.Authorizer] better type specification for checks, to get better autocomplete and compile time validation
* [Ash.Error.Invalid.NoSuchInput] added a `did_you_mean` field and used it in the error message
2024-05-15 02:15:48 +12:00
2024-05-16 09:50:39 +12:00
### Bug Fixes:
* [Ash.Resource] properly persist simple_notifiers (they were being ignored before)
* [code interface] accept single ids in code interface as subject for destroy/update
* [bulk update] ensure that the `changed?` context is set in after action hooks on batches
* [relationships] allow for inferred domains when authorizing join queries
2024-05-15 02:15:48 +12:00
2024-05-16 09:50:39 +12:00
* [Ash.Expr] don't treat `nil` as not a valid value when type casting lists
* [atomic upgrade] keep data's metadata in atomic upgraded update (#1165)
## [v3.0.1](https://github.com/ash-project/ash/compare/v3.0.0...v3.0.1) (2024-05-14)
2024-05-15 02:15:48 +12:00
### Features:
2024-05-15 03:42:50 +12:00
* [Ash.Resource.Change.Builtins] Add `cascade_destroy` to builtin changes.
2024-05-15 02:15:48 +12:00
### Bug Fixes:
2024-05-16 09:50:39 +12:00
* [calculations] calculation eager evaluation bug caused `exists` to eager evaluate when we didn't actually have the related data
2024-05-15 02:15:48 +12:00
2024-05-15 03:42:50 +12:00
* [field policies] fix field policy rewrite errors on non-success cases (#1163)
2024-05-15 02:15:48 +12:00
2024-05-15 03:42:50 +12:00
* [embedded resources] fix embedded resource authorization (#1159) (#1160)
2024-05-15 02:15:48 +12:00
2024-05-15 03:42:50 +12:00
* infinite recursion if query is empty (#1158)
2024-05-15 02:15:48 +12:00
2024-05-15 03:42:50 +12:00
* [Ash.DataLayer.Ets] ensure that changeset filters are honored in ETS destroy/update_query
2024-05-15 02:15:48 +12:00
2024-05-15 03:42:50 +12:00
* [update/destroy actions] don't rollback transactions on stale records, ignore stale records in bulk actions
2024-05-15 02:15:48 +12:00
2024-05-15 03:42:50 +12:00
* [bulk creates] don't check required belongs to fields until after setting them in bulk creation
2024-05-15 02:15:48 +12:00
2024-05-15 03:42:50 +12:00
* [code interface] check require_reference? when generating update code interface (#1152)
2024-05-15 02:15:48 +12:00
2024-05-09 10:29:48 +12:00
## [v3.0.0](https://github.com/ash-project/ash/compare/v3.0.0...2.0)
2020-06-01 17:19:07 +12:00
2024-05-09 10:29:48 +12:00
## 3.0
2020-06-01 17:19:07 +12:00
2024-05-09 10:29:48 +12:00
We are starting the changelog fresh. See `documentation/2.0-CHANGELOG.md` in GitHub for the old changelogs.
2020-07-08 02:39:50 +12:00
2020-07-25 09:35:28 +12:00
### Breaking Changes:
2020-07-08 02:39:50 +12:00
2024-05-09 10:29:48 +12:00
For a guide on adjusting to these breaking changes, see the [upgrade guide](/documentation/topics/development/upgrading-to-3.0.md)
- [Ash.Api] has been renamed to `Ash.Domain`, and references to the concept have been renamed as well, i.e in options and in the DSL
- [Ash] we now call functions on this, isntead of the domain. i.e `Ash.create` and `Ash.read`. The generated functions are now marked as deprecated
- [Ash] remove process context functionality. You can no longer store the actor/tenant in the context with `Ash.set_actor` and so on
- [private?] deprecate `private?: false` in favor of the more explicit `public?: true`
- [default_accept] default `default_accept` is now `[]`
- [action lifecycle] after transaction hooks cannot be added from inside of other lifecycle hooks
- [Ash.NotLoaded] use `%Ash.NotLoaded{}` for unselected values, instead of `nil`
- [require_atomic?] now defaults to `true`, requiring opt-out of atomic behavior
- [authorization] default `api.authorization.authorize` to `:by_default`
- [Ash.Registry] has been removed
- [actions] `domain` must always be known when constructing changesets
- [Ash.Notifier] `requires_original_data?/2` callback defaults to `false`
- [Ash.Notifier.PubSub] default to `previous_values?: false`, allowing notifications to be sent for atomic updates
- [unknown inputs] all action invocations now use `UnknownInput` errors when given an input they don't accept
- [policies] `requires_original_data?/2` callback on checks defaults to `false`
- [Ash.Calculation] has been renamed to `Ash.Resource.Calculation`
- [Ash.Resource.Calculation] "strict mode" has been added and defaults to `true`. This causes only explicitly requested fields from relationships to be loaded
- [Ash.Query.Calculation] positional arguments are now an options list
- [calculations] anonymous function calculations in a resource now take lists and return lists, instead of a single record (like standard calculations do)
- [context] The context argument passed to many different callbacks is now a struct, tailored to that specific context. For example, in a calculation you will receive an `Ash.Resource.Calculation.Context`
- [after_action/before_action] These builtin changes now accept a 3rd context argument
- [picosat_elixir] is now optional (`simple_sat` is now an alternative)
- [Ash.Changeset] `Ash.Changeset.new!` has been removed
- [Ash.Changeset] `Ash.Changeset.new/2` has been removed (`Ash.Changeset.new/1` is still available)
- [Ash.Changeset] `changeset.filters` is now `changeset.filter`
- [Ash.Changeset] reverse order of before action & before transaction hooks. They now run in the action they are added. They used to run in reverse order.
- [Ash.CiString] `Ash.CiString.new/1` returns `nil` on `nil` input
- [belongs_to.attribute_writable?] add `attribute_public?` for controlling publicity, and default `attribute_writable?` to `true`.
- [Ash.Filter.TemplateHelpers] removed, all functions needed for expressions are now defined in `Ash.Expr`
- [Ash.Expr] keyword lists are no longer special cased in ash expressions, and requiring pinning like any other value.
- [Ash.Resource] default read actions are now paginatable with keyset and offset pagination (but pagination is not required)
- [Ash.Resource] default actions require explicit accept lists (or will use `default_accept`). i.e `defaults [:read, create: [:first_name, :last_name]]`
- [Ash.Resource] `simple_notifiers` is now an option to `use Ash.Resource`, instead of being in the DSL at `resource.simple_notifiers`
- [Ash.Flow] has been removed and put in its own package `ash_flow`. It is being deprecated in favor of `Reactor`
- [Ash.Error] the implementation has been extracted out to `Splode`. Defining new `Ash.Error`s is now done by defining a new `Splode.Error`
- [Ash.Query] swap position of sort order and arguments in calculation sorting, i.e instead of `calculation: {:asc, %{...args}}` it is now `calculation: {%{...args}, :asc}`
- [Ash.Resource.Aggregate] add `include_nil?` aggregate option, and default it to `false` (so `list` and `first` aggregates do not consider `nil` values by default)
- [Ash.Policy.FilterCheck] now accepts `context` arguments, like `Ash.Policy.FilterCheckWithContext`
- [Ash.Policy.FilterCheckWithContext] has been removed, use `Ash.Policy.FilterCheck`
### Features:
- [Ash.Type] add new remove_nil_items? array type constraint (#1116)
- [Ash.Query] Paginatable relationships (#1050)
- [Ash.DataLayer] new `calculate/3` callback that allows for data layers to compute the result of expressions outside the context of a query. Used to power `Ash.calculate/3`.
- [validations] new builtin validations, `attributes_present/2` and `attributes_absent/2`
- [multitenancy] configurable multitenancy behaviour on read actions (#1030)
- [Ash.Reactor] Add new `change` step type which can be used to modify changesets.
- [Ash.Changeset] add `Ash.Changeset.update_change/2` function and builtin change (#976)
- [Ash.Domain] code interfaces can now be defined on the domain
- [Ash.Domain] policies can now be defined on the domain, and will run before resource policies
- [Ash.ToTenant] add `Ash.ToTenant`, allowing for passing arbitrary values as tenants
- [Ash] add `Ash.read_first` (like `Ash.read_one`, but applies a limit automatically)
- [Ash] support a second optional `input` option for `create`, `update` and `destroy`, allowing for things like `Ash.create!(Post, %{text: "text"}, opts)`
- [sensitive?] support `sensitive?` option in query aggregate/calculation (#963)
- [Ash.Resource] support `require_reference?: false` on code interfaces, for when an update or destroy action uniquely identifies a record (or for bulk update/destroy)
- [Ash.Resource] notifiers can now be specified for specific actions, using the `notifiers` option
- [mix ash.rollback] delegates to extensions to trigger their rollback tasks
- [Ash.Query] add `Ash.Query.apply_to/3`, to "apply" the query to a set of records (i.e filter, sort, distinct, etc.)
- [Ash.CustomExpression] Use `Ash.CustomExpression` to extend Ash's expression syntax in a data-layer agnostic way
- [code interface] Code interface functions now support bulk actions, in a "do what I mean" way. For example: `Domain.deactive(post)` can also be `Post |> Ash.Query.filter(active == true) |> Domain.deactive()`
### Improvements:
- [Ash.Actions.Sort] allow providing a stream of records to sort, and performance improvements
- [bulk actions] add `read_action` option to bulk actions (#1088)
- [Ash.stream] support streaming with offset, or even _no_ pagination
- [Ash.DataLayer.Ets] add debug logging, similar to ecto query debug logging
- [Ash.DataLayer.Ets] support update_query, destroy_query and `Ash.Changeset.filter/2`
- [Embedded resources] don't add `autogenerated_id` to embeds if they don't have a primary key
- [Ash.Resource] you can now omit the return type of generic actions, indicating it either succeeds or fails, returning `:ok` or `{:error, error}`
- [Ash.Resource] Generic actions can now accept a Reactor module, running it directly. (#993)
- [Ash.Resource] support `allow_nil_input` dsl option in update/destroy actions (#964)
- [Ash.Resource] The `filter` option can now be supplied multiple times in read actions and in relationships. They will be combined with `and`
- [Ash.Resource] private attributes can now be accepted as action inputs
- [Ash.Expr] is now imported automatically into places you will likely use it, like changes, validations, checks and calculations.
- [Ash.Query] is now required automatically in places you will likely use it, as above
- [sortable?] fields may mark themselves as unusable in sorts by using `sortable? false`
- [sensitive?] calculations and aggregates may now also be marked as `sensitive?`
### Bug Fixes:
- [Ash.Type] apply array type `nil_items?` constraint after item constraints are applied (#1115)
- [Ash.DataLayer.Ets] fix ETS data layer's support for lateral joining
- [bulk actions] ensure transaction is rolled back on data layer errors during streaming
- [bulk actions] set `notify?: true` when `return_notifications?: true` is set
- [Ash.Changeset] `attributes_present?/2` -> `attribute_present?/2`
- [Ash.Filter] don't eager evaluate `type/3` because data layers require type information
- [Ash.Changeset] when comparing identities for `manage_relationship`, we now properly cast the values. Before, `"1"` and `1` were not considered equal for integer primary keys/identity fields
- Many more bug fixes were added, but few are relevant enough to list here