Merge remote-tracking branch 'origin/plugin_api_v2' into plugin_api_v2

Author: Jack251970

.github/workflows/website-deploy.yml

@@ -0,0 +1,22 @@
+name: Deploy Website
+
+on:
+  push:
+    branches: [ plugin_api_v2 ]
+    paths:
+      - 'plugins.json'
+  workflow_dispatch:
+
+jobs:
+  dispatch:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Dispatch event
+        run: |
+          http_status=$(curl -L -f -s -o /dev/null -w "%{http_code}" \
+            -X POST \
+            -H "Accept: application/vnd.github+json" \
+            -H "Authorization: Bearer ${{ secrets.DEPLOY_WEBSITE }}" \
+            https://api.github.com/repos/Flow-Launcher/flow-launcher.github.io/dispatches \
+            -d '{"event_type":"deploy"}')
+          if [ "$http_status" -ne 204 ]; then echo "Error: Deploy trigger failed, HTTP status code is $http_status"; exit 1; fi

ci/src/_utils.py

@@ -8,6 +8,10 @@
 # If adding a third-party library here, check CI workflows Python files
 # that are dependant on this and require pip install.
 
+github_download_url_regex = re.compile(
+    r"https://github\.com/(?P<author>[a-zA-Z0-9-]+)/(?P<repo>[a-zA-Z0-9\.\-\_]*)/releases/download/(?P<version>[a-zA-Z\.0-9]+)/(?P<filename>.*)\.zip"
+)
+
 # path
 utils_path = Path(__file__).resolve()
 

ci/src/updater.py

@@ -1,7 +1,9 @@
 # -*-coding: utf-8 -*-
 import asyncio
 import aiohttp
+from zipfile import ZipFile
 import re
+from io import BytesIO
 from typing import List
 from os import getenv
 from sys import argv
@@ -12,11 +14,6 @@
 from _utils import *
 from discord import update_hook
 
-github_download_url_regex = re.compile(
-    r"https://github\.com/(?P<author>[a-zA-Z0-9-]+)/(?P<repo>[a-zA-Z0-9\.\-\_]*)/releases/download/(?P<version>[a-zA-Z\.0-9]+)/(?P<filename>.*)\.zip"
-)
-
-
 async def batch_github_plugin_info(
     info: P, tags: ETagsType, github_token=None, webhook_url: str | None = None
 ) -> P:
@@ -68,14 +65,29 @@ async def batch_github_plugin_info(
                     browser_download_url or assets[0]["browser_download_url"]
                 )
 
-                if webhook_url:
-                    await send_notification(
-                        info,
-                        clean(latest_rel["tag_name"], "v"),
-                        latest_rel,
-                        webhook_url,
+                latest_ver = clean(latest_rel["tag_name"], "v")
+                if version_tuple(info[version]) != version_tuple(latest_ver):
+                    tqdm.write(f"Update detected: {info[plugin_name]} {latest_ver}")
+
+                    metadata = await get_plugin_dot_json(
+                        info[url_download], session=session
                     )
-                info[version] = clean(latest_rel["tag_name"], "v")
+                    for key in (
+                        description,
+                        author,
+                        language_name,
+                        website,
+                    ):
+                        info[key] = metadata[key]
+
+                    if webhook_url:
+                        await send_notification(
+                            info,
+                            latest_ver,
+                            latest_rel,
+                            webhook_url,
+                        )
+                info[version] = latest_ver
 
             tags[info[id_name]] = res.headers.get(etag, "")
 
@@ -86,6 +98,21 @@ async def batch_github_plugin_info(
         return info
 
 
+async def get_plugin_dot_json(download_url: str, *, session: aiohttp.ClientSession):
+    async with session.get(download_url) as res:
+        data = await res.read()
+
+    with ZipFile(BytesIO(data)) as zip:
+        for fileinfo in zip.filelist:
+            if not fileinfo.filename.endswith("plugin.json"):
+                continue
+
+            with zip.open(fileinfo, "r") as file:
+                return json.loads(file.read())
+
+    raise ValueError(f"plugin.json file not found. Download Url: {download_url}")
+
+
 async def batch_plugin_infos(
     plugin_infos: Ps, tags: ETagsType, github_token, webhook_url: str | None = None
 ) -> Ps:
@@ -114,17 +141,15 @@ def remove_unused_etags(plugin_infos: PluginsType, etags: ETagsType) -> ETagsTyp
 
 
 async def send_notification(
-    info: PluginType, latest_ver, release, webhook_url: str | None = None
+    info: PluginType, latest_ver: str, 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))
+    try:
+        await update_hook(webhook_url, info, latest_ver, release)
+    except Exception as e:
+        tqdm.write(str(e))
 
 
 async def main():

ci/src/validator.py

@@ -2,7 +2,7 @@
 import uuid
 
 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)
+                    icon_path, id_name, language_list, language_name, plugin_reader, github_download_url_regex, url_download)
 
 plugin_infos = plugin_reader()
 
@@ -52,3 +52,7 @@ def test_submitted_plugin_id_is_valid_uuid():
             outcome = False
 
         assert outcome is True, f"The submission plugin ID {id} is not a valid v4 UUID"
+
+def test_valid_download_url():
+    for info in plugin_infos:
+        assert github_download_url_regex.fullmatch(info[url_download]), f" The plugin {info['Name']}-{info['ID']} does not have a valid download url: {info[url_download]}"