Rework errors to be plain structs #136
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
tlvenn
reviewed
Nov 27, 2016
| @@ -294,30 +323,21 @@ defmodule Stripe do | |||
| |> handle_response() | |||
| end | |||
|
|
|||
| @spec handle_response(http_success | http_failure) :: {:ok, map} | {:error, Exception.t} | |||
| @spec handle_response(http_success | http_failure) :: {:ok, map} | {:error, struct} | |||
There was a problem hiding this comment.
Should the typespec use api_error_struct instead of struct ?
tlvenn
reviewed
Nov 27, 2016
| @@ -275,7 +304,7 @@ defmodule Stripe do | |||
| @doc """ | |||
| A low level utility function to make an OAuth request to the Stripe API | |||
| """ | |||
| @spec oauth_request(method, String.t, map) :: {:ok, map} | {:error, Exception.t} | |||
| @spec oauth_request(method, String.t, map) :: {:ok, map} | {:error, struct} | |||
There was a problem hiding this comment.
Should the typespec use api_error_struct instead of struct ?
|
Not sure how github behave when you annotate some code once the PR has been merged. In any case, there are 2 instances where I believe the typespec could be more strict to target api_error_struct instead of struct in lib/stripe.ex |
|
@tlvenn Thanks for pointing those out. Missed them in my rework. Opening an issue for that |
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.
@joshsmith This is what I discussed with you and @tlvenn over in #132. This reforms the exceptions that were being created into plain structs. They still carry largely the same information. I have retained the
MissingAPIKeyErroras an actual error.Also, to avoid confusion, I have refrained from naming the plain structs ending in
Error, as that is typically reserved for actual exceptions per the naming documentation.I suggest that we use this to close #132. Soon we can also implement dialyzer which will catch more of this upfront as @tlvenn mentioned.