Add Waitress

Author: maggie44

docker-compose.yml

@@ -16,7 +16,7 @@ services:
       #USERNAME: "username" # Optional
       #PWC_PASSWORD: "your-password" # Optional. Must be 8 characters or more. 
 
-      ## System Variables ##
+      ## Required System Variables ##
       DBUS_SYSTEM_BUS_ADDRESS: "unix:path=/host/run/dbus/system_bus_socket"
     build:
       context: .

src/common/errors.py

@@ -4,15 +4,21 @@
 # Create custom logger
 logger = logging.getLogger('syslog')
 syslog = logging.StreamHandler()
-formatter = logging.Formatter('[%(asctime)s] - [%(levelname)s] - [%(module)s:'
-                              '%(lineno)d] - %(message)s', "%Y-%m-%d %H:%M:%S")
-syslog.setFormatter(formatter)
 logger.addHandler(syslog)
-logger.setLevel(logging.INFO)
 
-# Change default logging mode when in development environmnets
-if config.dev_mode:
+# When in development mode provide details in log of each line of code
+# that is executing
+if config.dev_mode is True:
+    formatter = logging.Formatter('[%(asctime)s] - [%(levelname)s] - '
+                                  '[%(module)s:%(lineno)d] - %(message)s',
+                                  '%Y-%m-%d %H:%M:%S')
     logger.setLevel(logging.DEBUG)
+else:
+    formatter = logging.Formatter('[%(asctime)s] - [%(levelname)s] - '
+                                  '%(message)s', '%Y-%m-%d %H:%M:%S')
+    logger.setLevel(logging.INFO)
+
+syslog.setFormatter(formatter)
 
 
 # Error classes for Flask-Restful

src/common/wifi.py

@@ -61,7 +61,7 @@ def auto_connect(ssid=None,
             break
     else:
         logger.info('Auto-connect failed as the device could not find the '
-                    'specified network.')
+                    'specified network. Starting hotspot instead...')
         connect()
 
 
@@ -108,7 +108,7 @@ def connect(conn_type=config.type_hotspot,
 
     try:
         NetworkManager.Settings.AddConnection(conn_dict)
-        logger.info(f"Added connection of type {conn_type}")
+        logger.debug(f"Added connection of type {conn_type}")
 
         # Find this connection and its device
         connections = \
@@ -139,7 +139,7 @@ def connect(conn_type=config.type_hotspot,
                 break
 
         if dev.State == NetworkManager.NM_DEVICE_STATE_ACTIVATED:
-            logger.info("Connected.")
+            logger.info("Active.")
             return True
         # If the current attempt is not already a hotspot attempt
         elif conn_type != config.type_hotspot:
@@ -170,14 +170,14 @@ def forget(create_new_hotspot=False, all_networks=False):
                     # Delete the identified connection
                     network_id = connection.GetSettings()["connection"]["id"]
                     connection.Delete()
-                    logger.info(f"Deleted connection: {network_id}")
+                    logger.debug(f"Deleted connection: {network_id}")
         else:
             connection_ids = \
                 dict([(x.GetSettings()['connection']['id'], x)
                      for x in connections])
             if config.ap_name in connection_ids:
                 connection_ids[config.ap_name].Delete()
-                logger.info(f"Deleted connection: {config.ap_name}")
+                logger.debug(f"Deleted connection: {config.ap_name}")
 
         if create_new_hotspot:
             refresh_networks()

src/requirements.in

@@ -1,2 +1,3 @@
 Flask-RESTful
 python-networkmanager
+waitress

src/requirements.txt

@@ -28,5 +28,7 @@ six==1.16.0
     # via
     #   flask-restful
     #   python-networkmanager
+waitress==2.0.0
+    # via -r requirements.in
 werkzeug==2.0.2
     # via flask

src/run.py

@@ -1,7 +1,4 @@
-import atexit
 import config
-import signal
-import sys
 import time
 from common.errors import errors
 from common.errors import logger
@@ -19,30 +16,27 @@
 from resources.wifi_routes import wifi_list_access_points
 from flask import Flask
 from flask_restful import Api
+from waitress import serve
 
 
-def handle_exit(*args):
-    logger.info('Finshed the exit process.')
+# Create Flask app instance
+app = Flask(__name__)
 
+# Load Flask-Restful API
+api = Api(app, errors=errors)
 
-def handle_sigterm(*args):
-    sys.exit(0)
+# Health check routes
+api.add_resource(system_health_check, '/healthcheck')
 
+# Wi-Fi routes
+api.add_resource(wifi_connect, '/v1/connect')
+api.add_resource(wifi_connection_status, '/v1/connection_status')
+api.add_resource(wifi_forget, '/v1/forget')
+api.add_resource(wifi_list_access_points, '/v1/list_access_points')
 
-# Startup process
 if __name__ == '__main__':
-    logger.info('Starting...')
-    # Load Flask-Restful API
-    api = Api(errors=errors)
-
-    # Create Flask app instance
-    app = Flask(__name__)
-
-    # Ensure soft shutdown to terminate wifi-connect
-    atexit.register(handle_exit, None, None)
-    signal.signal(signal.SIGHUP, handle_sigterm)
-    signal.signal(signal.SIGINT, handle_sigterm)
-    signal.signal(signal.SIGTERM, handle_sigterm)
+    # Begin loading program
+    logger.info('Checking for previously configured Wi-Fi connections...')
 
     # Start dnsmasq service for assigning IPs to connected devices
     dnsmasq()
@@ -53,6 +47,7 @@ def handle_sigterm(*args):
     # If the Wi-Fi connection is not already active, start a hotspot
     if check_wifi_status():
         logger.info('Wi-Fi connection already established.')
+        logger.info('Ready...')
     else:
         refresh_networks(retries=1)
         if config.auto_connect_kargs:
@@ -62,18 +57,4 @@ def handle_sigterm(*args):
             logger.info('Starting hotspot...')
             connect()
 
-    # Configure endpoints #
-
-    # Health check
-    api.add_resource(system_health_check, '/healthcheck')
-
-    # Wi-Fi
-    api.add_resource(wifi_connect, '/v1/connect')
-    api.add_resource(wifi_connection_status, '/v1/connection_status')
-    api.add_resource(wifi_forget, '/v1/forget')
-    api.add_resource(wifi_list_access_points, '/v1/list_access_points')
-
-    # Initialise and start
-    api.init_app(app)
-
-    app.run(port=port, host=host)
+    serve(app, host=host, port=port)