Merge lp:~mvo/software-center/spinner-while-agent-runs-5.2 into lp:software-center/5.2

[Michael Vogt]

This branch adds a spinner that is displayed if a app is not found but there is a update going on in the background. No string change as this is targeted for precise.

[Michael Vogt (mvo)]

We could use the "In Progress..." string that we have already, but there is really no good one in our pot.

[lp:~mvo/software-center/spinner-while-agent-runs-5.2]

3079. By Michael Vogt on 2012-08-10

softwarecenter/ui/gtk3/widgets/spinner.py: remove spurious change

[Gary Lasker (gary-lasker)]

Hi Michael, thanks for this! The code looks fine to me. I especially like that you moved the update-software-center-agent code out of app.py and into the backend.

I know that there was some discussion today about the UI implementation, and I believe that as a result of this you plan to do more work on this branch. I just wanted to approve it as it is in case you decide to stick with it. If you make further changes, I'll be happy to review them.

I do have one question. I noticed that the spinner is only displayed in the application's icon area and the text area to the right still prominently displays the "Not found" message. Would it be better to just show a spinner for the entire view instead? Just wondering what you think about that (since we can't change strings for the SRU, as you mentioned).

review: Approve

Unmerged revisions

3079. By Michael Vogt on 2012-08-10

softwarecenter/ui/gtk3/widgets/spinner.py: remove spurious change

3078. By Michael Vogt on 2012-08-09

add test for spinner

3077. By Michael Vogt on 2012-08-09

fix pep8

3076. By Michael Vogt on 2012-08-09

add "update-software-center-agent-finished" signal to the db

3075. By Michael Vogt on 2012-08-09

softwarecenter/ui/gtk3/views/appdetailsview.py: ensure the spinner is updated

3074. By Michael Vogt on 2012-08-09

add self.app_icon_spinner to be able to show the spinner

3073. By Michael Vogt on 2012-08-09

softwarecenter/db/database.py: fix datadir

3072. By Michael Vogt on 2012-08-09

move the update-software-center-agent functionality from the app.py into the DB

=== modified file 'softwarecenter/db/database.py'
--- softwarecenter/db/database.py	2012-05-22 13:39:12 +0000
+++ softwarecenter/db/database.py	2012-08-10 12:55:22 +0000
@@ -135,6 +135,10 @@
                     "open": (GObject.SIGNAL_RUN_FIRST,
                              GObject.TYPE_NONE,
                              (GObject.TYPE_STRING,)),
+                    "update-software-center-agent-finished":  (
+                             GObject.SIGNAL_RUN_FIRST,
+                             GObject.TYPE_NONE,
+                             (GObject.TYPE_BOOLEAN,)),
                     }
 
     def __init__(self, pathname=None, cache=None):
@@ -157,6 +161,7 @@
         self._db_per_thread = {}
         self._parser_per_thread = {}
         self._axi_stamp_monitor = None
+        self._software_center_agent_update_in_progress = False
 
     @property
     def xapiandb(self):
@@ -584,6 +589,33 @@
             matches.append(FakeMSetItem(match))
         return matches
 
+    # software-center-agent releated API
+    def update_software_center_agent(self, delay=0):
+        """ Update the list of available application from the net
+        """
+        self._software_center_agent_update_in_progress = True
+        GObject.timeout_add_seconds(delay, self._run_software_center_agent)
+
+    def _run_software_center_agent(self):
+        """ helper that triggers the update-software-center-agent helper """
+        datadir = softwarecenter.paths.datadir
+        sc_agent_update = os.path.join(
+            datadir, "update-software-center-agent")
+        (pid, stdin, stdout, stderr) = GObject.spawn_async(
+            [sc_agent_update, "--datadir", datadir],
+            flags=GObject.SPAWN_DO_NOT_REAP_CHILD)
+        GObject.child_watch_add(
+            pid, self._on_update_software_center_agent_finished)
+
+    def _on_update_software_center_agent_finished(self, pid, condition):
+        LOG.info("software-center-agent finished with status %i" %
+            os.WEXITSTATUS(condition))
+        success = (os.WEXITSTATUS(condition) == 0)
+        self._software_center_agent_update_in_progress = False
+        if success:
+            self.reopen()
+        self.emit("update-software-center-agent-finished", success)
+
     def __len__(self):
         """return the doc count of the database"""
         return self.xapiandb.get_doccount()
 
=== modified file 'softwarecenter/ui/gtk3/app.py'
--- softwarecenter/ui/gtk3/app.py	2012-06-11 09:56:45 +0000
+++ softwarecenter/ui/gtk3/app.py	2012-08-10 12:55:22 +0000
@@ -462,8 +462,7 @@
             if not (options.enable_lp or och):
                 self.menu_file.remove(self.separator_login)
         else:
-            # running the agent will trigger a db reload so we do it later
-            GObject.timeout_add_seconds(3, self._run_software_center_agent)
+            self.db.update_software_center_agent(delay=3)
 
         # keep the cache clean
         GObject.timeout_add_seconds(15, self._run_expunge_cache_helper)
@@ -489,16 +488,6 @@
             LOG.debug("launchpad integration error: '%s'" % e)
 
     # helper
-    def _run_software_center_agent(self):
-        """ helper that triggers the update-software-center-agent helper """
-        sc_agent_update = os.path.join(
-            self.datadir, "update-software-center-agent")
-        (pid, stdin, stdout, stderr) = GObject.spawn_async(
-            [sc_agent_update, "--datadir", self.datadir],
-            flags=GObject.SPAWN_DO_NOT_REAP_CHILD)
-        GObject.child_watch_add(
-            pid, self._on_update_software_center_agent_finished)
-
     def _run_expunge_cache_helper(self):
         """ helper that expires the piston-mini-client cache """
         sc_expunge_cache = os.path.join(
@@ -593,12 +582,6 @@
             self._recommender_agent = RecommenderAgent()
         return self._recommender_agent
 
-    def _on_update_software_center_agent_finished(self, pid, condition):
-        LOG.info("software-center-agent finished with status %i" %
-            os.WEXITSTATUS(condition))
-        if os.WEXITSTATUS(condition) == 0:
-            self.db.reopen()
-
     def on_review_stats_loaded(self, reviews):
         LOG.debug("on_review_stats_loaded: '%s'" % len(reviews))
 
 
=== modified file 'softwarecenter/ui/gtk3/views/appdetailsview.py'
--- softwarecenter/ui/gtk3/views/appdetailsview.py	2012-06-28 08:10:33 +0000
+++ softwarecenter/ui/gtk3/views/appdetailsview.py	2012-08-10 12:55:22 +0000
@@ -64,6 +64,7 @@
 from softwarecenter.ui.gtk3.widgets.containers import SmallBorderRadiusFrame
 from softwarecenter.ui.gtk3.widgets.stars import Star, StarRatingsWidget
 from softwarecenter.ui.gtk3.widgets.description import AppDescription
+from softwarecenter.ui.gtk3.widgets.spinner import SpinnerNotebook
 from softwarecenter.ui.gtk3.widgets.thumbnail import ScreenshotGallery
 from softwarecenter.ui.gtk3.widgets.videoplayer import VideoPlayer
 from softwarecenter.ui.gtk3.widgets.weblivedialog import (
@@ -817,6 +818,9 @@
         Viewport.__init__(self)
         # basic stuff
         self.db = db
+        self.db.connect(
+            "update-software-center-agent-finished",
+            self._on_update_software_center_agent_finished)
         self.distro = distro
         self.icons = icons
         self.cache = cache
@@ -1144,9 +1148,11 @@
         hb.set_spacing(StockEms.MEDIUM)
         vb.pack_start(hb, False, False, 0)
 
-        # the app icon
+        # the app icon / spinner combo
         self.icon = Gtk.Image()
-        hb.pack_start(self.icon, False, False, 0)
+        self.icon.show()
+        self.app_icon_spinner = SpinnerNotebook(self.icon)
+        hb.pack_start(self.app_icon_spinner, False, False, 0)
 
         # the app title/summary
         self.title = Gtk.Label()
@@ -1356,6 +1362,9 @@
         self.subtitle.set_markup(summary)
 
     def _update_app_icon(self, app_details):
+        # update the spinner
+        self._update_spinner(app_details)
+
         pb = self._get_icon_as_pixbuf(app_details)
         # should we show the green tick?
 #        self._show_overlay = app_details.pkg_state == PkgStates.INSTALLED
@@ -1508,6 +1517,17 @@
         # Update addons state bar
         self.addons_statusbar.configure()
 
+    def _on_update_software_center_agent_finished(self, database, result):
+        if self.app_details:
+            self._update_spinner(self.app_details)
+
+    def _update_spinner(self, app_details):
+        if app_details.pkg_state is PkgStates.NOT_FOUND:
+            if self.db._software_center_agent_update_in_progress:
+                self.app_icon_spinner.show_spinner()
+            else:
+                self.app_icon_spinner.hide_spinner()
+
     def _update_all(self, app_details, skip_update_addons=False):
         # reset view to top left
         vadj = self.get_vadjustment()
 
=== modified file 'test/gtk3/test_appdetailsview.py'
--- test/gtk3/test_appdetailsview.py	2012-06-18 14:39:27 +0000
+++ test/gtk3/test_appdetailsview.py	2012-08-10 12:55:22 +0000
@@ -11,7 +11,11 @@
 from mock import Mock, patch
 
 from softwarecenter.db.application import Application
-from softwarecenter.testutils import get_mock_app_from_real_app, do_events, make_recommend_app_data
+from softwarecenter.testutils import (
+    get_mock_app_from_real_app,
+    do_events,
+    make_recommend_app_data,
+    do_events_with_sleep)
 from softwarecenter.ui.gtk3.widgets.labels import HardwareRequirementsBox
 from softwarecenter.ui.gtk3.views.appdetailsview import get_test_window_appdetails
 from softwarecenter.enums import PkgStates
@@ -264,6 +268,21 @@
         self.view.show_app(self.view.app)
         self.assertEqual(self.view.videoplayer.uri, video_url)
 
+    def test_update_software_center_agent_spinner(self):
+        # test that a spinner is shown while the agent is running
+        self.view.db._software_center_agent_update_in_progress = True
+        app = Application("", "no-such-app-really")
+        self.view.show_app(app)
+        do_events_with_sleep()
+        self.assertEqual(self.view.app_icon_spinner.get_current_page(),
+                         self.view.app_icon_spinner.SPINNER_PAGE)
+        # now switch
+        self.view.db._software_center_agent_update_in_progress = False
+        self.view.db.emit("update-software-center-agent-finished", True)
+        do_events()
+        self.assertEqual(self.view.app_icon_spinner.get_current_page(),
+                         self.view.app_icon_spinner.CONTENT_PAGE)
+        
 
 class MultipleVersionsTestCase(unittest.TestCase):