Fix alarm setting typo treshold -> threshold
#350
Closed
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
michaelklishin
approved these changes
Oct 2, 2024
|
@essen what about this PR? |
|
I have updated the CI, please force push to run CI again. |
juhlig
force-pushed
the
fix_typo_treshold_to_threshold
branch
from
17d658c to
2436ade
Compare
essen
reviewed
Nov 8, 2024
| @@ -597,7 +597,7 @@ misc_connection_alarms(_) -> | |||
| Self ! {connection_alarm, {Ref, AlarmName, length(ActiveConns)}} | |||
| end, | |||
| Alarms0 = #{ | |||
| test1 => Alarm1 = #{type => num_connections, treshold => 2, cooldown => 0, callback => AlarmCallback}, | |||
| test1 => Alarm1 = #{type => num_connections, threshold => 2, cooldown => 0, callback => AlarmCallback}, | |||
There was a problem hiding this comment.
We should probably keep a test that uses treshold.
There was a problem hiding this comment.
We do, see the next line after this one.
There was a problem hiding this comment.
Ahah understood. In that case a comment before the next line should say that we are testing for backward compatibility but that it should be removed in 3.0.
There was a problem hiding this comment.
Done in last commit.
The setting `threshold` was misspelled as `treshold`.
juhlig
force-pushed
the
fix_typo_treshold_to_threshold
branch
from
b3dc646 to
37d77a9
Compare
|
Merged, thanks! |
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.
Fixes #349.
The misspelled option
tresholdis still accepted byranch:start_listener/5andranch:set_transport_options/2, and will be normalized tothresholdinternally. The transport options are however stored inranch_serveras they were given (ie, with possibly misspelledtresholds), such thatranch:get_transport_options/1returns them unchanged. It would have been easier to store them normalized, but there is an (admittedly off) chance that this may break existing code which has expectations as to the naming of the key in the return fromranch:get_transport_options/1.I also changed the
alarmtype by changing thetresholdkey tothreshold. I did, however, not do anything to also allow thetresholdkey there, so dialyzer may (ie, I didn't check) complain on existing code using it. I think this is just as well, since it would serve as an incentive to adapt.The documentation has been adapted by replacing all occurrences of "treshold" or "Treshold" with "threshold" or "Threshold", respectively. The
tresholdkey is now effectively undocumented.The respective test
acceptor_SUITE:misc_connection_alarms, which uses two alarms, has been changed such that one uses the properly spelled and one the misspelled option.