Merge branch 'plugin_api_v2' into patch-5

Author: DiekoMA

.github/workflows/links.yml

@@ -14,6 +14,16 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - name: Create plugins.json For All Plugins
+        if: ${{ github.event_name == 'schedule' }}
+        run: |
+          python ./ci/src/merge-manifest.py
+      
+      - name: Create plugins.json For New Plugins Only
+        if: ${{ github.event_name == 'pull_request' }}
+        run: |
+          python ./ci/src/merge-manifest.py new-only
+
       - name: Link Checker
         id: lychee
         uses: lycheeverse/lychee-action@v2

.github/workflows/python-passed.yml

@@ -19,8 +19,12 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: 3.x
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r ./ci/envs/requirements-update-tested.txt
       - name: Run script
-        run: python ./ci/src/update-tested.py
+        run: python ./ci/src/update-tested.py ${{ secrets.DISCORD_WEBHOOK }}
       - name: Update plugin manifest
         if: success()
         uses: stefanzweifel/git-auto-commit-action@v4

ci/envs/requirements-update-tested.txt

@@ -0,0 +1,2 @@
+aiohttp
+tqdm

ci/src/_utils.py

@@ -1,9 +1,12 @@
 # -*-coding: utf-8 -*-
 import json
+import os
+import re
 from pathlib import Path
 from typing import Dict, List, TypeVar
-import re
-import os
+
+# If adding a third-party library here, check CI workflows Python files
+# that are dependant on this and require pip install.
 
 # path
 utils_path = Path(__file__).resolve()
@@ -17,7 +20,18 @@
 # constants
 id_name = "ID"
 language_name = "Language"
-language_list = ("csharp", "executable", "fsharp", "python", "javascript", "typescript", "python_v2", "executable_v2", "javascript_v2", "typescript_v2")
+language_list = (
+    "csharp",
+    "executable",
+    "fsharp",
+    "python",
+    "javascript",
+    "typescript",
+    "python_v2",
+    "executable_v2",
+    "javascript_v2",
+    "typescript_v2",
+)
 etag = "ETag"
 version = "Version"
 url_sourcecode = "UrlSourceCode"
@@ -30,6 +44,7 @@
 github_url = "https://github.com"
 release_date = "LatestReleaseDate"
 date_added = "DateAdded"
+website = "Website"
 
 # typing
 PluginType = Dict[str, str]
@@ -51,12 +66,20 @@ def plugin_reader() -> P:
 
     return manifests
 
+
+def save_plugins_json_file(content: list[dict[str]]) -> None:
+    with open("plugins.json", "w", encoding="utf-8") as f:
+        json.dump(content, f, indent=4, ensure_ascii=False)
+
+
 def get_plugin_file_paths() -> list[str]:
     return [os.path.join(plugin_dir, filename) for filename in get_plugin_filenames()]
 
+
 def get_plugin_filenames() -> list[str]:
     return os.listdir(plugin_dir)
 
+
 def etag_reader() -> ETagsType:
     with open(etag_file, "r", encoding="utf-8") as f:
         return json.load(f)
@@ -66,7 +89,8 @@ def plugin_writer(content: P):
     for plugin in content:
         with open(plugin_dir / f"{plugin[plugin_name]}-{plugin[id_name]}.json", "w", encoding="utf-8") as f:
             json.dump(plugin, f, indent=4)
-        
+
+
 def etags_writer(content: ETagsType):
     with open(etag_file, "w", encoding="utf-8") as f:
         json.dump(content, f, indent=4)
@@ -75,10 +99,12 @@ def etags_writer(content: ETagsType):
 def clean(string: str, flag="-") -> str:
     return string.lower().replace(flag, "").strip()
 
+
 def version_tuple(version: str) -> tuple:
     version = clean(version, "v")
     return tuple(version.split("."))
 
+
 def check_url(url: str) -> bool:
     regex = re.compile(
         r"^(?:http|ftp)s?://"  # http:// or https://
@@ -100,3 +126,19 @@ def get_file_plugins_json_info(required_key: str = "") -> list[dict[str, str]]:
         return data
 
     return [{required_key: plugin[required_key]} for plugin in data]
+
+
+def get_new_plugin_submission_ids() -> list[str]:
+    plugins_json_ids = [item["ID"] for item in get_file_plugins_json_info("ID")]
+    existing_plugin_file_ids = [info["ID"] for info in plugin_reader()]
+
+    new_ids = []
+
+    for id in existing_plugin_file_ids:
+        # plugins.json would not contain new submission's ID.
+        if id in plugins_json_ids:
+            continue
+
+        new_ids.append(id)
+
+    return new_ids

ci/src/discord.py

@@ -1,11 +1,11 @@
 import aiohttp
-
+from tqdm.asyncio import tqdm
 from _utils import *
 
 MAX_BODY_LEN = 1024
 
 
-async def update_hook(webhook_url: str, info: dict, latest_ver: str, release: dict) -> None:
+async def update_hook(webhook_url: str, info: PluginType, latest_ver: str, release: dict) -> None:
     embed = {
         "content": None,
         "embeds": [
@@ -43,6 +43,43 @@ async def update_hook(webhook_url: str, info: dict, latest_ver: str, release: di
         embed['embeds'][0]['fields'].append({"name": "Release Notes", "value": truncate_release_notes(release['html_url'], release.get('body', ""))})
     async with aiohttp.ClientSession() as session:
         await session.post(webhook_url, json=embed)
+
+async def release_hook(webhook_url: str, info: PluginType) -> None:
+    embed = {
+        "content": None,
+        "embeds": [
+            {
+            "title": info[plugin_name],
+            "description": f"New Plugin!\nReleased at v{info[version]}.",
+            "url": info[website],
+            "color": 5763719, # green
+            "fields": [
+                {
+                "name": "Plugin Description",
+                "value": info[description]
+                },
+                {
+                "name": "Plugin Language",
+                "value": info[language_name]
+                }
+            ],
+            "author": {
+                "name": info[author]
+            },
+            "thumbnail": {
+                "url": info[icon_path]
+            }
+            }
+        ]
+        }
+    if 'github.com' in info[url_sourcecode].lower():
+        github_username = info[url_sourcecode].split('/')[3]
+        embed['embeds'][0]['author']['name'] = github_username
+        embed['embeds'][0]['author']['url'] = f"{github_url}/{github_username}"
+        embed['embeds'][0]["author"]["icon_url"] = f"{github_url}/{github_username}.png?size=40"
+    
+    async with aiohttp.ClientSession() as session:
+        await session.post(webhook_url, json=embed)
 
 def truncate_release_notes(url: str, release_notes: str, length: int = MAX_BODY_LEN) -> str:
     if len(release_notes) <= length:

ci/src/merge-manifest.py

@@ -1,15 +1,30 @@
-import glob
-import json
+import sys
 
-if __name__ == "__main__":
-    plugins = sorted(glob.glob("plugins/*.json"))
+from _utils import get_new_plugin_submission_ids, plugin_reader, save_plugins_json_file
+
+
+def get_all_plugins() -> list[dict[str]]:
+    return plugin_reader()
+
+
+def get_new_plugins() -> list[dict[str]]:
+    ids = get_new_plugin_submission_ids()
+    plugins_from_plugins_dir = plugin_reader()
 
-    manifests = []
+    new_plugins = []
 
-    for plugin in plugins:
-        with open(plugin, "r", encoding="utf-8") as f:
-            manifest = json.load(f)
-            manifests.append(manifest)
+    for id in ids:
+        for plugin in plugins_from_plugins_dir:
+            if plugin["ID"] == id:
+                new_plugins.append(plugin)
+                break
+
+    return new_plugins
+
+
+if __name__ == "__main__":
 
-    with open("plugins.json", "w", encoding="utf-8") as f:
-        json.dump(manifests, f, indent=4, ensure_ascii=False)
+    if len(sys.argv) > 1 and str(sys.argv[1]) == "new-only":
+        save_plugins_json_file(get_new_plugins())
+    else:
+        save_plugins_json_file(get_all_plugins())

ci/src/update-tested.py

@@ -1,26 +1,32 @@
-import sys
-import json
-import os
-import zipfile
-import io
-from datetime import datetime
+import asyncio
+from datetime import datetime, UTC
+from sys import argv
+from _utils import plugin_reader, plugin_writer, date_added
+from discord import release_hook
 
-from _utils import clean, id_name, language_list, language_name, plugin_reader, plugin_writer, release_date, date_added
 
-if __name__ == "__main__":
+async def update_tested():
+    webhook_url = None
+    if len(argv) > 1:
+        webhook_url = argv[1]
+
     plugin_infos = plugin_reader()
 
     for idx, plugin in enumerate(plugin_infos):
         if plugin["Language"] == "python" and "Tested" not in plugin.keys():
             plugin_infos[idx]["Tested"] = True
+
         # Add date added if field is not present
         if plugin.get(date_added) is None:
-            plugin_infos[idx][date_added] = datetime.utcnow().strftime("%Y-%m-%dT%H:%M:%SZ")
-    plugin_writer(plugin_infos)
-
-
-
+            plugin_infos[idx][date_added] = datetime.now(UTC).strftime(
+                "%Y-%m-%dT%H:%M:%SZ"
+            )
 
+            if webhook_url:
+                await release_hook(webhook_url, plugin)
 
+    plugin_writer(plugin_infos)
 
 
+if __name__ == "__main__":
+    asyncio.run(update_tested())

ci/src/updater.py

@@ -12,9 +12,8 @@
 from _utils import *
 from discord import update_hook
 
-
 async def batch_github_plugin_info(
-    info: P, tags: ETagsType, github_token=None, webhook_url: str = None
+    info: P, tags: ETagsType, github_token=None, webhook_url: str | None = None
 ) -> P:
     try:
         headers = {"authorization": f"token {github_token}"}
@@ -47,9 +46,10 @@ async def batch_github_plugin_info(
                 info[release_date] = latest_rel.get("published_at")
             if assets:
                 info[url_download] = assets[0]["browser_download_url"]
-                await send_notification(
-                    info, clean(latest_rel["tag_name"], "v"), latest_rel, webhook_url
-                )
+                if webhook_url:
+                    await send_notification(
+                        info, clean(latest_rel["tag_name"], "v"), latest_rel, webhook_url
+                    )
                 info[version] = clean(latest_rel["tag_name"], "v")
 
             tags[info[id_name]] = res.headers.get(etag, "")
@@ -62,7 +62,7 @@ async def batch_github_plugin_info(
 
 
 async def batch_plugin_infos(
-    plugin_infos: Ps, tags: ETagsType, github_token, webhook_url: str = None
+    plugin_infos: Ps, tags: ETagsType, github_token, webhook_url: str | None = None
 ) -> Ps:
     return await tqdm.gather(
         *[
@@ -72,7 +72,7 @@ async def batch_plugin_infos(
     )
 
 
-def remove_unused_etags(plugin_infos: Ps, etags: ETagsType) -> ETagsType:
+def remove_unused_etags(plugin_infos: PluginsType, etags: ETagsType) -> ETagsType:
     etags_updated = {}
     plugin_ids = [info.get("ID") for info in plugin_infos]
 
@@ -90,16 +90,18 @@ def remove_unused_etags(plugin_infos: Ps, etags: ETagsType) -> ETagsType:
 
 
 async def send_notification(
-    info: P, latest_ver, release, webhook_url: str = None
+    info: PluginType, latest_ver, release, webhook_url: str | None = None
 ) -> None:
+    if not webhook_url:
+        return
+    
     if version_tuple(info[version]) != version_tuple(latest_ver):
         tqdm.write(f"Update detected: {info[plugin_name]} {latest_ver}")
         try:
             await update_hook(webhook_url, info, latest_ver, release)
         except Exception as e:
             tqdm.write(str(e))
 
-
 async def main():
     webhook_url = None
     if len(argv) > 1:

ci/src/validator.py

@@ -1,7 +1,7 @@
 # -*-coding: utf-8 -*-
 import uuid
 
-from _utils import (check_url, clean, get_file_plugins_json_info, get_plugin_file_paths, get_plugin_filenames,
+from _utils import (check_url, clean, get_new_plugin_submission_ids, get_plugin_file_paths, get_plugin_filenames,
                     icon_path, id_name, language_list, language_name, plugin_reader)
 
 plugin_infos = plugin_reader()
@@ -22,32 +22,29 @@ def test_language_in_list():
     msg = f"The '{language_name}' is not in the list of {language_list}"
     assert set(language_list) >= set(languages), msg
 
+
 def test_valid_icon_url():
     for plugin in plugin_infos:
         msg = f"The URL in {icon_path} is not a valid URL."
         assert check_url(plugin[icon_path]), msg
 
+
 def test_file_type_json():
     incorrect_ext_files = [file_path for file_path in get_plugin_file_paths() if not file_path.endswith(".json")]
 
     assert len(incorrect_ext_files) == 0, f"Expected the following file to be of .json extension: {incorrect_ext_files}"
 
+
 def test_file_name_construct():
     filenames = get_plugin_filenames()
     for info in plugin_infos:
         assert (
             f"{info['Name']}-{info['ID']}.json" in filenames
         ), f"Plugin {info['Name']} with ID {info['ID']} does not have the correct filename. Make sure it's name + ID, i.e. {info['Name']}-{info['ID']}.json"
 
-def test_submitted_plugin_id_is_valid_uuid():
-    plugins_json_ids = [item["ID"] for item in get_file_plugins_json_info("ID")]
-    existing_plugin_file_ids = [info["ID"] for info in plugin_infos]
-
-    for id in existing_plugin_file_ids:
-        # plugins.json would not contain new submission's ID.
-        if id in plugins_json_ids:
-            continue
 
+def test_submitted_plugin_id_is_valid_uuid():
+    for id in get_new_plugin_submission_ids():
         try:
             uuid.UUID(id, version=4)
             outcome = True