Tests for Supavisor.Jwt.authorize/2 #36
Merged
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
Closed
wojtekmach
reviewed
Mar 23, 2023
test/supavisor/jwt_test.exs
Outdated
| end | ||
|
|
||
| test "returns {:error, :token_not_a_string} for non-binary token" do | ||
| assert {:error, :token_not_a_string} = Jwt.authorize(123, @secret) |
There was a problem hiding this comment.
double-checking: instead of gracefully handling non-string tokens would it make sense to crash? In other words, wouldn't it be a programmer's mistake if we called this function with invalid type?
There was a problem hiding this comment.
Well, I don't have a strong opinion on this matter. What would you recommend? Should I remove the handling of other types?
There was a problem hiding this comment.
Yeah, I'd remove it. Its type spec is @spec authorize(String.t(), String.t()) :: {:ok, map()} | {:error, any()}, it accepts only strings, it's fine to raise.
For completeness, here's a random example from stdlib:
iex> Version.parse("1.0.0")
{:ok, %Version{major: 1, minor: 0, patch: 0}}
iex> Version.parse("1")
:error
iex> Version.parse(1)
** (FunctionClauseError) no function clause matching in Version.parse/1
The following arguments were given to Version.parse/1:
# 1
1
Attempted function clauses (showing 1 out of 1):
def parse(string) when is_binary(string)
(elixir 1.15.0-dev) lib/version.ex:367: Version.parse/1
iex:9: (file)There was a problem hiding this comment.
got it, thanks for the explanation!
Co-authored-by: Wojtek Mach <wojtekmach@users.noreply.github.com>
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.
This PR adds tests for Supavisor.Jwt.authorize/2, as recommended by @wojtekmach here