Packaging rework (#531)marios8543/async-plugin-method-requests

* fix: get rid of title view jank on latest beta

* Count the number of installs for each plugin (#557)

* Bump aiohttp from 3.8.4 to 3.8.5 in /backend (#558)

* fix: include Decky version in request for index.js

This avoids the If-Modified-Since logic in aiohttp and ensures Steam doesn't cache old JS,
even if the timestamps are normalized.

* fix: clean up shellcheck warnings in act runner script

* fix: gitignore settings/

* fix: ensure state directories exist when running without the installer

* feat: determine root directory correctly when running from in-tree

* fix: fix typo in CI script

* refactor: build a proper Python package with poetry

* refactor: move decky_plugin under the poetry structure

There's no need to special case it anymore, just treat it like any other Python module.

* sandboxed_plugin: better fix, attempt 2

---------

Co-authored-by: AAGaming <aagaming@riseup.net>
Co-authored-by: Party Wumpus <48649272+PartyWumpus@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

3 files changed, 0 insertions, 251 deletions

diff --git a/backend/src/plugin/method_call_request.py b/backend/src/plugin/method_call_request.py
deleted file mode 100644
index cebe34f8..00000000
--- a/backend/src/plugin/method_call_request.py
+++ /dev/null
@@ -1,29 +0,0 @@
-from typing import Any, TypedDict
-from uuid import uuid4
-from asyncio import Event
-
-class SocketResponseDict(TypedDict):
-    id: str
-    success: bool
-    res: Any
-
-class MethodCallResponse:
-    def __init__(self, success: bool, result: Any) -> None:
-        self.success = success
-        self.result = result
-
-class MethodCallRequest:
-    def __init__(self) -> None:
-        self.id = str(uuid4())
-        self.event = Event()
-        self.response: MethodCallResponse
-    
-    def set_result(self, dc: SocketResponseDict):
-        self.response = MethodCallResponse(dc["success"], dc["res"])
-        self.event.set()
-    
-    async def wait_for_result(self):
-        await self.event.wait()
-        if not self.response.success:
-            raise Exception(self.response.result)
-        return self.response.result
\ No newline at end of file
diff --git a/backend/src/plugin/plugin.py b/backend/src/plugin/plugin.py
deleted file mode 100644
index 6c338106..00000000
--- a/backend/src/plugin/plugin.py
+++ /dev/null
@@ -1,84 +0,0 @@
-from asyncio import Task, create_task
-from json import dumps, load, loads
-from logging import getLogger
-from os import path
-from multiprocessing import Process
-
-from .sandboxed_plugin import SandboxedPlugin
-from .method_call_request import MethodCallRequest
-from ..localplatform.localsocket import LocalSocket
-
-from typing import Any, Callable, Coroutine, Dict
-
-class PluginWrapper:
-    def __init__(self, file: str, plugin_directory: str, plugin_path: str) -> None:
-        self.file = file
-        self.plugin_path = plugin_path
-        self.plugin_directory = plugin_directory
-
-        self.version = None
-
-        json = load(open(path.join(plugin_path, plugin_directory, "plugin.json"), "r", encoding="utf-8"))
-        if path.isfile(path.join(plugin_path, plugin_directory, "package.json")):
-            package_json = load(open(path.join(plugin_path, plugin_directory, "package.json"), "r", encoding="utf-8"))
-            self.version = package_json["version"]
-
-        self.name = json["name"]
-        self.author = json["author"]
-        self.flags = json["flags"]
-        
-        self.passive = not path.isfile(self.file)
-
-        self.log = getLogger("plugin")
-
-        self.sandboxed_plugin = SandboxedPlugin(self.name, self.passive, self.flags, self.file, self.plugin_directory, self.plugin_path, self.version, self.author)
-        #TODO: Maybe make LocalSocket not require on_new_message to make this cleaner
-        self._socket = LocalSocket(self.sandboxed_plugin.on_new_message)
-        self._listener_task: Task[Any]
-        self._method_call_requests: Dict[str, MethodCallRequest] = {}
-
-        self.emitted_message_callback: Callable[[Dict[Any, Any]], Coroutine[Any, Any, Any]]
-
-    def __str__(self) -> str:
-        return self.name
-    
-    async def _response_listener(self):
-        while True:
-            try:
-                line = await self._socket.read_single_line()
-                if line != None:
-                    res = loads(line)
-                    if res["id"] == "0":
-                        create_task(self.emitted_message_callback(res["payload"]))
-                    else:
-                        self._method_call_requests.pop(res["id"]).set_result(res)
-            except:
-                pass
-
-    def set_emitted_message_callback(self, callback: Callable[[Dict[Any, Any]], Coroutine[Any, Any, Any]]):
-        self.emitted_message_callback = callback
-
-    async def execute_method(self, method_name: str, kwargs: Dict[Any, Any]):
-        if self.passive:
-            raise RuntimeError("This plugin is passive (aka does not implement main.py)")
-        
-        request = MethodCallRequest()
-        await self._socket.get_socket_connection()
-        await self._socket.write_single_line(dumps({ "method": method_name, "args": kwargs, "id": request.id }, ensure_ascii=False))
-        self._method_call_requests[request.id] = request
-
-        return await request.wait_for_result()
-    
-    def start(self):
-        if self.passive:
-            return self
-        Process(target=self.sandboxed_plugin.initialize, args=[self._socket]).start()
-        self._listener_task = create_task(self._response_listener())
-        return self
-
-    def stop(self):
-        self._listener_task.cancel()
-        async def _(self: PluginWrapper):
-            await self._socket.write_single_line(dumps({ "stop": True }, ensure_ascii=False))
-            await self._socket.close_socket_connection()
-        create_task(_(self))
\ No newline at end of file
diff --git a/backend/src/plugin/sandboxed_plugin.py b/backend/src/plugin/sandboxed_plugin.py
deleted file mode 100644
index adf9f802..00000000
--- a/backend/src/plugin/sandboxed_plugin.py
+++ /dev/null
@@ -1,138 +0,0 @@
-from os import path, environ
-from signal import SIGINT, signal
-from importlib.util import module_from_spec, spec_from_file_location
-from json import dumps, loads
-from logging import getLogger
-from sys import exit, path as syspath, modules as sysmodules
-from traceback import format_exc
-from asyncio import (get_event_loop, new_event_loop,
-                     set_event_loop, sleep)
-
-from .method_call_request import SocketResponseDict
-from ..localplatform.localsocket import LocalSocket
-from ..localplatform.localplatform import setgid, setuid, get_username, get_home_path
-from ..customtypes import UserType
-from .. import helpers
-
-from typing import Any, Dict, List
-
-class SandboxedPlugin:
-    def __init__(self,
-                 name: str,
-                 passive: bool,
-                 flags: List[str],
-                 file: str,
-                 plugin_directory: str,
-                 plugin_path: str,
-                 version: str|None,
-                 author: str) -> None:
-        self.name = name
-        self.passive = passive
-        self.flags = flags
-        self.file = file
-        self.plugin_path = plugin_path
-        self.plugin_directory = plugin_directory
-        self.version = version
-        self.author = author
-
-        self.log = getLogger("plugin")
-
-    def initialize(self, socket: LocalSocket):
-        self._socket = socket
-
-        try:
-            signal(SIGINT, lambda s, f: exit(0))
-
-            set_event_loop(new_event_loop())
-            if self.passive:
-                return
-            setgid(UserType.ROOT if "root" in self.flags else UserType.HOST_USER)
-            setuid(UserType.ROOT if "root" in self.flags else UserType.HOST_USER)
-            # export a bunch of environment variables to help plugin developers
-            environ["HOME"] = get_home_path(UserType.ROOT if "root" in self.flags else UserType.HOST_USER)
-            environ["USER"] = "root" if "root" in self.flags else get_username()
-            environ["DECKY_VERSION"] = helpers.get_loader_version()
-            environ["DECKY_USER"] = get_username()
-            environ["DECKY_USER_HOME"] = helpers.get_home_path()
-            environ["DECKY_HOME"] = helpers.get_homebrew_path()
-            environ["DECKY_PLUGIN_SETTINGS_DIR"] = path.join(environ["DECKY_HOME"], "settings", self.plugin_directory)
-            helpers.mkdir_as_user(path.join(environ["DECKY_HOME"], "settings"))
-            helpers.mkdir_as_user(environ["DECKY_PLUGIN_SETTINGS_DIR"])
-            environ["DECKY_PLUGIN_RUNTIME_DIR"] = path.join(environ["DECKY_HOME"], "data", self.plugin_directory)
-            helpers.mkdir_as_user(path.join(environ["DECKY_HOME"], "data"))
-            helpers.mkdir_as_user(environ["DECKY_PLUGIN_RUNTIME_DIR"])
-            environ["DECKY_PLUGIN_LOG_DIR"] = path.join(environ["DECKY_HOME"], "logs", self.plugin_directory)
-            helpers.mkdir_as_user(path.join(environ["DECKY_HOME"], "logs"))
-            helpers.mkdir_as_user(environ["DECKY_PLUGIN_LOG_DIR"])
-            environ["DECKY_PLUGIN_DIR"] = path.join(self.plugin_path, self.plugin_directory)
-            environ["DECKY_PLUGIN_NAME"] = self.name
-            if self.version:
-                environ["DECKY_PLUGIN_VERSION"] = self.version
-            environ["DECKY_PLUGIN_AUTHOR"] = self.author
-
-            # append the plugin's `py_modules` to the recognized python paths
-            syspath.append(path.join(environ["DECKY_PLUGIN_DIR"], "py_modules"))
-            
-            #TODO: FIX IN A LESS CURSED WAY
-            keys = [key.replace("src.", "") for key in sysmodules if key.startswith("src.")]
-            for key in keys:
-                sysmodules[key] = sysmodules["src"].__dict__[key]
-
-            spec = spec_from_file_location("_", self.file)
-            assert spec is not None
-            module = module_from_spec(spec)
-            assert spec.loader is not None
-            spec.loader.exec_module(module)
-            self.Plugin = module.Plugin
-
-            setattr(self.Plugin, "emit_message", self.emit_message)
-            #TODO: Find how to put emit_message on global namespace so it doesn't pollute Plugin
-
-            if hasattr(self.Plugin, "_migration"):
-                get_event_loop().run_until_complete(self.Plugin._migration(self.Plugin))
-            if hasattr(self.Plugin, "_main"):
-                get_event_loop().create_task(self.Plugin._main(self.Plugin))
-            get_event_loop().create_task(socket.setup_server())
-            get_event_loop().run_forever()
-        except:
-            self.log.error("Failed to start " + self.name + "!\n" + format_exc())
-            exit(0)
-
-    async def _unload(self):
-        try:
-            self.log.info("Attempting to unload with plugin " + self.name + "'s \"_unload\" function.\n")
-            if hasattr(self.Plugin, "_unload"):
-                await self.Plugin._unload(self.Plugin)
-                self.log.info("Unloaded " + self.name + "\n")
-            else:
-                self.log.info("Could not find \"_unload\" in " + self.name + "'s main.py" + "\n")
-        except:
-            self.log.error("Failed to unload " + self.name + "!\n" + format_exc())
-            exit(0)
-
-    async def on_new_message(self, message : str) -> str|None:
-        data = loads(message)
-
-        if "stop" in data:
-            self.log.info("Calling Loader unload function.")
-            await self._unload()
-            get_event_loop().stop()
-            while get_event_loop().is_running():
-                await sleep(0)
-            get_event_loop().close()
-            raise Exception("Closing message listener")
-
-        d: SocketResponseDict = {"res": None, "success": True, "id": data["id"]}
-        try:
-            d["res"] = await getattr(self.Plugin, data["method"])(self.Plugin, **data["args"])
-        except Exception as e:
-            d["res"] = str(e)
-            d["success"] = False
-        finally:
-            return dumps(d, ensure_ascii=False)
-        
-    async def emit_message(self, message: Dict[Any, Any]):
-        await self._socket.write_single_line_server(dumps({
-            "id": "0",
-            "payload": message
-        }))
\ No newline at end of file