sws-api-client 3.1.0__tar.gz → 3.2.0__tar.gz

{sws_api_client-3.1.0 → sws_api_client-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: sws_api_client
-Version: 3.1.0
+Version: 3.2.0
 Author-email: Matteo <matteo.terrinoni@fao.org>, Daniele <daniele.mansillo@fao.org>, Luca <luca.simi@fao.org>
 License-File: LICENSE
 Requires-Python: <4,>=3.10
@@ -235,3 +235,10 @@ The `main` branch is the production branch. Any commit to the main branch will c
 
 ### Release
 Migrated to github test 6
+
+### Harvest attempt correlation
+
+Pass the CM event file entry’s `attemptId` as `attempt_id=` to `claim_harvest`,
+`heartbeat_harvest` and `complete_harvest`. Keep that identity through success and failure;
+never look up the file’s newest attempt to complete an older run. Omitting the argument preserves
+the request body used by legacy events.

{sws_api_client-3.1.0 → sws_api_client-3.2.0}/README.md

@@ -221,3 +221,10 @@ The `main` branch is the production branch. Any commit to the main branch will c
 
 ### Release
 Migrated to github test 6
+
+### Harvest attempt correlation
+
+Pass the CM event file entry’s `attemptId` as `attempt_id=` to `claim_harvest`,
+`heartbeat_harvest` and `complete_harvest`. Keep that identity through success and failure;
+never look up the file’s newest attempt to complete an older run. Omitting the argument preserves
+the request body used by legacy events.

{sws_api_client-3.1.0 → sws_api_client-3.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sws_api_client"
-version = "3.1.0"
+version = "3.2.0"
 description = ""
 authors = [
     { name = "Matteo", email = "matteo.terrinoni@fao.org" },

{sws_api_client-3.1.0 → sws_api_client-3.2.0}/sws_api_client/__init__.py

@@ -58,4 +58,4 @@ from .tasks import PluginPayload, TaskDataset, TaskInfo, TaskManager, TaskRespon
 from .users import User, Users
 from .harvester import Harvester
 
-__version__ = "3.1.0"
+__version__ = "3.2.0"

{sws_api_client-3.1.0 → sws_api_client-3.2.0}/sws_api_client/campaign_manager.py

@@ -568,13 +568,16 @@ class CampaignManager:
         file_id: Union[int, str],
         task_id: str,
         expires_at: Optional[str] = None,
+        *,
+        attempt_id: Optional[str] = None,
     ) -> Dict[str, Any]:
-        """Take the job of putting this questionnaire's data into SWS."""
+        """Claim the event's harvest attempt; omit attempt_id only for legacy events."""
         return self._call(
             "POST",
             f"/api/v1/files/{file_id}/harvest/processing",
             params={"teamId": team_id},
-            json_body={"taskId": task_id, "expiresAt": expires_at},
+            json_body={"taskId": task_id, "expiresAt": expires_at,
+                       **({"attemptId": attempt_id} if attempt_id is not None else {})},
         )
 
     def heartbeat_harvest(
@@ -583,13 +586,16 @@ class CampaignManager:
         file_id: Union[int, str],
         expires_at: str,
         reason: Optional[str] = None,
+        *,
+        attempt_id: Optional[str] = None,
     ) -> Dict[str, Any]:
-        """Still alive — see :meth:`heartbeat_validation`."""
+        """Keep the same harvest attempt alive — see :meth:`heartbeat_validation`."""
         return self._call(
             "PUT",
             f"/api/v1/files/{file_id}/harvest/status",
             params={"teamId": team_id},
-            json_body={"status": "PENDING", "reason": reason, "expiresAt": expires_at},
+            json_body={"status": "PENDING", "reason": reason, "expiresAt": expires_at,
+                       **({"attemptId": attempt_id} if attempt_id is not None else {})},
         )
 
     def complete_harvest(
@@ -600,9 +606,13 @@ class CampaignManager:
         reason: Optional[str] = None,
         result: Optional[Dict[str, Any]] = None,
         outputs: Optional[List["RunOutput"]] = None,
+        *,
+        attempt_id: Optional[str] = None,
     ) -> Dict[str, Any]:
         """How taking the data in went — and where it went.
 
+        ``attempt_id`` identifies the original request even if another harvest has started.
+
         Harvesting is the one verb whose output is not a file: the data lands inside SWS. So the
         result travels with the outcome (``{"rows": …, "dataset": …, "session": …}``, or whatever the
         harvester can say), because without it the platform records that something was taken in and
@@ -613,6 +623,7 @@ class CampaignManager:
             f"/api/v1/files/{file_id}/harvest/complete",
             params={"teamId": team_id},
             json_body={
+                **({"attemptId": attempt_id} if attempt_id is not None else {}),
                 "outcome": outcome,
                 "reason": reason,
                 "result": result,