Shared Ctx tab rename to SharedJSContext (#395)

.github/workflows/edit-check.yml

@@ -0,0 +1,47 @@
+name: Push Updated Plugin Stub to Template
+
+on: push
+
+jobs:
+  copy-stub:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@8230315d06ad95c617244d2f265d237a1682d445
+      with:
+        ref: ${{ github.sha }}
+        fetch-depth: 0
+        token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Checkout
+      uses: actions/checkout@v2
+      
+    - name: Is stub changed
+      id: changed-stub
+      run: |
+        STUB_CHANGED="false"
+        PATHS=(plugin plugin/decky_plugin.pyi)
+        SHA=${{ github.sha }}
+        SHA_PREV=$(git rev-list --parents -n 1 $SHA)
+        FILES=$(git diff $SHA_PREV..$SHA --name-only -- ${PATHS[@]} | jq -Rsc 'split("\n")[:-1] | join (",")')
+        if [[ "$FILES" == *"plugin/decky_plugin.pyi"* ]]; then
+          $STUB_CHANGED="true"
+          echo "Stub has changed, pushing updated stub"
+        else
+          echo "Stub has not changed, exiting."
+          echo "has_changed=$STUB_CHANGED" >> $GITHUB_OUTPUT
+          exit 0
+        fi
+        echo "has_changed=$STUB_CHANGED" >> $GITHUB_OUTPUT
+
+    - name: Push updated stub
+      if: steps.changed-stub.outputs.has_changed == true
+      uses: dmnemec/copy_file_to_another_repo_action@bbebd3da22e4a37d04dca5f782edd5201cb97083
+      env:
+        API_TOKEN_GITHUB: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        source_file: 'plugin/decky_plugin.pyi'
+        destination_repo: 'SteamDeckHomebrew/decky-plugin-template'
+        user_email: '11465594+TrainDoctor@users.noreply.github.com'
+        user_name: 'TrainDoctor'
+        commit_message: 'Updated template with latest plugin stub changes'

backend/browser.py

@@ -42,7 +42,7 @@ class PluginBrowser:
             return False
         zip_file = ZipFile(zip)
         zip_file.extractall(self.plugin_path)
-        plugin_dir = self.find_plugin_folder(name)
+        plugin_dir = path.join(self.plugin_path, self.find_plugin_folder(name))
         code_chown = call(["chown", "-R", get_user()+":"+get_user_group(), plugin_dir])
         code_chmod = call(["chmod", "-R", "555", plugin_dir])
         if code_chown != 0 or code_chmod != 0:
@@ -92,6 +92,7 @@ class PluginBrowser:
 
         return rv
 
+    """Return the filename (only) for the specified plugin"""
     def find_plugin_folder(self, name):
         for folder in listdir(self.plugin_path):
             try:
@@ -99,7 +100,7 @@ class PluginBrowser:
                     plugin = json.load(f)
 
                 if plugin['name'] == name:
-                    return str(path.join(self.plugin_path, folder))
+                    return folder
             except:
                 logger.debug(f"skipping {folder}")
 
@@ -107,9 +108,10 @@ class PluginBrowser:
         if self.loader.watcher:
             self.loader.watcher.disabled = True
         tab = await get_gamepadui_tab()
+        plugin_dir = path.join(self.plugin_path, self.find_plugin_folder(name))
         try:
             logger.info("uninstalling " + name)
-            logger.info(" at dir " + self.find_plugin_folder(name))
+            logger.info(" at dir " + plugin_dir)
             logger.debug("calling frontend unload for %s" % str(name))
             res = await tab.evaluate_js(f"DeckyPluginLoader.unloadPlugin('{name}')")
             logger.debug("result of unload from UI: %s", res)
@@ -123,11 +125,11 @@ class PluginBrowser:
                 del self.plugins[name]
                 logger.debug("Plugin %s was removed from the dictionary", name)
             logger.debug("removing files %s" % str(name))
-            rmtree(self.find_plugin_folder(name))
+            rmtree(plugin_dir)
         except FileNotFoundError:
             logger.warning(f"Plugin {name} not installed, skipping uninstallation")
         except Exception as e:
-            logger.error(f"Plugin {name} in {self.find_plugin_folder(name)} was not uninstalled")
+            logger.error(f"Plugin {name} in {plugin_dir} was not uninstalled")
             logger.error(f"Error at %s", exc_info=e)
         if self.loader.watcher:
             self.loader.watcher.disabled = False
@@ -160,7 +162,8 @@ class PluginBrowser:
                 logger.debug("Unzipping...")
                 ret = self._unzip_to_plugin_dir(res_zip, name, hash)
                 if ret:
-                    plugin_dir = self.find_plugin_folder(name)
+                    plugin_folder = self.find_plugin_folder(name)
+                    plugin_dir = path.join(self.plugin_path, plugin_folder)
                     ret = await self._download_remote_binaries_for_plugin_with_name(plugin_dir)
                     if ret:
                         logger.info(f"Installed {name} (Version: {version})")
@@ -168,7 +171,7 @@ class PluginBrowser:
                             self.loader.plugins[name].stop()
                             self.loader.plugins.pop(name, None)
                         await sleep(1)
-                        self.loader.import_plugin(path.join(plugin_dir, "main.py"), plugin_dir)
+                        self.loader.import_plugin(path.join(plugin_dir, "main.py"), plugin_folder)
                     else:
                         logger.fatal(f"Failed Downloading Remote Binaries")
                 else:

backend/injector.py

@@ -394,8 +394,10 @@ async def get_tab_lambda(test) -> Tab:
         raise ValueError(f"Tab not found by lambda")
     return tab
 
+SHARED_CTX_NAMES = ["SharedJSContext", "Steam Shared Context presented by Valve™", "Steam", "SP"]
+
 def tab_is_gamepadui(t: Tab) -> bool:
-    return "https://steamloopback.host/routes/" in t.url and (t.title == "Steam Shared Context presented by Valve™" or t.title == "Steam" or t.title == "SP")
+    return "https://steamloopback.host/routes/" in t.url and t.title in SHARED_CTX_NAMES
 
 async def get_gamepadui_tab() -> Tab:
     tabs = await get_tabs()
@@ -412,7 +414,7 @@ async def inject_to_tab(tab_name, js, run_async=False):
 async def close_old_tabs():
     tabs = await get_tabs()
     for t in tabs:
-        if not t.title or (t.title != "Steam Shared Context presented by Valve™" and t.title != "Steam" and t.title != "SP"):
+        if not t.title or t.title not in SHARED_CTX_NAMES:
             logger.debug("Closing tab: " + getattr(t, "title", "Untitled"))
             await t.close()
-            await sleep(0.5)
+            await sleep(0.5)