fix: CustomCloud export, event handler & error handler (cherry picked)

Author: faretek1

scratchattach/__init__.py

@@ -1,4 +1,4 @@
-from .cloud.cloud import ScratchCloud, TwCloud, get_cloud, get_scratch_cloud, get_tw_cloud
+from .cloud.cloud import CustomCloud, ScratchCloud, TwCloud, get_cloud, get_scratch_cloud, get_tw_cloud
 from .cloud._base import BaseCloud, AnyCloud
 
 from .eventhandlers.cloud_server import init_cloud_server

scratchattach/cloud/_base.py

@@ -1,4 +1,5 @@
 from __future__ import annotations
+import traceback
 
 import json
 import ssl
@@ -9,6 +10,8 @@
 from collections.abc import Iterator
 import warnings
 
+from scratchattach.cloud import cloud as cloud_module
+
 if TYPE_CHECKING:
     from _typeshed import SupportsRead
 else:
@@ -116,7 +119,12 @@ class WebSocketEventStream(EventStream):
     reading: Lock
     def __init__(self, cloud: BaseCloud):
         super().__init__()
-        self.source_cloud = type(cloud)(project_id=cloud.project_id)
+        # NOTE: maybe consider using copy.copy here (copy.deepcopy doesn't work as you cannot deepcopy a Thread)
+        cloud_type = type(cloud)
+        if cloud_type is cloud_module.CustomCloud:
+            self.source_cloud = cloud_type(project_id=cloud.project_id, cloud_host=cloud.cloud_host)
+        else:
+            self.source_cloud = cloud_type(project_id=cloud.project_id)
         self.source_cloud._session = cloud._session
         self.source_cloud.cookie = cloud.cookie
         self.source_cloud.header = cloud.header
@@ -160,7 +168,6 @@ def read(self, amount: int = -1) -> Iterator[dict[str, Any]]:
         done = False
         # print("Getting data...")
         with self.reading:
-            # print("Getting data...", end_time is None, end_time > time.time(), end_time is None or end_time > time.time())
             while not done:
                 # print("Getting data...")
                 try:
@@ -171,11 +178,18 @@ def read(self, amount: int = -1) -> Iterator[dict[str, Any]]:
                             self.receive_new(timeout = timeout_end - time.time() if has_timeout else None)
                         if not self.packets_left:
                             continue
-                        yield json.loads(self.packets_left.pop(0))
                         i += 1
+                        yield json.loads(self.packets_left.pop(0))
                     done = True
+                except json.JSONDecodeError as e:
+                    # this could happen e.g. when the scratchattach server sends the message
+                    # "This server uses @TimMcCool's scratchattach 2.0.0"
+                    warnings.warn(f"Invalid JSON sent from server: {e}")
                 except Exception:
-                    # traceback.print_exc()
+                    # NOTE: at the very least for `except Exception`, let's print the traceback
+                    # ideally we would never even use `except Exception`. Maybe this is technical debt.
+                    # TODO: investigate what the exception we actually want to catch here
+                    traceback.print_exc()
                     self.source_cloud.reconnect()
 
     def __del__(self):

scratchattach/eventhandlers/cloud_events.py

@@ -1,17 +1,20 @@
 """CloudEvents class"""
+
 from __future__ import annotations
 
 from scratchattach.cloud import _base
 from ._base import BaseEventHandler
 from scratchattach.site import cloud_activity
 import time
-import json
+import traceback
 from collections.abc import Iterator
 
+
 class CloudEvents(BaseEventHandler):
     """
     Class that calls events when on cloud updates that are received through a websocket connection.
     """
+
     def __init__(self, cloud: _base.AnyCloud):
         super().__init__()
         self.cloud = cloud
@@ -37,34 +40,48 @@ def _updater(self):
                     self.source_stream.timeout = 1
                     for data in self.source_stream.read():
                         try:
-                            _a = cloud_activity.CloudActivity(timestamp=time.time()*1000, _session=self._session, cloud=self.cloud)
-                            if _a.timestamp < self.startup_time + 500: # catch the on_connect message sent by TurboWarp's (and sometimes Scratch's) cloud server
+                            _a = cloud_activity.CloudActivity(
+                                timestamp=time.time() * 1000,
+                                _session=self._session,
+                                cloud=self.cloud,
+                            )
+                            if (
+                                _a.timestamp < self.startup_time + 500
+                            ):  # catch the on_connect message sent by TurboWarp's (and sometimes Scratch's) cloud server
+                                # print(f"Skipped as {_a.timestamp} < {self.startup_time + 500}")
                                 continue
                             data["variable_name"] = data["name"]
                             data["name"] = data["variable_name"].replace("☁ ", "")
                             _a._update_from_dict(data)
-                            self.call_event("on_"+_a.type, [_a])
+                            # print(f"sending event {_a}")
+                            self.call_event("on_" + _a.type, [_a])
                         except Exception as e:
                             pass
             except Exception:
                 # print("CloudEvents: Disconnected. Reconnecting ...", time.time())
-                time.sleep(0.1) # cooldown
+                traceback.print_exc()  # always print blanketed exceptions!!
+                self.subsequent_reconnects += 1
+                time.sleep(0.1)  # cooldown
 
                 # print("CloudEvents: Reconnected.", time.time())
                 self.call_event("on_reconnect", [])
 
+
 class ManualCloudLogEvents:
     """
     Class that calls events on cloud updates that are received from a clouddata log.
     """
+
     def __init__(self, cloud: _base.LogCloud):
         if not isinstance(cloud, _base.LogCloud):
-            raise ValueError("Cloud log events can't be used with a cloud that has no logs available")
+            raise ValueError(
+                "Cloud log events can't be used with a cloud that has no logs available"
+            )
         self.cloud = cloud
         self.source_cloud = cloud
         self._session = cloud._session
         self.last_timestamp = 0
-    
+
     def update(self) -> Iterator[tuple[str, list[cloud_activity.CloudActivity]]]:
         """
         Update once and yield all packets
@@ -75,19 +92,22 @@ def update(self) -> Iterator[tuple[str, list[cloud_activity.CloudActivity]]]:
                 if _a.timestamp <= self.last_timestamp:
                     continue
                 self.last_timestamp = _a.timestamp
-                yield ("on_"+_a.type, [_a])
+                yield ("on_" + _a.type, [_a])
         except Exception:
             pass
-        
+
 
 class CloudLogEvents(BaseEventHandler):
     """
     Class that calls events on cloud updates that are received from a clouddata log.
     """
+
     def __init__(self, cloud: _base.LogCloud, *, update_interval=0.1):
         super().__init__()
         if not isinstance(cloud, _base.LogCloud):
-            raise ValueError("Cloud log events can't be used with a cloud that has no logs available")
+            raise ValueError(
+                "Cloud log events can't be used with a cloud that has no logs available"
+            )
         self.cloud = cloud
         self.source_cloud = cloud
         self.update_interval = update_interval