Merge lp:~mikemc/ubuntuone-control-panel/fix-1248326 into lp:ubuntuone-control-panel

[Mike McCracken]

- Prompt user to re-login with SSO if UnauthorizedError is raised by web client. (LP: #1248326)

- Prompt user to re-login with SSO if UnauthorizedError is raised by web client. (LP: #1248326)

To test: log in and then invalidate the token using the web site.
Then trigger a web call by changing to either the devices or account tabs.
The SSO login window should pop up immediately.
Previously, the uncaught exception traceback was just shown to the user.

[dobey (dobey)]

No tests?

review: Needs Fixing

[dobey (dobey)]

review: Approve

[Roberto Alsina (ralsina)]

review: Approve

=== modified file 'ubuntuone/controlpanel/gui/qt/account.py'
--- ubuntuone/controlpanel/gui/qt/account.py	2012-02-22 15:35:13 +0000
+++ ubuntuone/controlpanel/gui/qt/account.py	2013-11-27 19:55:46 +0000
@@ -19,6 +19,8 @@
 
 """The user interface for the control panel for Ubuntu One."""
 
+from PyQt4 import QtCore
+
 from twisted.internet import defer
 
 from ubuntuone.controlpanel.logger import setup_logging, log_call
@@ -33,6 +35,7 @@
 from ubuntuone.controlpanel.gui.qt.ubuntuonebin import UbuntuOneBin
 from ubuntuone.controlpanel.gui.qt.ui import account_ui
 
+from ubuntu_sso.utils.webclient.common import UnauthorizedError
 
 logger = setup_logging('qt.account')
 
@@ -43,6 +46,8 @@
     ui_class = account_ui
     logger = logger
 
+    credentialsCleared = QtCore.pyqtSignal()
+
     def _setup(self):
         """Do some extra setupping for the UI."""
         super(AccountPanel, self)._setup()
@@ -58,8 +63,14 @@
     def load(self):
         """Load info."""
         self.is_processing = True
-        info = yield self.backend.account_info()
-        self.process_info(info)
+        try:
+            info = yield self.backend.account_info()
+        except UnauthorizedError:
+            self.is_processing = False
+            logger.debug("handling UnauthorizedError from account_info()")
+            self.credentialsCleared.emit()
+        else:
+            self.process_info(info)
 
     @log_call(logger.debug)
     def process_info(self, info):
 
=== modified file 'ubuntuone/controlpanel/gui/qt/controlpanel.py'
--- ubuntuone/controlpanel/gui/qt/controlpanel.py	2013-03-11 18:46:14 +0000
+++ ubuntuone/controlpanel/gui/qt/controlpanel.py	2013-11-27 19:55:46 +0000
@@ -46,6 +46,7 @@
 from ubuntuone.controlpanel.gui.qt.ubuntuonebin import UbuntuOneBin
 from ubuntuone.controlpanel.gui.qt.ui import controlpanel_ui
 
+from ubuntu_sso.utils.webclient.common import UnauthorizedError
 
 logger = setup_logging('qt.controlpanel')
 
@@ -96,6 +97,10 @@
         # account info
         self.ui.tab_widget.show_overlay = False
 
+        for tab in [self.ui.account_tab, self.ui.folders_tab,
+                    self.ui.devices_tab]:
+            tab.credentialsCleared.connect(self.on_credentials_cleared)
+
     @defer.inlineCallbacks
     def connect_file_sync(self):
         """Connect file sync service if the setting autoconnect is enabled."""
@@ -122,14 +127,26 @@
         self.connect_file_sync()
         yield self.show_management_ui()
 
+    @log_call(logger.debug)
+    @defer.inlineCallbacks
+    def on_credentials_cleared(self):
+        """Prompt user to log back in after credentials have been deleted."""
+        yield self.backend.login()
+        # ignore returned credentials from login(), load() re-gets them.
+        yield self.load()
+
     @defer.inlineCallbacks
     def show_management_ui(self):
         """Show mgmt UI. File sync is already connected if desired."""
         self.ui.switcher.setCurrentWidget(self.ui.management)
-        info = yield self.backend.account_info()
-        self.process_info(info)
-        self.is_processing = False
-        self.ui.tab_widget.show_overlay = True
+        try:
+            info = yield self.backend.account_info()
+        except UnauthorizedError:
+            self.on_credentials_cleared()
+        else:
+            self.process_info(info)
+            self.is_processing = False
+            self.ui.tab_widget.show_overlay = True
 
     # pylint: disable=E0202
     @defer.inlineCallbacks
 
=== modified file 'ubuntuone/controlpanel/gui/qt/device.py'
--- ubuntuone/controlpanel/gui/qt/device.py	2012-03-08 20:46:13 +0000
+++ ubuntuone/controlpanel/gui/qt/device.py	2013-11-27 19:55:46 +0000
@@ -37,6 +37,8 @@
 from ubuntuone.controlpanel.gui.qt.ui import device_ui
 from ubuntuone.controlpanel.logger import setup_logging
 
+from ubuntu_sso.utils.webclient.common import UnauthorizedError
+
 COMPUTER_ICON = "computer"
 PHONE_ICON = "phone"
 DEFAULT_ICON = COMPUTER_ICON
@@ -105,7 +107,13 @@
         response = QtGui.QMessageBox.warning(self, '', msg, buttons, NO)
 
         if response == YES:
-            yield self.backend.remove_device(device_id=self.id)
+            try:
+                yield self.backend.remove_device(device_id=self.id)
+            except UnauthorizedError:
+                # Ignore UnauthorizedError because it means our
+                # local device was invalidated remotely, which we can
+                # handle the same way
+                pass
             self.removed.emit()
         else:
             self.removeCanceled.emit()
 
=== modified file 'ubuntuone/controlpanel/gui/qt/devices.py'
--- ubuntuone/controlpanel/gui/qt/devices.py	2012-03-08 20:46:13 +0000
+++ ubuntuone/controlpanel/gui/qt/devices.py	2013-11-27 19:55:46 +0000
@@ -35,6 +35,7 @@
 from ubuntuone.controlpanel.gui.qt.ubuntuonebin import UbuntuOneBin
 from ubuntuone.controlpanel.gui.qt import device
 
+from ubuntu_sso.utils.webclient.common import UnauthorizedError
 
 logger = setup_logging('qt.devices')
 
@@ -45,6 +46,7 @@
     ui_class = devices_ui
     logger = logger
 
+    credentialsCleared = QtCore.pyqtSignal()
     localDeviceRemoved = QtCore.pyqtSignal()
 
     def _setup(self):
@@ -60,8 +62,14 @@
     def load(self):
         """Load info."""
         self.is_processing = True
-        info = yield self.backend.device_names_info()
-        self.process_info(info)
+        try:
+            info = yield self.backend.device_names_info()
+        except UnauthorizedError:
+            self.is_processing = False
+            logger.debug("handling UnauthorizedError from device_names_info()")
+            self.credentialsCleared.emit()
+        else:
+            self.process_info(info)
 
     @log_call(logger.debug)
     def process_info(self, info):
 
=== modified file 'ubuntuone/controlpanel/gui/qt/folders.py'
--- ubuntuone/controlpanel/gui/qt/folders.py	2012-11-29 20:15:08 +0000
+++ ubuntuone/controlpanel/gui/qt/folders.py	2013-11-27 19:55:46 +0000
@@ -63,6 +63,7 @@
 from ubuntuone.controlpanel.gui.qt.ubuntuonebin import UbuntuOneBin
 from ubuntuone.controlpanel.gui.qt.ui import folders_ui, local_folders_ui
 
+from ubuntu_sso.utils.webclient.common import UnauthorizedError
 
 logger = setup_logging('qt.folders')
 
@@ -118,6 +119,8 @@
     ui_class = folders_ui
     widget_items = {}
 
+    credentialsCleared = QtCore.pyqtSignal()
+
     def _setup(self):
         """Do some extra setupping for the UI."""
         super(FoldersPanel, self)._setup()
@@ -157,7 +160,6 @@
     @log_call(logger.info)
     def on_folder_created(self, new_folder):
         """Reload folder info after folder creation."""
-        self.is_processing = True
         self.load()
 
     # pylint: disable=E0202
@@ -165,9 +167,15 @@
     def load(self):
         """Load specific tab info."""
         self.is_processing = True
-        info = yield self.backend.volumes_info(with_storage_info=False,
-                                               refresh=self.remote_folders)
-        self.process_info(info)
+        try:
+            info = yield self.backend.volumes_info(with_storage_info=False,
+                                                   refresh=self.remote_folders)
+        except UnauthorizedError:
+            self.is_processing = False
+            logger.debug("handling UnauthorizedError from volumes_info")
+            self.credentialsCleared.emit()
+        else:
+            self.process_info(info)
 
     @handle_errors(logger=logger)
     @log_call(logger.debug)
 
=== modified file 'ubuntuone/controlpanel/gui/qt/tests/test_account.py'
--- ubuntuone/controlpanel/gui/qt/tests/test_account.py	2012-03-12 16:58:16 +0000
+++ ubuntuone/controlpanel/gui/qt/tests/test_account.py	2013-11-27 19:55:46 +0000
@@ -27,6 +27,9 @@
 from ubuntuone.controlpanel.gui.qt.tests.test_ubuntuonebin import (
     UbuntuOneBinTestCase,
 )
+from ubuntuone.controlpanel.gui.tests import FakeSignal
+
+from ubuntu_sso.utils.webclient.common import UnauthorizedError
 
 
 class AccountPanelTestCase(UbuntuOneBinTestCase):
@@ -59,6 +62,19 @@
         yield self.ui.load()
         self.assert_backend_called('account_info')
 
+    @defer.inlineCallbacks
+    def test_load_signals_on_unauthorized(self):
+        """Emit credentialsCleared when UnauthorizedError is raised"""
+        def account_info_error(*args, **kwargs):
+            raise UnauthorizedError()
+        fake_cleared_signal = FakeSignal()
+        fake_cleared_signal.connect(self._set_called)
+        self.patch(self.ui.backend, 'account_info', account_info_error)
+        self.patch(self.ui, 'credentialsCleared', fake_cleared_signal)
+
+        yield self.ui.load()
+        self.assertEqual(self._called, ((), {}))
+
     def test_process_info(self):
         """The info is processed when ready."""
         self.ui.process_info(SAMPLE_ACCOUNT_INFO)
 
=== modified file 'ubuntuone/controlpanel/gui/qt/tests/test_controlpanel.py'
--- ubuntuone/controlpanel/gui/qt/tests/test_controlpanel.py	2013-03-12 19:25:09 +0000
+++ ubuntuone/controlpanel/gui/qt/tests/test_controlpanel.py	2013-11-27 19:55:46 +0000
@@ -107,6 +107,14 @@
         self.assertEqual(self._called, ((), {}))
 
     @defer.inlineCallbacks
+    def test_on_credentials_cleared(self):
+        """Call backend.login and self.load."""
+        self.patch(self.ui, 'load', self._set_called)
+        yield self.ui.on_credentials_cleared()
+        self.assert_backend_called('login')
+        self.assertEqual(self._called, ((), {}))
+
+    @defer.inlineCallbacks
     def test_info_is_requested_on_load(self):
         """The info is requested to the backend."""
         self.patch(self.ui, 'process_info', self._set_called)
 
=== modified file 'ubuntuone/controlpanel/gui/qt/tests/test_devices.py'
--- ubuntuone/controlpanel/gui/qt/tests/test_devices.py	2012-03-12 16:53:02 +0000
+++ ubuntuone/controlpanel/gui/qt/tests/test_devices.py	2013-11-27 19:55:46 +0000
@@ -26,6 +26,10 @@
     UbuntuOneBinTestCase,
 )
 
+from ubuntuone.controlpanel.gui.tests import FakeSignal
+
+from ubuntu_sso.utils.webclient.common import UnauthorizedError
+
 
 class DevicesPanelTestCase(UbuntuOneBinTestCase):
     """Test the qt control panel."""
@@ -58,6 +62,20 @@
         yield self.ui.load()
         self.assert_backend_called('device_names_info')
 
+    @defer.inlineCallbacks
+    def test_load_signals_on_unauthorized(self):
+        """Emit credentialsCleared when UnauthorizedError is raised"""
+        def device_names_info_error(*args, **kwargs):
+            raise UnauthorizedError()
+        fake_cleared_signal = FakeSignal()
+        fake_cleared_signal.connect(self._set_called)
+        self.patch(self.ui.backend, 'device_names_info',
+                   device_names_info_error)
+        self.patch(self.ui, 'credentialsCleared', fake_cleared_signal)
+
+        yield self.ui.load()
+        self.assertEqual(self._called, ((), {}))
+
     def test_no_devices_at_startup(self):
         """The UI is reset at startup."""
         self.assertEqual(self.ui.ui.list_devices.count(), 0)
 
=== modified file 'ubuntuone/controlpanel/gui/qt/tests/test_folders.py'
--- ubuntuone/controlpanel/gui/qt/tests/test_folders.py	2012-11-30 17:55:58 +0000
+++ ubuntuone/controlpanel/gui/qt/tests/test_folders.py	2013-11-27 19:55:46 +0000
@@ -31,6 +31,7 @@
 
 from ubuntuone.controlpanel.tests import helper_fail
 from ubuntuone.controlpanel.gui.tests import (
+    FakeSignal,
     FAKE_VOLUMES_INFO,
     FAKE_VOLUMES_MINIMAL_INFO,
     FAKE_VOLUMES_NO_FREE_SPACE_INFO,
@@ -49,6 +50,8 @@
     UbuntuOneBinTestCase,
 )
 
+from ubuntu_sso.utils.webclient.common import UnauthorizedError
+
 # Access to a protected member
 # Instance of 'ControlBackend' has no '_called' member
 # pylint: disable=W0212, E1103
@@ -730,6 +733,19 @@
         parent = super(RemoteFoldersPanelTestCase, self)
         parent.test_process_info_with_music_folder(volumes=volumes)
 
+    @defer.inlineCallbacks
+    def test_load_signals_on_unauthorized(self):
+        """Emit credentialsCleared when UnauthorizedError is raised"""
+        def volumes_info_error(*args, **kwargs):
+            raise UnauthorizedError()
+        fake_cleared_signal = FakeSignal()
+        fake_cleared_signal.connect(self._set_called)
+        self.patch(self.ui.backend, 'volumes_info', volumes_info_error)
+        self.patch(self.ui, 'credentialsCleared', fake_cleared_signal)
+
+        yield self.ui.load()
+        self.assertEqual(self._called, ((), {}))
+
     def test_share_publish_button(self):
         """When clicking the share/publish button, the proper url is opened."""
         self.assertFalse(self.ui.ui.share_publish_button.isVisible())