mirror of
https://github.com/aljazceru/python-teos.git
synced 2025-12-17 14:14:22 +01:00
2cdd78b8e6
We were passing some unnecessary parameters to the Cleaner (locator) that could be derived from other data (uuid and appointments). Also standarises the order of the parameters to match the rest of the methods
123 lines
5.2 KiB
Python
123 lines
5.2 KiB
Python
from pisa.logger import Logger
|
|
|
|
logger = Logger("Cleaner")
|
|
|
|
|
|
class Cleaner:
|
|
"""
|
|
The ``Cleaner`` is the class in charge of removing expired / completed data from the tower.
|
|
|
|
Mutable objects (like dicts) are passed-by-reference in Python, so no return is needed for the Cleaner.
|
|
"""
|
|
|
|
@staticmethod
|
|
def delete_expired_appointment(expired_appointments, appointments, locator_uuid_map, db_manager):
|
|
"""
|
|
Deletes appointments which ``end_time`` has been reached (with no trigger) both from memory
|
|
(:mod:`Watcher <pisa.watcher>`) and disk.
|
|
|
|
Args:
|
|
expired_appointments (list): a list of appointments to be deleted.
|
|
appointments (dict): a dictionary containing all the :mod:`Watcher <pisa.watcher>` appointments.
|
|
locator_uuid_map (dict): a ``locator:uuid`` map for the :mod:`Watcher <pisa.watcher>` appointments.
|
|
db_manager (DBManager): a :mod:`DBManager <pisa.db_manager>` instance to interact with the database.
|
|
"""
|
|
|
|
for uuid in expired_appointments:
|
|
locator = appointments[uuid].locator
|
|
|
|
appointments.pop(uuid)
|
|
|
|
if len(locator_uuid_map[locator]) == 1:
|
|
locator_uuid_map.pop(locator)
|
|
|
|
else:
|
|
locator_uuid_map[locator].remove(uuid)
|
|
|
|
logger.info("End time reached with no match. Deleting appointment.", locator=locator, uuid=uuid)
|
|
|
|
# Delete appointment from the db
|
|
db_manager.delete_watcher_appointment(uuid)
|
|
|
|
@staticmethod
|
|
def delete_completed_appointment(uuid, appointments, locator_uuid_map, db_manager):
|
|
"""
|
|
Deletes a triggered appointment from memory (:mod:`Watcher <pisa.watcher>`) and flags it as triggered in disk.
|
|
|
|
Args:
|
|
uuid (str): a unique 16-byte hex-encoded str that identifies the appointment.
|
|
appointments (dict): a dictionary containing all the :mod:`Watcher <pisa.watcher>` appointments.
|
|
locator_uuid_map (dict): a ``locator:uuid`` map for the :mod:`Watcher <pisa.watcher>` appointments.
|
|
db_manager (DBManager): a :mod:`DBManager <pisa.db_manager>` instance to interact with the database.
|
|
"""
|
|
|
|
# Delete the appointment
|
|
appointment = appointments.pop(uuid)
|
|
|
|
# If there was only one appointment that matches the locator we can delete the whole list
|
|
if len(locator_uuid_map[appointment.locator]) == 1:
|
|
locator_uuid_map.pop(appointment.locator)
|
|
else:
|
|
# Otherwise we just delete the appointment that matches locator:appointment_pos
|
|
locator_uuid_map[appointment.locator].remove(uuid)
|
|
|
|
# DISCUSS: instead of deleting the appointment, we will mark it as triggered and delete it from both
|
|
# the watcher's and responder's db after fulfilled
|
|
# Update appointment in the db
|
|
db_manager.store_watcher_appointment(uuid, appointment.to_json(triggered=True))
|
|
|
|
@staticmethod
|
|
def delete_completed_jobs(completed_jobs, height, jobs, tx_job_map, db_manager):
|
|
"""
|
|
Deletes a completed job both from memory (:mod:`Responder <pisa.responder>`) and disk (from the
|
|
:mod:`Responder <pisa.responder>` and :mod:`Watcher <pisa.watcher>` databases).
|
|
|
|
Args:
|
|
jobs (dict): a dictionary containing all the :mod:`Responder <pisa.responder>` jobs.
|
|
tx_job_map (dict): a ``penalty_txid:uuid`` map for the :mod:`Responder <pisa.responder>` jobs.
|
|
completed_jobs (list): a list of completed jobs to be deleted.
|
|
height (int): the block height at which the jobs were completed.
|
|
db_manager (DBManager): a :mod:`DBManager <pisa.db_manager>` instance to interact with the database.
|
|
"""
|
|
|
|
for uuid, confirmations in completed_jobs:
|
|
logger.info(
|
|
"Job completed. Appointment ended after reaching enough confirmations.",
|
|
uuid=uuid,
|
|
height=height,
|
|
confirmations=confirmations,
|
|
)
|
|
|
|
justice_txid = jobs[uuid].justice_txid
|
|
locator = jobs[uuid].locator
|
|
jobs.pop(uuid)
|
|
|
|
if len(tx_job_map[justice_txid]) == 1:
|
|
tx_job_map.pop(justice_txid)
|
|
|
|
logger.info("No more jobs for justice transaction.", justice_txid=justice_txid)
|
|
|
|
else:
|
|
tx_job_map[justice_txid].remove(uuid)
|
|
|
|
# Delete appointment from the db (both watchers's and responder's)
|
|
db_manager.delete_watcher_appointment(uuid)
|
|
db_manager.delete_responder_job(uuid)
|
|
|
|
# Update / delete the locator map
|
|
locator_map = db_manager.load_locator_map(locator)
|
|
if locator_map is not None:
|
|
if uuid in locator_map:
|
|
if len(locator_map) == 1:
|
|
db_manager.delete_locator_map(locator)
|
|
|
|
else:
|
|
locator_map.remove(uuid)
|
|
db_manager.store_update_locator_map(locator, locator_map)
|
|
|
|
else:
|
|
logger.error("UUID not found in the db.", uuid=uuid)
|
|
|
|
else:
|
|
logger.error("Locator not found in the db.", uuid=uuid)
|