Merge pull request #2329 from freedomofpress/2232-error-on-retry

fix(`_streaming_download`): handle retry-level JSON error responses
freedomofpress · Dec 20, 2024 · ef99a49 · ef99a49
2 parents ba63e54 + d233eb3
commit ef99a49
Show file tree

Hide file tree

Showing 33 changed files with 5,836 additions and 5,777 deletions.
diff --git a/client/securedrop_client/sdk/__init__.py b/client/securedrop_client/sdk/__init__.py
@@ -140,6 +140,7 @@ def _streaming_download(
         download_finished = False
 
         while not download_finished and retry < self.download_retry_limit:
+            bytes_written_prev = bytes_written
             logger.debug(f"Streaming download, retry {retry}")
 
             try:
@@ -213,10 +214,15 @@ def _streaming_download(
                 contents = fobj.read()
                 fobj.close()
 
-                # Check for an error response
+                # Check for an error response first at the request level...
                 if contents[0:1] == b"{":
                     logger.error(f"Retry {retry}, received JSON error response.")
                     return self._handle_json_response(contents)
+                # ...and then at the retry level.
+                partial = contents[bytes_written_prev:bytes_written]
+                if retry > 0 and partial[0:1] == b"{":
+                    logger.error(f"Retry {retry}, received JSON error response.")
+                    return self._handle_json_response(partial)
 
                 # Get the headers
                 if proc.stderr is not None:

diff --git a/client/tests/sdk/data/setup_method.yml b/client/tests/sdk/data/setup_method.yml
@@ -1,22 +1,22 @@
 interactions:
 - request:
     body: '{"username": "journalist", "passphrase": "correct horse battery staple
-      profanity oil chewy", "one_time_code": "112097"}'
+      profanity oil chewy", "one_time_code": "578466"}'
     headers: {}
     method: POST
     uri: api/v1/token
   response: !!python/object:securedrop_client.sdk.JSONResponse
     data:
-      expiration: '2024-02-29T23:13:01.444028Z'
+      expiration: '2024-12-11T02:37:22.232423Z'
       journalist_first_name: null
       journalist_last_name: null
-      journalist_uuid: ed64b0fa-0565-4b12-9c48-6cfe27a73fd9
-      token: Ilhha2ZHZWpVcFZQVmpKdWJOUzJYRG1YVUc4QXZWS0JiOGVNQXJycE5GUFUi.ZeDzXQ.10ODTj49yF7kxKbeMm9eaayR3Xo
+      journalist_uuid: e7e047d5-aa5e-4afe-9a4f-c24e5f2cec8d
+      token: IlAzb1p1MjRubnlLOFo0SDVaajZPc2JPZWRRcjRYRUxLM3RrUmhsUEFWVTQi.Z1jewg.4VNFOk_5HSHXhgn319zzDh9JVyg
     headers:
       connection: close
       content-length: '290'
       content-type: application/json
-      date: Thu, 29 Feb 2024 21:13:01 GMT
+      date: Wed, 11 Dec 2024 00:37:22 GMT
       server: Werkzeug/2.2.3 Python/3.8.10
     status: 200
 version: 1
diff --git a/client/tests/sdk/data/test_auth_badpassword.yml b/client/tests/sdk/data/test_auth_badpassword.yml
@@ -1,6 +1,6 @@
 interactions:
 - request:
-    body: '{"username": "journalist", "passphrase": "no", "one_time_code": "112097"}'
+    body: '{"username": "journalist", "passphrase": "no", "one_time_code": "578466"}'
     headers: {}
     method: POST
     uri: api/v1/token

diff --git a/client/tests/sdk/data/test_auth_baduser.yml b/client/tests/sdk/data/test_auth_baduser.yml
@@ -1,7 +1,7 @@
 interactions:
 - request:
     body: '{"username": "no", "passphrase": "correct horse battery staple profanity
-      oil chewy", "one_time_code": "112097"}'
+      oil chewy", "one_time_code": "578466"}'
     headers: {}
     method: POST
     uri: api/v1/token

diff --git a/client/tests/sdk/data/test_delete_conversation.yml b/client/tests/sdk/data/test_delete_conversation.yml
diff --git a/client/tests/sdk/data/test_delete_reply.yml b/client/tests/sdk/data/test_delete_reply.yml
@@ -5,45 +5,71 @@ interactions:
       Accept:
       - application/json
       Authorization:
-      - Token Ilhha2ZHZWpVcFZQVmpKdWJOUzJYRG1YVUc4QXZWS0JiOGVNQXJycE5GUFUi.ZeDzXQ.10ODTj49yF7kxKbeMm9eaayR3Xo
+      - Token IlAzb1p1MjRubnlLOFo0SDVaajZPc2JPZWRRcjRYRUxLM3RrUmhsUEFWVTQi.Z1jewg.4VNFOk_5HSHXhgn319zzDh9JVyg
       Content-Type:
       - application/json
     method: GET
     uri: api/v1/replies
   response: !!python/object:securedrop_client.sdk.JSONResponse
     data:
       replies:
-      - filename: 5-hand-to-mouth_greasewood-reply.gpg
+      - filename: 5-intricate_hock-reply.gpg
         is_deleted_by_source: false
         journalist_first_name: ''
         journalist_last_name: ''
         journalist_username: dellsberg
-        journalist_uuid: e101e4e2-230e-4e27-9f58-ad094079c230
-        reply_url: /api/v1/sources/127ce85b-2c3e-4f06-a46f-89882ecb82d0/replies/8d0b333a-082f-4c01-a4c4-5763795af7f7
+        journalist_uuid: a6e99098-ca63-403c-a76d-38530a2e88dd
+        reply_url: /api/v1/sources/c0f0153d-0cb0-4ad3-9f0e-f8540891b5c8/replies/417d50e9-6e12-4aee-b11a-4d2e2bb58cde
         seen_by:
-        - ed64b0fa-0565-4b12-9c48-6cfe27a73fd9
-        - e101e4e2-230e-4e27-9f58-ad094079c230
-        size: 1331
-        source_url: /api/v1/sources/127ce85b-2c3e-4f06-a46f-89882ecb82d0
-        uuid: 8d0b333a-082f-4c01-a4c4-5763795af7f7
-      - filename: 6-hand-to-mouth_greasewood-reply.gpg
+        - e7e047d5-aa5e-4afe-9a4f-c24e5f2cec8d
+        - a6e99098-ca63-403c-a76d-38530a2e88dd
+        size: 1174
+        source_url: /api/v1/sources/c0f0153d-0cb0-4ad3-9f0e-f8540891b5c8
+        uuid: 417d50e9-6e12-4aee-b11a-4d2e2bb58cde
+      - filename: 6-intricate_hock-reply.gpg
         is_deleted_by_source: false
         journalist_first_name: ''
         journalist_last_name: ''
         journalist_username: deleted
-        journalist_uuid: b2857ac1-3765-4a3e-95d2-528209ef9525
-        reply_url: /api/v1/sources/127ce85b-2c3e-4f06-a46f-89882ecb82d0/replies/40460ca9-8d80-40d6-8181-c5175ad961cc
+        journalist_uuid: c98cd9c4-a45a-42cb-a704-9d9af34f4563
+        reply_url: /api/v1/sources/c0f0153d-0cb0-4ad3-9f0e-f8540891b5c8/replies/c8142538-e670-42dd-9126-fb67242166dd
+        seen_by:
+        - e7e047d5-aa5e-4afe-9a4f-c24e5f2cec8d
+        - c98cd9c4-a45a-42cb-a704-9d9af34f4563
+        size: 1293
+        source_url: /api/v1/sources/c0f0153d-0cb0-4ad3-9f0e-f8540891b5c8
+        uuid: c8142538-e670-42dd-9126-fb67242166dd
+      - filename: 5-generational_catchment-reply.gpg
+        is_deleted_by_source: false
+        journalist_first_name: ''
+        journalist_last_name: ''
+        journalist_username: deleted
+        journalist_uuid: c98cd9c4-a45a-42cb-a704-9d9af34f4563
+        reply_url: /api/v1/sources/ee212060-9cd5-4031-b596-581ea15cffa0/replies/946ab2d4-a13d-4fd9-9372-e9a7aac55aca
+        seen_by:
+        - e7e047d5-aa5e-4afe-9a4f-c24e5f2cec8d
+        - c98cd9c4-a45a-42cb-a704-9d9af34f4563
+        size: 1331
+        source_url: /api/v1/sources/ee212060-9cd5-4031-b596-581ea15cffa0
+        uuid: 946ab2d4-a13d-4fd9-9372-e9a7aac55aca
+      - filename: 6-generational_catchment-reply.gpg
+        is_deleted_by_source: false
+        journalist_first_name: ''
+        journalist_last_name: ''
+        journalist_username: dellsberg
+        journalist_uuid: a6e99098-ca63-403c-a76d-38530a2e88dd
+        reply_url: /api/v1/sources/ee212060-9cd5-4031-b596-581ea15cffa0/replies/97ad15ab-64a2-4fb9-8d26-80cf46fedfae
         seen_by:
-        - ed64b0fa-0565-4b12-9c48-6cfe27a73fd9
-        - b2857ac1-3765-4a3e-95d2-528209ef9525
+        - e7e047d5-aa5e-4afe-9a4f-c24e5f2cec8d
+        - a6e99098-ca63-403c-a76d-38530a2e88dd
         size: 1237
-        source_url: /api/v1/sources/127ce85b-2c3e-4f06-a46f-89882ecb82d0
-        uuid: 40460ca9-8d80-40d6-8181-c5175ad961cc
+        source_url: /api/v1/sources/ee212060-9cd5-4031-b596-581ea15cffa0
+        uuid: 97ad15ab-64a2-4fb9-8d26-80cf46fedfae
     headers:
       connection: close
-      content-length: '1395'
+      content-length: '2745'
       content-type: application/json
-      date: Thu, 29 Feb 2024 21:13:15 GMT
+      date: Wed, 11 Dec 2024 00:37:40 GMT
       server: Werkzeug/2.2.3 Python/3.8.10
     status: 200
 - request:
@@ -52,45 +78,71 @@ interactions:
       Accept:
       - application/json
       Authorization:
-      - Token Ilhha2ZHZWpVcFZQVmpKdWJOUzJYRG1YVUc4QXZWS0JiOGVNQXJycE5GUFUi.ZeDzXQ.10ODTj49yF7kxKbeMm9eaayR3Xo
+      - Token IlAzb1p1MjRubnlLOFo0SDVaajZPc2JPZWRRcjRYRUxLM3RrUmhsUEFWVTQi.Z1jewg.4VNFOk_5HSHXhgn319zzDh9JVyg
       Content-Type:
       - application/json
     method: GET
     uri: api/v1/replies
   response: !!python/object:securedrop_client.sdk.JSONResponse
     data:
       replies:
-      - filename: 5-hand-to-mouth_greasewood-reply.gpg
+      - filename: 5-intricate_hock-reply.gpg
         is_deleted_by_source: false
         journalist_first_name: ''
         journalist_last_name: ''
         journalist_username: dellsberg
-        journalist_uuid: e101e4e2-230e-4e27-9f58-ad094079c230
-        reply_url: /api/v1/sources/127ce85b-2c3e-4f06-a46f-89882ecb82d0/replies/8d0b333a-082f-4c01-a4c4-5763795af7f7
+        journalist_uuid: a6e99098-ca63-403c-a76d-38530a2e88dd
+        reply_url: /api/v1/sources/c0f0153d-0cb0-4ad3-9f0e-f8540891b5c8/replies/417d50e9-6e12-4aee-b11a-4d2e2bb58cde
         seen_by:
-        - ed64b0fa-0565-4b12-9c48-6cfe27a73fd9
-        - e101e4e2-230e-4e27-9f58-ad094079c230
-        size: 1331
-        source_url: /api/v1/sources/127ce85b-2c3e-4f06-a46f-89882ecb82d0
-        uuid: 8d0b333a-082f-4c01-a4c4-5763795af7f7
-      - filename: 6-hand-to-mouth_greasewood-reply.gpg
+        - e7e047d5-aa5e-4afe-9a4f-c24e5f2cec8d
+        - a6e99098-ca63-403c-a76d-38530a2e88dd
+        size: 1174
+        source_url: /api/v1/sources/c0f0153d-0cb0-4ad3-9f0e-f8540891b5c8
+        uuid: 417d50e9-6e12-4aee-b11a-4d2e2bb58cde
+      - filename: 6-intricate_hock-reply.gpg
+        is_deleted_by_source: false
+        journalist_first_name: ''
+        journalist_last_name: ''
+        journalist_username: deleted
+        journalist_uuid: c98cd9c4-a45a-42cb-a704-9d9af34f4563
+        reply_url: /api/v1/sources/c0f0153d-0cb0-4ad3-9f0e-f8540891b5c8/replies/c8142538-e670-42dd-9126-fb67242166dd
+        seen_by:
+        - e7e047d5-aa5e-4afe-9a4f-c24e5f2cec8d
+        - c98cd9c4-a45a-42cb-a704-9d9af34f4563
+        size: 1293
+        source_url: /api/v1/sources/c0f0153d-0cb0-4ad3-9f0e-f8540891b5c8
+        uuid: c8142538-e670-42dd-9126-fb67242166dd
+      - filename: 5-generational_catchment-reply.gpg
         is_deleted_by_source: false
         journalist_first_name: ''
         journalist_last_name: ''
         journalist_username: deleted
-        journalist_uuid: b2857ac1-3765-4a3e-95d2-528209ef9525
-        reply_url: /api/v1/sources/127ce85b-2c3e-4f06-a46f-89882ecb82d0/replies/40460ca9-8d80-40d6-8181-c5175ad961cc
+        journalist_uuid: c98cd9c4-a45a-42cb-a704-9d9af34f4563
+        reply_url: /api/v1/sources/ee212060-9cd5-4031-b596-581ea15cffa0/replies/946ab2d4-a13d-4fd9-9372-e9a7aac55aca
         seen_by:
-        - ed64b0fa-0565-4b12-9c48-6cfe27a73fd9
-        - b2857ac1-3765-4a3e-95d2-528209ef9525
+        - e7e047d5-aa5e-4afe-9a4f-c24e5f2cec8d
+        - c98cd9c4-a45a-42cb-a704-9d9af34f4563
+        size: 1331
+        source_url: /api/v1/sources/ee212060-9cd5-4031-b596-581ea15cffa0
+        uuid: 946ab2d4-a13d-4fd9-9372-e9a7aac55aca
+      - filename: 6-generational_catchment-reply.gpg
+        is_deleted_by_source: false
+        journalist_first_name: ''
+        journalist_last_name: ''
+        journalist_username: dellsberg
+        journalist_uuid: a6e99098-ca63-403c-a76d-38530a2e88dd
+        reply_url: /api/v1/sources/ee212060-9cd5-4031-b596-581ea15cffa0/replies/97ad15ab-64a2-4fb9-8d26-80cf46fedfae
+        seen_by:
+        - e7e047d5-aa5e-4afe-9a4f-c24e5f2cec8d
+        - a6e99098-ca63-403c-a76d-38530a2e88dd
         size: 1237
-        source_url: /api/v1/sources/127ce85b-2c3e-4f06-a46f-89882ecb82d0
-        uuid: 40460ca9-8d80-40d6-8181-c5175ad961cc
+        source_url: /api/v1/sources/ee212060-9cd5-4031-b596-581ea15cffa0
+        uuid: 97ad15ab-64a2-4fb9-8d26-80cf46fedfae
     headers:
       connection: close
-      content-length: '1395'
+      content-length: '2745'
       content-type: application/json
-      date: Thu, 29 Feb 2024 21:13:15 GMT
+      date: Wed, 11 Dec 2024 00:37:40 GMT
       server: Werkzeug/2.2.3 Python/3.8.10
     status: 200
 - request:
@@ -99,19 +151,19 @@ interactions:
       Accept:
       - application/json
       Authorization:
-      - Token Ilhha2ZHZWpVcFZQVmpKdWJOUzJYRG1YVUc4QXZWS0JiOGVNQXJycE5GUFUi.ZeDzXQ.10ODTj49yF7kxKbeMm9eaayR3Xo
+      - Token IlAzb1p1MjRubnlLOFo0SDVaajZPc2JPZWRRcjRYRUxLM3RrUmhsUEFWVTQi.Z1jewg.4VNFOk_5HSHXhgn319zzDh9JVyg
       Content-Type:
       - application/json
     method: DELETE
-    uri: api/v1/sources/127ce85b-2c3e-4f06-a46f-89882ecb82d0/replies/8d0b333a-082f-4c01-a4c4-5763795af7f7
+    uri: api/v1/sources/c0f0153d-0cb0-4ad3-9f0e-f8540891b5c8/replies/417d50e9-6e12-4aee-b11a-4d2e2bb58cde
   response: !!python/object:securedrop_client.sdk.JSONResponse
     data:
       message: Reply deleted
     headers:
       connection: close
       content-length: '33'
       content-type: application/json
-      date: Thu, 29 Feb 2024 21:13:15 GMT
+      date: Wed, 11 Dec 2024 00:37:40 GMT
       server: Werkzeug/2.2.3 Python/3.8.10
     status: 200
 - request:
@@ -120,32 +172,58 @@ interactions:
       Accept:
       - application/json
       Authorization:
-      - Token Ilhha2ZHZWpVcFZQVmpKdWJOUzJYRG1YVUc4QXZWS0JiOGVNQXJycE5GUFUi.ZeDzXQ.10ODTj49yF7kxKbeMm9eaayR3Xo
+      - Token IlAzb1p1MjRubnlLOFo0SDVaajZPc2JPZWRRcjRYRUxLM3RrUmhsUEFWVTQi.Z1jewg.4VNFOk_5HSHXhgn319zzDh9JVyg
       Content-Type:
       - application/json
     method: GET
     uri: api/v1/replies
   response: !!python/object:securedrop_client.sdk.JSONResponse
     data:
       replies:
-      - filename: 6-hand-to-mouth_greasewood-reply.gpg
+      - filename: 6-intricate_hock-reply.gpg
         is_deleted_by_source: false
         journalist_first_name: ''
         journalist_last_name: ''
         journalist_username: deleted
-        journalist_uuid: b2857ac1-3765-4a3e-95d2-528209ef9525
-        reply_url: /api/v1/sources/127ce85b-2c3e-4f06-a46f-89882ecb82d0/replies/40460ca9-8d80-40d6-8181-c5175ad961cc
+        journalist_uuid: c98cd9c4-a45a-42cb-a704-9d9af34f4563
+        reply_url: /api/v1/sources/c0f0153d-0cb0-4ad3-9f0e-f8540891b5c8/replies/c8142538-e670-42dd-9126-fb67242166dd
+        seen_by:
+        - e7e047d5-aa5e-4afe-9a4f-c24e5f2cec8d
+        - c98cd9c4-a45a-42cb-a704-9d9af34f4563
+        size: 1293
+        source_url: /api/v1/sources/c0f0153d-0cb0-4ad3-9f0e-f8540891b5c8
+        uuid: c8142538-e670-42dd-9126-fb67242166dd
+      - filename: 5-generational_catchment-reply.gpg
+        is_deleted_by_source: false
+        journalist_first_name: ''
+        journalist_last_name: ''
+        journalist_username: deleted
+        journalist_uuid: c98cd9c4-a45a-42cb-a704-9d9af34f4563
+        reply_url: /api/v1/sources/ee212060-9cd5-4031-b596-581ea15cffa0/replies/946ab2d4-a13d-4fd9-9372-e9a7aac55aca
+        seen_by:
+        - e7e047d5-aa5e-4afe-9a4f-c24e5f2cec8d
+        - c98cd9c4-a45a-42cb-a704-9d9af34f4563
+        size: 1331
+        source_url: /api/v1/sources/ee212060-9cd5-4031-b596-581ea15cffa0
+        uuid: 946ab2d4-a13d-4fd9-9372-e9a7aac55aca
+      - filename: 6-generational_catchment-reply.gpg
+        is_deleted_by_source: false
+        journalist_first_name: ''
+        journalist_last_name: ''
+        journalist_username: dellsberg
+        journalist_uuid: a6e99098-ca63-403c-a76d-38530a2e88dd
+        reply_url: /api/v1/sources/ee212060-9cd5-4031-b596-581ea15cffa0/replies/97ad15ab-64a2-4fb9-8d26-80cf46fedfae
         seen_by:
-        - ed64b0fa-0565-4b12-9c48-6cfe27a73fd9
-        - b2857ac1-3765-4a3e-95d2-528209ef9525
+        - e7e047d5-aa5e-4afe-9a4f-c24e5f2cec8d
+        - a6e99098-ca63-403c-a76d-38530a2e88dd
         size: 1237
-        source_url: /api/v1/sources/127ce85b-2c3e-4f06-a46f-89882ecb82d0
-        uuid: 40460ca9-8d80-40d6-8181-c5175ad961cc
+        source_url: /api/v1/sources/ee212060-9cd5-4031-b596-581ea15cffa0
+        uuid: 97ad15ab-64a2-4fb9-8d26-80cf46fedfae
     headers:
       connection: close
-      content-length: '707'
+      content-length: '2067'
       content-type: application/json
-      date: Thu, 29 Feb 2024 21:13:15 GMT
+      date: Wed, 11 Dec 2024 00:37:40 GMT
       server: Werkzeug/2.2.3 Python/3.8.10
     status: 200
 version: 1