Update tests and add comments

wagtail · Oct 23, 2021 · 25938cc · 25938cc
1 parent b0d0d28
commit 25938cc
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/src/wagtail_live/apps.py b/src/wagtail_live/apps.py
@@ -16,4 +16,9 @@ def ready(self):
         if issubclass(live_publisher, BaseWebsocketPublisher):
             from wagtail_live.signals import live_page_update
 
-            live_page_update.connect(live_publisher(), weak=False, dispatch_uid="live_publisher")
+            # Set`weak=False` to avoid the publisher being garbage collected.
+            # See:
+            # https://docs.djangoproject.com/en/3.2/topics/signals/#django.dispatch.Signal.connect
+            live_page_update.connect(
+                live_publisher(), weak=False, dispatch_uid="live_publisher"
+            )
diff --git a/tests/testapp/publishers.py b/tests/testapp/publishers.py
@@ -2,7 +2,8 @@
 
 
 class DummyWebsocketPublisher(BaseWebsocketPublisher):
-    pass
+    def publish(self, channel_id, renders, removals):
+        pass
 
 
 class DummyPublisher: