diff options
Diffstat (limited to 'jb/managers')
| -rw-r--r-- | jb/managers/amt.py | 131 | ||||
| -rw-r--r-- | jb/managers/hit.py | 3 |
2 files changed, 86 insertions, 48 deletions
diff --git a/jb/managers/amt.py b/jb/managers/amt.py index 0ec70d3..b764ffc 100644 --- a/jb/managers/amt.py +++ b/jb/managers/amt.py @@ -1,18 +1,24 @@ import logging from datetime import timezone, datetime -from typing import Tuple, Optional, List +from typing import Tuple, Optional, List, Dict, Any import botocore.exceptions -from mypy_boto3_mturk.type_defs import AssignmentTypeDef, BonusPaymentTypeDef +from mypy_boto3_mturk.type_defs import ( + AssignmentTypeDef, + BonusPaymentTypeDef, + CreateHITTypeResponseTypeDef, + GetHITResponseTypeDef, + CreateHITWithHITTypeResponseTypeDef, +) from jb.config import TOPIC_ARN -from jb.decorators import AMT_CLIENT from jb.models import AMTAccount from jb.models.assignment import Assignment from jb.models.bonus import Bonus from generalresearchutils.currency import USDCent from jb.models.definitions import HitStatus from jb.models.hit import HitType, HitQuestion, Hit +from mypy_boto3_mturk import MTurkClient REJECT_MESSAGE_UNKNOWN_ASSIGNMENT = "Unknown assignment" REJECT_MESSAGE_NO_WORK = "Assignment was submitted with no attempted work." @@ -26,10 +32,22 @@ BONUS_MESSAGE = "Great job! Bonus for a survey complete" class AMTManager: + """ + I am type annotating this more than needed (depending on the editor), + however it's only because AMT on boto3 is not intuitive... at all. + """ + + def __init__( + self, + amt_client: MTurkClient, + **kwargs, # type: ignore + ): + super().__init__(**kwargs) + self.amt_client = amt_client + + def fetch_account(self) -> AMTAccount: + res = self.amt_client.get_account_balance() - @staticmethod - def fetch_account() -> AMTAccount: - res = AMT_CLIENT.get_account_balance() return AMTAccount.model_validate( { "available_balance": res["AvailableBalance"], @@ -37,19 +55,19 @@ class AMTManager: } ) - @staticmethod - def get_hit_if_exists(amt_hit_id: str) -> Tuple[Optional[Hit], Optional[str]]: + def get_hit_if_exists(self, amt_hit_id: str) -> Tuple[Optional[Hit], Optional[str]]: try: - res = AMT_CLIENT.get_hit(HITId=amt_hit_id) - except AMT_CLIENT.exceptions.RequestError as e: + res: GetHITResponseTypeDef = self.amt_client.get_hit(HITId=amt_hit_id) + + except self.amt_client.exceptions.RequestError as e: msg = e.response.get("Error", {}).get("Message", "") return None, msg + hit = Hit.from_amt_get_hit(res["HIT"]) return hit, None - @classmethod - def get_hit_status(cls, amt_hit_id: str) -> HitStatus: - res, msg = cls.get_hit_if_exists(amt_hit_id=amt_hit_id) + def get_hit_status(self, amt_hit_id: str) -> HitStatus: + res, msg = self.get_hit_if_exists(amt_hit_id=amt_hit_id) if res is None: if msg is None: @@ -57,17 +75,23 @@ class AMTManager: if " does not exist. (" in msg: return HitStatus.Disposed + else: logging.warning(msg) return HitStatus.Unassignable return res.status - @staticmethod - def create_hit_type(hit_type: HitType): - res = AMT_CLIENT.create_hit_type(**hit_type.to_api_request_body()) # type: ignore + def create_hit_type(self, hit_type: HitType) -> HitType: + assert hit_type.amt_hit_type_id is None + + res: CreateHITTypeResponseTypeDef = self.amt_client.create_hit_type(**hit_type.to_api_request_body()) # type: ignore + hit_type.amt_hit_type_id = res["HITTypeId"] - AMT_CLIENT.update_notification_settings( + + # TODO: Assert / Check that the SNS Notification was + # successfully created. + self.amt_client.update_notification_settings( HITTypeId=hit_type.amt_hit_type_id, Notification={ "Destination": TOPIC_ARN, @@ -81,8 +105,7 @@ class AMTManager: return hit_type - @staticmethod - def create_hit_with_hit_type(hit_type: HitType, question: HitQuestion) -> Hit: + def create_hit_with_hit_type(self, hit_type: HitType, question: HitQuestion) -> Hit: """ HITTypeId: str LifetimeInSeconds: int @@ -94,27 +117,30 @@ class AMTManager: assert hit_type.amt_hit_type_id is not None data = hit_type.generate_hit_amt_request(question=question) - res = AMT_CLIENT.create_hit_with_hit_type(**data) + res: CreateHITWithHITTypeResponseTypeDef = ( + self.amt_client.create_hit_with_hit_type(**data) + ) + return Hit.from_amt_create_hit(res["HIT"], hit_type=hit_type, question=question) - @staticmethod - def get_assignment(amt_assignment_id: str) -> Assignment: + def get_assignment(self, amt_assignment_id: str) -> Assignment: """ You CANNOT get an Assignment if it has been only ACCEPTED (by the worker). The api is stupid, it will only show up once it is Submitted """ - res = AMT_CLIENT.get_assignment(AssignmentId=amt_assignment_id) + res = self.amt_client.get_assignment(AssignmentId=amt_assignment_id) ass_res: AssignmentTypeDef = res["Assignment"] assignment = Assignment.from_amt_get_assignment(ass_res) # to be clear, this has not checked whether it exists in our db assert assignment.id is None return assignment - @classmethod - def get_assignment_if_exists(cls, amt_assignment_id: str) -> Optional[Assignment]: + def get_assignment_if_exists(self, amt_assignment_id: str) -> Optional[Assignment]: expected_err_msg = f"Assignment {amt_assignment_id} does not exist" + try: - return cls.get_assignment(amt_assignment_id=amt_assignment_id) + return self.get_assignment(amt_assignment_id=amt_assignment_id) + except botocore.exceptions.ClientError as e: logging.warning(e) error_code = e.response["Error"]["Code"] @@ -123,80 +149,90 @@ class AMTManager: return None raise e - @staticmethod def reject_assignment_if_possible( - amt_assignment_id: str, msg: str = REJECT_MESSAGE_UNKNOWN_ASSIGNMENT - ): + self, amt_assignment_id: str, msg: str = REJECT_MESSAGE_UNKNOWN_ASSIGNMENT + ) -> Optional[Dict[str, Any]]: + # Unclear to me when this would fail try: - return AMT_CLIENT.reject_assignment( + return self.amt_client.reject_assignment( AssignmentId=amt_assignment_id, RequesterFeedback=msg ) + except botocore.exceptions.ClientError as e: logging.warning(e) return None - @staticmethod def approve_assignment_if_possible( + self, amt_assignment_id: str, msg: str = APPROVAL_MESSAGE, override_rejection: bool = False, - ): + ) -> Optional[Dict[str, Any]]: + # Unclear to me when this would fail try: - return AMT_CLIENT.approve_assignment( + return self.amt_client.approve_assignment( AssignmentId=amt_assignment_id, RequesterFeedback=msg, OverrideRejection=override_rejection, ) + except botocore.exceptions.ClientError as e: logging.warning(e) return None - @staticmethod - def update_hit_review_status(amt_hit_id: str, revert: bool = False) -> None: + def update_hit_review_status(self, amt_hit_id: str, revert: bool = False) -> None: try: # Reviewable to Reviewing - AMT_CLIENT.update_hit_review_status(HITId=amt_hit_id, Revert=revert) + self.amt_client.update_hit_review_status(HITId=amt_hit_id, Revert=revert) + except botocore.exceptions.ClientError as e: logging.warning(f"{amt_hit_id=}, {e}") error_msg = e.response["Error"]["Message"] + if "does not exist" in error_msg: raise ValueError(error_msg) + # elif "This HIT is currently in the state 'Reviewing'" in error_msg: # logging.warning(error_msg) return None - @staticmethod def send_bonus( + self, amt_worker_id: str, amount: USDCent, amt_assignment_id: str, reason: str, unique_request_token: str, - ): + ) -> Optional[Dict[str, Any]]: try: - return AMT_CLIENT.send_bonus( + return self.amt_client.send_bonus( WorkerId=amt_worker_id, BonusAmount=str(amount.to_usd()), AssignmentId=amt_assignment_id, Reason=reason, UniqueRequestToken=unique_request_token, ) + except botocore.exceptions.ClientError as e: logging.warning(f"{amt_worker_id=} {amt_assignment_id=}, {e}") return None - @staticmethod - def get_bonus(amt_assignment_id: str, payout_event_id: str) -> Optional[Bonus]: - res: List[BonusPaymentTypeDef] = AMT_CLIENT.list_bonus_payments( + def get_bonus( + self, amt_assignment_id: str, payout_event_id: str + ) -> Optional[Bonus]: + + res: List[BonusPaymentTypeDef] = self.amt_client.list_bonus_payments( AssignmentId=amt_assignment_id )["BonusPayments"] + assert ( len(res) <= 1 ), f"{amt_assignment_id=} Expected 1 or 0 bonuses, got {len(res)}" d = res[0] if res else None + if d: return Bonus.model_validate( { @@ -208,18 +244,19 @@ class AMTManager: "payout_event_id": payout_event_id, } ) + return None - @staticmethod - def expire_all_hits() -> None: - # used in testing only (or in an emergency I guess) + def expire_all_hits(self) -> None: + # Used in testing only (or in an emergency I guess) now = datetime.now(tz=timezone.utc) - paginator = AMT_CLIENT.get_paginator("list_hits") + paginator = self.amt_client.get_paginator("list_hits") for page in paginator.paginate(): for hit in page["HITs"]: if hit["HITStatus"] in ("Assignable", "Reviewable", "Reviewing"): - AMT_CLIENT.update_expiration_for_hit( + self.amt_client.update_expiration_for_hit( HITId=hit["HITId"], ExpireAt=now ) + return None diff --git a/jb/managers/hit.py b/jb/managers/hit.py index 7d60b63..533f45a 100644 --- a/jb/managers/hit.py +++ b/jb/managers/hit.py @@ -163,8 +163,9 @@ class HitTypeManager(PostgresManager): with conn.cursor() as c: c.execute(query, data) conn.commit() - assert c.rowcount == 1, c.rowcount + row_cnt = c.rowcount + assert row_cnt == 1, f"Expected 1 row updated, got {row_cnt}" return None |