Handle unload properly and flush stdout.

Author: Mike Stegeman

gateway_addon/adapter.py

@@ -1,7 +1,6 @@
 """High-level Adapter base class implementation."""
 
 from .addon_manager_proxy import AddonManagerProxy
-from .ipc import IpcClient
 
 
 class Adapter:
@@ -28,19 +27,20 @@ def __init__(self, _id, package_name, verbose=False):
         # False in it's constructor.
         self.ready = True
 
-        self.ipc_client = IpcClient(self.id, verbose=verbose)
-        self.manager_proxy = AddonManagerProxy(self.ipc_client.plugin_socket,
-                                               self.id,
-                                               verbose=verbose)
+        self.manager_proxy = AddonManagerProxy(self.id, verbose=verbose)
         self.manager_proxy.add_adapter(self)
 
+    def proxy_running(self):
+        """Return boolean indicating whether or not the proxy is running."""
+        return self.manager_proxy.running
+
     def close_proxy(self):
         """Close the manager proxy."""
         self.manager_proxy.close()
 
     def dump(self):
         """Dump the state of the adapter to the log."""
-        print('Adapter:', self.name, '- dump() not implemented')
+        print('Adapter:', self.name, '- dump() not implemented', flush=True)
 
     def get_id(self):
         """
@@ -130,11 +130,13 @@ def start_pairing(self, timeout):
 
         timeout -- Timeout in seconds at which to quit pairing
         """
-        print('Adapter:', self.name, 'id', self.id, 'pairing started')
+        print('Adapter:', self.name, 'id', self.id, 'pairing started',
+              flush=True)
 
     def cancel_pairing(self):
         """Cancel the pairing process."""
-        print('Adapter:', self.name, 'id', self.id, 'pairing cancelled')
+        print('Adapter:', self.name, 'id', self.id, 'pairing cancelled',
+              flush=True)
 
     def remove_thing(self, device_id):
         """
@@ -145,7 +147,8 @@ def remove_thing(self, device_id):
         device = self.get_device(device_id)
         if device:
             print('Adapter:', self.name, 'id', self.id,
-                  'remove_thing(' + device.id + ')')
+                  'remove_thing(' + device.id + ')',
+                  flush=True)
 
     def cancel_remove_thing(self, device_id):
         """
@@ -156,8 +159,9 @@ def cancel_remove_thing(self, device_id):
         device = self.get_device(device_id)
         if device:
             print('Adapter:', self.name, 'id', self.id,
-                  'cancel_remove_thing(' + device.id + ')')
+                  'cancel_remove_thing(' + device.id + ')',
+                  flush=True)
 
     def unload(self):
         """Perform any necessary cleanup before adapter is shut down."""
-        print('Adapter:', self.name, 'unloaded')
+        print('Adapter:', self.name, 'unloaded', flush=True)

gateway_addon/addon_manager_proxy.py

@@ -4,6 +4,8 @@
 import json
 import threading
 
+from .ipc import IpcClient
+
 
 class AddonManagerProxy:
     """
@@ -13,16 +15,15 @@ class AddonManagerProxy:
     to be handled by add-ons and sends back responses as appropriate.
     """
 
-    def __init__(self, socket, plugin_id, verbose=False):
+    def __init__(self, plugin_id, verbose=False):
         """
         Initialize the object.
 
-        socket -- the IPC socket
         plugin_id -- ID of this plugin
         verbose -- whether or not to enable verbose logging
         """
         self.adapter = None
-        self.socket = socket
+        self.ipc_client = IpcClient(plugin_id, verbose=verbose)
         self.plugin_id = plugin_id
         self.verbose = verbose
         self.running = True
@@ -35,7 +36,8 @@ def close(self):
         self.running = False
 
         try:
-            self.socket.close()
+            self.ipc_client.manager_socket.close()
+            self.ipc_client.plugin_socket.close()
         except NNError:
             pass
 
@@ -46,12 +48,13 @@ def add_adapter(self, adapter):
         adapter -- the Adapter that was added
         """
         if self.verbose:
-            print('AddonManagerProxy: add_adapter:', adapter.id)
+            print('AddonManagerProxy: add_adapter:', adapter.id, flush=True)
 
         self.adapter = adapter
         self.send('addAdapter', {
             'adapterId': adapter.id,
-            'name': adapter.name
+            'name': adapter.name,
+            'packageName': adapter.package_name,
         })
 
     def handle_device_added(self, device):
@@ -61,7 +64,8 @@ def handle_device_added(self, device):
         device -- the Device that was added
         """
         if self.verbose:
-            print('AddonManagerProxy: handle_device_added:', device.id)
+            print('AddonManagerProxy: handle_device_added:', device.id,
+                  flush=True)
 
         device_dict = device.as_dict()
         device_dict['adapterId'] = device.adapter.id
@@ -74,7 +78,8 @@ def handle_device_removed(self, device):
         device -- the Device that was removed
         """
         if self.verbose:
-            print('AddonManagerProxy: handle_device_removed:', device.id)
+            print('AddonManagerProxy: handle_device_removed:', device.id,
+                  flush=True)
 
         self.send('handleDeviceRemoved', {
             'adapterId': device.adapter.id,
@@ -106,42 +111,44 @@ def send(self, msg_type, data):
         data['pluginId'] = self.plugin_id
 
         try:
-            self.socket.send(json.dumps({
+            self.ipc_client.plugin_socket.send(json.dumps({
                 'messageType': msg_type,
                 'data': data,
             }))
         except NNError as e:
-            print('AddonManagerProxy: Failed to send message: {}'.format(e))
+            print('AddonManagerProxy: Failed to send message: {}'.format(e),
+                  flush=True)
 
     def recv(self):
         """Read a message from the IPC socket."""
         while self.running:
             try:
-                msg = self.socket.recv()
+                msg = self.ipc_client.plugin_socket.recv()
             except NNError as e:
                 print('AddonManagerProxy: Error receiving message from '
-                      'socket: {}'.format(e))
+                      'socket: {}'.format(e), flush=True)
                 break
 
             if self.verbose:
-                print('AddonMangerProxy: recv:', msg)
+                print('AddonMangerProxy: recv:', msg, flush=True)
 
             if not msg:
                 break
 
             if not self.adapter:
                 print('AddonManagerProxy: No adapter added yet, ignoring '
-                      'message.')
+                      'message.', flush=True)
                 continue
 
             try:
                 msg = json.loads(msg)
             except ValueError:
-                print('AddonManagerProxy: Error parsing message as JSON')
+                print('AddonManagerProxy: Error parsing message as JSON',
+                      flush=True)
                 continue
 
             if 'messageType' not in msg:
-                print('AddonManagerProxy: Invalid message')
+                print('AddonManagerProxy: Invalid message', flush=True)
                 continue
 
             msg_type = msg['messageType']
@@ -160,19 +167,20 @@ def recv(self):
                 def unload_fn(proxy):
                     proxy.adapter.unload()
                     proxy.send('adapterUnloaded',
-                               {'adapterId', proxy.adapter.id})
+                               {'adapterId': proxy.adapter.id})
 
                 self.make_thread(unload_fn, args=(self,))
                 continue
 
             if msg_type == 'unloadPlugin':
                 self.send('pluginUnloaded', {})
-                continue
+                self.close()
+                break
 
             # All messages from here on are assumed to require a valid deviceId
             if 'data' not in msg or 'deviceId' not in msg['data']:
                 print('AddonManagerProxy: No deviceId present in message, '
-                      'ignoring.')
+                      'ignoring.', flush=True)
                 continue
 
             device_id = msg['data']['deviceId']

gateway_addon/ipc.py

@@ -23,7 +23,7 @@ def __init__(self, plugin_id, verbose=False):
             self.manager_socket.connect(_IPC_BASE + 'gateway.addonManager')
 
         if verbose:
-            print('IpcClient: Connected to server, registering...')
+            print('IpcClient: Connected to server, registering...', flush=True)
 
         try:
             self.manager_socket.send(json.dumps({
@@ -33,17 +33,20 @@ def __init__(self, plugin_id, verbose=False):
                 }
             }))
         except NNError as e:
-            print('IpcClient: Failed to send message: {}'.format(e))
+            print('IpcClient: Failed to send message: {}'.format(e),
+                  flush=True)
             return
 
         try:
             resp = self.manager_socket.recv()
         except NNError as e:
-            print('IpcClient: Error receiving message: {}'.format(e))
+            print('IpcClient: Error receiving message: {}'.format(e),
+                  flush=True)
             return
 
         if verbose:
-            print('IpcClient: Received manager message:', resp)
+            print('IpcClient: Received manager message: {}'.format(resp),
+                  flush=True)
 
         try:
             resp = json.loads(resp)
@@ -56,7 +59,7 @@ def __init__(self, plugin_id, verbose=False):
                 _IPC_BASE + resp['data']['ipcBaseAddr'])
 
             if verbose:
-                print('IpcClient: Registered with PluginServer')
+                print('IpcClient: Registered with PluginServer', flush=True)
         except ValueError:
-            print('IpcClient: Unexpected registration reply from gateway:',
-                  resp)
+            print('IpcClient: Unexpected registration reply from gateway: {}'
+                  .format(resp), flush=True)

setup.py

@@ -13,7 +13,7 @@
 
 setup(
     name='gateway_addon',
-    version='0.1.0',
+    version='0.2.0',
     description='Bindings for Mozilla IoT Gateway add-ons',
     long_description=long_description,
     url='https://github.com/mozilla-iot/gateway-addon-python',