Skip to content

[IDEV-2487] fix: handle limit_exceeded check for XML format responses #198

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

Merged
briluza merged 1 commit into from
Jun 15, 2026
Merged

[IDEV-2487] fix: handle limit_exceeded check for XML format responses #198

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
19 changes: 12 additions & 7 deletions domaintools/base_results.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
RequestUriTooLongException,
)


try: # pragma: no cover
from collections.abc import MutableMapping, MutableSequence
except ImportError: # pragma: no cover
Expand Down Expand Up @@ -111,7 +110,9 @@ def _make_request(self):
if self.product == "iris-investigate" and "irisql" in self.kwargs:
irisql_query = self.kwargs["irisql"]
auth_keys = {"api_username", "timestamp", "signature", "api_key"}
query_params = {k: v for k, v in self.kwargs.items() if k != "irisql" and k not in auth_keys}
query_params = {
k: v for k, v in self.kwargs.items() if k != "irisql" and k not in auth_keys
}
query_params.update(self.api.extra_request_params)
return session.post(
url=self.url,
Expand Down Expand Up @@ -164,21 +165,27 @@ def data(self):
self._data = results.json()
else:
self._data = results.text

self.check_limit_exceeded()

return self._data

def check_limit_exceeded(self):
limit_exceeded, reason = False, ""

if isinstance(self._data, dict) and (
"response" in self._data
and "limit_exceeded" in self._data["response"]
and self._data["response"]["limit_exceeded"] is True
):
limit_exceeded, reason = True, self._data["response"]["message"]
elif "response" in self._data and "limit_exceeded" in self._data:
limit_exceeded = True
# check for xml format, and return the actual error message
if self.kwargs.get("format") == "xml" and isinstance(self._data, str):
if re.search(r"<limit_exceeded>1</limit_exceeded>", self._data):
msg = re.search(r"<message>(.*?)</message>", self._data)
limit_exceeded, reason = True, msg.group(1) if msg else ""
else:
limit_exceeded = True

if limit_exceeded:
raise ServiceException(503, f"Limit Exceeded {reason}")
Expand Down Expand Up @@ -354,9 +361,7 @@ def html(self):
)

def as_list(self):
return "\n".join(
[json.dumps(item, indent=4, separators=(",", ": ")) for item in self._items()]
)
return "\n".join([json.dumps(item, indent=4, separators=(",", ": ")) for item in self._items()])

def __str__(self):
return str(
Expand Down
28 changes: 28 additions & 0 deletions tests/test_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -602,6 +602,34 @@ def test_limit_exceeded():
response.response()


def test_limit_exceeded_xml():
xml_response = """<response>
<error>
<code>413</code>
<message>Maximum 10000 returned - you may need to refine your query.</message>
</error>
<limit_exceeded>1</limit_exceeded>
<has_more_results>1</has_more_results>
<message>Maximum 10000 returned - you may need to refine your query.</message>
<missing_domains/>
</response>"""

mock_response = MagicMock()
mock_response.status_code = 200
mock_response.text = xml_response

with patch("domaintools.base_results.Client") as mock_client:
mock_session = MagicMock()
mock_client.return_value.__enter__.return_value = mock_session
mock_session.post.return_value = mock_response

with pytest.raises(exceptions.ServiceException) as exc_info:
result = api.iris_investigate(ip="8.8.8.8", format="xml")
result.data()

assert "Maximum 10000 returned" in str(exc_info.value)


@vcr.use_cassette
def test_newly_observed_domains_feed():
results = feeds_api.nod(after="-60", top=5)
Expand Down
Loading