[FIX] - catch missing orgbook entity and improve logging (#3301)

* data typing issues and clean up

* better logging

* better logging of errors

* list of tuples

* add celery decorator

* rename var to match envvar

* credential per mine_party_appt produces duplicates.

* wrong class

* don't invoke if being used by celery

* query must excluded deleted permit_amendments

* add check if cred not created

* improve logging of problem states

* make date a date, formatting

* revered received date, update issue_Date validator

* all datetimes, never dates

* typo

* names are important

* only use datetime objects, no date objects

* better typing

ensure factory is producing a datetime and not a date

* ensure second is non-zero for datetime

* oops

* brackets matter

* what is happening?

* scoping

* factories making dates, should be datetimes.

i have no idea anymore

* idk why that today generator suck

* pass callable

* what

* use jank

* use work

* huh?

* typing dates as dates. some db columns are dates, others aren'

* dates

* handling incoming datetime for date column

* probably failing on date comparison

* type hinting is good

* clean up logging

* columns are dates

* received date is parsed to datetime

* expand on type hinting

* pass function, not value

Author: Jsyro

services/core-api/app/api/mines/permits/permit/models/permit.py

@@ -32,8 +32,8 @@ class Permit(SoftDeleteMixin, AuditMixin, Base):
     status_changed_timestamp = db.Column(db.DateTime)
     project_id = db.Column(db.String)
 
-    #if true, this permit is locked from any vc'ed issued for it. 
-    mines_act_permit_vc_locked = db.Column(db.Boolean, default=False) 
+    #if true, this permit is locked from any vc'ed issued for it.
+    mines_act_permit_vc_locked = db.Column(db.Boolean, default=False)
 
     _all_permit_amendments = db.relationship(
         'PermitAmendment',
@@ -43,7 +43,12 @@ class Permit(SoftDeleteMixin, AuditMixin, Base):
         order_by='desc(PermitAmendment.issue_date), desc(PermitAmendment.permit_amendment_id)',
         lazy='select')
 
-    _all_mines = db.relationship('Mine', lazy='select', secondary='mine_permit_xref', back_populates='_permit_identities', overlaps='mine,mine_permit_xref,all_mine_permit_xref')
+    _all_mines = db.relationship(
+        'Mine',
+        lazy='select',
+        secondary='mine_permit_xref',
+        back_populates='_permit_identities',
+        overlaps='mine,mine_permit_xref,all_mine_permit_xref')
 
     permittee_appointments = db.relationship(
         'MinePartyAppointment',
@@ -66,8 +71,13 @@ class Permit(SoftDeleteMixin, AuditMixin, Base):
     is_exploration = db.Column(db.Boolean)
 
     bonds = db.relationship(
-        'Bond', lazy='select', secondary='bond_permit_xref', order_by='desc(Bond.issue_date)', back_populates='permit')
-    reclamation_invoices = db.relationship('ReclamationInvoice', lazy='select', back_populates='permit')
+        'Bond',
+        lazy='select',
+        secondary='bond_permit_xref',
+        order_by='desc(Bond.issue_date)',
+        back_populates='permit')
+    reclamation_invoices = db.relationship(
+        'ReclamationInvoice', lazy='select', back_populates='permit')
     exemption_fee_status_code = db.Column(
         db.String, db.ForeignKey('exemption_fee_status.exemption_fee_status_code'))
     exemption_fee_status_note = db.Column(db.String)
@@ -77,7 +87,8 @@ class Permit(SoftDeleteMixin, AuditMixin, Base):
         lazy='select',
         primaryjoin='and_(Permit.permit_guid == MineType.permit_guid, MineType.active_ind==True)')
 
-    _mine_associations = db.relationship('MinePermitXref', overlaps='_all_mines,all_mine_permit_xref,mine_permit_xref')
+    _mine_associations = db.relationship(
+        'MinePermitXref', overlaps='_all_mines,all_mine_permit_xref,mine_permit_xref')
 
     # Liability on permit after permit is closed
     remaining_static_liability = db.Column(db.Numeric(16, 2))
@@ -113,7 +124,7 @@ def current_permittee_digital_wallet_connection_state(self):
             return ""
 
     @hybrid_property
-    def permit_amendments(self):
+    def permit_amendments(self) -> list[PermitAmendment]:
         if not self._context_mine:
             raise Exception('this getter is only available if _context_mine has been set')
         return [
@@ -171,55 +182,55 @@ def delete(self):
         super(Permit, self).delete()
 
     @classmethod
-    def find_by_permit_guid(cls, _id, mine_guid=None):
+    def find_by_permit_guid(cls, _id, mine_guid=None) -> "Permit":
         pmt = cls.query.filter_by(permit_guid=_id, deleted_ind=False).first()
         if pmt and mine_guid:
             pmt._context_mine = [m for m in pmt._all_mines if str(m.mine_guid) == str(mine_guid)][0]
         return pmt
 
     @classmethod
-    def find_by_permit_id(cls, _id):
+    def find_by_permit_id(cls, _id) -> "Permit":
         return cls.query.filter_by(permit_id=_id, deleted_ind=False).first()
 
     @classmethod
-    def find_by_mine_guid(cls, _id):
+    def find_by_mine_guid(cls, _id) -> list["Permit"]:
         return cls.query.filter_by(
             mine_guid=_id, deleted_ind=False).filter(cls.permit_status_code != 'D').all()
 
     @classmethod
-    def find_by_permit_no(cls, _permit_no):
+    def find_by_permit_no(cls, _permit_no) -> "Permit":
         return cls.query.filter_by(
             permit_no=_permit_no, deleted_ind=False).filter(cls.permit_status_code != 'D').first()
 
     @classmethod
-    def find_by_permit_no_deleted_in_draft(cls, _permit_no):
+    def find_by_permit_no_deleted_in_draft(cls, _permit_no) -> "Permit":
         return cls.query.filter(
             and_(
                 cls.permit_no.like(_permit_no + '%'), cls.deleted_ind == True,
                 cls.permit_status_code == 'D')).order_by(cls.permit_id.desc()).first()
 
     @classmethod
-    def find_by_permit_no_all(cls, _permit_no):
+    def find_by_permit_no_all(cls, _permit_no) -> list["Permit"]:
         return cls.query.filter_by(
             permit_no=_permit_no, deleted_ind=False).filter(cls.permit_status_code != 'D').all()
 
     @classmethod
-    def find_by_permit_guid_or_no(cls, _permit_guid_or_no):
+    def find_by_permit_guid_or_no(cls, _permit_guid_or_no) -> "Permit":
         result = cls.find_by_permit_guid(_permit_guid_or_no)
         if not result:
             result = cls.find_by_permit_no(_permit_guid_or_no)
         return result
 
     @classmethod
-    def find_by_now_application_guid(cls, _now_application_guid):
+    def find_by_now_application_guid(cls, _now_application_guid) -> "Permit":
         permit_amendment = PermitAmendment.find_by_now_application_guid(_now_application_guid)
         if permit_amendment is not None:
             permit = Permit.find_by_permit_id(permit_amendment.permit_id)
             permit._context_mine = permit_amendment.mine
             return permit
         return None
 
-    def assign_permit_no(self, notice_of_work_type_code):
+    def assign_permit_no(self, notice_of_work_type_code) -> None:
         permit_prefix = notice_of_work_type_code if notice_of_work_type_code != 'S' else 'G'
         if permit_prefix in ['M', 'C'] and self.is_exploration:
             permit_prefix = permit_prefix + 'X'
@@ -292,4 +303,4 @@ def validate_exemption_fee_status(cls,
                     or mine_tenure_type_code == "PRL") and exemption_fee_status_code != 'MIP':
                 raise AssertionError('Exemption fee should be "Pits/Quarry" for this permit')
 
-        return exemption_fee_status_code
+        return exemption_fee_status_code

services/core-api/app/api/mines/permits/permit_amendment/models/permit_amendment.py

@@ -1,13 +1,12 @@
 import uuid
 from datetime import date, datetime
+from typing import Union
 
 from app.api.constants import *
 from app.api.mines.permits.permit_amendment.models.permit_amendment_document import (
-    PermitAmendmentDocument,
-)
+    PermitAmendmentDocument, )
 from app.api.mines.permits.permit_conditions.models.permit_conditions import (
-    PermitConditions,
-)
+    PermitConditions, )
 from app.api.utils.models_mixins import AuditMixin, Base, SoftDeleteMixin
 from app.api.verifiable_credentials.aries_constants import IssueCredentialIssuerState
 from app.extensions import db
@@ -29,9 +28,9 @@ class PermitAmendment(SoftDeleteMixin, AuditMixin, Base):
     mine_guid = db.Column(UUID(as_uuid=True), db.ForeignKey('mine.mine_guid'), nullable=False)
     permit_amendment_guid = db.Column(UUID(as_uuid=True), server_default=FetchedValue())
     permit_id = db.Column(db.Integer, db.ForeignKey('permit.permit_id'), nullable=False)
-    received_date = db.Column(db.DateTime, nullable=False)
-    issue_date: date = db.Column(db.DateTime, nullable=False)
-    authorization_end_date = db.Column(db.DateTime, nullable=False)
+    received_date: date = db.Column(db.Date, nullable=False)          # db column is date
+    issue_date: date = db.Column(db.Date, nullable=False)             # db column is date
+    authorization_end_date: date = db.Column(db.Date, nullable=False) # db column is date
     permit_amendment_status_code = db.Column(
         db.String(3), db.ForeignKey('permit_amendment_status_code.permit_amendment_status_code'))
     permit_amendment_type_code = db.Column(
@@ -294,18 +293,21 @@ def validate_received_date(self, key, received_date):
         return received_date
 
     @validates('issue_date')
-    def validate_issue_date(self, key, issue_date):
+    def validate_issue_date(self, key, issue_date: Union[date, datetime]) -> date:
         # TODO DO NOT REMOVE NEXT LINE. If this validation removed then exception will be thrown on permit creation/editing:
         # "permit_amendment" violates foreign key constraint "permit_amendment_mine_permit_xref_mine_guid_permit_no_fk"
         # DETAIL:  Key (mine_guid, permit_id)=(28966bf7-8e65-4cc4-b077-b248b6a136ef, 212) is not present in table "mine_permit_xref".
         original_permit_amendment = self.query.filter_by(permit_id=self.permit_id).filter_by(
             permit_amendment_type_code='OGP').first()
 
+        if isinstance(issue_date, datetime):
+            issue_date = issue_date.date()
+
         if issue_date:
             if issue_date.isoformat() == '9999-12-31':
                 raise AssertionError(
                     'Permit amendment issue date should be set to null if not known.')
-            if self.permit_amendment_status_code != 'DFT' and issue_date > datetime.today():
+            if self.permit_amendment_status_code != 'DFT' and issue_date > date.today():
                 raise AssertionError('Permit amendment issue date cannot be set to the future.')
         return issue_date