Skip to content
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

[IEx][Autocomplete] Fix crashing on autocompleting structs #14150

Merged
merged 4 commits into from
Jan 7, 2025
+14 −1
Merged

[IEx][Autocomplete] Fix crashing on autocompleting structs #14150

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
9f879dd
[IEx][Autocomplete] Fix crashing on autocompleting structs
GuillaumeMilan Jan 6, 2025
37b04b3
[AutocompleteTest] completion for struct keys when var is struct
GuillaumeMilan Jan 7, 2025
07d1796
Update lib/iex/test/iex/autocomplete_test.exs
josevalim Jan 7, 2025
d607ac4
Update lib/iex/test/iex/autocomplete_test.exs
josevalim Jan 7, 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
2 changes: 1 addition & 1 deletion lib/iex/lib/iex/autocomplete.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ defmodule IEx.Autocomplete do
end)

entries =
for {key, _value} <- pairs,
for key when key != :__struct__ <- Map.keys(pairs),
name = Atom.to_string(key),
if(hint == "",
do: not String.starts_with?(name, "_"),
Expand Down
13 changes: 13 additions & 0 deletions lib/iex/test/iex/autocomplete_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,6 +440,19 @@ defmodule IEx.AutocompleteTest do
assert {:yes, ~c"ry: ", []} = expand(~c"%URI{var | path: \"foo\", que")
assert {:no, [], []} = expand(~c"%URI{var | path: \"foo\", unkno")
assert {:no, [], []} = expand(~c"%Unknown{var | path: \"foo\", unkno")

eval("var = %URI{}")
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't we add a test for an exception struct (e.g. ArgumentError) as well?

Copy link
Member

Choose a reason for hiding this comment

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

@lukaszsamson this is tricky because how do we know which keys to skip? You likely want to skip the meta key in Ecto schemas too and so on. So I'd prefer to provide a general mechanism to control this (perhaps with the type system) instead of special casing __exception__.

Copy link
Contributor

Choose a reason for hiding this comment

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

Sure. Either we filter out all underscored fields or let the library decide in some way what is internal. My concern was more if __exception__ needs some special handling the way __struct__ does.


assert {:yes, ~c"", entries} = expand(~c"%{var | ")
assert ~c"path:" in entries
assert ~c"query:" in entries

assert {:yes, ~c"", entries} = expand(~c"%{var | path: \"foo\",")
assert ~c"path:" not in entries
assert ~c"query:" in entries

assert {:yes, ~c"ry: ", []} = expand(~c"%{var | path: \"foo\", que")
assert {:no, [], []} = expand(~c"%URI{var | path: \"foo\", unkno")
end

test "completion for map keys in update syntax" do
Expand Down
Loading