Fix phx.routes mix task when docs return multiple annotations #5606
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm not entirely sure how to reproduce this, not even how it actually happens, but I'm currently working on a codebase where running
mix phx.routes --info [ROUTE]
raises an exception with the following message:After reviewing the code for
mix phx.routes
I noticed that it relies onCode.fetch_docs/1
to find the line number for a specific function in a module's file.However, it assumes that
Code.fetch_docs/1
will always return the function's location as the second element of the tuple, which is not always the case, asCode.fetch_docs/1
can return a list of annotations -:erl_anno.anno()
- as a Keyword list. When that's the case, the line number is actually the value for the:location
key.As such, this Pull Request updates the
Mix.Tasks.Phx.Routes.get_line_number/2
to make sure that both situations are supported.