Remove yaml migration, start work on preset config

.devcontainer/devcontainer.json

@@ -21,7 +21,7 @@
     "host",
   ],
   "mounts": [
-    "source=${localWorkspaceFolder}/.devcontainer/ledfx-config.yml,target=/root/.ledfx/config.yaml,type=bind,consistency=cached"
+    "source=${localWorkspaceFolder}/.devcontainer/ledfx-config.yml,target=/root/.ledfx/config.json,type=bind,consistency=cached"
   ],
   // Set *default* container specific settings.json values on container create.
   "settings": {

docs/developer.rst

@@ -89,7 +89,7 @@ Building the LedFx frontend is different from how the core backend is built. The
 uses NPM as the core package management.
 
 .. note:: LedFx will need to be running in development mode for everything to work. To enable development mode,
-          open the ``config.yaml`` file in the ``.ledfx`` folder and set ``dev_mode: true``)
+          open the ``config.json`` file in the ``.ledfx`` folder and set ``dev_mode: true``)
 
 .. _linux-frontend:
 

ledfx/config.py

@@ -5,11 +5,12 @@ import os
 import sys
 
 import voluptuous as vol
-import yaml
+
+from ledfx.consts import CONFIGURATION_VERSION
 
 CONFIG_DIRECTORY = ".ledfx"
 CONFIG_FILE_NAME = "config.json"
-OLD_CONFIG_FILE_NAME = "config.yaml"
+PRESETS_FILE_NAME = "presets.json"
 
 CORE_CONFIG_SCHEMA = vol.Schema(
     {
@@ -25,6 +26,9 @@ CORE_CONFIG_SCHEMA = vol.Schema(
         vol.Optional("virtuals", default=[]): list,
         vol.Optional("wled_preferred_mode", default=""): str,
         vol.Optional("scan_on_startup", default=True): bool,
+        vol.Optional(
+            "configuration_version", default=CONFIGURATION_VERSION
+        ): str,
     },
     extra=vol.ALLOW_EXTRA,
 )
@@ -49,13 +53,16 @@ def get_config_file(config_dir: str) -> str:
 
     json_path = os.path.join(config_dir, CONFIG_FILE_NAME)
     if os.path.isfile(json_path) is False:  # Can't find a JSON file
-        yaml_path = os.path.join(
-            config_dir, OLD_CONFIG_FILE_NAME
-        )  # Look for an old YAML file
-        if os.path.isfile(yaml_path):  # Found one!
-            return yaml_path  # Return the YAML File
-        else:
-            return None  # No Valid Configs, return None to build another one
+        return None  # No Valid Configs, return None to build another one
+    return json_path  # Return the JSON file if we find one.
+
+
+def get_preset_file(config_dir: str) -> str:
+    """Finds a supported preset file in the provided directory"""
+
+    json_path = os.path.join(config_dir, PRESETS_FILE_NAME)
+    if os.path.isfile(json_path) is False:  # Can't find a JSON file
+        return None  # No Valid Configs, return None to build another one
     return json_path  # Return the JSON file if we find one.
 
 
@@ -103,6 +110,16 @@ def ensure_config_file(config_dir: str) -> str:
     return config_path
 
 
+def check_preset_file(config_dir: str) -> str:
+
+    ensure_config_directory(config_dir)
+    presets_path = get_preset_file(config_dir)
+    if presets_path is None:
+        return None
+
+    return presets_path
+
+
 def ensure_config_directory(config_dir: str) -> None:
     """Validate that the config directory is valid."""
 
@@ -136,17 +153,13 @@ def load_config(config_dir: str) -> dict:
     print(
         f"Loading configuration file: {os.path.join(config_dir, CONFIG_FILE_NAME)}"
     )
-
-    if config_file.endswith("yaml"):
-        migrate_config(config_dir, config_file)
-        config_file = os.path.join(config_dir, CONFIG_FILE_NAME)
     try:
 
         with open(config_file, encoding="utf-8") as file:
             config_json = json.load(file)
             return CORE_CONFIG_SCHEMA(config_json)
     except json.JSONDecodeError:
-        date = datetime.date.today()
+        date = datetime.datetime.now().strftime("%d-%m-%y_%H-%M-%S")
         backup_location = os.path.join(
             config_dir, f"config.json.backup.{date}"
         )
@@ -165,35 +178,29 @@ def save_config(config: dict, config_dir: str) -> None:
 
     config_file = ensure_config_file(config_dir)
     _LOGGER.info(("Saving configuration file to {}").format(config_dir))
-    # prevent defaults being saved to config.yaml by creating a copy (python
-    # no pass by value)
+    config["configuration_version"] = CONFIGURATION_VERSION
     config_view = dict(config)
-    if "ledfx_presets" in config_view.keys():
-        del config_view["ledfx_presets"]
+    unneeded_keys = ["ledfx_presets"]
+    for key in [key for key in config_view if key in unneeded_keys]:
+        del config_view[key]
+
     with open(config_file, "w", encoding="utf-8") as file:
         json.dump(
             config_view, file, ensure_ascii=False, sort_keys=True, indent=4
         )
 
 
-def migrate_config(config_dir, config_file):
-    """Save the old configuration file as a new JSON object and resume the loading process"""
+def save_presets(config: dict, config_dir: str) -> None:
+    """Saves the configuration to the provided directory"""
 
-    print("Migrating configuration file to JSON")
-    with open(config_file, "rt") as file:
-        config_yaml = yaml.safe_load(file)
-        json_config_file = os.path.join(config_dir, CONFIG_FILE_NAME)
-        with open(json_config_file, "w", encoding="utf-8") as file:
-            json.dump(
-                config_yaml, file, ensure_ascii=False, sort_keys=True, indent=4
-            )
-    try:
-        old_config_location = os.path.join(
-            config_dir, f"{datetime.date.today()}_config.yaml.backup"
-        )
-        _LOGGER.info(f"Renaming old configuration to {old_config_location}")
-        os.rename(config_file, old_config_location)
-    except PermissionError as DelError:
-        _LOGGER.warning(
-            f"Unable to rename old configuration file: {DelError}."
+    presets_file = check_preset_file(config_dir)
+    _LOGGER.info(("Saving user presets to {}").format(config_dir))
+
+    config_view = dict(config)
+    for key in [key for key in config_view if key != "user_presets"]:
+        del config_view[key]
+
+    with open(presets_file, "w", encoding="utf-8") as file:
+        json.dump(
+            config_view, file, ensure_ascii=False, sort_keys=True, indent=4
         )

ledfx/consts.py

@@ -24,6 +24,13 @@ PROJECT_VERSION = "{}.{}.{}".format(
 )
 DEV_VERSION = 0
 POST_VERSION = 0
+CONFIG_MAJOR_VERSION = 1
+CONFIG_MINOR_VERSION = 0
+CONFIG_MICRO_VERSION = 0
+
+CONFIGURATION_VERSION = "{}.{}.{}".format(
+    CONFIG_MAJOR_VERSION, CONFIG_MINOR_VERSION, CONFIG_MICRO_VERSION
+)
 
 if DEV > 0:
     DEV_VERSION = "{}-dev{}".format(PROJECT_VERSION, DEV)

requirements.txt

@@ -14,7 +14,6 @@
     multidict>=5.0.0
     aiohttp_jinja2>=1.1.0
     requests>=2.24.0
-    pyyaml>=5.3.1
     aubio>=0.4.9
     zeroconf>=0.28.6
     cython==0.29.21

setup-gh.py

@@ -29,7 +29,6 @@ INSTALL_REQUIRES = [
     "chardet==3.0.4",
     "aiohttp_jinja2>=1.1.0",
     "requests>=2.24.0",
-    "pyyaml>=5.3.1",
     "aubio>=0.4.9",
     "zeroconf>=0.28.6",
     'pywin32>=300; platform_system == "Windows"',

setup.py

@@ -28,7 +28,6 @@ INSTALL_REQUIRES = [
     "multidict>=5.0.0",
     "aiohttp_jinja2>=1.1.0",
     "requests>=2.24.0",
-    "pyyaml>=5.3.1",
     "aubio>=0.4.9",
     "zeroconf>=0.28.6",
     'pypiwin32>=223; platform_system == "Windows"',