Skip to content

Fix assign_async return docs #4236

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

Merged
SteffenDE merged 2 commits into from
May 18, 2026
Merged

Fix assign_async return docs #4236

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ee506f
Fix assign_async return docs
preciz May 17, 2026
f2310df
Reject keyword assigns in assign_async tests
preciz May 18, 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
4 changes: 2 additions & 2 deletions lib/phoenix_live_view.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2245,8 +2245,8 @@ defmodule Phoenix.LiveView do
an `Phoenix.LiveView.AsyncResult` struct holding the status of the operation
and the result when the function completes.

The function must return either a map or a keyword list with the assigns
to merge into the socket.
The function must return either `{:ok, assigns}` or `{:error, reason}`,
where `assigns` is a map with the keys passed to `assign_async/3`.
Copy link
Copy Markdown
Collaborator

@SteffenDE SteffenDE May 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A keyword list should work

Suggested change
where `assigns` is a map with the keys passed to `assign_async/3`.
where `assigns` is a map or keyword list with the keys passed to `assign_async/3`.

Copy link
Copy Markdown
Contributor Author

@preciz preciz May 18, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't work when keyword list is used:

phoenix_live_view/lib/phoenix_live_view/async.ex

Line 142 in af1631c

{:ok, %{} = assigns} ->

Also just tested it manually again.

Copy link
Copy Markdown
Collaborator

@SteffenDE SteffenDE May 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm I guess the list check here is unnecessary then:

phoenix_live_view/lib/phoenix_live_view/async.ex

Line 366 in af1631c

{:ok, {:ok, assigns}} when is_map(assigns) or is_list(assigns) ->
- if it never worked, we can adjust the documentation indeed


The task is only started when the socket is connected.

Expand Down
Loading