8000 Propagate opts configured in `prepare_query/3` to preloads by derekkraan · Pull Request #4637 · elixir-ecto/ecto · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Propagate opts configured in prepare_query/3 to preloads #4637

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

Closed
wants to merge 2 commits into from
Closed

Propagate opts configured in prepare_query/3 to preloads #4637

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99d9588
Propagate opts configured in `prepare_query/3` to preloads
derekkraan Jul 1, 2025
c92d8a8
WIP tests
derekkraan Jul 1, 2025
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
8 changes: 7 additions & 1 deletion lib/ecto/repo.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -644,11 +644,17 @@ defmodule Ecto.Repo do
def preload(struct_or_structs_or_nil, preloads, opts \\ []) do
repo = get_dynamic_repo()

{adapter_meta, opts} =
_tuplet =
Ecto.Repo.Supervisor.tuplet(repo, prepare_opts(:preload, opts))

{_query, opts} = repo.prepare_query(:preload, struct_or_structs_or_nil, opts)

Ecto.Repo.Preloader.preload(
struct_or_structs_or_nil,
repo,
preloads,
Ecto.Repo.Supervisor.tuplet(repo, prepare_opts(:preload, opts))
{adapter_meta, opts}
)
end

Expand Down
11 changes: 9 additions & 2 deletions lib/ecto/repo/queryable.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ defmodule Ecto.Repo.Queryable do

## Helpers

defp execute(operation, name, query, {adapter_meta, opts} = tuplet) do
defp execute(operation, name, query, {adapter_meta, opts} = _tuplet) do
%{adapter: adapter, cache: cache, repo: repo} = adapter_meta

{query, opts} = repo.prepare_query(operation, query, opts)
Expand Down Expand Up @@ -244,7 +244,14 @@ defmodule Ecto.Repo.Queryable do
{count,
rows
|> Ecto.Repo.Assoc.query(assocs, sources, preprocessor)
|> Ecto.Repo.Preloader.query(name, preloads, take, assocs, postprocessor, tuplet)}
|> Ecto.Repo.Preloader.query(
name,
preloads,
take,
assocs,
postprocessor,
{adapter_meta, opts}
)}
end
end

Expand Down
35 changes: 34 additions & 1 deletion test/ecto/repo_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@
end

defmodule MySchemaOneField do
use Ecto.Schema
use Ecto.Schema

@primary_key false
schema "my_schema" do
Expand Down Expand Up @@ -2211,6 +2211,13 @@

def prepare_query(op, query, opts) do
send(self(), {op, query, opts})

opts =
case Keyword.fetch(opts, :for_on_preloader_spawn) do
{:ok, fun} -> [{:on_preloader_spawn, fun} | opts]
_ -> opts
end

{%{query | prefix: "rewritten"}, opts}
end
end
Expand Down Expand Up @@ -2253,13 +2260,13 @@
assert_received {:stream, %{prefix: "rewritten"}}
end

test "preload" do

Check failure on line 2263 in test/ecto/repo_test.exs

View workflow job for this annotation

GitHub Actions / unit test (1.17.3, 27.1) 

test prepare_for_query preload (Ecto.RepoTest)

Check failure on line 2263 in test/ecto/repo_test.exs

View workflow job for this annotation

GitHub Actions / unit test (1.18.1, 27.2, lint) 

test prepare_for_query preload (Ecto.RepoTest)

Check failure on line 2263 in test/ecto/repo_test.exs

View workflow job for this annotation

GitHub Actions / unit test (1.17.3, 25.0.4) 

test prepare_for_query preload (Ecto.RepoTest)

Check failure on line 2263 in test/ecto/repo_test.exs

View workflow job for this annotation

GitHub Actions / unit test (1.14.5, 24.3.4.17) 

test prepare_for_query preload (Ecto.RepoTest)
PrepareRepo.preload(%MySchemaWithAssoc{parent_id: 1}, :parent, hello: :world)
assert_received {:all, query, [ecto_query: :preload, hello: :world]}
assert query.from.source == {"my_parent", Ecto.RepoTest.MyParent}
end

test "preload with :on_preloader_spawn" do

Check failure on line 2269 in test/ecto/repo_test.exs

View workflow job for this annotation

GitHub Actions / unit test (1.17.3, 27.1) 

test prepare_for_query preload with :on_preloader_spawn (Ecto.RepoTest)

Check failure on line 2269 in test/ecto/repo_test.exs

View workflow job for this annotation

GitHub Actions / unit test (1.18.1, 27.2, lint) 

test prepare_for_query preload with :on_preloader_spawn (Ecto.RepoTest)

Check failure on line 2269 in test/ecto/repo_test.exs

View workflow job for this annotation

GitHub Actions / unit test (1.17.3, 25.0.4)

8000 
test prepare_for_query preload with :on_preloader_spawn (Ecto.RepoTest)

Check failure on line 2269 in test/ecto/repo_test.exs

View workflow job for this annotation

GitHub Actions / unit test (1.14.5, 24.3.4.17) 

test prepare_for_query preload with :on_preloader_spawn (Ecto.RepoTest)
test_process = self()
fun = fn -> send(test_process, {:callback_ran, self()}) end

Expand All @@ -2270,6 +2277,32 @@
assert_received {:callback_ran, pid2} when pid2 != self()
assert pid1 != pid2
end

test "preload with :on_preloader_spawn in prepare_query/3 callback" do

Check failure on line 2281 in test/ecto/repo_test.exs

View workflow job for this annotation

GitHub Actions / unit test (1.17.3, 27.1) 

test prepare_for_query preload with :on_preloader_spawn in prepare_query/3 callback (Ecto.RepoTest)

Check failure on line 2281 in test/ecto/repo_test.exs

View workflow job for this annotation

GitHub Actions / unit test (1.18.1, 27.2, lint) 

test prepare_for_query preload with :on_preloader_spawn in prepare_query/3 callback (Ecto.RepoTest)

Check failure on line 2281 in test/ecto/repo_test.exs

View workflow job for this annotation

GitHub Actions / unit test (1.17.3, 25.0.4) 

test prepare_for_query preload with :on_preloader_spawn in prepare_query/3 callback (Ecto.RepoTest)

Check failure on line 2281 in test/ecto/repo_test.exs

View workflow job for this annotation

GitHub Actions / unit test (1.14.5, 24.3.4.17) 

test prepare_for_query preload with :on_preloader_spawn in prepare_query/3 callback (Ecto.RepoTest)
test_process = self()
fun = fn -> send(test_process, {:callback_ran, self()}) end

%MySchemaWithMultiAssoc{parent_id: 1, mother_id: 2}
|> PrepareRepo.preload([:parent, :mother], for_on_preloader_spawn: fun)

assert_received {:callback_ran, pid1} when pid1 != self()
assert_received {:callback_ran, pid2} when pid2 != self()
assert pid1 != pid2
end

test "all with preload with :on_preloader_spawn in prepare_query/3 callback" do

Check failure on line 2293 in test/ecto/repo_test.exs

View workflow job for this annotation

GitHub Actions / unit test (1.17.3, 27.1) 

test prepare_for_query all with preload with :on_preloader_spawn in prepare_query/3 callback (Ecto.RepoTest)

Check failure on line 2293 in test/ecto/r 8AAF epo_test.exs

View workflow job for this annotation

GitHub Actions / unit test (1.18.1, 27.2, lint) 

test prepare_for_query all with preload with :on_preloader_spawn in prepare_query/3 callback (Ecto.RepoTest)

Check failure on line 2293 in test/ecto/repo_test.exs

View workflow job for this annotation

GitHub Actions / unit test (1.17.3, 25.0.4) 

test prepare_for_query all with preload with :on_preloader_spawn in prepare_query/3 callback (Ecto.RepoTest)

Check failure on line 2293 in test/ecto/repo_test.exs

View workflow job for this annotation

GitHub Actions / unit test (1.14.5, 24.3.4.17) 

test prepare_for_query all with preload with :on_preloader_spawn in prepare_query/3 callback (Ecto.RepoTest)
test_process = self()
fun = fn -> send(test_process, {:callback_ran, self()}) end

from(p in MyParent,
preload: [:parent, :mother]
)
|> PrepareRepo.all(for_on_preloader_spawn: fun)

assert_received {:callback_ran, pid1} when pid1 != self()
assert_received {:callback_ran, pid2} when pid2 != self()
assert pid1 != pid2
end
end

describe "prepare_transaction" do
Expand Down
Loading
0