Build bot now build new SVGs in folder that were already built (#666)

* Refactor the pull request fetching code

* Refactor build script to use past PRs

* Added function to update icomoon json

* new icon: matlab (line) (#640)

* Add matlab-line

* Fixed issues reported by check svg bot

* optimisation for svg (#643)

Co-authored-by: Clemens Bastian <8781699+amacado@users.noreply.github.com>
Co-authored-by: David Leal <halfpacho@gmail.com>

* Add better logging to icomoon_build

Co-authored-by: Clemens Bastian <8781699+amacado@users.noreply.github.com>
Co-authored-by: David Leal <halfpacho@gmail.com>

.github/scripts/icomoon_build.py

@@ -1,36 +1,36 @@
 from pathlib import Path
 import sys
 from selenium.common.exceptions import TimeoutException
+import re
 import subprocess
 import json
+from typing import List, Dict
+
 
 # pycharm complains that build_assets is an unresolved ref
 # don't worry about it, the script still runs
 from build_assets.SeleniumRunner import SeleniumRunner
-from build_assets import filehandler, arg_getters
-from build_assets import util
+from build_assets import filehandler, arg_getters, util, api_handler
 
 
 def main():
-    args = arg_getters.get_selenium_runner_args()
-    new_icons = filehandler.find_new_icons(args.devicon_json_path, args.icomoon_json_path)
-    if len(new_icons) == 0:
-        sys.exit("No files need to be uploaded. Ending script...")
-
-    # print list of new icons
-    print("List of new icons:", *new_icons, sep = "\n")
-    
+    """
+    Build the icons using Icomoon. Also optimize the svgs.
+    """
     runner = None
     try:
-        svgs = filehandler.get_svgs_paths(new_icons, args.icons_folder_path, icon_versions_only=False)
-        # optimizes the files
-        # do in each batch in case the command 
-        # line complains there's too many characters
-        start = 0
-        step = 10
-        for i in range(start, len(svgs), step):
-            batch = svgs[i:i + step]
-            subprocess.run(["npm", "run", "optimize-svg", "--", f"--svgFiles={json.dumps(batch)}"], shell=True)
+        args = arg_getters.get_selenium_runner_args()
+        new_icons = get_icons_for_building(args.devicon_json_path, args.token)
+        if len(new_icons) == 0:
+            sys.exit("No files need to be uploaded. Ending script...")
+
+        print(f"There are {len(new_icons)} icons to be build. Here are they:", *new_icons, sep = "\n")
+
+        print("Begin optimizing files")
+        optimize_svgs(new_icons, args.icons_folder_path)
+
+        print("Updating the icomoon json")
+        update_icomoon_json(new_icons, args.icomoon_json_path)
 
         icon_svgs = filehandler.get_svgs_paths(
             new_icons, args.icons_folder_path, icon_versions_only=True)
@@ -50,7 +50,79 @@ def main():
     except Exception as e:
         util.exit_with_err(e)
     finally:
-        runner.close() 
+        if runner is not None:
+            runner.close() 
+
+
+def get_icons_for_building(devicon_json_path: str, token: str):
+    """
+    Get the icons for building.
+    :param devicon_json_path - the path to the `devicon.json`.
+    :param token - the token to access the GitHub API.
+    """
+    all_icons = filehandler.get_json_file_content(devicon_json_path)
+    pull_reqs = api_handler.get_merged_pull_reqs_since_last_release(token)
+    new_icons = []
+
+    for pull_req in pull_reqs:
+        if api_handler.is_feature_icon(pull_req):
+            filtered_icon = util.find_object_added_in_this_pr(all_icons, pull_req["title"])
+            new_icons.append(filtered_icon)
+    return new_icons
+
+
+def optimize_svgs(new_icons: List[str], icons_folder_path: str):
+    """
+    Optimize the newly added svgs. This is done in batches
+    since the command line has a limit on characters allowed.
+    :param new_icons - the new icons that need to be optimized.
+    :param icons_folder_path - the path to the /icons folder.
+    """
+    svgs = filehandler.get_svgs_paths(new_icons, icons_folder_path, icon_versions_only=False)
+    start = 0
+    step = 10
+    for i in range(start, len(svgs), step):
+        batch = svgs[i:i + step]
+        subprocess.run(["npm", "run", "optimize-svg", "--", f"--svgFiles={json.dumps(batch)}"], shell=True)
+
+
+def update_icomoon_json(new_icons: List[str], icomoon_json_path: str):
+    """
+    Update the `icomoon.json` if it contains any icons
+    that needed to be updated. This will remove the icons
+    from the `icomoon.json` so the build script will reupload
+    it later.
+    """
+    icomoon_json = filehandler.get_json_file_content(icomoon_json_path)
+    cur_len = len(icomoon_json["icons"])
+    messages = []
+
+    wrapper_function = lambda icomoon_icon : find_icomoon_icon_not_in_new_icons(
+        icomoon_icon, new_icons, messages)
+    icons_to_keep = filter(wrapper_function, icomoon_json["icons"])
+    icomoon_json["icons"] = list(icons_to_keep)
+
+    new_len = len(icomoon_json["icons"])
+    print(f"Update completed. Removed {cur_len - new_len} icons:", *messages, sep='\n')
+    filehandler.write_to_file(icomoon_json_path, json.dumps(icomoon_json))
+  
+
+def find_icomoon_icon_not_in_new_icons(icomoon_icon: Dict, new_icons: List, messages: List):
+    """
+    Find all the icomoon icons that are not listed in the new icons.
+    This also add logging for which icons were removed.
+    :param icomoon_icon - a dict object from the icomoon.json's `icons` attribute.
+    :param new_icons - a list of new icons. Each element is an object from the `devicon.json`.
+    :param messages - an empty list where the function can attach logging on which 
+    icon were removed.
+    """
+    for new_icon in new_icons:
+        pattern = re.compile(f"^{new_icon['name']}-")
+        if pattern.search(icomoon_icon["properties"]["name"]):
+            message = f"-'{icomoon_icon['properties']['name']}' cause it matches '{new_icon['name']}'"
+            messages.append(message)
+            return False
+    return True
 
 
 if __name__ == "__main__":