Skip to content

Commit d30f043

Browse files
authored
Merge pull request #28 from dataquest-dev/fix/fetch-resource-friendly-401-404
fix(client): log expected 401/404 fetch failures as concise warnings
2 parents 7bb55fa + d1343a5 commit d30f043

2 files changed

Lines changed: 62 additions & 1 deletion

File tree

‎dspace_rest_client/client.py‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
import json
1818
import logging
1919
import os
20+
from urllib.parse import urlparse
2021
from uuid import UUID
2122

2223
import requests
@@ -26,6 +27,9 @@
2627

2728
__all__ = ['DSpaceClient']
2829

30+
# cap on the response body echoed into an error log line
31+
_ERR_BODY_MAX = 500
32+
2933
_logger = logging.getLogger("dspace.client")
3034
# A library must not configure the root logger - that is the consuming
3135
# application's job. Attach a NullHandler (once) so records are dropped unless
@@ -522,7 +526,20 @@ def fetch_resource(self, url, params=None):
522526
# record the failing response so callers can tell a 404 (the
523527
# resource is gone) from a transient 5xx before we drop the body
524528
self._last_err = r
525-
_logger.error(f'Error encountered fetching resource: {r.text}')
529+
# keep the query: on search endpoints it holds the only resource id
530+
u = urlparse(r.url)
531+
path = f'{u.path}?{u.query}' if u.query else u.path
532+
if r.status_code == 401:
533+
_logger.warning(
534+
f'DSpace returned 401 for [{path}] - authentication required '
535+
'(session expired or not logged in)')
536+
elif r.status_code == 404:
537+
_logger.warning(
538+
f'DSpace returned 404 for [{path}] - resource not found (deleted?)')
539+
else:
540+
_logger.error(
541+
f'Error encountered fetching resource: {r.status_code} for '
542+
f'[{path}]: {r.text[:_ERR_BODY_MAX]}')
526543
return None
527544
# ValueError / JSON handling moved to static method
528545
return parse_json(r)

‎tests/test_client_read.py‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -337,6 +337,50 @@ def test_404_returns_none_and_records_last_err(self):
337337
self.assertIsNone(c.fetch_resource(url))
338338
self.assertEqual(c.last_err.status_code, 404)
339339

340+
def test_401_logs_warning_with_path_not_body(self):
341+
# expired session token or a client that never logged in
342+
c = make_client()
343+
url = f"{API}/core/items/{ITEM_UUID}/bundles"
344+
with requests_mock.Mocker() as m:
345+
m.get(url, status_code=401,
346+
json={"status": 401, "message": "Authentication is required"})
347+
with self.assertLogs("dspace.client", level="WARNING") as logs:
348+
self.assertIsNone(c.fetch_resource(url, params={"size": 10}))
349+
self.assertEqual(c.last_err.status_code, 401)
350+
self.assertEqual(logs.output, [
351+
"WARNING:dspace.client:DSpace returned 401 for "
352+
f"[/server/api/core/items/{ITEM_UUID}/bundles?size=10] - "
353+
"authentication required (session expired or not logged in)"])
354+
355+
def test_404_logs_warning_with_path_and_query_not_body(self):
356+
# on search endpoints the query carries the only id of the resource
357+
c = make_client()
358+
url = f"{API}/authz/resourcepolicies/search/resource"
359+
with requests_mock.Mocker() as m:
360+
m.get(url, status_code=404, json={"timestamp": "2026-01-01"})
361+
with self.assertLogs("dspace.client", level="WARNING") as logs:
362+
self.assertIsNone(c.fetch_resource(url, params={"uuid": ITEM_UUID}))
363+
self.assertEqual(logs.output, [
364+
"WARNING:dspace.client:DSpace returned 404 for "
365+
f"[/server/api/authz/resourcepolicies/search/resource?uuid={ITEM_UUID}]"
366+
" - resource not found (deleted?)"])
367+
368+
def test_other_error_logs_error_with_truncated_body(self):
369+
c = make_client()
370+
url = f"{API}/core/items/{ITEM_UUID}/bundles"
371+
with requests_mock.Mocker() as m:
372+
m.get(url, status_code=500, text="boom" + "x" * 5000)
373+
with self.assertLogs("dspace.client", level="WARNING") as logs:
374+
self.assertIsNone(c.fetch_resource(url, params={"size": 10}))
375+
self.assertEqual(c.last_err.status_code, 500)
376+
self.assertEqual(len(logs.records), 1)
377+
rec = logs.records[0]
378+
self.assertEqual(rec.levelname, "ERROR")
379+
msg = rec.getMessage()
380+
self.assertIn("500", msg)
381+
self.assertIn(f"[/server/api/core/items/{ITEM_UUID}/bundles?size=10]", msg)
382+
self.assertIn("boom", msg)
383+
self.assertLess(len(msg), 1000)
340384

341385
if __name__ == "__main__":
342386
unittest.main()

0 commit comments

Comments
 (0)