Fix crash in warning message generation and bug in reporting #144
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
add_message calls Agent.update, which always returns `:ok`, so it
doesn't make sense to use the return value for the new `options1`.
Since both paths shouldn't alter `options`, have the `case` only be run
for side-effect of add_message call.
Fixes this error
```
16:21:23.570 [error] Task #PID<0.512.0> started from #PID<0.70.0>
terminating
** (BadMapError) expected a map, got: :ok
(earmark) lib/earmark/block.ex:177: Earmark.Block._parse/3
(earmark) lib/earmark/block.ex:65: Earmark.Block.lines_to_blocks/2
(earmark) lib/earmark/block.ex:56: Earmark.Block.parse/2
(earmark) lib/earmark.ex:337: Earmark.parse/2
(earmark) lib/earmark.ex:321: Earmark._as_html/2
(earmark) lib/earmark.ex:314: Earmark.as_html!/2
(ex_doc) lib/ex_doc/markdown.ex:32: ExDoc.Markdown.to_html/2
(ex_doc) lib/ex_doc/formatter/html.ex:192:
ExDoc.Formatter.HTML.build_extra/6
Function: #Function<14.119834956/0 in
ExDoc.Formatter.HTML.build_extras/3>
Args: []
** (EXIT from #PID<0.70.0>) an exception was raised:
** (BadMapError) expected a map, got: :ok
(earmark) lib/earmark/block.ex:177: Earmark.Block._parse/3
(earmark) lib/earmark/block.ex:65:
Earmark.Block.lines_to_blocks/2
(earmark) lib/earmark/block.ex:56: Earmark.Block.parse/2
(earmark) lib/earmark.ex:337: Earmark.parse/2
(earmark) lib/earmark.ex:321: Earmark._as_html/2
(earmark) lib/earmark.ex:314: Earmark.as_html!/2
(ex_doc) lib/ex_doc/markdown.ex:32: ExDoc.Markdown.to_html/2
(ex_doc) lib/ex_doc/formatter/html.ex:192:
ExDoc.Formatter.HTML.build_extra/6
```
The Agent's state is never reset, so once a line has a warning it has that warning for all subsequent files. Since `get_all_messages()` is never called twice to report the same warnings intentionally, `get_all_messages` can be changed to `pop_all_messages`, so it gets the messages as before, but also resets the state, in preparation for the next call. This fixes errors like ``` CHANGELOG.md:41: warning: Closing unclosed backquotes ` at end of input lib/retort/meta.ex:41: warning: Closing unclosed backquotes ` at end of input lib/retort.ex:41: warning: Closing unclosed backquotes ` at end of input ``` where the only the first warning is real, but it is reported on all following files.
|
Many thanks for this one, I had designed the lifetime for the call of |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 can demonstrate the below bugs on C-S-D/retort@8afabf4bb2e04ef83a27a820fff772394cee3883 if you need something to test this against for verification.
Changelog
Bug Fixes
add_messagecallsAgent.update, which always returns:ok, so it doesn't make sense to use the return value for the newoptions1in_parse. Since both paths shouldn't alteroptions, have thecaseonly be run for side-effect of add_message call.Fixes this error
The
Agent's state inEarmark.Global.Messagesis never reset, so once a line has a warning it has that warning for all subsequent files. Sinceget_all_messages()is never called twice to report the same warnings intentionally,get_all_messagescan be changed topop_all_messages, so it gets the messages as before, but also resets the state, in preparation for the next call.This fixes errors like
where the only the first warning is real, but it is reported on all
following files.
Incompatible Changes
Earmark.Global.Messages.get_all_messages/0is replaced byEarmark.Global.Messages.pop_all_messages/0to prevent leaking messages between files.