Merge branch 'plugin_api_v2' into plugin_api_v2

Author: jjw24

.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

README.md

@@ -6,12 +6,12 @@ This repository contains the information for community-made plugins used in [Flo
 
 ## Plugin list
 
-Looking for a list of currently available plugins in Flow? Visit [here](https://flow-launcher.github.io/docs/#/plugins)
+Looking for a list of currently available plugins in Flow? Visit [here](https://www.flowlauncher.com/plugins)
 
 ## How to submit your plugin
 
-1. Create a file named `${name}-${uuid}.json` in the _plugins_ directory.
-2. Copy these items from your plugin project's plugin.json file:
+1. Create a file named `${name}-${uuid}.json` in the [plugins](https://github.com/Flow-Launcher/Flow.Launcher.PluginsManifest/tree/plugin_api_v2/plugins) directory.
+2. Copy these items from your plugin project's `plugin.json` file:
    - `ID`
    - `Name`
    - `Description`
@@ -23,16 +23,16 @@ Looking for a list of currently available plugins in Flow? Visit [here](https://
 4. It should look like this:
    ```json
    {
-     "ID": "Unique GUID from your plugin.json",  
-     "Name": "Plugin name",
-     "Description": "Short description",
-     "Author": "Author",
-     "Version": "Version from your plugin.json",
-     "Language": "Programming language",
-     "Website": "Plugin website",
-     "UrlDownload": "URL to download",
-     "UrlSourceCode": "URL to source code",
-     "IcoPath": "Plugin icon image's CDN URL, e.g. https://cdn.jsdelivr.net/gh/Flow-Launcher/Flow.Launcher/Plugins/Flow.Launcher.Plugin.Explorer/Images/explorer.png"
+     "ID": "Unique GUID from your plugin.json, e.g. 2f4e384e-76ce-45c3-aea2-b16f5e5c328f",
+     "Name": "Plugin name, e.g. Hello World Python",
+     "Description": "Short description, e.g. Python Hello World example plugin",
+     "Author": "Author, e.g. Flow Launcher",
+     "Version": "Version from your plugin.json, e.g. 1.0.0",
+     "Language": "Programming language, e.g. python",
+     "Website": "Plugin website, e.g. https://github.com/Flow-Launcher/Flow.Launcher.Plugin.HelloWorldPython",
+     "UrlDownload": "URL to download, e.g. https://github.com/Flow-Launcher/Flow.Launcher.Plugin.HelloWorldPython/releases/download/v1.0.0/Flow.Launcher.Plugin.HelloWorldPython.zip",
+     "UrlSourceCode": "URL to source code, e.g. https://github.com/Flow-Launcher/Flow.Launcher.Plugin.HelloWorldPython/tree/main", 
+     "IcoPath": "Plugin icon image's CDN URL, e.g. https://cdn.jsdelivr.net/gh/Flow-Launcher/Flow.Launcher.Plugin.HelloWorldPython@main/Images/app.png"
    }
    ```
 5. For `IcoPath`, use a CDN provider for global accessibility. [jsdelivr.com](https://www.jsdelivr.com/) for example as shown above, works well with GitHub repositories.
@@ -49,6 +49,8 @@ While the plugin has not yet appeared in the store, you and your users can manua
 
 Every three hours the *CI* in this repository will check for new updates from plugins and automatically update them to the latest version.
 
+So you do not need to manually submit a pull request after you make a new release.
+
 ## Plugin Store policy
 
 Plugins that facilitate or contain any of the following will not be allowed:
@@ -65,7 +67,7 @@ Plugins that facilitate or contain any of the following will not be allowed:
 ## Plugin Store
 
 Users will be able to install your plugin via the store or type `pm install <your-plugin-name>`:
-<p align="center"><img src="https://user-images.githubusercontent.com/6903107/207155616-d559f0d2-ee95-4072-a7bc-3ffcc2faec27.png" width="800"></p>
+<p align="center"><img src="assets/plugin_store.png" width="800"></p>
 
 ## Have a plugin enhancement request or issue?
 

assets/plugin_store.png

@@ -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/_utils.py

@@ -81,15 +81,36 @@ def get_all_python_plugins(manifest: dict) -> list:
     return [plugin for plugin in manifest if plugin["Language"].lower() == "python"]
 
 def run_plugin(plugin_name: str, plugin_path: str, execute_path: str) -> bool:
-    """Run plugin and check output. Returns true if test successfull else false"""
+    """Run plugin and check output. Returns true if test successful else false"""
     os.chdir(plugin_path)
     default_settings = init_settings(plugin_name, plugin_path)
     args = json.dumps(
         {"method": "query", "parameters": [""], "Settings": default_settings}
     )
-    full_args = ["python", "-S", Path(plugin_path, execute_path), args]
+
     # Older Flox used environmental variable to locate Images directory
     os.environ["PYTHONPATH"] = str(USER_PATH.joinpath("PythonEmbeddable"))
+
+    # Compose the sys.path setup and runpy logic as Flow Launcher does in
+    # https://github.com/Flow-Launcher/Flow.Launcher/blob/dfe96160ed44684810bcdf853f86fda4305122d6/Flow.Launcher.Core/Plugin/PythonPlugin.cs#L69-L81
+    sys_path_setup = (
+        f"import sys; "
+        f"sys.path.append(r'{plugin_path}'); "
+        f"sys.path.append(r'{plugin_path}\\lib'); "
+        f"sys.path.append(r'{plugin_path}\\lib\\win32\\lib'); "
+        f"sys.path.append(r'{plugin_path}\\lib\\win32'); "
+        f"sys.path.append(r'{plugin_path}\\plugin'); "
+        f"import runpy; "
+        f"runpy.run_path(r'{Path(plugin_path, execute_path)}', None, '__main__')"
+    )
+    
+    full_args = [
+        "python",
+        "-S",
+        "-c",
+        sys_path_setup,
+        args
+    ]
     print_section("Input", full_args)
     p = Popen(full_args, text=True, stdout=PIPE, stderr=PIPE)
     stdout, stderr = p.communicate()
@@ -104,7 +125,7 @@ def run_plugin(plugin_name: str, plugin_path: str, execute_path: str) -> bool:
         return True
     else:
         print_section(f"{plugin['Name']} test FAILED!", "")
-        print(f'Plugin returned a non-zero exit code: {max(exit_code, 1)}')
+        print(f'Plugin has returned a non-zero exit code: {max(exit_code, 1)}')
         if stderr != "":
             print_section('Trace', stderr)
         if json_msg:

ci/src/test-python.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/updater.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]}"