fix(backend): update only 'running' containers (#80)

+ added skip of not 'running' containers to avoid potential errors
+ added hints to the ui
+ edited readme

Author: Quenary

README.md

@@ -129,6 +129,8 @@ Automatic updates are disabled by default. You can choose only what you need.
 
   - **Image pull** performed for containers marked for **check**;
   - If there is a **new image** for any group's container and it is **marked for auto-update**, the update process begins;
+    * [protected](#custom-labels) containers will be skipped
+    * not `running` containers will be skipped
   - After that, all containers in the group are stopped in **order from most dependent**;
   - Then, **in reverse order** (from most dependable):
     - Updatable containers being recreated and started;
@@ -253,4 +255,3 @@ See [/backend/README.md](/backend/README.md) and [/frontend/README.md](/frontend
 - Dozzle integration or something more universal (list of urls for redirects?)
 - Swarm support?
 - Try to add release notes (from labels or something)
-- Do not update stopped containers

backend/core/container/util/__init__.py

@@ -28,3 +28,4 @@
 )
 from .get_container_entrypoint_str import get_container_entrypoint_str
 from .is_protected_container import is_protected_container
+from .is_running_container import is_running_container

backend/core/container/util/is_running_container.py

@@ -0,0 +1,9 @@
+from python_on_whales.components.container.models import (
+    ContainerInspectResult,
+)
+
+
+def is_running_container(container: ContainerInspectResult) -> bool:
+    return bool(
+        container.state and container.state.status == "running"
+    )

backend/core/containers_core.py

@@ -26,6 +26,7 @@
     get_container_config,
     merge_container_config_with_image,
     update_containers_data_after_check,
+    is_running_container,
 )
 from backend.core.container import (
     GroupCheckProgressCache,
@@ -170,8 +171,23 @@ def _will_update(gc: ContainerGroupItem) -> bool:
             and gc.new_image
             and gc.action == "update"
             and not gc.protected
+            and is_running_container(gc.container)
         )
 
+    def _will_skip(gc: ContainerGroupItem) -> bool:
+        """Whether to skip container"""
+        if gc.protected:
+            logging.info(
+                f"Container {gc.name} labeled with {TUGTAINER_PROTECTED_LABEL}, skipping."
+            )
+            return True
+        elif not is_running_container(gc.container):
+            logging.info(
+                f"Container {gc.name} is not running, skipping."
+            )
+            return True
+        return False
+
     def _group_state_to_result(
         group: ContainerGroup,
     ) -> GroupCheckResult:
@@ -223,7 +239,7 @@ async def _run_commands(commands: list[list[str]]):
         result = _group_state_to_result(group)
         await update_containers_data_after_check(result)
         logging.info(
-            f"""Group check completed.
+            f"""Group check completed. 
 ================================================================="""
         )
         CACHE.update({"status": ECheckStatus.DONE, "result": result})
@@ -232,20 +248,11 @@ async def _run_commands(commands: list[list[str]]):
     logging.info("Starting to update a group...")
     CACHE.update({"status": ECheckStatus.UPDATING})
 
-    protected_containers = [
-        gc for gc in group.containers if gc.protected
-    ]
-    for gc in protected_containers:
-        logging.info(
-            f"Container {gc.name} labeled with {TUGTAINER_PROTECTED_LABEL} and will be skipped."
-        )
-
-    # Starting from most dependent
+    # Getting containers configs and stopping them,
+    # from most dependent to most dependable.
     for gc in group.containers[::-1]:
-        # Skipping protected containers
-        if gc.protected:
+        if _will_skip(gc):
             continue
-        # Getting configs for all containers
         try:
             logging.info(
                 f"Getting config for container {gc.container.name}..."
@@ -261,7 +268,6 @@ async def _run_commands(commands: list[list[str]]):
 ================================================================="""
                 )
                 return await _on_stop_fail()
-        # Stopping all containers
         try:
             logging.info(f"Stopping container {gc.container.name}...")
             await client.container.stop(gc.name)
@@ -273,17 +279,15 @@ async def _run_commands(commands: list[list[str]]):
             )
             return await _on_stop_fail()
 
-    # Starting from most dependable.
-    # At that moment all containers should be stopped.
-    # Will update/start them in dependency order
+    # Updating and/or starting containers,
+    # from most dependable to most dependent.
 
     # Indicates was there an exception during the update
     # If True, the following updates will not be processed.
     any_failed: bool = False
 
     for gc in group.containers:
-        # Skipping protected containers
-        if gc.protected:
+        if _will_skip(gc):
             continue
         c_name = gc.name
         # Updating container
@@ -354,9 +358,13 @@ async def _run_commands(commands: list[list[str]]):
                 if await wait_for_container_healthy(
                     client, rolled_back, host.container_hc_timeout
                 ):
-                    logging.warning("Container is healthy!")
+                    logging.warning(
+                        "Container is healthy after rolling back!"
+                    )
                     continue
-                logging.warning("Container is unhealthy!")
+                logging.warning(
+                    "Container is unhealthy after rolling back!"
+                )
             # Failed to roll back
             except Exception as e:
                 logging.exception(e)
@@ -475,7 +483,9 @@ async def check_all(update: bool):
     Function performs checks in separate threads for each host.
     Should not raises errors, only logging.
     """
-    CACHE = ProcessCache[AllCheckProgressCache](ALL_CONTAINERS_STATUS_KEY)
+    CACHE = ProcessCache[AllCheckProgressCache](
+        ALL_CONTAINERS_STATUS_KEY
+    )
     try:
         STATUS = CACHE.get()
         if STATUS and STATUS.get("status") not in _ALLOW_STATUSES:

frontend/public/i18n/en.json

@@ -122,6 +122,10 @@
     "CHECKED_AT": "Last check",
     "UPDATED_AT": "Last update",
     "UPDATE": "Update",
+    "UPDATE_DISABLED_HINTS": {
+      "PROTECTED": "The protected container cannot be updated from the app.\n",
+      "NOT_RUNNING": "The container must be in running state.\n"
+    },
     "CHECK": "Check",
     "MAIN_BTN_HINT": "If a container is a part of a compose project, all project's containers will be involved in the process.",
     "PROTECTED": "Protected",

frontend/src/app/shared/components/container-actions/container-actions.html

@@ -1,17 +1,29 @@
+@let _loading = loading();
+
 <p-button-group>
   <p-button
-    [loading]="loading() == 'check'"
-    [disabled]="loading() == 'update'"
+    [loading]="_loading == 'check'"
+    [disabled]="_loading == 'update'"
     [label]="'CONTAINERS.CHECK' | translate"
     (onClick)="check(false)"
   ></p-button>
-  @if (!item()?.protected) {
-    <p-button
-      [loading]="loading() == 'update'"
-      [disabled]="!item()?.update_available || loading() == 'check'"
-      [label]="'CONTAINERS.UPDATE' | translate"
-      severity="success"
-      (onClick)="check(true)"
-    ></p-button>
-  }
+  <p-button
+    [loading]="_loading == 'update'"
+    [disabled]="_loading == 'check' || cantUpdate()"
+    [pTooltip]="updateButtonTooltip"
+    [tooltipDisabled]="!showUpdateTooltip()"
+    [label]="'CONTAINERS.UPDATE' | translate"
+    severity="success"
+    (onClick)="check(true)"
+  ></p-button>
 </p-button-group>
+
+<ng-template #updateButtonTooltip>
+  @let _item = item();
+  @if (_item.status != 'running') {
+    {{ 'CONTAINERS.UPDATE_DISABLED_HINTS.NOT_RUNNING' | translate }}
+  }
+  @if (_item.protected) {
+    {{ 'CONTAINERS.UPDATE_DISABLED_HINTS.PROTECTED' | translate }}
+  }
+</ng-template>

frontend/src/app/shared/components/container-actions/container-actions.ts

@@ -1,6 +1,7 @@
 import {
   ChangeDetectionStrategy,
   Component,
+  computed,
   DestroyRef,
   inject,
   input,
@@ -11,6 +12,7 @@ import { takeUntilDestroyed } from '@angular/core/rxjs-interop';
 import { TranslatePipe, TranslateService } from '@ngx-translate/core';
 import { ButtonModule } from 'primeng/button';
 import { ButtonGroupModule } from 'primeng/buttongroup';
+import { TooltipModule } from 'primeng/tooltip';
 import { finalize } from 'rxjs';
 import { ToastService } from 'src/app/core/services/toast.service';
 import { ContainersApiService } from 'src/app/entities/containers/containers-api.service';
@@ -22,7 +24,7 @@ import { IGroupCheckProgressCache } from 'src/app/entities/progress-cache/progre
  */
 @Component({
   selector: 'app-container-actions',
-  imports: [ButtonGroupModule, ButtonModule, TranslatePipe],
+  imports: [ButtonGroupModule, ButtonModule, TranslatePipe, TooltipModule],
   templateUrl: './container-actions.html',
   styleUrl: './container-actions.scss',
   changeDetection: ChangeDetectionStrategy.OnPush,
@@ -49,6 +51,20 @@ export class ContainerActions {
    * Loading flag
    */
   protected readonly loading = signal<'check' | 'update'>(null);
+  /**
+   * Container cannot be updated
+   */
+  protected readonly cantUpdate = computed<boolean>(() => {
+    const item = this.item();
+    return !item.update_available || item.status != 'running' || item.protected;
+  });
+  /**
+   * Whether to show update button tooltip
+   */
+  protected readonly showUpdateTooltip = computed<boolean>(() => {
+    const item = this.item();
+    return item.update_available && (item.status != 'running' || item.protected);
+  });
 
   /**
    * Run check/update process