[setup] invoke command updates (#11340)

* invoke command updates

- wait for db before migrating data
- improve task state reporting
- early return from isGeneratingSchema

* Disable warning message (for now)

* Fix typo

- This caused large delay when restoring data

* Remove debug statement

* Add warning message if isGeneratingSchema called falls through unexpectedly

src/backend/InvenTree/InvenTree/backends.py

@@ -84,10 +84,11 @@ class InvenTreeMaintenanceModeBackend(AbstractStateBackend):
 
             r -= 1
 
-            if r == 0:
+            # Disable this warning message (for now) as it is confusing users with no upside
-                logger.warning(
+            # if r == 0:
-                    'Failed to set maintenance mode state after %s retries', retries
+            #     logger.warning(
-                )
+            #         'Failed to set maintenance mode state after %s retries', retries
+            #     )
 
 
 class InvenTreeMailLoggingBackend(BaseEmailBackend):

src/backend/InvenTree/InvenTree/ready.py

@@ -6,6 +6,11 @@ import os
 import sys
 import warnings
 
+import structlog
+
+logger = structlog.get_logger('inventree')
+
+
 # Keep track of loaded apps, to prevent multiple executions of ready functions
 _loaded_apps = set()
 
@@ -33,6 +38,11 @@ def isInTestMode():
     return 'test' in sys.argv or sys.argv[0].endswith('pytest')
 
 
+def isWaitingForDatabase():
+    """Return True if we are currently waiting for the database to be ready."""
+    return 'wait_for_db' in sys.argv
+
+
 def isImportingData():
     """Returns True if the database is currently importing (or exporting) data, e.g. 'loaddata' command is performed."""
     return any(x in sys.argv for x in ['flush', 'loaddata', 'dumpdata'])
@@ -61,7 +71,7 @@ def isRunningBackup():
             'backup',
             'restore',
             'dbbackup',
-            'dbresotore',
+            'dbrestore',
             'mediabackup',
             'mediarestore',
         ]
@@ -82,11 +92,23 @@ def isGeneratingSchema():
     if isInTestMode():
         return False
 
+    if isWaitingForDatabase():
+        return False
+
     if 'schema' in sys.argv:
         return True
 
     # This is a very inefficient call - so we only use it as a last resort
-    return any('drf_spectacular' in frame.filename for frame in inspect.stack())
+    result = any('drf_spectacular' in frame.filename for frame in inspect.stack())
+
+    if not result:
+        # We should only get here if we *are* generating schema
+        # Any other time this is called, it should be from a server thread, worker thread, or test mode
+        logger.warning(
+            'isGeneratingSchema called outside of expected contexts - this may be a sign of a problem with the ready() function'
+        )
+
+    return result
 
 
 def isInWorkerThread():

tasks.py

@@ -139,16 +139,16 @@ def state_logger(fn=None, method_name=None):
     """Decorator to log state markers before/after function execution, optionally accepting arguments."""
 
     def decorator(func):
-        func.method_name = method_name or f'invoke task named `{func.__name__}`'
+        func.method_name = method_name or func.__name__
 
         @wraps(func)
         def wrapped(c, *args, **kwargs):
             do_log = is_debug_environment()
             if do_log:
-                info(f'# {func.method_name}| start')
+                info(f'# task | {func.method_name} | start')
             func(c, *args, **kwargs)
             if do_log:
-                info(f'# {func.method_name}| done')
+                info(f'# task | {func.method_name} | done')
 
         return wrapped
 
@@ -530,10 +530,18 @@ def check_file_existence(filename: Path, overwrite: bool = False):
             sys.exit(1)
 
 
+@task
+@state_logger
+def wait(c):
+    """Wait until the database connection is ready."""
+    info('Waiting for database connection...')
+    return manage(c, 'wait_for_db')
+
+
 # Install tasks
 # region tasks
 @task(help={'uv': 'Use UV (experimental package manager)'})
-@state_logger('TASK01')
+@state_logger
 def plugins(c, uv=False):
     """Installs all plugins as specified in 'plugins.txt'."""
     from src.backend.InvenTree.InvenTree.config import (  # type: ignore[import]
@@ -553,7 +561,7 @@ def plugins(c, uv=False):
         'dev': 'Install development requirements instead of production requirements',
     }
 )
-@state_logger('TASK02')
+@state_logger
 def install(c, uv=False, skip_plugins=False, dev=False):
     """Installs required python packages."""
     if dev:
@@ -639,7 +647,7 @@ def rebuild_thumbnails(c):
 
 
 @task
-@state_logger('TASK09')
+@state_logger
 def clean_settings(c):
     """Clean the setting tables of old settings."""
     info('Cleaning old settings from the database')
@@ -669,7 +677,7 @@ def remove_mfa(c, mail='', username=''):
         'skip_plugins': 'Ignore collection of plugin static files',
     }
 )
-@state_logger('TASK08')
+@state_logger
 def static(c, frontend=False, clear=True, skip_plugins=False):
     """Copies required static files to the STATIC_ROOT directory, as per Django requirements."""
     if frontend and node_available():
@@ -725,7 +733,7 @@ def translate(c, ignore_static=False, no_frontend=False):
         'skip_media': 'Skip media backup step (only backup database files)',
     }
 )
-@state_logger('TASK04')
+@state_logger
 def backup(
     c,
     clean: bool = False,
@@ -838,15 +846,15 @@ def restore(
 
 
 @task()
-@state_logger()
+@state_logger
 def listbackups(c):
     """List available backup files."""
     info('Finding available backup files...')
     manage(c, 'listbackups')
 
 
-@task(post=[rebuild_models, rebuild_thumbnails])
+@task(pre=[wait], post=[rebuild_models, rebuild_thumbnails])
-@state_logger('TASK05')
+@state_logger
 def migrate(c):
     """Performs database migrations.
 
@@ -879,7 +887,7 @@ def showmigrations(c, app=''):
         'uv': 'Use UV (experimental package manager)',
     },
 )
-@state_logger('TASK03')
+@state_logger
 def update(
     c,
     skip_backup: bool = False,
@@ -953,7 +961,8 @@ def update(
         'include_sso': 'Include SSO token data in the output file (default = False)',
         'include_session': 'Include user session data in the output file (default = False)',
         'retain_temp': 'Retain temporary files (containing permissions) at end of process (default = False)',
-    }
+    },
+    pre=[wait],
 )
 def export_records(
     c,
@@ -1050,6 +1059,7 @@ def export_records(
         'clear': 'Clear existing data before import',
         'retain_temp': 'Retain temporary files at end of process (default = False)',
     },
+    pre=[wait],
     post=[rebuild_models, rebuild_thumbnails],
 )
 def import_records(
@@ -1199,12 +1209,6 @@ def import_fixtures(c):
 
 
 # Execution tasks
-@task
-@state_logger('TASK10')
-def wait(c):
-    """Wait until the database connection is ready."""
-    info('Waiting for database connection...')
-    return manage(c, 'wait_for_db')
 
 
 @task(
@@ -1506,7 +1510,7 @@ def setup_test(
         'no_default': 'Do not use default settings for schema (default = off/False)',
     }
 )
-@state_logger('TASK11')
+@state_logger
 def schema(
     c, filename='schema.yml', overwrite=False, ignore_warnings=False, no_default=False
 ):
@@ -1668,7 +1672,7 @@ def frontend_check(c):
 
 
 @task(help={'extract': 'Extract translation strings. Default: False'})
-@state_logger('TASK06')
+@state_logger
 def frontend_compile(c, extract: bool = False):
     """Generate react frontend.
 
@@ -1781,7 +1785,7 @@ def frontend_test(c, host: str = '0.0.0.0'):
         'clean': 'Delete old files from InvenTree/web/static/web first, default: True',
     }
 )
-@state_logger('TASK07')
+@state_logger
 def frontend_download(
     c,
     ref=None,