clients/horizonclient: add IsNotFoundError #2197
Conversation
| return false | ||
| } | ||
|
|
||
| return hErr.Problem.Type == "https://stellar.org/horizon-errors/not_found" |
There was a problem hiding this comment.
@leighmcculloch Is there a particular reason for using Type rather than Status? Using Status could help us prevent possible issues if we decide to change the URL or something like that. A 404 will always be a 404, unless, it can't be found.
There was a problem hiding this comment.
According to the Horizon documentation the important thing is that the error is a not_found error, not that the status code is 404.
When Horizon can’t find whatever data you are requesting, it will return a
not_founderror. This is similar to a HTTP 404 Error error response.
Ref: https://www.stellar.org/developers/horizon/reference/errors/not-found.html.
Also, according to RFC7807 the type should uniquely identify the problem, so I don't think it's something we'd ever change, or if we did it would be a breaking API change.
"type" (string) - A URI reference [RFC3986] that identifies the problem type.
Ref: https://tools.ietf.org/html/draft-ietf-appsawg-http-problem-00#section-3.1.
There was a problem hiding this comment.
Another reason: I think ideally we use the same pattern for any error helpers like this, and others will need to use the type. If the API ever returns a 404 that doesn't fit the horizon error, then it isn't really a horizon error and something else more significant has happened. This helps to protect a client that points to the wrong URL and is getting 404s from thinking resources don't exist on Horizon.
There was a problem hiding this comment.
Makes sense! thanks for the explanation
PR Checklist
PR Structure
otherwise).
services/friendbot, orallordocif the changes are broad or impact manypackages.
Thoroughness
I've updated any docs (developer docs,.mdfiles, etc... affected by this change). Take a look in the
docsfolder for a given service,like this one.
Release planning
needed with deprecations, added features, breaking changes, and DB schema changes.
semver, or if it's mainly a patch change. The PR is targeted at the next
release branch if it's not a patch change.
What
Add
horizonclient.IsNotFoundErrorthat returns true if anerroris a Horizonnot_foundproblem error.Why
It is remarkably verbose and difficult to detect if an account exists in Horizon. The code to do so must unwrap the horizonclient.Error, know to do so as a pointer and not as the pointer-less type, and then check that the problem's type is a long URI. In application code this is very verbose and easy to get wrong.
I'm writing code that tests if an account is present in the
exp/services/webauthservice and attempting to simplifying it.Closes #2194
Known limitations
N/A