28703 ppr search cc payment (#2164)

* PPR API search cc payment changes.

Signed-off-by: Doug Lovett <doug@diamante.ca>

* MHR API search by org name bug fix.

Signed-off-by: Doug Lovett <doug@diamante.ca>

---------

Signed-off-by: Doug Lovett <doug@diamante.ca>

Author: doug-lovett

mhr-api/src/database/postgres_views/mhr_search_owner_bus_vw.py

@@ -35,6 +35,7 @@
      AND og.registration_id = p.registration_id
      AND p.owner_group_id = og.id
      AND p.party_type IN ('EXECUTOR', 'TRUSTEE', 'ADMINISTRATOR', 'TRUST', 'OWNER_BUS')
+     AND p.business_name IS NOT NULL
      AND r.mhr_number = rl.mhr_number
      AND r.mhr_number = rd.mhr_number
      AND rl.id = l.registration_id

mhr-api/src/database/postgres_views/mhr_search_owner_ind_vw.py

@@ -37,6 +37,7 @@
      AND og.registration_id = p.registration_id
      AND p.party_type IN ('EXECUTOR', 'TRUSTEE', 'ADMINISTRATOR', 'TRUST', 'OWNER_IND')
      AND p.owner_group_id = og.id
+     AND p.last_name IS NOT NULL
      AND r.mhr_number = rl.mhr_number
      AND r.mhr_number = rd.mhr_number
      AND rl.id = l.registration_id

ppr-api/src/ppr_api/models/search_request.py

@@ -35,6 +35,7 @@
 # Async search report status pending.
 REPORT_STATUS_PENDING = "PENDING"
 CHARACTER_SET_UNSUPPORTED = "The search name {} charcter set is not supported.\n"
+PAY_PENDING: int = 1000
 
 
 class SearchRequest(db.Model):  # pylint: disable=too-many-instance-attributes
@@ -92,15 +93,17 @@ def json(self) -> dict:
             "maxResultsSize": search_utils.SEARCH_RESULTS_MAX_SIZE,
             "searchQuery": self.search_criteria,
         }
-        if self.updated_selection:
+        if self.search_result and self.search_result.is_payment_pending():
+            result["paymentPending"] = True
+            result["results"] = []
+        elif self.updated_selection:
             result["results"] = self.updated_selection
         elif self.search_response:
             result["results"] = self.search_response
 
         if self.pay_invoice_id and self.pay_path:
             payment = {"invoiceId": str(self.pay_invoice_id), "receipt": self.pay_path}
             result["payment"] = payment
-
         return result
 
     def save(self):
@@ -418,7 +421,11 @@ def find_all_by_account_id(
                         # if api_result is null then the selections have not been finished
                         search["inProgress"] = not row[11] and row[11] != [] and search["totalResultsSize"] > 0
                         search["userId"] = str(row[12])
-                        if not search.get("inProgress") and (row[8] or model_utils.report_retry_elapsed(search_ts)):
+                        if row[13] and int(row[13]) == PAY_PENDING:
+                            search["paymentPending"] = True
+                            search["invoiceId"] = str(row[14]) if row[14] else ""
+                            search["reportAvailable"] = False
+                        elif not search.get("inProgress") and (row[8] or model_utils.report_retry_elapsed(search_ts)):
                             search["reportAvailable"] = True
                         else:
                             search["reportAvailable"] = False

ppr-api/src/ppr_api/models/search_result.py

@@ -34,6 +34,7 @@
 SCORE_LARGE_REPORT: int = 999
 LARGE_REPORT_REG_COUNT: int = 400
 LARGE_REPORT_JSON_SIZE: int = 1024000
+SCORE_PAY_PENDING: int = 1000
 
 
 class SearchResult(db.Model):  # pylint: disable=too-many-instance-attributes
@@ -76,6 +77,10 @@ def json(self) -> dict:
                 result["selected"] = self.search_select
         return result
 
+    def is_payment_pending(self):
+        """Evaluate if search results are waiting on payment completion."""
+        return self.score and self.score == SCORE_PAY_PENDING
+
     def save(self):
         """Render a search results detail information to the local cache."""
         try:

ppr-api/src/ppr_api/models/search_utils.py

@@ -313,7 +313,7 @@
                        ELSE '' END
              FROM users u WHERE u.username = sc.user_id FETCH FIRST 1 ROWS ONLY)
       END) AS username,
-  sr.api_result, sc.user_id
+  sr.api_result, sc.user_id, sr.score, sc.pay_invoice_id
 FROM search_requests sc, search_results sr
 WHERE sc.id = sr.search_id
   AND sc.account_id = '?'
@@ -347,7 +347,7 @@
                        ELSE '' END
              FROM users u WHERE u.username = sc.user_id FETCH FIRST 1 ROWS ONLY)
       END) AS username,
-  sr.api_result, sc.user_id
+  sr.api_result, sc.user_id, sr.score, sc.pay_invoice_id
 FROM search_requests sc, search_results sr
 WHERE sc.id = sr.search_id
   AND sc.account_id = '?'
@@ -379,7 +379,7 @@
                        ELSE '' END
              FROM users u WHERE u.username = sc.user_id FETCH FIRST 1 ROWS ONLY)
       END) AS username,
-  sr.api_result, sc.user_id
+  sr.api_result, sc.user_id, sr.score, sc.pay_invoice_id
 FROM search_requests sc, search_results sr
 WHERE sc.id = sr.search_id
   AND sc.account_id = '?'
@@ -412,7 +412,7 @@
                        ELSE '' END
              FROM users u WHERE u.username = sc.user_id FETCH FIRST 1 ROWS ONLY)
       END) AS username,
-  sr.api_result, sc.user_id
+  sr.api_result, sc.user_id, sr.score, sc.pay_invoice_id
 FROM search_requests sc, search_results sr
 WHERE sc.id = sr.search_id
   AND sc.account_id = '?'

ppr-api/src/ppr_api/resources/cc_payment_utils.py

@@ -59,6 +59,7 @@
     "11S": "11S: staff search credit card payment set up complete for invoice id={invoice_id}.",
     "13": "13: credit card payment update error no search found for invoice id={invoice_id}.",
     "14": "14: credit card payment update error search no pending payment for invoice id={invoice_id}.",
+    "15": "15: search selection allowed for invoice id={invoice_id}.",
 }
 
 

ppr-api/src/ppr_api/resources/v1/callbacks.py

@@ -21,7 +21,7 @@
 from ppr_api.callback.document_storage.storage_service import DocumentTypes, GoogleStorageService
 from ppr_api.callback.utils.exceptions import ReportDataException, ReportException, StorageException
 from ppr_api.exceptions import DatabaseException
-from ppr_api.models import Draft, FinancingStatement, MailReport, Registration
+from ppr_api.models import Draft, EventTracking, FinancingStatement, MailReport, Registration, SearchResult
 from ppr_api.models import utils as model_utils
 from ppr_api.reports import get_callback_pdf
 from ppr_api.reports.v2.report_utils import ReportTypes
@@ -39,6 +39,7 @@
 PAY_CANCELLED_MSG = "Payment status cancelled/deleted: draft reverted."
 PAY_NO_REG_MSG = "Change no financing statement found for base reg num={reg_num}."
 PAY_REG_SUCCESS_MSG = "Registration created fs id={fs_id} reg_id={reg_id} reg num={reg_num}."
+PAY_SEARCH_SUCCESS_MSG = "Search selection allowed for search id={search_id}."
 ALLOWED_PAY_STATUS = [
     StatusCodes.CANCELLED.value,
     StatusCodes.COMPLETED.value,
@@ -151,6 +152,11 @@ def post_payment_callback(invoice_id: str):  # pylint: disable=too-many-return-s
         elif pay_status not in ALLOWED_PAY_STATUS:
             error_msg: str = PAY_STATUS_INVALID_MSG.format(pay_status=pay_status)
             return pay_callback_error("02", invoice_id, HTTPStatus.BAD_REQUEST, error_msg)
+
+        search_id: int = get_search_id(invoice_id)
+        if search_id and search_id > 0:
+            return pay_callback_search(search_id, invoice_id)
+
         draft: Draft = Draft.find_by_invoice_id(invoice_id)
         if not draft:
             return pay_callback_error("03", invoice_id, HTTPStatus.NOT_FOUND)
@@ -171,6 +177,40 @@ def post_payment_callback(invoice_id: str):  # pylint: disable=too-many-return-s
         return pay_callback_error("00", invoice_id, HTTPStatus.INTERNAL_SERVER_ERROR, str(default_err))
 
 
+def get_search_id(invoice_id: str):
+    """Try to get the search id if the payment is for a search request."""
+    events = EventTracking.find_by_key_id(int(invoice_id))
+    if not events:
+        return None
+    for event in events:
+        if event.event_tracking_type == EventTracking.EventTrackingTypes.PPR_PAYMENT.value and event.message:
+            message: str = str(event.message)
+            if message.startswith("11"):
+                tokens = message.split("*")
+                if tokens and len(tokens) > 1:
+                    search_id = int(tokens[1])
+                    logger.info(f"get_search_id found id={search_id}")
+                    return search_id
+    return None
+
+
+def pay_callback_search(search_id: int, invoice_id: str):
+    """Handle a payment complete notification for a search request."""
+    search_result: SearchResult = SearchResult.find_by_search_id(search_id)
+    if not search_result:
+        return pay_callback_error("13", invoice_id, HTTPStatus.NOT_FOUND)
+    if not search_result.is_payment_pending():
+        return pay_callback_error("14", invoice_id, HTTPStatus.BAD_REQUEST, f"Search id={search_id}")
+    logger.info(f"Request valid for invoice id={invoice_id} search id={search_id}, marking search as completed.")
+    cc_payment_utils.track_event("09", invoice_id, HTTPStatus.OK, f"Search id={search_id}")
+    search_result.score = None
+    search_result.save()
+    logger.info(f"Search pending payment status removed for {search_id}.")
+    msg = PAY_SEARCH_SUCCESS_MSG.format(search_id=search_id)
+    cc_payment_utils.track_event("15", invoice_id, HTTPStatus.OK, msg)
+    return {}, HTTPStatus.OK
+
+
 def pay_callback_error(code: str, key_id: int, status_code, message: str = None):
     """Return the payment event listener callback error response based on the code."""
     error: str = cc_payment_utils.track_event(code, key_id, status_code, message)