Update Firefox icons from Acorn repo (#22526)

* Updated Icons from Acorn repo

* Update acorn icons script with single source of thruth

* Update sync acorn icons script to take into account ExtraSmall size

* Add documentation for sync_acorns_icons.py as file header

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Filippo <fzazzeroni@mozilla.com>

Author: github-actions[bot]

latest_acorn_release.json

@@ -1,9 +1,9 @@
 {
-    "url": "https://api.github.com/repos/FirefoxUX/acorn-icons/releases/177905895",
-    "assets_url": "https://api.github.com/repos/FirefoxUX/acorn-icons/releases/177905895/assets",
-    "upload_url": "https://uploads.github.com/repos/FirefoxUX/acorn-icons/releases/177905895/assets{?name,label}",
-    "html_url": "https://github.com/FirefoxUX/acorn-icons/releases/tag/v1.23.0",
-    "id": 177905895,
+    "url": "https://api.github.com/repos/FirefoxUX/acorn-icons/releases/178987114",
+    "assets_url": "https://api.github.com/repos/FirefoxUX/acorn-icons/releases/178987114/assets",
+    "upload_url": "https://uploads.github.com/repos/FirefoxUX/acorn-icons/releases/178987114/assets{?name,label}",
+    "html_url": "https://github.com/FirefoxUX/acorn-icons/releases/tag/v1.24.0",
+    "id": 178987114,
     "author": {
         "login": "cwzilla",
         "id": 87655586,
@@ -24,16 +24,16 @@
         "type": "User",
         "site_admin": false
     },
-    "node_id": "RE_kwDOI1CID84KmqDn",
-    "tag_name": "v1.23.0",
+    "node_id": "RE_kwDOI1CID84KqyBq",
+    "tag_name": "v1.24.0",
     "target_commitish": "main",
-    "name": "v1.23.0",
+    "name": "v1.24.0",
     "draft": false,
     "prerelease": false,
-    "created_at": "2024-10-01T23:07:12Z",
-    "published_at": "2024-10-01T23:11:26Z",
+    "created_at": "2024-10-08T20:56:01Z",
+    "published_at": "2024-10-08T20:56:53Z",
     "assets": [],
-    "tarball_url": "https://api.github.com/repos/FirefoxUX/acorn-icons/tarball/v1.23.0",
-    "zipball_url": "https://api.github.com/repos/FirefoxUX/acorn-icons/zipball/v1.23.0",
-    "body": "# Changelog\r\n## [1.23.0]\r\n### Added\r\n- SVG\r\n  - folder-arrow-right-24.svg\r\n\r\n- XML\r\n  - ic_folder_arrow_right_24.xml"
+    "tarball_url": "https://api.github.com/repos/FirefoxUX/acorn-icons/tarball/v1.24.0",
+    "zipball_url": "https://api.github.com/repos/FirefoxUX/acorn-icons/zipball/v1.24.0",
+    "body": "# Changelog\r\n## [1.24.0]\r\n### Added\r\n\r\n- PDF\r\n  - chevronDownExtraSmall.pdf\r\n  - thumbsDownFillLarge.pdf\r\n  - thumbsUpFillLarge.pdf\r\n\r\n- SVG\r\n  - thumbs-down-fill-24.svg\r\n  - thumbs-up-fill-24.svg\r\n\r\n- XML\r\n  - ic_thumbs_down_fill_24.xml\r\n  - ic_thumbs_up_fill_24.xml"
 }

sync_acorn_icons.py

@@ -4,6 +4,41 @@
 import shutil
 import subprocess
 
+"""
+This script automates the process of fetching, syncing, and organizing Acorn icons for the Firefox iOS project.
+It performs the following tasks:
+1. Fetches the latest release of the Acorn icons repository from GitHub.
+2. Saves the latest release information locally to detect if a new release needs to be synced.
+3. Downloads the icons from the latest release and synchronizes them with the project's asset folder.
+4. Sorts icons into categories based on their size (e.g., ExtraSmall, Small, Large, etc.).
+5. Generates the StandardImageIdentifiers.swift from BrowserKit's Common package.
+
+Important:
+- If a new size needs to be added, modify the `TARGET_SIZES` list by adding the appropriate tuple item.
+  The tuple is composed of:
+  - The first item: the directory name where the Acorn icons for that size are stored (e.g., for the "ExtraSmall" category, 
+    the icons are stored in `mobile/8`).
+  - The second item: the size category used in the file names and in the `StandardImageIdentifiers.swift` structures (e.g., "ExtraSmall").
+
+Usage:
+- This script is designed to be run periodically by a Github action.
+- It will automatically detect and download new releases, update the asset folder, and regenerate the image identifiers.
+
+If you want to test the script locally make sure to have all the required packages installed and remove the root json file `latest_acorn_release.json`.
+Then run `python3 sync_acorn_icons.py`. All the time the script is run the `latest_acorn_release.json` is created so if you see nothing in the console
+remove this file first.
+"""
+
+# List the target sizes that now are supported from FXIOS
+# Only those sizes are synced for updates.
+TARGET_SIZES = [
+    ("8", "ExtraSmall"),
+    ("16", "Small"),
+    ("20", "Medium"),
+    ("24", "Large"),
+    ("30", "ExtraLarge")
+]
+
 def fetch_latest_release_from_acorn() -> dict|None:
     owner = "FirefoxUX" 
     repo = "acorn-icons"    
@@ -52,10 +87,10 @@ def download_icons_and_save_in_assets():
     if clone_response.returncode != 0:
         print(f"Couldn't clone acorn icon repository")
         exit()
-    target_size_to_copy = [16, 20, 24, 30]
     asset_folder_path = "../firefox-ios/Client/Assets/Images.xcassets/"
     asset_folder_list = os.listdir(asset_folder_path)
-    for size in target_size_to_copy:
+    sizes_to_copy = map(lambda x: x[0], TARGET_SIZES)
+    for size in sizes_to_copy:
         icons_dir_path = f"acorn-icons/icons/mobile/{size}/pdf"
         directory_tree = os.walk(icons_dir_path)
 
@@ -78,22 +113,34 @@ def download_icons_and_save_in_assets():
     subprocess.run(["rm", "-rf", temp_dir_folder_name])
 
 def sort_icons_by_size() -> dict:
-    icons_by_size: dict[str, list[tuple[str]]] = {
-        "Small": [],
-        "Medium": [],
-        # Extra Large should be before Large since next() will pick Large also for ExtraLarge case
-        "ExtraLarge": [],
-        "Large": []
-    }
+    '''
+    Sort all the Acorns icons in firefox-ios/Client/Assets/Images.xcassets/ by their respective size
+
+    Returns:
+        dict: A dictionary with the title sizes as key and as value the list of acorn folders with the respective size
+        {
+            "ExtraSmall": [],
+            "Small": [],
+            ...
+        }
+    '''
+    icons_by_size = {}
+    for _, titleSize in TARGET_SIZES:
+        icons_by_size[titleSize] = []
 
     asset_folder_path = "firefox-ios/Client/Assets/Images.xcassets/"
     for folder in os.listdir(asset_folder_path):
         if folder.endswith(".imageset"):
             file_name = folder.split(".")[0]
-            
+
             size_key = next((key for key in icons_by_size if key in file_name), None)
 
             if size_key:
+                # Check wether Extra not in the size_key while the file name has Extra size
+                # this means the next method pulled the wrong size_key
+                if "Extra" not in size_key and "Extra" in file_name:
+                    size_key = f"Extra{size_key}"
+                
                 icon_name = file_name.replace(size_key, "")
                 icons_by_size[size_key].append((icon_name, file_name))
 
@@ -111,13 +158,9 @@ def generate_standard_image_identifiers_swift(sorted_icons: dict):
 /// Sing the song if you must.
 public struct StandardImageIdentifiers {
 """
-
-    size_struct_map = {
-        "Small": "16x16",
-        "Medium": "20x20",
-        "Large": "24x24",
-        "ExtraLarge": "30x30"
-    }
+    size_struct_map = {}
+    for image_size, image_size_title in TARGET_SIZES:
+        size_struct_map[image_size_title] = f"{image_size}x{image_size}"
 
     for size, struct_name in size_struct_map.items():
         if sorted_icons[size]: