From c6115946ac9b698449051a6283041c473a97a069 Mon Sep 17 00:00:00 2001
From: Tobias Veselsky <veselsky@tu-berlin.de>
Date: Wed, 29 Jan 2025 20:35:40 +0100
Subject: [PATCH] fix: Handle skipped timeline details properly to avoid script
 getting stuck after recent pull request adding support for
 UnsupportedEventError

---
 pytr/dl.py       |  2 ++
 pytr/timeline.py | 56 ++++++++++++++++++++++++++++--------------------
 2 files changed, 35 insertions(+), 23 deletions(-)

diff --git a/pytr/dl.py b/pytr/dl.py
index b89542f..6d8ed31 100644
--- a/pytr/dl.py
+++ b/pytr/dl.py
@@ -86,6 +86,8 @@ async def dl_loop(self):
                     self.tl.process_timelineDetail(response, self)
                 except UnsupportedEventError:
                     self.log.warning("Ignoring unsupported event %s", response)
+                    self.tl.skipped_detail += 1
+                    self.tl.check_if_done(self)
             else:
                 self.log.warning(
                     f"unmatched subscription of type '{subscription['type']}':\n{preview(response)}"
diff --git a/pytr/timeline.py b/pytr/timeline.py
index 12fe8b2..2d897c3 100644
--- a/pytr/timeline.py
+++ b/pytr/timeline.py
@@ -15,6 +15,7 @@ def __init__(self, tr, max_age_timestamp):
         self.log = get_logger(__name__)
         self.received_detail = 0
         self.requested_detail = 0
+        self.skipped_detail = 0
         self.events_without_docs = []
         self.events_with_docs = []
         self.num_timelines = 0
@@ -177,29 +178,38 @@ def process_timelineDetail(self, response, dl):
         else:
             self.events_without_docs.append(event)
 
-        if self.received_detail == self.requested_detail:
-            self.log.info("Received all details")
-            dl.output_path.mkdir(parents=True, exist_ok=True)
-            with open(dl.output_path / "other_events.json", "w", encoding="utf-8") as f:
-                json.dump(self.events_without_docs, f, ensure_ascii=False, indent=2)
-
-            with open(
-                dl.output_path / "events_with_documents.json", "w", encoding="utf-8"
-            ) as f:
-                json.dump(self.events_with_docs, f, ensure_ascii=False, indent=2)
-
-            with open(dl.output_path / "all_events.json", "w", encoding="utf-8") as f:
-                json.dump(
-                    self.events_without_docs + self.events_with_docs,
-                    f,
-                    ensure_ascii=False,
-                    indent=2,
-                )
+        self.check_if_done(dl)
+
+    def check_if_done(self, dl):
+        if (self.received_detail + self.skipped_detail) == self.requested_detail:
+            self.finish_timeline_details(dl)
+
+    def finish_timeline_details(self, dl):
+        self.log.info("Received all details")
+        if self.skipped_detail > 0:
+            self.log.warning(f"Skipped {self.skipped_detail} unsupported events")
+
+        dl.output_path.mkdir(parents=True, exist_ok=True)
+        with open(dl.output_path / "other_events.json", "w", encoding="utf-8") as f:
+            json.dump(self.events_without_docs, f, ensure_ascii=False, indent=2)
 
-            export_transactions(
-                dl.output_path / "all_events.json",
-                dl.output_path / "account_transactions.csv",
-                sort=dl.sort_export,
+        with open(
+            dl.output_path / "events_with_documents.json", "w", encoding="utf-8"
+        ) as f:
+            json.dump(self.events_with_docs, f, ensure_ascii=False, indent=2)
+
+        with open(dl.output_path / "all_events.json", "w", encoding="utf-8") as f:
+            json.dump(
+                self.events_without_docs + self.events_with_docs,
+                f,
+                ensure_ascii=False,
+                indent=2,
             )
 
-            dl.work_responses()
+        export_transactions(
+            dl.output_path / "all_events.json",
+            dl.output_path / "account_transactions.csv",
+            sort=dl.sort_export,
+        )
+
+        dl.work_responses()