Skip to content

fix: don't pass the extra pagination row to read hooks #2916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
barnabasJ wants to merge 4 commits into
base: main
Choose a base branch
from
+598 −91
Open

fix: don't pass the extra pagination row to read hooks #2916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
104d534
Add test to verify that the extra row fetched in pagination is not pa…
Rutgerdj Mar 4, 2026
edcf89b
fix: don't pass the extra pagination record to read after_action hooks
barnabasJ Sep 5, 2026
c4fc781
fix: drop the extra pagination row before authorize_results and tidy up
barnabasJ Sep 7, 2026
1bdfdb2
fix: make `Ash.data_layer_query/2`'s `run` return the page
barnabasJ Sep 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion lib/ash.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2970,14 +2970,29 @@ defmodule Ash do
run: (Ash.DataLayer.data_layer_query() ->
{:ok, list(Ash.Resource.Record.t()) | Ash.Page.page() | no_return}
| {:error, Ash.Error.t()}),
load: (list(Ash.Resource.Record.t()) | Ash.Page.page() ->
load: (Ash.Query.t(), list(Ash.Resource.Record.t()) | Ash.Page.page() ->
{:ok, list(Ash.Resource.Record.t()) | Ash.Page.page()}
| {:error, Ash.Error.t()})
}

@doc """
Gets the full query and any runtime calculations that would be loaded

## Pagination

When the query is paginated, `run` returns an `Ash.Page.Offset` or
`Ash.Page.Keyset` rather than a list. The data layer query fetches one row
beyond the page limit so that `more?` can be determined; `run` drops that row
before any `authorize_results` or `after_action` hooks see it, exactly as
`Ash.read/2` does, and sets `more?` (and `count`, when requested) on the page.
For an unpaginated query `run` returns a list of records.

Pass whatever `run` returned to `load`, which loads relationships,
calculations and load-through attributes on the records and returns the same
shape it was given. `load` also accepts the raw rows of a paginated data
layer query you executed yourself, extra row included, and builds the page
from them. Passing `page.results` instead of the page loses `more?`.

## Examples

iex> query = MyApp.Post |> Ash.Query.filter(published: true)
Expand Down
Loading
Loading