Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

services/horizon: Wrap invalid cursor in claimable balances in problem.P #3088

Conversation

abuiles
Copy link
Contributor

@abuiles abuiles commented Oct 2, 2020

PR Checklist

PR Structure

  • This PR has reasonably narrow scope (if not, break it down into smaller PRs).
  • This PR avoids mixing refactoring changes with feature changes (split into two PRs
    otherwise).
  • This PR's title starts with name of package that is most changed in the PR, ex.
    services/friendbot, or all or doc if the changes are broad or impact many
    packages.

Thoroughness

  • This PR adds tests for the most critical parts of the new functionality or fixes.
  • I've updated any docs (developer docs, .md
    files, etc... affected by this change). Take a look in the docs folder for a given service,
    like this one.

Release planning

  • I've updated the relevant CHANGELOG (here for Horizon) if
    needed with deprecations, added features, breaking changes, and DB schema changes.
  • I've decided if this PR requires a new major/minor version according to
    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

Wrap invalid cursor in claimable balances in problem.P

Why

We do cursor validation, however, if there is an error we return a
plain error instead of a problem.P -- this causes horizon to handle
the error as a 500 instead of a 400.

This fix moves cursor parsing to its own method and then use it in the
query handler to return a problem.P error which causes horizon to
return the correct response.

I opted to create a new error instead of returning the inner error
since it exposes low-level details which are not relevant for the API
user, for example:

  • Invalid cursor - first value should be higher than 0: strconv.ParseInt: parsing \"\": invalid syntax
  • Invalid cursor - second value should be a valid claimable balance id: xdr:decode: switch '67' is not valid enum value for union

Fixes #3085.

Known limitations

@cla-bot cla-bot bot added the cla: yes label Oct 2, 2020
@abuiles abuiles requested a review from bartekn October 2, 2020 13:06
historyQ, err := horizonContext.HistoryQFromRequest(r)
if err != nil {
return nil, err
return nil, problem.MakeInvalidFieldProblem("query parameters", err)
}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ignore this

We do cursor validation, however, if there is an error we return a
plain error instead of a `problem.P` -- this causes horizon to handle
the error as a 500 instead of a 400.

This fix moves cursor parsing to its own method and then use it in the
query handler to return a `problem.P` error.

Fixes stellar#3085.
@abuiles abuiles force-pushed the fix-claimable-balance-invalid-cursor-error branch from 67bdb8c to 52b6649 Compare October 2, 2020 13:11
@abuiles abuiles merged commit b51b25c into stellar:release-horizon-v1.10.0 Oct 2, 2020
@abuiles abuiles deleted the fix-claimable-balance-invalid-cursor-error branch October 2, 2020 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants