Add more error messages for the transactions.xml endpoint #19
Merged
Add more error messages for the transactions.xml endpoint #19
Conversation
eguzki
approved these changes
Apr 17, 2018
unleashed
reviewed
Apr 17, 2018
Contributor
unleashed
left a comment
unleashed
left a comment
There was a problem hiding this comment.
looking good, check the comments
| ## | ||
| ## | ||
| post '/transactions.xml' do | ||
|
|
Contributor
Author
There was a problem hiding this comment.
I have fixed the formatting issues with blank the blank lines in a new forced push
| end | ||
|
|
||
| if transactions.any? { |_id, data| data.nil? } | ||
| raise TransactionsHasNilTransaction |
Contributor
There was a problem hiding this comment.
can this actually happen? all the cases I imagine where a hash has a key the "data"/value part of it should not be nil but at most an empty string.
Contributor
Author
There was a problem hiding this comment.
This can happen.
For example, I reproduced the problem by performing the following request (see the last transactions specified without values):
[<username>@localhost apisonator]$ curl -X POST -v '127.0.0.1:3000/transactions.xml' -d 'provider_key=provider_keytest&transactions[0][app_id]=5207&transactions[0][usage][hits]=1&transactions[0][timestamp]=2018-04-17 10:13:11 UTC&transactions[1]'
Note: Unnecessary use of -X or --request, POST is already inferred.
* Trying 127.0.0.1...
* TCP_NODELAY set
* Connected to 127.0.0.1 (127.0.0.1) port 3000 (#0)
> POST /transactions.xml HTTP/1.1
> Host: 127.0.0.1:3000
> User-Agent: curl/7.55.1
> Accept: */*
> Content-Length: 156
> Content-Type: application/x-www-form-urlencoded
>
* upload completely sent off: 156 out of 156 bytes
< HTTP/1.1 400 Bad Request
< Content-Type: application/vnd.3scale-v2.0+xml
< Access-Control-Allow-Origin: *
< Access-Control-Expose-Headers: ETag, Link, 3scale-rejection-reason
< X-Content-Type-Options: nosniff
< Transfer-Encoding: chunked
<
* Connection #0 to host 127.0.0.1 left intact
<?xml version="1.0" encoding="UTF-8"?><error code="transactions_has_nil_transaction">transactions has a nil transaction</error>[<username>@localhost apisonator]$
The test 'returns error if any of the reported transactions are nil' in test/integration/report_test.rb also reproduces the nil error message.
| assert_equal '', last_response.body | ||
| assert_not_equal '', last_response.body | ||
|
|
||
|
|
miguelsorianod
force-pushed
the
improvement/add_transactions_error_messages
branch
from
a097289 to
e621117
Compare
unleashed
approved these changes
Apr 17, 2018
unleashed
reviewed
Apr 17, 2018
| ## | ||
| ## | ||
| post '/transactions.xml' do | ||
|
|
Contributor
There was a problem hiding this comment.
this diff belongs to the previous commit
Contributor
Author
There was a problem hiding this comment.
Should be placed in the other commit now
miguelsorianod
force-pushed
the
improvement/add_transactions_error_messages
branch
from
e621117 to
b22c7cb
Compare
We log a message if a request in transactions.xml has a params hash that is nil. We have manually verified that this should never happen. If we do not detect any log message after this commit then we will remove the params nil checking in all routings
…nvalid We now return a proper 400 error code with some information in XML format when the following situations are detected: · The transactions parameter is blank · The transactions parameter is not a hash · Some transaction of the transactions parameter is nil
We test that the following situations are handled: · The transactions parameter is blank · The transactions parameter is not a hash · Some transaction of the transactions parameter is nil
miguelsorianod
force-pushed
the
improvement/add_transactions_error_messages
branch
from
b22c7cb to
0de21ed
Compare
Contributor
|
bors r=@eguzki,@unleashed |
bors Bot
added a commit
that referenced
this pull request
Apr 17, 2018
19: Add more error messages for the transactions.xml endpoint r=eguzki,unleashed a=miguelsorianod We now return a proper 400 error code with some information in XML format when the following situations are detected: · The transactions parameter is blank · The transactions parameter is not a hash · Some transaction of the transactions parameter is nil Also, we have added temporary logging to confirm that the params hash can never be nil and we'll remove the checking of the nil value and the logging if we do not detect related logs for a while. Co-authored-by: Miguel Soriano <msoriano@redhat.com>
Contributor
Build succeeded |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
We now return a proper 400 error code with some information in XML
format when the following situations are detected:
· The transactions parameter is blank
· The transactions parameter is not a hash
· Some transaction of the transactions parameter is nil
Also, we have added temporary logging to confirm that the params hash can never be nil and we'll remove the checking of the nil value and the logging if we do not detect related logs for a while.