Branch v2.3.0

.github/config/repo_devs.json

@@ -13,6 +13,8 @@
     "reecebrowne",
     "DarioGii",
     "ConnorYoh",
-    "EthanHealy01"
+    "EthanHealy01",
+    "jbrunton96",
+    "balazs-szucs"
   ]
 }

.github/scripts/check_language_toml.py

@@ -11,13 +11,16 @@
 Usage:
     python check_language_toml.py --reference-file <path_to_reference_file> --branch <branch_name> [--actor <actor_name>] [--files <list_of_changed_files>]
 """
+
 # Sample for Windows:
 # python .github/scripts/check_language_toml.py --reference-file frontend/public/locales/en-GB/translation.toml --branch "" --files frontend/public/locales/de-DE/translation.toml frontend/public/locales/fr-FR/translation.toml
 
+import argparse
 import glob
 import os
-import argparse
 import re
+from pathlib import Path
+
 import tomllib  # Python 3.11+ (stdlib)
 import tomli_w  # For writing TOML files
 
@@ -36,7 +39,8 @@ def find_duplicate_keys(file_path, keys=None, prefix=""):
     duplicates = []
 
     # Load TOML file
-    with open(file_path, "rb") as file:
+    file_path = Path(file_path)
+    with file_path.open("rb") as file:
         data = tomllib.load(file)
 
     def process_dict(obj, current_prefix=""):
@@ -55,8 +59,8 @@ def process_dict(obj, current_prefix=""):
     return duplicates
 
 
-# Maximum size for TOML files (e.g., 500 KB)
-MAX_FILE_SIZE = 500 * 1024
+# Maximum size for TOML files (e.g., 570 KB)
+MAX_FILE_SIZE = 570 * 1024
 
 
 def parse_toml_file(file_path):
@@ -65,7 +69,8 @@ def parse_toml_file(file_path):
     :param file_path: Path to the TOML file.
     :return: Dictionary with flattened keys.
     """
-    with open(file_path, "rb") as file:
+    file_path = Path(file_path)
+    with file_path.open("rb") as file:
         data = tomllib.load(file)
 
     def flatten_dict(d, parent_key="", sep="."):
@@ -108,7 +113,8 @@ def write_toml_file(file_path, updated_properties):
     """
     nested_data = unflatten_dict(updated_properties)
 
-    with open(file_path, "wb") as file:
+    file_path = Path(file_path)
+    with file_path.open("wb") as file:
         tomli_w.dump(nested_data, file)
 
 
@@ -119,18 +125,23 @@ def update_missing_keys(reference_file, file_list, branch=""):
     :param file_list: List of translation files to update.
     :param branch: Branch where the files are located.
     """
+    reference_file = Path(reference_file)
     reference_properties = parse_toml_file(reference_file)
+    branch_path = Path(branch) if branch else Path()
 
     for file_path in file_list:
-        basename_current_file = os.path.basename(os.path.join(branch, file_path))
+        file_path = Path(file_path)
+        language_dir = file_path.parent.name
+        reference_lang_dir = reference_file.parent.name
         if (
-            basename_current_file == os.path.basename(reference_file)
-            or not file_path.endswith(".toml")
-            or not os.path.dirname(file_path).endswith("locales")
+            language_dir == reference_lang_dir
+            or file_path.suffix != ".toml"
+            or file_path.parents[1].name != "locales"
         ):
+            print(f"Skipping file: {file_path}")
             continue
 
-        current_properties = parse_toml_file(os.path.join(branch, file_path))
+        current_properties = parse_toml_file(branch_path / file_path)
         updated_properties = {}
 
         for ref_key, ref_value in reference_properties.items():
@@ -141,22 +152,25 @@ def update_missing_keys(reference_file, file_list, branch=""):
                 # Add missing key with reference value
                 updated_properties[ref_key] = ref_value
 
-        write_toml_file(os.path.join(branch, file_path), updated_properties)
+        write_toml_file(branch_path / file_path, updated_properties)
 
 
 def check_for_missing_keys(reference_file, file_list, branch):
     update_missing_keys(reference_file, file_list, branch)
 
 
 def read_toml_keys(file_path):
-    if os.path.isfile(file_path) and os.path.exists(file_path):
+    file_path = Path(file_path)
+    if file_path.is_file():
         return parse_toml_file(file_path)
     return {}
 
 
 def check_for_differences(reference_file, file_list, branch, actor):
     reference_branch = branch
-    basename_reference_file = os.path.basename(reference_file)
+    reference_file = Path(reference_file)
+    basename_reference_file = reference_file.name
+    branch_path = Path(branch) if branch else Path()
 
     report = []
     report.append(f"#### 🔄 Reference Branch: `{reference_branch}`")
@@ -170,39 +184,44 @@ def check_for_differences(reference_file, file_list, branch, actor):
     if len(file_list) == 1:
         file_arr = file_list[0].split()
 
-    base_dir = os.path.abspath(
-        os.path.join(os.getcwd(), "frontend", "public", "locales")
-    )
+    base_dir = Path.cwd() / "frontend" / "public" / "locales"
 
     for file_path in file_arr:
-        file_normpath = os.path.normpath(file_path)
-        absolute_path = os.path.abspath(file_normpath)
+        file_path = Path(file_path)
+        file_normpath = file_path
+        absolute_path = file_normpath.resolve()
+
+        basename_current_file = (branch_path / file_normpath).name
+        locale_dir = file_normpath.parent.name
+        report.append(f"#### 📃 **File Check:** `{locale_dir}/{basename_current_file}`")
 
         # Verify that file is within the expected directory
-        if not absolute_path.startswith(base_dir):
-            raise ValueError(f"Unsafe file found: {file_normpath}")
+        if not absolute_path.is_relative_to(base_dir):
+            has_differences = True
+            report.append(
+                f"\n⚠️ Unsafe file found: `{locale_dir}/{basename_current_file}`\n\n---\n"
+            )
+            continue
 
         # Verify file size before processing
-        if os.path.getsize(os.path.join(branch, file_normpath)) > MAX_FILE_SIZE:
-            raise ValueError(
-                f"The file {file_normpath} is too large and could pose a security risk."
+        if (branch_path / file_normpath).stat().st_size > MAX_FILE_SIZE:
+            has_differences = True
+            report.append(
+                f"\n⚠️ The file `{locale_dir}/{basename_current_file}` is too large and could pose a security risk.\n\n---\n"
             )
-
-        basename_current_file = os.path.basename(os.path.join(branch, file_normpath))
-        locale_dir = os.path.basename(os.path.dirname(file_normpath))
+            continue
 
         if basename_current_file == basename_reference_file and locale_dir == "en-GB":
             continue
 
         if (
-            not file_normpath.endswith(".toml")
+            file_normpath.suffix != ".toml"
             or basename_current_file != "translation.toml"
         ):
             continue
 
         only_reference_file = False
-        report.append(f"#### 📃 **File Check:** `{locale_dir}/{basename_current_file}`")
-        current_keys = read_toml_keys(os.path.join(branch, file_path))
+        current_keys = read_toml_keys(branch_path / file_path)
         reference_key_count = len(reference_keys)
         current_key_count = len(current_keys)
 
@@ -247,13 +266,13 @@ def check_for_differences(reference_file, file_list, branch, actor):
         else:
             report.append("2. **Test Status:** ✅ **_Passed_**")
 
-        if find_duplicate_keys(os.path.join(branch, file_normpath)):
+        if find_duplicate_keys(branch_path / file_normpath):
             has_differences = True
             output = "\n".join(
                 [
                     f"      - `{key}`: first at {first}, duplicate at `{duplicate}`"
                     for key, first, duplicate in find_duplicate_keys(
-                        os.path.join(branch, file_normpath)
+                        branch_path / file_normpath
                     )
                 ]
             )