Don't parse mike versions while sorting

There are 2 main reasons for this:

1. Parsing the mike versions is less future proof, as if more fields
   are added to the JSON in the future, we'll remove them from the
   output, making the sorting more bug prone and more costly to
   maintain.

2. Avoiding the extra wrapping in `sort_mike_versions()` makes it easier
   to test, as otherwise we need to do the extra wrapping in tests,
   wrapping that is really not related to sorting so it adds noise to
   the tests.

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>

Author: llucax

src/frequenz/repo/config/cli/version/mike/sort.py

@@ -4,36 +4,35 @@
 """Sort `mike`'s `version.json` file with a custom order."""
 
 
-import dataclasses
 import json
 import sys
-from typing import TextIO
+from typing import Any, TextIO
 
 from .... import github
-from ....mkdocs.mike import MikeVersionInfo, sort_mike_versions
+from ....mkdocs.mike import sort_mike_versions
 
 
-def _load_and_sort_versions_from(stream: TextIO) -> list[MikeVersionInfo]:
-    """Load the versions from the given stream.
+def _load_and_sort_versions_from(stream: TextIO) -> dict[str, dict[str, Any]]:
+    """Load the versions from the given stream and sort them.
 
     Args:
         stream: The stream to read the versions from.
 
     Returns:
-        The loaded versions.
+        The sorted loaded versions.
     """
-    versions = [MikeVersionInfo(**v) for v in json.load(stream)]
-    return sort_mike_versions(versions)
+    versions = {v["version"]: v for v in json.load(stream)}
+    return {v: versions[v] for v in sort_mike_versions(list(versions.keys()))}
 
 
-def _dump_versions_to(versions: list[MikeVersionInfo], stream: TextIO) -> None:
+def _dump_versions_to(versions: dict[str, dict[str, Any]], stream: TextIO) -> None:
     """Dump the versions to the given stream.
 
     Args:
         versions: The versions to dump.
         stream: The stream to write the versions to.
     """
-    json.dump([dataclasses.asdict(v) for v in versions], stream, separators=(",", ":"))
+    json.dump(list(versions.values()), stream, separators=(",", ":"))
 
 
 def main() -> None:

src/frequenz/repo/config/mkdocs/mike.py

@@ -210,9 +210,7 @@ def compare_mike_version(version1: str, version2: str) -> int:
     return -1 if version1 < version2 else 1
 
 
-def sort_mike_versions(
-    versions: list[MikeVersionInfo], *, reverse: bool = True
-) -> list[MikeVersionInfo]:
+def sort_mike_versions(versions: list[str], *, reverse: bool = True) -> list[str]:
     """Sort `mike`'s `version.json` file with a custom order.
 
     The `version` keys are expected as follows:
@@ -246,9 +244,5 @@ def sort_mike_versions(
     Returns:
         The sorted list of versions.
     """
-
-    def compare(ver1: MikeVersionInfo, ver2: MikeVersionInfo) -> int:
-        return compare_mike_version(ver1.version, ver2.version)
-
-    versions.sort(key=functools.cmp_to_key(compare), reverse=reverse)
+    versions.sort(key=functools.cmp_to_key(compare_mike_version), reverse=reverse)
     return versions