Tests: Replace remaining uses of wait_for_download_to_start_and_finish() with wait_for_download_task_to_start_and_finish()

davidfstr · davidfstr · commit a7b553feb241 · 2025-10-15T10:02:00.000-04:00
Also:
* Tests: Remove now-unused wait_for_download_to_start_and_finish()
diff --git a/src/crystal/tests/README.md b/src/crystal/tests/README.md
@@ -324,13 +324,13 @@ download.
 It's not recommended to manually wait for a download to complete using a 
 fixed timeout because they can take a highly variable amount of time to complete,
 depending on how many embedded subresources there are, among other factors.
-Instead use the `wait_for_download_to_start_and_finish` utility method,
+Instead use the `wait_for_download_task_to_start_and_finish` utility method,
 which looks for continued *progress* in a download, regardless of how long the
 total download task takes to finish:
 
 ```
-            home_ti.Expand()
-            await wait_for_download_to_start_and_finish(mw.task_tree)
+            async with wait_for_download_task_to_start_and_finish(project):
+                home_ti.Expand()
 ```
 
 ## Waiting for other things to happen
diff --git a/src/crystal/tests/test_download.py b/src/crystal/tests/test_download.py
@@ -7,7 +7,7 @@
 from crystal.tests.util.controls import click_button, TreeItem
 from crystal.tests.util.runner import bg_sleep
 from crystal.tests.util.server import MockHttpServer, served_project
-from crystal.tests.util.tasks import wait_for_download_to_start_and_finish
+from crystal.tests.util.tasks import wait_for_download_task_to_start_and_finish
 from crystal.tests.util.wait import DEFAULT_WAIT_PERIOD, wait_for
 from crystal.tests.util.windows import NewGroupDialog, OpenOrCreateDialog
 import crystal.tests.util.xtempfile as xtempfile
@@ -37,12 +37,11 @@ async def test_given_downloading_resource_when_start_download_resource_then_exis
         async with (await OpenOrCreateDialog.wait_for()).create() as (mw, project):
             r = Resource(project, home_url)
             
-            rr_future = r.download()
-            
-            rr_future2 = r.download()
-            assert rr_future2 is rr_future
-            
-            await wait_for_download_to_start_and_finish(mw.task_tree)
+            async with wait_for_download_task_to_start_and_finish(project):
+                rr_future = r.download()
+                
+                rr_future2 = r.download()
+                assert rr_future2 is rr_future
 
 
 # ------------------------------------------------------------------------------
diff --git a/src/crystal/tests/test_entitytree.py b/src/crystal/tests/test_entitytree.py
@@ -7,7 +7,7 @@
 from crystal.tests.util.downloads import network_down
 from crystal.tests.util.runner import bg_sleep
 from crystal.tests.util.server import extracted_project, served_project
-from crystal.tests.util.tasks import wait_for_download_to_start_and_finish
+from crystal.tests.util.tasks import wait_for_download_task_to_start_and_finish
 from crystal.tests.util.wait import (
     DEFAULT_WAIT_PERIOD, first_child_of_tree_item_is_not_loading_condition,
     wait_for,
@@ -725,11 +725,11 @@ async def test_given_rr_is_downloaded_and_is_error_when_expand_rrn_then_shows_er
             with network_down():
                 r = Resource(project, home_url)
                 home_rr = RootResource(project, 'Home', r)
-                revision_future = home_rr.download()
-                while not revision_future.done():
-                    await bg_sleep(DEFAULT_WAIT_PERIOD)
-                # Wait for download to complete, including the trailing wait
-                await wait_for_download_to_start_and_finish(mw.task_tree, immediate_finish_ok=True)
+                async with wait_for_download_task_to_start_and_finish(project):
+                    revision_future = home_rr.download()
+                    while not revision_future.done():
+                        await bg_sleep(DEFAULT_WAIT_PERIOD)
+                    # (Wait for download to complete, including the trailing wait)
                 
                 rr = revision_future.result()
                 assert DownloadErrorDict(
@@ -780,16 +780,15 @@ async def test_given_rr_is_downloaded_but_revision_body_missing_when_expand_rrn_
                 # TODO: In the future, block on the redownload finishing
                 #       and list the links in the redownloaded revision,
                 #       WITHOUT needing to reopen the project later
-                home_ti.Expand()
-                await wait_for(first_child_of_tree_item_is_not_loading_condition(home_ti))
-                (error_ti,) = home_ti.Children
-                assert (
-                    'Cannot list links: URL revision body is missing. Recommend delete and redownload.' ==
-                    error_ti.Text
-                )
-                
-                # Wait for redownload to complete
-                await wait_for_download_to_start_and_finish(mw.task_tree, immediate_finish_ok=True)
+                async with wait_for_download_task_to_start_and_finish(project):
+                    home_ti.Expand()
+                    await wait_for(first_child_of_tree_item_is_not_loading_condition(home_ti))
+                    (error_ti,) = home_ti.Children
+                    assert (
+                        'Cannot list links: URL revision body is missing. Recommend delete and redownload.' ==
+                        error_ti.Text
+                    )
+                    # (Wait for redownload to complete)
                 
                 # Reexpand RootResourceNode and ensure the children are the same
                 home_ti.Collapse()
diff --git a/src/crystal/tests/test_load_urls.py b/src/crystal/tests/test_load_urls.py
@@ -6,7 +6,7 @@
 from crystal.tests.util.server import extracted_project, served_project
 from crystal.tests.util.ssd import database_on_ssd
 from crystal.tests.util.subtests import awith_subtests, SubtestsContext
-from crystal.tests.util.tasks import wait_for_download_task_to_start_and_finish, wait_for_download_to_start_and_finish
+from crystal.tests.util.tasks import wait_for_download_task_to_start_and_finish
 from crystal.tests.util.wait import (
     first_child_of_tree_item_is_not_loading_condition,
     tree_has_no_children_condition, wait_for,
diff --git a/src/crystal/tests/test_new_group.py b/src/crystal/tests/test_new_group.py
@@ -6,7 +6,7 @@
 from crystal.tests.util.controls import click_button, click_checkbox, TreeItem
 from crystal.tests.util.server import MockHttpServer, served_project
 from crystal.tests.util.ssd import database_on_ssd
-from crystal.tests.util.tasks import wait_for_download_task_to_start_and_finish, wait_for_download_to_start_and_finish
+from crystal.tests.util.tasks import wait_for_download_task_to_start_and_finish
 from crystal.tests.util.wait import (
     first_child_of_tree_item_is_not_loading_condition,
     tree_has_no_children_condition, tree_item_has_no_children_condition,
@@ -190,8 +190,8 @@ async def test_given_resource_node_with_multiple_link_children_matching_url_patt
                 (home_ti,) = root_ti.Children
             
             # Expand home URL
-            home_ti.Expand()
-            await wait_for_download_to_start_and_finish(mw.task_tree)
+            async with wait_for_download_task_to_start_and_finish(project):
+                home_ti.Expand()
             assert first_child_of_tree_item_is_not_loading_condition(home_ti)()
             
             # Select a comic link from the home URL
@@ -326,7 +326,7 @@ async def test_given_node_is_selected_in_entity_tree_when_press_new_group_button
                 comic_rgn = _find_child(root_ti, comic_pattern, url_prefix)
                 
                 # Children of RootResourceNode (a kind of _ResourceNode) that is inside RootNode
-                await _expand_node(home_rrn, mw, will_download=True)
+                await _expand_node(home_rrn, project, will_download=True)
                 home_rrn__atom_feed_rrn = _find_child(
                     home_rrn, atom_feed_url, url_prefix)
                 home_rrn__about_rrn = _find_child(
@@ -361,21 +361,21 @@ async def test_given_node_is_selected_in_entity_tree_when_press_new_group_button
                 # ---
                 
                 # Children of LinkedResourceNode (a kind of _ResourceNode) that is inside GroupedLinkedResourceNode
-                await _expand_node(home_rrn__feed_glrn__rss_feed_lrn, mw, will_download=True)
+                await _expand_node(home_rrn__feed_glrn__rss_feed_lrn, project, will_download=True)
                 home_rrn__feed_glrn__rss_feed_lrn__home_rrn = _find_child(
                     home_rrn__feed_glrn__rss_feed_lrn, home_url, url_prefix)
                 
                 # Children of LinkedResourceNode (a kind of _ResourceNode) that is inside RootResourceNode
                 # HACK: Relies on Crystal's "Not in Archive" page to provide a
                 #       link to the original URL (which is offsite)
-                await _expand_node(home_rrn__archive_lrn, mw)  # not in archive
+                await _expand_node(home_rrn__archive_lrn, project)  # not in archive
                 home_rrn__archive_lrn__offsite_cn = _find_child_by_title(
                     home_rrn__archive_lrn, 'Offsite')
                 
                 # Children of LinkedResourceNode (a kind of _ResourceNode) that is inside ClusterNode
                 # HACK: Relies on Crystal's "Not in Archive" page to provide a
                 #       link to the original URL (which is offsite)
-                await _expand_node(home_rrn__offsite_cn__twitter_lrn, mw)  # not in archive
+                await _expand_node(home_rrn__offsite_cn__twitter_lrn, project)  # not in archive
                 home_rrn__offsite_cn__twitter_lrn__offsite_cn = _find_child_by_title(
                     home_rrn__offsite_cn__twitter_lrn, 'Offsite')
                 await _expand_node(home_rrn__embedded_cn__stylesheet_lrn)  # already downloaded
@@ -430,15 +430,14 @@ async def test_given_node_is_selected_in_entity_tree_when_press_new_group_button
                 assertEqual('Feed', await _source_name_for_node(feed_rgn__rss_feed_nrn__home_rrn, mw))
 
 
-async def _expand_node(node_ti: TreeItem, mw: MainWindow | None=None, *, will_download: bool=False) -> None:
-    node_ti.Expand()
+async def _expand_node(node_ti: TreeItem, project: Project | None=None, *, will_download: bool=False) -> None:
     if will_download:
-        if mw is None:
-            raise ValueError('Need mw parameter when will_download=True')
-        await wait_for_download_to_start_and_finish(
-            mw.task_tree,
-            immediate_finish_ok=True,
-            stacklevel_extra=1)
+        if project is None:
+            raise ValueError('Need project parameter when will_download=True')
+        async with wait_for_download_task_to_start_and_finish(project):
+            node_ti.Expand()
+    else:
+        node_ti.Expand()
     await wait_for(
         first_child_of_tree_item_is_not_loading_condition(node_ti),
         timeout=3.0,  # took 2.2s on Windows CI
@@ -501,8 +500,8 @@ async def test_given_urls_loaded_and_new_url_created_when_show_new_group_dialog_
                 assert progress_listener_method.call_count >= 1
             
             # Expand home URL, to discover initial comic URLs
-            home_ti.Expand()
-            await wait_for_download_to_start_and_finish(mw.task_tree)
+            async with wait_for_download_task_to_start_and_finish(project):
+                home_ti.Expand()
             assert first_child_of_tree_item_is_not_loading_condition(home_ti)()
             assert len(comic_ti.Children) >= 2  # contains at least the first and last comics
             
@@ -532,8 +531,8 @@ async def test_when_add_group_then_does_not_download_immediately_by_default() ->
     with _served_simple_site_with_group() as (home_url, comic_pattern):
         async with (await OpenOrCreateDialog.wait_for()).create() as (mw, project):
             rr = RootResource(project, 'Home', Resource(project, home_url))
-            rr.download()
-            await wait_for_download_to_start_and_finish(mw.task_tree)
+            async with wait_for_download_task_to_start_and_finish(project):
+                rr.download()
             
             assert mw.new_group_button.Enabled
             click_button(mw.new_group_button)
@@ -553,8 +552,8 @@ async def test_when_add_group_can_download_group_immediately_with_1_extra_click(
     with _served_simple_site_with_group() as (home_url, comic_pattern):
         async with (await OpenOrCreateDialog.wait_for()).create() as (mw, project):
             rr = RootResource(project, 'Home', Resource(project, home_url))
-            rr.download()
-            await wait_for_download_to_start_and_finish(mw.task_tree)
+            async with wait_for_download_task_to_start_and_finish(project):
+                rr.download()
             
             assert mw.new_group_button.Enabled
             click_button(mw.new_group_button)
@@ -563,12 +562,12 @@ async def test_when_add_group_can_download_group_immediately_with_1_extra_click(
             ngd.pattern_field.Value = comic_pattern
             ngd.name_field.Value = 'Comic'
             click_checkbox(ngd.download_immediately_checkbox)  # extra click #1
-            await ngd.ok()
-            
-            # Ensure started downloading
-            root_ti = TreeItem.GetRootItem(mw.entity_tree.window)
-            root_ti.find_child(comic_pattern, project.default_url_prefix)
-            await wait_for_download_to_start_and_finish(mw.task_tree)
+            async with wait_for_download_task_to_start_and_finish(project):
+                await ngd.ok()
+                
+                # Ensure started downloading
+                root_ti = TreeItem.GetRootItem(mw.entity_tree.window)
+                root_ti.find_child(comic_pattern, project.default_url_prefix)
 
 
 async def test_when_edit_group_then_new_group_options_not_shown() -> None:
diff --git a/src/crystal/tests/test_new_root_url.py b/src/crystal/tests/test_new_root_url.py
@@ -14,7 +14,6 @@
     append_deferred_top_level_tasks,
     scheduler_disabled,
     wait_for_download_task_to_start_and_finish,
-    wait_for_download_to_start_and_finish,
 )
 from crystal.tests.util.wait import (
     DEFAULT_WAIT_PERIOD, first_child_of_tree_item_is_not_loading_condition,
@@ -157,8 +156,8 @@ async def test_given_resource_node_with_links_can_create_new_root_url_to_label_l
                 (home_ti,) = root_ti.Children
             
             # Expand home URL
-            home_ti.Expand()
-            await wait_for_download_to_start_and_finish(mw.task_tree)
+            async with wait_for_download_task_to_start_and_finish(project):
+                home_ti.Expand()
             assert first_child_of_tree_item_is_not_loading_condition(home_ti)()
             
             # Select the Atom Feed link from the home URL
@@ -225,12 +224,12 @@ async def test_when_add_url_then_downloads_url_immediately_by_default() -> None:
             assert nud.download_immediately_checkbox.Value
             
             nud.url_field.Value = home_url
-            await nud.ok()
-            
-            # Ensure started downloading
-            root_ti = TreeItem.GetRootItem(mw.entity_tree.window)
-            home_ti = root_ti.find_child(home_url, project.default_url_prefix)
-            await wait_for_download_to_start_and_finish(mw.task_tree)
+            async with wait_for_download_task_to_start_and_finish(project):
+                await nud.ok()
+                
+                # Ensure started downloading
+                root_ti = TreeItem.GetRootItem(mw.entity_tree.window)
+                home_ti = root_ti.find_child(home_url, project.default_url_prefix)
             await _assert_tree_item_icon_tooltip_contains(home_ti, 'Fresh')
 
 
diff --git a/src/crystal/tests/test_readonly_mode.py b/src/crystal/tests/test_readonly_mode.py
@@ -15,7 +15,7 @@
 from crystal.tests.util.server import MockHttpServer, served_project, extracted_project
 from crystal.tests.util.skip import skipTest
 from crystal.tests.util.subtests import awith_subtests, SubtestsContext
-from crystal.tests.util.tasks import scheduler_disabled, step_scheduler_until_done, wait_for_download_to_start_and_finish
+from crystal.tests.util.tasks import scheduler_disabled, step_scheduler_until_done, wait_for_download_task_to_start_and_finish
 from crystal.tests.util.wait import tree_has_no_children_condition, wait_for, first_child_of_tree_item_is_not_loading_condition
 from crystal.tests.util.windows import MainWindow, MenuitemDisabledError, OpenOrCreateDialog, NewGroupDialog, NewRootUrlDialog, PreferencesDialog
 from crystal.util.db import DatabaseCursor
@@ -241,8 +241,8 @@ async def test_when_readonly_project_is_saved_then_becomes_writable_and_all_unsa
                     
                     root_ti = TreeItem.GetRootItem(mw.entity_tree.window)
                     (home_ti,) = root_ti.Children
-                    home_ti.Expand()
-                    await wait_for_download_to_start_and_finish(mw.task_tree)
+                    async with wait_for_download_task_to_start_and_finish(project):
+                        home_ti.Expand()
                 
             # Reopen the project as read-only
             async with (await OpenOrCreateDialog.wait_for()).open(project_dirpath, readonly=True) as (mw, project):
diff --git a/src/crystal/tests/test_server.py b/src/crystal/tests/test_server.py
diff --git a/src/crystal/tests/test_workflows.py b/src/crystal/tests/test_workflows.py
diff --git a/src/crystal/tests/util/tasks.py b/src/crystal/tests/util/tasks.py
