Merge ~nteodosio/software-properties:valid-magic-wait-event into software-properties:ubuntu/master

[Nathan Teodosio]

This is an alternative to the superseded request.

Instead of sleeping, use Event to detect when the radio button is changed.

[Sebastien Bacher (seb128)]

Thanks, that should work but is there any reason we keep pooling for tokens when the option is not selected? Also wouldn't it be simpler to make the status update conditional to the selected widget option rather than using events?

review: Needs Information

[Nathan Teodosio (nteodosio)]

> is there any reason we keep pooling for tokens when the option is not selected?

Since wait() blocks, interrupting that thread when the user selects the other radio button is a bit involved, as far as I know. But I'll investigate this option further.

> wouldn't it be simpler to make the status update conditional to the selected widget option rather than using events?

Do you mean something like: Once wait() returns,

- If magic button selected, call update_state as we do now.
- If token button selected, set a flag, and make on_radio_toggled consider that flag and call update_state if set.

? That seems good.

[Sebastien Bacher (seb128)]

> Since wait() blocks, interrupting that thread when the user selects the other radio button is a bit involved, as far as I know. But I'll investigate this option further.

right, that might be annoying, don't worry about it if we can go with the other option

> Do you mean something like: Once wait() returns,

> - If magic button selected, call update_state as we do now.
> - If token button selected, set a flag, and make on_radio_toggled consider that flag and call update_state if set.

> ? That seems good.

yes, something around those lines

Unmerged commits

7298048... by Nathan Teodosio on 2023-03-03

Make PIN validation wait to update UI until magic radio is selected.

https://launchpad.net/bugs/2006940

diff --git a/softwareproperties/gtk/DialogUaAttach.py b/softwareproperties/gtk/DialogUaAttach.py
index 5de167c..175173f 100644
--- a/softwareproperties/gtk/DialogUaAttach.py
+++ b/softwareproperties/gtk/DialogUaAttach.py
@@ -25,6 +25,7 @@ from softwareproperties.gtk.utils import setup_ui
 from uaclient.api.u.pro.attach.magic.initiate.v1 import initiate
 from uaclient.api.u.pro.attach.magic.wait.v1 import MagicAttachWaitOptions, wait
 from uaclient.exceptions import MagicAttachTokenError
+from threading import Event
 
 class DialogUaAttach:
     def __init__(self, parent, datadir, ua_object):
@@ -39,6 +40,8 @@ class DialogUaAttach:
         self.attaching = False
         self.poll = None
         self.pin = ""
+        self.magic_radio_active_event = Event()
+        self.magic_radio_active_event.set()
 
         self.net_monitor = Gio.network_monitor_get_default()
         self.net_monitor.connect("network-changed", self.net_status_changed, 0)
@@ -148,8 +151,10 @@ class DialogUaAttach:
         try:
             response = wait(options)
             self.contract_token = response.contract_token
+            self.magic_radio_active_event.wait()
             GLib.idle_add(self.update_state, 'pin_validated')
         except MagicAttachTokenError:
+            self.magic_radio_active_event.wait()
             GLib.idle_add(self.update_state, 'expired')
         except Exception as e:
             print("Error getting the Ubuntu Pro token: ", e, flush = True)
@@ -177,6 +182,10 @@ class DialogUaAttach:
         self.poll = GLib.Thread.new("poll", self.poll_for_magic_token)
 
     def on_radio_toggled(self, button):
+        if self.token_radio.get_active():
+            self.magic_radio_active_event.clear()
+        else:
+            self.magic_radio_active_event.set()
         self.update_state()
 
     def on_magic_radio_clicked(self, button):