Replace all REST query empty result HTTP Status codes to 200 #4065

MarinX · 2019-04-06T15:37:54Z

All query params that are empty will now return success (http.StatusOK) instead of mixed http status codes (http.StatusNoContent/http.StatusBadRequest/http.StatusInternalServerError)

closes: #2007

Targeted PR against correct branch (see CONTRIBUTING.md)
Linked to github-issue with discussion and accepted design OR link to spec that describes this work.
Wrote tests
Updated relevant documentation (docs/)
Added a relevant changelog entry: sdkch add [section] [stanza] [message]
rereviewed Files changed in the github PR explorer

For Admin Use:

Added appropriate labels to PR (ex. wip, ready-for-review, docs)
Reviewers Assigned
Squashed all commits, uses message "Merge pull request #XYZ: [title]" (coding standards)

codecov · 2019-04-06T15:48:05Z

Codecov Report

Merging #4065 into develop will increase coverage by 0.01%.
The diff coverage is 0%.

@@             Coverage Diff             @@
##           develop    #4065      +/-   ##
===========================================
+ Coverage    60.01%   60.02%   +0.01%     
===========================================
  Files          212      212              
  Lines        15107    15104       -3     
===========================================
  Hits          9066     9066              
+ Misses        5420     5417       -3     
  Partials       621      621

codecov · 2019-04-06T15:48:05Z

Codecov Report

Merging #4065 into develop will increase coverage by 0.01%.
The diff coverage is 0%.

@@             Coverage Diff             @@
##           develop    #4065      +/-   ##
===========================================
+ Coverage    60.01%   60.02%   +0.01%     
===========================================
  Files          212      212              
  Lines        15107    15104       -3     
===========================================
  Hits          9066     9066              
+ Misses        5420     5417       -3     
  Partials       621      621

fedekunze

thanks @MarinX again for your contribution ! I left some notes that need to be addressed

x/gov/client/rest/rest.go

x/slashing/client/rest/query.go

x/staking/client/rest/query.go

x/auth/client/rest/query.go

fedekunze · 2019-04-06T17:41:28Z

x/auth/client/rest/query.go

@@ -88,7 +88,7 @@ func QueryBalancesRequestHandlerFn(

 		// the query will return empty if there is no data for this account
 		if len(res) == 0 {
-			w.WriteHeader(http.StatusNoContent)
+			w.WriteHeader(http.StatusOK)


curious if this function is a duplicate from the one above ?

Most of it is duplicated, only change is response. Eg. for /auth/accounts/{address} we are returning Account{} which in case /bank/balances/{address} we are returning sdk.Coins

The balance endpoint does not make sense for me, it should be /auth/accounts/{address}/balances and the same function should check the endpoint and return corresponding model. But this is a API breaking change so maybe it should be a separated issue for code cleanup :)

I agree it doesn’t make much sense. Let’s open an issue for it

alexanderbez

Thanks @MarinX -- changes l look mostly good, but a bunch of return codes have been modified that shouldn't have.

MarinX · 2019-04-08T21:06:17Z

Summary of change:

Reverted back most of statuses for empty query params
For empty results, we are returning empty models
Added TestAccountBalanceQuery which covers the case for empty results

alexanderbez

Missing pending change log entry 👍

fedekunze

ACK, missing changelog entry tho

MarinX · 2019-04-09T21:10:45Z

noted.
Added the changelog entry

alessio

Changelog entry is wrong

.pending/improvements/gaiarest/4065-http-200-with-e

alexanderbez

Minor nit but otherwise LGMT.

MarinX · 2019-04-10T12:50:24Z

Thanks for the suggestion.
I updated it.
It should be ok now :)

alexanderbez · 2019-04-10T13:07:13Z

@alessio please approve :)

All query params that are empty now returns success (http.StatusOK) instead of mixed http status codes (http.StatusNoContent/http.StatusBadRequest/ http.StatusInternalServerError) Closes: #2007

MarinX added 2 commits April 6, 2019 17:19

Replace http status code with http.StatusOK for empty query results

549a1d5

Fix test case to require http.StatusOK instead of http.StatusNoContent

b501a2c

MarinX requested review from cwgoes, ebuchman and rigelrozanski as code owners April 6, 2019 15:37

MarinX changed the title ~~2007 empty query results~~ Replace all REST query empty result HTTP Status codes to 200 Apr 6, 2019

fedekunze suggested changes Apr 6, 2019

View reviewed changes

alessio requested review from alessio and sabau April 7, 2019 19:00

alexanderbez added ready-for-review labels Apr 8, 2019

alexanderbez suggested changes Apr 8, 2019

View reviewed changes

MarinX added 2 commits April 8, 2019 22:50

Revert back status codes

5f32f04

Adds test for empty results

18a65fc

alexanderbez suggested changes Apr 9, 2019

View reviewed changes

fedekunze approved these changes Apr 9, 2019

View reviewed changes

Update changelog entry

c23b54a

fedekunze requested a review from alexanderbez April 10, 2019 09:11

alessio suggested changes Apr 10, 2019

View reviewed changes

.pending/improvements/gaiarest/4065-http-200-with-e Outdated Show resolved Hide resolved

alexanderbez approved these changes Apr 10, 2019

View reviewed changes

.pending/improvements/gaiarest/4065-http-200-with-e Outdated Show resolved Hide resolved

alexanderbez suggested changes Apr 10, 2019

View reviewed changes

Update changelog entry

32df57f

alexanderbez approved these changes Apr 10, 2019

View reviewed changes

MarinX mentioned this pull request Apr 10, 2019

REST Account/Balance query duplicated logic #4090

Closed

4 tasks

alessio approved these changes Apr 10, 2019

View reviewed changes

alessio merged commit b50b25d into cosmos:develop Apr 10, 2019

MarinX deleted the 2007-empty-query-results branch April 10, 2019 17:41

alexanderbez mentioned this pull request May 3, 2019

[ICS20] Balance endpoint returns null for empty balance account #4259

Closed

4 tasks

alexanderbez added the next-minor-release label May 3, 2019

alexanderbez removed the next-minor-release label May 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace all REST query empty result HTTP Status codes to 200 #4065

Replace all REST query empty result HTTP Status codes to 200 #4065

MarinX commented Apr 6, 2019 •

edited

Loading

codecov bot commented Apr 6, 2019

codecov bot commented Apr 6, 2019 •

edited

Loading

fedekunze left a comment

fedekunze Apr 6, 2019

MarinX Apr 8, 2019

fedekunze Apr 8, 2019

alexanderbez left a comment

MarinX commented Apr 8, 2019

alexanderbez left a comment

fedekunze left a comment

MarinX commented Apr 9, 2019

alessio left a comment

alexanderbez left a comment

MarinX commented Apr 10, 2019

alexanderbez commented Apr 10, 2019

Replace all REST query empty result HTTP Status codes to 200 #4065

Replace all REST query empty result HTTP Status codes to 200 #4065

Conversation

MarinX commented Apr 6, 2019 • edited Loading

codecov bot commented Apr 6, 2019

Codecov Report

codecov bot commented Apr 6, 2019 • edited Loading

Codecov Report

fedekunze left a comment

Choose a reason for hiding this comment

fedekunze Apr 6, 2019

Choose a reason for hiding this comment

MarinX Apr 8, 2019

Choose a reason for hiding this comment

fedekunze Apr 8, 2019

Choose a reason for hiding this comment

alexanderbez left a comment

Choose a reason for hiding this comment

MarinX commented Apr 8, 2019

alexanderbez left a comment

Choose a reason for hiding this comment

fedekunze left a comment

Choose a reason for hiding this comment

MarinX commented Apr 9, 2019

alessio left a comment

Choose a reason for hiding this comment

alexanderbez left a comment

Choose a reason for hiding this comment

MarinX commented Apr 10, 2019

alexanderbez commented Apr 10, 2019

MarinX commented Apr 6, 2019 •

edited

Loading

codecov bot commented Apr 6, 2019 •

edited

Loading