♻️ Use file instead of config for incomplete startup flag

Makes it easier in CI situations to reconfigure the server.
OctoPrint · Jul 18, 2023 · fc53dab · fc53dab
1 parent ceb85d3
commit fc53dab
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 12 deletions.
diff --git a/docs/configuration/config_yaml.rst b/docs/configuration/config_yaml.rst
@@ -871,10 +871,6 @@ Use the following settings to configure the server:
      # reset the setting to false
      startOnceInSafeMode: false
 
-     # Signals to OctoPrint that the last startup was incomplete. OctoPrint will then startup
-     # in safe mode
-     incompleteStartup: false
-
      # Set this to true to make OctoPrint ignore incomplete startups. Helpful for development.
      ignoreIncompleteStartup: false
 

diff --git a/src/octoprint/__init__.py b/src/octoprint/__init__.py
@@ -124,7 +124,7 @@ def init_platform(
     )
     settings_incomplete_startup_safemode = (
         "incomplete_startup"
-        if settings.getBoolean(["server", "incompleteStartup"])
+        if os.path.exists(os.path.join(settings._basedir, ".incomplete_startup"))
         and not settings.getBoolean(["server", "ignoreIncompleteStartup"])
         else None
     )

diff --git a/src/octoprint/schema/config/server.py b/src/octoprint/schema/config/server.py
@@ -165,9 +165,6 @@ class ServerConfig(BaseModel):
     ignoreIncompleteStartup: bool = False
     """Set this to true to make OctoPrint ignore incomplete startups. Helpful for development."""
 
-    incompleteStartup: bool = False
-    """Signals to OctoPrint that the last startup was incomplete. OctoPrint will then startup in safe mode."""
-
     seenWizards: Dict[str, str] = {}
 
     secretKey: Optional[str] = None

diff --git a/src/octoprint/server/__init__.py b/src/octoprint/server/__init__.py
@@ -9,6 +9,7 @@
 import logging.config
 import mimetypes
 import os
+import pathlib
 import re
 import signal
 import sys
@@ -300,9 +301,14 @@ def run(self):
         if self._settings is None:
             self._settings = settings()
 
+        incomplete_startup_flag = (
+            pathlib.Path(self._settings._basedir) / ".incomplete_startup"
+        )
         if not self._settings.getBoolean(["server", "ignoreIncompleteStartup"]):
-            self._settings.setBoolean(["server", "incompleteStartup"], True)
-            self._settings.save()
+            try:
+                incomplete_startup_flag.touch()
+            except Exception:
+                self._logger.exception("Could not create startup triggered safemode flag")
 
         if self._plugin_manager is None:
             self._plugin_manager = octoprint.plugin.plugin_manager()
@@ -1294,8 +1300,13 @@ def call_on_after_startup(name, plugin):
 
                 # if there was a rogue plugin we wouldn't even have made it here, so remove startup triggered safe mode
                 # flag again...
-                self._settings.setBoolean(["server", "incompleteStartup"], False)
-                self._settings.save()
+                try:
+                    if incomplete_startup_flag.exists():
+                        incomplete_startup_flag.unlink()
+                except Exception:
+                    self._logger.exception(
+                        "Could not clear startup triggered safe mode flag"
+                    )
 
                 # make a backup of the current config
                 self._settings.backup(ext="backup")