feature(installer): update installer version and improve desktop version launcher

.github/workflows/deploy.yml

@@ -4,6 +4,7 @@ on:
     branches:
       - "master"
       - "hotfix/**"
+      - "feature/update-installer"
 
 jobs:
   binary:

AntaresWebLinux.spec

@@ -1,25 +1,27 @@
 # -*- mode: python ; coding: utf-8 -*-
 from pathlib import Path
-from PyInstaller.utils.hooks import collect_dynamic_libs
 
 block_cipher = None
 
-# We need to analyze all alembic files to be sure the migration phase works fine
-migrations_dir = Path('alembic/versions')
-migration_files = [str(f) for f in migrations_dir.iterdir() if f.is_file() and f.suffix == '.py']
+# We need to analyze all alembic files to be sure the migration phase works fine:
+# alembic loads version files by their path, so we need to add them as "data" to the package,
+# but all the dependencies they use need to be included also, wo we need to perform a
+# dedicated analyse for this.
+versions_dir = Path('alembic/versions')
+versions_files = [str(f) for f in versions_dir.iterdir() if f.is_file() and f.suffix == '.py']
+alembic_analysis = Analysis(["alembic/env.py"] + versions_files)
 
-binaries = [('./alembic.ini', './alembic.ini')]  + collect_dynamic_libs('tables')
-
-antares_web_server_a = Analysis(['antarest/gui.py', 'alembic/env.py'] + migration_files,
+antares_web_server_a = Analysis(['antarest/gui.py'],
              pathex=[],
-             binaries=binaries,
-             datas=[('./resources', './resources'), ('./alembic', './alembic')],
+             binaries=[],
+             datas=[('./resources', './resources'), ('./alembic', './alembic'), ('./alembic.ini', './')],
              hiddenimports=[
                  'cmath',
                  'antarest.dbmodel',
                  'plyer.platforms.linux',
                  'plyer.platforms.linux.notification',
                  'pythonjsonlogger.jsonlogger',
+                 'tables',
              ],
              hookspath=['extra-hooks'],
              hooksconfig={},
@@ -29,8 +31,13 @@ antares_web_server_a = Analysis(['antarest/gui.py', 'alembic/env.py'] + migratio
              win_private_assemblies=False,
              cipher=block_cipher,
              noarchive=False)
-antares_web_server_pyz = PYZ(antares_web_server_a.pure, antares_web_server_a.zipped_data,
+
+all_python = antares_web_server_a.pure + alembic_analysis.pure
+all_zipped_data = antares_web_server_a.zipped_data + alembic_analysis.zipped_data
+
+antares_web_server_pyz = PYZ(all_python, all_zipped_data,
              cipher=block_cipher)
+
 antares_web_server_exe = EXE(antares_web_server_pyz,
           antares_web_server_a.scripts, 
           [],

AntaresWebWin.spec

@@ -1,25 +1,27 @@
 # -*- mode: python ; coding: utf-8 -*-
 from pathlib import Path
-from PyInstaller.utils.hooks import collect_dynamic_libs
 
 block_cipher = None
 
-# We need to analyze all alembic files to be sure the migration phase works fine
-migrations_dir = Path('alembic/versions')
-migration_files = [str(f) for f in migrations_dir.iterdir() if f.is_file() and f.suffix == '.py']
+# We need to analyze all alembic files to be sure the migration phase works fine:
+# alembic loads version files by their path, so we need to add them as "data" to the package,
+# but all the dependencies they use need to be included also, wo we need to perform a
+# dedicated analyse for this.
+versions_dir = Path('alembic/versions')
+versions_files = [str(f) for f in versions_dir.iterdir() if f.is_file() and f.suffix == '.py']
+alembic_analysis = Analysis(["alembic/env.py"] + versions_files)
 
-binaries = [('./alembic.ini', './alembic.ini')]  + collect_dynamic_libs('tables')
-
-antares_web_server_a = Analysis(['antarest/gui.py', 'alembic/env.py'] + migration_files,
+antares_web_server_a = Analysis(['antarest/gui.py'],
              pathex=[],
-             binaries=binaries,
-             datas=[('./resources', './resources'), ('./alembic', './alembic')],
+             binaries=[],
+             datas=[('./resources', './resources'), ('./alembic', './alembic'), ('./alembic.ini', './')],
              hiddenimports=[
                  'cmath',
                  'antarest.dbmodel',
                  'plyer.platforms.win',
                  'plyer.platforms.win.notification',
                  'pythonjsonlogger.jsonlogger',
+                 'tables',
              ],
              hookspath=['extra-hooks'],
              hooksconfig={},
@@ -29,8 +31,13 @@ antares_web_server_a = Analysis(['antarest/gui.py', 'alembic/env.py'] + migratio
              win_private_assemblies=False,
              cipher=block_cipher,
              noarchive=False)
-antares_web_server_pyz = PYZ(antares_web_server_a.pure, antares_web_server_a.zipped_data,
+
+all_python = antares_web_server_a.pure + alembic_analysis.pure
+all_zipped_data = antares_web_server_a.zipped_data + alembic_analysis.zipped_data
+
+antares_web_server_pyz = PYZ(all_python, all_zipped_data,
              cipher=block_cipher)
+
 antares_web_server_exe = EXE(antares_web_server_pyz,
           antares_web_server_a.scripts, 
           [],

antarest/gui.py

@@ -15,13 +15,15 @@
 import platform
 import time
 import webbrowser
+from dataclasses import dataclass
 from multiprocessing import Process
 from pathlib import Path
+from threading import Thread
 
 import httpx
 import uvicorn
-from PyQt5.QtGui import QIcon
-from PyQt5.QtWidgets import QAction, QApplication, QMenu, QSystemTrayIcon
+from PyQt5.QtGui import QCursor, QIcon
+from PyQt5.QtWidgets import QApplication, QMenu, QSystemTrayIcon
 
 from antarest.core.utils.utils import get_local_path
 from antarest.main import fastapi_app, parse_arguments
@@ -39,67 +41,139 @@ def run_server(config_file: Path) -> None:
     uvicorn.run(app, host="127.0.0.1", port=8080)
 
 
+def start_server(config_file: Path) -> Process:
+    server = multiprocessing.Process(
+        target=run_server,
+        args=(config_file,),
+    )
+    server.start()
+    return server
+
+
 def open_app() -> None:
     webbrowser.open("http://localhost:8080")
 
 
-def main() -> None:
-    multiprocessing.freeze_support()
-    arguments = parse_arguments()
+@dataclass(frozen=True)
+class AntaresSystrayApp:
+    """
+    Used to keep ownership of root Qt objects.
+    QMenu can only be owned by QWidgets, but we don't have one.
+    """
+
+    app: QApplication
+    menu: QMenu
+
+
+def create_systray_app() -> AntaresSystrayApp:
+    """
+    Creates the small application that allows to open
+    the browser or shutdown the server.
+    """
+    app = QApplication([])
+    app.setQuitOnLastWindowClosed(False)
+
+    # Adding an icon
+    icon = QIcon(str(RESOURCE_PATH / "webapp" / "logo16.png"))
+    # Adding item on the menu bar
+    tray = QSystemTrayIcon(icon, app)
+    tray.setToolTip("AntaresWebServer")
+
+    # Creating the options
+    menu = QMenu()
+    open_app_action = menu.addAction("Open application")
+    assert open_app_action is not None
+    open_app_action.triggered.connect(open_app)
+    # To quit the app
+    quit_action = menu.addAction("Quit")
+    assert quit_action is not None
+    quit_action.triggered.connect(app.quit)
+
+    # Adding options to the System Tray
+    def handle_action(reason: int) -> None:
+        """
+        Shows context menu also on left click
+        """
+        if reason == QSystemTrayIcon.Trigger:  # type: ignore
+            menu = tray.contextMenu()
+            assert menu is not None
+            menu.popup(QCursor.pos())
+
+    tray.setContextMenu(menu)
+    tray.activated.connect(handle_action)
+
+    tray.setVisible(True)
+
+    return AntaresSystrayApp(app, menu)
+
+
+def monitor_server_process(server: Process, app: QApplication) -> None:
+    """
+    Quits the application when server process ends.
+    """
+    server.join()
+    app.quit()
+
+
+def setup_exit_application_on_server_end(server: Process, app: QApplication) -> None:
+    Thread(target=monitor_server_process, args=(server, app)).start()
+
+
+def check_server_started() -> bool:
+    with contextlib.suppress(httpx.ConnectError):
+        res = httpx.get("http://localhost:8080/health")
+        if res.status_code == 200:
+            return True
+    return False
+
+
+def wait_for_server_start() -> None:
+    for _ in range(30, 0, -1):
+        if check_server_started():
+            break
+        time.sleep(1)
+
+
+def notification_popup(message: str, threaded: bool = True) -> None:
     if platform.system() == "Windows":
         # noinspection PyPackageRequirements
         from win10toast import ToastNotifier  # type: ignore
 
         toaster = ToastNotifier()
         toaster.show_toast(
             "AntaresWebServer",
-            "Antares Web Server started, you can manage the application within the systray app",
+            message,
             icon_path=RESOURCE_PATH / "webapp" / "favicon.ico",
-            threaded=True,
+            threaded=threaded,
         )
     else:
         from plyer import notification  # type: ignore
 
         notification.notify(
             title="AntaresWebServer",
-            message="Antares Web Server started, you can manage the application within the systray app",
+            message=message,
             app_name="AntaresWebServer",
-            app_icon=RESOURCE_PATH / "webapp" / "favicon.ico",
+            app_icon=str(RESOURCE_PATH / "webapp" / "favicon.ico"),
             timeout=600,
         )
-    app = QApplication([])
-    app.setQuitOnLastWindowClosed(False)
-    # Adding an icon
-    icon = QIcon(str(RESOURCE_PATH / "webapp" / "logo16.png"))
-    # Adding item on the menu bar
-    tray = QSystemTrayIcon()
-    tray.setIcon(icon)
-    tray.setVisible(True)
-    # Creating the options
-    menu = QMenu()
-    open_app_action = QAction("Open application")
-    menu.addAction(open_app_action)
-    open_app_action.triggered.connect(open_app)
-    # To quit the app
-    quit_action = QAction("Quit")
-    quit_action.triggered.connect(app.quit)
-    menu.addAction(quit_action)
-    # Adding options to the System Tray
-    tray.setContextMenu(menu)
-    app.processEvents()
-    tray.setToolTip("AntaresWebServer")
-    server = Process(
-        target=run_server,
-        args=(arguments.config_file,),
-    )
-    server.start()
-    for _ in range(30, 0, -1):
-        with contextlib.suppress(httpx.ConnectError):
-            res = httpx.get("http://localhost:8080")
-            if res.status_code == 200:
-                break
-        time.sleep(1)
-    app.exec_()
+
+
+def main() -> None:
+    multiprocessing.freeze_support()
+
+    arguments = parse_arguments()
+    if check_server_started():
+        notification_popup(
+            "Antares Web Server already running, you can manage the application within the system tray.", threaded=False
+        )
+        return
+    notification_popup("Starting Antares Web Server...")
+    systray_app = create_systray_app()
+    server = start_server(arguments.config_file)
+    setup_exit_application_on_server_end(server, systray_app.app)
+    wait_for_server_start()
+    notification_popup("Antares Web Server started, you can manage the application within the system tray.")
+    systray_app.app.exec_()
     server.kill()