feat: hold update until the app creates a file signaling it is loaded -

closes #177

CHANGELOG.md

@@ -11,6 +11,7 @@
 - fix: pass raw bytes to `DisplayRenderEvent` and `DisplayCompressedRenderEvent` to avoid encoding issues
 - fix: add ".local" to hostname in users menus - closes #134
 - fix: use stdout instead of stderr for reading rpi-connect process output - closes #174
+- feat: hold update until the app creates a file signaling it is loaded - closes #177
 
 ## Version 1.1.0
 

pyproject.toml

@@ -151,7 +151,7 @@ select = ["ALL"]
 ignore = ["INP001", "PLR0911", "D203", "D213", "PLC0415", "TD003"]
 fixable = ["ALL"]
 unfixable = []
-logger-objects = ['ubo_app.logging.logger']
+logger-objects = ['ubo_app.logger.logger']
 
 [tool.ruff.lint.flake8-builtins]
 builtins-ignorelist = ["type", "id"]

tests/conftest.py

@@ -95,7 +95,7 @@ def app_context(original_app_context: AppContext) -> AppContext:
 def _logger() -> None:
     import logging
 
-    from ubo_app.logging import ExtraFormatter
+    from ubo_app.logger import ExtraFormatter
 
     extra_formatter = ExtraFormatter()
 

tests/fixtures/app.py

@@ -276,7 +276,7 @@ async def app_context(
 
     import os
 
-    from ubo_app.logging import setup_logging
+    from ubo_app.logger import setup_logging
 
     setup_logging()
 

ubo_app/error_handlers.py

@@ -49,7 +49,7 @@ def global_exception_handler(
     exception_traceback: TracebackType,
 ) -> None:
     _ = exception_type, exception_traceback
-    from ubo_app.logging import logger
+    from ubo_app.logger import logger
 
     threads_info = get_all_thread_stacks()
 
@@ -67,7 +67,7 @@ def global_exception_handler(
 
 
 def thread_exception_handler(args: threading.ExceptHookArgs) -> None:
-    from ubo_app.logging import logger
+    from ubo_app.logger import logger
 
     threads_info = get_all_thread_stacks()
 
@@ -98,7 +98,7 @@ def loop_exception_handler(
     context: dict[str, object],
 ) -> None:
     from ubo_app.constants import DEBUG_MODE_TASKS
-    from ubo_app.logging import logger
+    from ubo_app.logger import logger
 
     threads_info = get_all_thread_stacks()
 

ubo_app/load_services.py

@@ -29,7 +29,7 @@
     SERVICES_PATH,
 )
 from ubo_app.error_handlers import STACKS, loop_exception_handler
-from ubo_app.logging import logger
+from ubo_app.logger import logger
 
 if TYPE_CHECKING:
     from asyncio.tasks import Task
@@ -339,7 +339,7 @@ def task_wrapper(stack: str) -> None:
         )
 
     async def shutdown(self: UboServiceThread) -> None:
-        from ubo_app.logging import logger
+        from ubo_app.logger import logger
 
         logger.debug(
             'Stopping service thread',

ubo_app/main.py

@@ -8,7 +8,7 @@
 import dotenv
 
 from ubo_app.error_handlers import setup_error_handling
-from ubo_app.logging import setup_logging
+from ubo_app.logger import setup_logging
 from ubo_app.setup import setup
 from ubo_app.utils import IS_RPI
 
@@ -67,7 +67,7 @@ def main() -> None:
         ),
     )
 
-    from ubo_app.logging import logger
+    from ubo_app.logger import logger
     from ubo_app.menu_app.menu import MenuApp
 
     logger.info('----------------------Starting the app----------------------')

ubo_app/menu_app/menu_central.py

@@ -12,7 +12,7 @@
 from ubo_gui.menu.stack_item import StackItem, StackMenuItem
 
 from ubo_app.constants import DEBUG_MODE_MENU
-from ubo_app.logging import logger
+from ubo_app.logger import logger
 from ubo_app.menu_app.menu_notification_handler import MenuNotificationHandler
 from ubo_app.store.core.types import (
     CloseApplicationEvent,

ubo_app/rpc/server.py

@@ -7,7 +7,7 @@
 from grpclib.server import Server
 
 from ubo_app.constants import GRPC_LISTEN_ADDRESS, GRPC_LISTEN_PORT
-from ubo_app.logging import logger
+from ubo_app.logger import logger
 from ubo_app.rpc.service import StoreService
 
 

ubo_app/rpc/service.py

@@ -7,7 +7,7 @@
 
 import betterproto
 
-from ubo_app.logging import logger
+from ubo_app.logger import logger
 from ubo_app.rpc.generated.store.v1 import (
     DispatchActionRequest,
     DispatchActionResponse,

ubo_app/service.py

@@ -62,7 +62,7 @@ def task_wrapper(stack: str) -> None:
 
     async def shutdown(self: WorkerThread) -> None:
         from ubo_app.constants import MAIN_LOOP_GRACE_PERIOD
-        from ubo_app.logging import logger
+        from ubo_app.logger import logger
 
         logger.info('Stopping worker thread')
 

ubo_app/services/000-audio/audio_manager.py

@@ -10,7 +10,7 @@
 import simpleaudio
 from simpleaudio import _simpleaudio  # pyright: ignore [reportAttributeAccessIssue]
 
-from ubo_app.logging import logger
+from ubo_app.logger import logger
 from ubo_app.store.main import store
 from ubo_app.store.services.audio import AudioPlaybackDoneAction
 from ubo_app.utils.async_ import create_task

ubo_app/services/030-wifi/pages/create_wireless_connection.py

@@ -12,7 +12,7 @@
 from ubo_gui.page import PageWidget
 from wifi_manager import add_wireless_connection
 
-from ubo_app.logging import logger
+from ubo_app.logger import logger
 from ubo_app.store.core.types import CloseApplicationAction
 from ubo_app.store.input.types import InputFieldDescription, InputFieldType, InputMethod
 from ubo_app.store.main import store

ubo_app/services/030-wifi/setup.py

@@ -12,7 +12,7 @@
     request_scan,
 )
 
-from ubo_app.logging import logger
+from ubo_app.logger import logger
 from ubo_app.store.core.types import (
     RegisterSettingAppAction,
     SettingsCategory,

ubo_app/services/030-wifi/wifi_manager.py

@@ -264,7 +264,7 @@ async def add_wireless_connection(
             'auth-alg': ('s', 'open'),
             'psk': ('s', password),
         }
-    from ubo_app.logging import logger
+    from ubo_app.logger import logger
 
     properties: NetworkManagerConnectionProperties = {
         'connection': {

ubo_app/services/040-rgb-ring/rgb_ring_client.py

@@ -3,7 +3,7 @@
 
 from typing import TYPE_CHECKING
 
-from ubo_app.logging import logger
+from ubo_app.logger import logger
 from ubo_app.store.main import store
 from ubo_app.store.services.rgb_ring import RgbRingSetIsConnectedAction
 from ubo_app.utils.server import send_command

ubo_app/services/050-rpi-connect/commands.py

@@ -9,7 +9,7 @@
 from debouncer import DebounceOptions, debounce
 from ubo_gui.constants import DANGER_COLOR
 
-from ubo_app.logging import logger
+from ubo_app.logger import logger
 from ubo_app.store.main import store
 from ubo_app.store.services.notifications import (
     Chime,

ubo_app/services/050-rpi-connect/sign_in_page.py

@@ -13,7 +13,7 @@
 from ubo_gui.constants import DANGER_COLOR
 from ubo_gui.page import PageWidget
 
-from ubo_app.logging import logger
+from ubo_app.logger import logger
 from ubo_app.store.core.types import CloseApplicationAction
 from ubo_app.store.main import store
 from ubo_app.store.services.notifications import (

ubo_app/services/050-users/setup.py

@@ -21,7 +21,7 @@
     SubMenuItem,
 )
 
-from ubo_app.logging import logger
+from ubo_app.logger import logger
 from ubo_app.store.core.types import (
     RegisterSettingAppAction,
     SettingsCategory,

ubo_app/services/050-vscode/commands.py

@@ -11,7 +11,7 @@
 from debouncer import DebounceOptions, debounce
 from ubo_gui.constants import DANGER_COLOR
 
-from ubo_app.logging import logger
+from ubo_app.logger import logger
 from ubo_app.store.main import store
 from ubo_app.store.services.notifications import (
     Chime,

ubo_app/services/050-vscode/login_page.py

@@ -14,7 +14,7 @@
 from ubo_gui.constants import DANGER_COLOR
 from ubo_gui.page import PageWidget
 
-from ubo_app.logging import logger
+from ubo_app.logger import logger
 from ubo_app.store.core.types import CloseApplicationAction
 from ubo_app.store.main import store
 from ubo_app.store.services.notifications import (

ubo_app/services/080-docker/docker_container.py

@@ -13,7 +13,7 @@
 from docker_images import IMAGES
 from redux import AutorunOptions, FinishEvent
 
-from ubo_app.logging import logger
+from ubo_app.logger import logger
 from ubo_app.store.main import store
 from ubo_app.store.services.docker import (
     DockerImageSetDockerIdAction,

ubo_app/services/080-docker/docker_image.py

@@ -9,7 +9,7 @@
 from docker_images import IMAGES
 
 from ubo_app.constants import DOCKER_CREDENTIALS_TEMPLATE
-from ubo_app.logging import logger
+from ubo_app.logger import logger
 from ubo_app.store.main import store
 from ubo_app.store.services.docker import DockerImageSetStatusAction, DockerItemStatus
 from ubo_app.utils import secrets

ubo_app/services/080-docker/setup.py

@@ -22,7 +22,7 @@
 from ubo_gui.menu.types import ActionItem, HeadedMenu, Item, SubMenuItem
 
 from ubo_app.constants import DOCKER_CREDENTIALS_TEMPLATE
-from ubo_app.logging import logger
+from ubo_app.logger import logger
 from ubo_app.store.core.types import (
     RegisterRegularAppAction,
     RegisterSettingAppAction,

ubo_app/setup.py

@@ -152,7 +152,7 @@ def clear_signal_handlers() -> None:
 def signal_handler(signum: int, _: object) -> None:
     """Handle the signal."""
     from ubo_app import display
-    from ubo_app.logging import logger
+    from ubo_app.logger import logger
 
     logger.info('Received signal %s, turning off the display...', signum)
 

ubo_app/side_effects.py

@@ -12,6 +12,7 @@
 from redux import FinishAction, FinishEvent
 
 from ubo_app import display
+from ubo_app.constants import INSTALLATION_PATH
 from ubo_app.store.core.types import (
     PowerOffEvent,
     RebootEvent,
@@ -152,3 +153,7 @@ def setup_side_effects() -> None:
     store.subscribe_event(ReplayRecordedSequenceEvent, replay_recorded_sequence)
 
     store.dispatch(UpdateManagerSetStatusAction(status=UpdateStatus.CHECKING))
+
+    # Create a file signaling that the app is ready
+    Path(INSTALLATION_PATH).mkdir(parents=True, exist_ok=True)
+    (Path(INSTALLATION_PATH) / 'app_ready').touch()

ubo_app/store/main.py

@@ -26,7 +26,7 @@
 )
 
 from ubo_app.constants import DEBUG_MODE, STORE_GRACE_PERIOD
-from ubo_app.logging import logger
+from ubo_app.logger import logger
 from ubo_app.store.core.reducer import reducer as main_reducer
 from ubo_app.store.core.types import MainAction, MainEvent
 from ubo_app.store.input.reducer import reducer as input_reducer

ubo_app/store/update_manager/utils.py

@@ -22,7 +22,7 @@
     UPDATE_ASSETS_PATH,
     UPDATE_LOCK_PATH,
 )
-from ubo_app.logging import logger
+from ubo_app.logger import logger
 from ubo_app.store.core.types import RebootAction
 from ubo_app.store.dispatch_action import DispatchItem
 from ubo_app.store.main import store

ubo_app/system/bootstrap.py

@@ -13,7 +13,7 @@
 from typing import Literal, TypedDict
 
 from ubo_app.constants import INSTALLATION_PATH, USERNAME
-from ubo_app.logging import logger
+from ubo_app.logger import logger
 
 RETRIES = 5
 

ubo_app/system/install.sh

@@ -7,6 +7,7 @@ set -o nounset
 
 USERNAME=${USERNAME:-"ubo"}
 UPDATE=${UPDATE:-false}
+WAIT_FOR_APP=${WAIT_FOR_APP:-false}
 ALPHA=${ALPHA:-false}
 WITH_DOCKER=${WITH_DOCKER:-false}
 IN_PACKER=false
@@ -22,6 +23,10 @@ do
         UPDATE=true
         shift # Remove --update from processing
         ;;
+        --wait-for-app)
+        WAIT_FOR_APP=true
+        shift # Remove --wait-for-app from processing
+        ;;
         --alpha)
         ALPHA=true
         shift # Remove --alpha from processing
@@ -104,7 +109,14 @@ set -o errexit
 # Define the installation path
 INSTALLATION_PATH=${INSTALLATION_PATH:-"/opt/ubo"}
 
-# Create the installation path
+if [ "$WAIT_FOR_APP" = true ]; then
+  # Wait for the app to signal
+  while [ ! -f "$INSTALLATION_PATH/app_ready" ]; do
+    sleep 1
+  done
+fi
+
+# Remove the old files and create a fresh virtual environment in the installation path
 rm -rf "$INSTALLATION_PATH/env"
 virtualenv --system-site-packages "$INSTALLATION_PATH/env"
 

ubo_app/system/services/update.service.tmpl

@@ -13,7 +13,8 @@ User=root
 Environment=INSTALLATION_PATH={{INSTALLATION_PATH}}
 Environment=USERNAME={{USERNAME}}
 ExecStartPre=/bin/bash -c '[[ -e /opt/ubo/_update/update_is_ready.lock ]]'
-ExecStart={{INSTALLATION_PATH}}/_update/install.sh --update
+ExecStartPre=rm -f {{INSTALLATION_PATH}}/app_ready
+ExecStart={{INSTALLATION_PATH}}/_update/install.sh --update --wait-for-app
 RemainAfterExit=no
 Restart=yes
 RestartSec=5

ubo_app/system/system_manager/audio.py

@@ -5,7 +5,7 @@
 import time
 from pathlib import Path
 
-from ubo_app.logging import get_logger
+from ubo_app.logger import get_logger
 
 DEVICE = '1-001a'
 DRIVER_PATH = Path('/sys/bus/i2c/drivers/wm8960')

ubo_app/system/system_manager/led.py

@@ -12,7 +12,7 @@
 from adafruit_blinka.microcontroller.generic_micropython import Pin
 from fake import Fake
 
-from ubo_app.logging import add_file_handler, add_stdout_handler, get_logger
+from ubo_app.logger import add_file_handler, add_stdout_handler, get_logger
 
 if Path('/proc/device-tree/model').read_text().startswith('Raspberry Pi 5'):
     import sys

ubo_app/system/system_manager/main.py

@@ -19,7 +19,7 @@
 
 from ubo_app.constants import USERNAME
 from ubo_app.error_handlers import setup_error_handling
-from ubo_app.logging import add_file_handler, add_stdout_handler, get_logger
+from ubo_app.logger import add_file_handler, add_stdout_handler, get_logger
 from ubo_app.store.services.ethernet import NetState
 from ubo_app.system.system_manager.audio import audio_handler
 from ubo_app.system.system_manager.docker import docker_handler

ubo_app/system/system_manager/package.py

@@ -4,7 +4,7 @@
 
 import subprocess
 
-from ubo_app.logging import get_logger
+from ubo_app.logger import get_logger
 from ubo_app.utils.apt import install_package, uninstall_package
 
 PACKAGE_WHITELIST = [

ubo_app/system/system_manager/reset_button.py

@@ -3,7 +3,7 @@
 import subprocess
 import time
 
-from ubo_app.logging import get_logger
+from ubo_app.logger import get_logger
 
 logger = get_logger('system-manager')