Skip to content

fix(api): check HTTP status before decoding POST responses #157

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.

Sign up for GitHub

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

Open
JianYan11 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(api): check HTTP status before decoding POST responses #157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/browsergym/workarena/api/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,15 @@ def table_api_call(
params=params,
json=json,
)

# Check for HTTP success code before decoding the response body.
response.raise_for_status()

if method == "POST":
sys_id = response.json()["result"]["sys_id"]
data = {}
params = {"sysparm_query": f"sys_id={sys_id}"}

# Check for HTTP success code (fail otherwise)
response.raise_for_status()

record_exists = False
num_retries = 0
if method == "POST" or wait_for_record:
Expand Down
66 changes: 66 additions & 0 deletions tests/test_api_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
import json
from types import SimpleNamespace
from unittest.mock import Mock

import pytest
import requests

from browsergym.workarena.api import utils


@pytest.fixture
def instance():
return SimpleNamespace(snow_url="https://example.invalid", snow_credentials=("user", "pass"))


def make_response(status_code, content):
response = requests.Response()
response.status_code = status_code
response.url = "https://example.invalid/api/now/table/incident"
response._content = content
return response


@pytest.mark.parametrize("method", ["GET", "POST", "PUT", "DELETE"])
@pytest.mark.parametrize(
"status_code, content",
[(401, b'{"error": {"message": "Unauthorized"}}'), (503, b"<html>Unavailable</html>")],
)
def test_table_api_raises_http_error_before_decoding(
monkeypatch, instance, method, status_code, content
):
response = make_response(status_code, content)
decode = Mock(wraps=response.json)
monkeypatch.setattr(response, "json", decode)
request = Mock(return_value=response)
sleep = Mock()
monkeypatch.setattr(utils.requests, "request", request)
monkeypatch.setattr(utils, "sleep", sleep)

with pytest.raises(requests.HTTPError) as exc_info:
utils.table_api_call(instance, table="incident", method=method)

assert exc_info.value.response is response
decode.assert_not_called()
sleep.assert_not_called()
assert request.call_count == 1


def test_table_api_successful_post_still_waits_for_record(monkeypatch, instance):
created = {"result": {"sys_id": "record-123"}}
request = Mock(
side_effect=[
make_response(201, json.dumps(created).encode()),
make_response(200, b'{"result": [{"sys_id": "record-123"}]}'),
]
)
monkeypatch.setattr(utils.requests, "request", request)
monkeypatch.setattr(utils, "sleep", Mock())

result = utils.table_api_call(instance, table="incident", method="POST")

assert result == created
assert request.call_count == 2
assert request.call_args_list[0].kwargs["method"] == "POST"
assert request.call_args_list[1].kwargs["method"] == "GET"
assert request.call_args_list[1].kwargs["params"] == {"sysparm_query": "sys_id=record-123"}