Shared Ctx tab rename to SharedJSContext (#395)

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -12,6 +12,7 @@ body:
         - label: I have searched existing issues
         - label: This issue is not a duplicate of an existing one
         - label: I have checked the [common issues section in the readme file](https://github.com/SteamDeckHomebrew/decky-loader#-common-issues)
+        - label: I have attached logs to this bug report (failure to include logs will mean your issue will not be responded too).
 
   - type: textarea
     attributes:
@@ -70,4 +71,4 @@ body:
       description: Please reboot your deck (if possible) when attempting to recreate the issue, then run ``cd ~ && journalctl -b0  -u plugin_loader.service > deckylog.txt``. This will save the log file to ``~`` aka ``/home/deck``. Please upload the file here
       placeholder: deckylog.txt
     validations:
-      required: false
+      required: true

.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'

README.md

@@ -88,7 +88,7 @@ There is no complete plugin development documentation yet. However a good starti
 
 ### 🤝 Contributing
 
-Please consult [the wiki page regarding development](https://deckbrew.xyz/en/loader-dev/development) for more information on installing development versions of Decky Loader. You can also install the Steam Deck UI on a Windows or Linux computer for testing by following [this YouTube guide](https://youtu.be/1IAbZte8e7E?t=112).
+Please consult [the wiki page regarding development](https://wiki.deckbrew.xyz/en/loader-dev/development) for more information on installing development versions of Decky Loader. You can also install the Steam Deck UI on a Windows or Linux computer for testing by following [this YouTube guide](https://youtu.be/1IAbZte8e7E?t=112).
 
 1. Clone the repository using the latest commit to main before starting your PR.
 1. In your clone of the repository, run these commands.

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)

backend/updater.py

@@ -108,10 +108,10 @@ class Updater:
         logger.debug("determining release type to find, branch is %i" % selectedBranch)
         if selectedBranch == 0:
             logger.debug("release type: release")
-            self.remoteVer = next(filter(lambda ver: ver["tag_name"].startswith("v") and not ver["prerelease"] and ver["tag_name"], remoteVersions), None)
+            self.remoteVer = next(filter(lambda ver: ver["tag_name"].startswith("v") and not ver["prerelease"] and not ver["tag_name"].find("-pre") > 0 and ver["tag_name"], remoteVersions), None)
         elif selectedBranch == 1:
             logger.debug("release type: pre-release")
-            self.remoteVer = next(filter(lambda ver: ver["prerelease"] and ver["tag_name"].startswith("v") and ver["tag_name"].find("-pre"), remoteVersions), None)
+            self.remoteVer = next(filter(lambda ver:ver["tag_name"].startswith("v"), remoteVersions), None)
         else:
             logger.error("release type: NOT FOUND")
             raise ValueError("no valid branch found")

backend/utilities.py

@@ -251,7 +251,7 @@ class Utilities:
                             enumerable: true,
                             configurable: true,
                             get: function() {
-                                return FocusNavController?.m_ActiveContext?.ActiveWindow || window;
+                                return (GamepadNavTree?.m_context?.m_controller || FocusNavController)?.m_ActiveContext?.ActiveWindow || window;
                             }
                         });
                     """ + await res.text() + "\n}"

frontend/package.json

@@ -42,7 +42,7 @@
     }
   },
   "dependencies": {
-    "decky-frontend-lib": "^3.18.10",
+    "decky-frontend-lib": "^3.19.1",
     "react-file-icon": "^1.2.0",
     "react-icons": "^4.4.0",
     "react-markdown": "^8.0.3",

frontend/pnpm-lock.yaml

@@ -11,7 +11,7 @@ specifiers:
   '@types/react-file-icon': ^1.0.1
   '@types/react-router': 5.1.18
   '@types/webpack': ^5.28.0
-  decky-frontend-lib: ^3.18.10
+  decky-frontend-lib: ^3.19.1
   husky: ^8.0.1
   import-sort-style-module: ^6.0.0
   inquirer: ^8.2.4
@@ -31,7 +31,7 @@ specifiers:
   typescript: ^4.7.4
 
 dependencies:
-  decky-frontend-lib: 3.18.10
+  decky-frontend-lib: 3.19.1
   react-file-icon: 1.2.0_wcqkhtmu7mswc6yz4uyexck3ty
   react-icons: 4.4.0_react@16.14.0
   react-markdown: 8.0.3_vshvapmxg47tngu7tvrsqpq55u
@@ -975,8 +975,8 @@ packages:
     dependencies:
       ms: 2.1.2
 
-  /decky-frontend-lib/3.18.10:
-    resolution: {integrity: sha512-2mgbA3sSkuwQR/FnmhXVrcW6LyTS95IuL6muJAmQCruhBvXapDtjk1TcgxqMZxFZwGD1IPnemPYxHZll6IgnZw==}
+  /decky-frontend-lib/3.19.1:
+    resolution: {integrity: sha512-hU4+EFs74MGzUCv8l1AO2+EBj9RRbnpU19Crm4u+3lbLu6d63U2GsUeQ9ssmNRcOMY1OuVZkRoZBE58soOBJ3A==}
     dev: false
 
   /decode-named-character-reference/1.0.2:

frontend/src/components/Markdown.tsx

@@ -1,4 +1,4 @@
-import { Focusable, Router } from 'decky-frontend-lib';
+import { Focusable, Navigation } from 'decky-frontend-lib';
 import { FunctionComponent, useRef } from 'react';
 import ReactMarkdown, { Options as ReactMarkdownOptions } from 'react-markdown';
 import remarkGfm from 'remark-gfm';
@@ -22,7 +22,7 @@ const Markdown: FunctionComponent<MarkdownProps> = (props) => {
                 onActivate={() => {}}
                 onOKButton={() => {
                   props.onDismiss?.();
-                  Router.NavigateToExternalWeb(aRef.current!.href);
+                  Navigation.NavigateToExternalWeb(aRef.current!.href);
                 }}
                 style={{ display: 'inline' }}
               >

frontend/src/components/QuickAccessVisibleState.tsx

@@ -4,15 +4,11 @@ const QuickAccessVisibleState = createContext<boolean>(true);
 
 export const useQuickAccessVisible = () => useContext(QuickAccessVisibleState);
 
-export const QuickAccessVisibleStateProvider: FC<{ initial: boolean; setter: ((val: boolean) => {}[]) | never[] }> = ({
-  children,
-  initial,
-  setter,
-}) => {
+export const QuickAccessVisibleStateProvider: FC<{ initial: boolean; tab: any }> = ({ children, initial, tab }) => {
   const [visible, setVisible] = useState<boolean>(initial);
   const [prev, setPrev] = useState<boolean>(initial);
-  // hack to use an array as a "pointer" to pass the setter up the tree
-  setter[0] = setVisible;
+  // HACK but i can't think of a better way to do this
+  tab.qAMVisibilitySetter = setVisible;
   if (initial != prev) {
     setPrev(initial);
     setVisible(initial);

frontend/src/components/modals/filepicker/patches/library.ts

@@ -4,13 +4,6 @@ import Logger from '../../../../logger';
 
 const logger = new Logger('LibraryPatch');
 
-declare global {
-  interface Window {
-    SteamClient: any;
-    appDetailsStore: any;
-  }
-}
-
 let patch: Patch;
 
 function rePatch() {
@@ -20,7 +13,9 @@ function rePatch() {
       const details = window.appDetailsStore.GetAppDetails(appid);
       logger.debug('game details', details);
       // strShortcutStartDir
-      const file = await window.DeckyPluginLoader.openFilePicker(details.strShortcutStartDir.replaceAll('"', ''));
+      const file = await window.DeckyPluginLoader.openFilePicker(
+        details?.strShortcutStartDir.replaceAll('"', '') || '/',
+      );
       logger.debug('user selected', file);
       window.SteamClient.Apps.SetShortcutExe(appid, JSON.stringify(file.path));
       const pathArr = file.path.split('/');

frontend/src/components/settings/pages/developer/index.tsx

@@ -52,7 +52,7 @@ export default function DeveloperSettings() {
       >
         <Toggle
           value={reactDevtoolsEnabled}
-          disabled={reactDevtoolsIP == ''}
+          // disabled={reactDevtoolsIP == ''}
           onChange={(toggleValue) => {
             setReactDevtoolsEnabled(toggleValue);
             setShouldConnectToReactDevTools(toggleValue);

frontend/src/components/settings/pages/general/Updater.tsx

@@ -6,6 +6,7 @@ import {
   Focusable,
   ProgressBarWithInfo,
   Spinner,
+  findSP,
   showModal,
 } from 'decky-frontend-lib';
 import { useCallback } from 'react';
@@ -14,7 +15,6 @@ import { useEffect, useState } from 'react';
 import { FaExclamation } from 'react-icons/fa';
 
 import { VerInfo, callUpdaterMethod, finishUpdate } from '../../../../updater';
-import { findSP } from '../../../../utils/windows';
 import { useDeckyState } from '../../../DeckyState';
 import InlinePatchNotes from '../../../patchnotes/InlinePatchNotes';
 import WithSuspense from '../../../WithSuspense';

frontend/src/components/store/Store.tsx

@@ -15,7 +15,7 @@ import Logger from '../../logger';
 import { StorePlugin, getPluginList } from '../../store';
 import PluginCard from './PluginCard';
 
-const logger = new Logger('FilePicker');
+const logger = new Logger('Store');
 
 const StorePage: FC<{}> = () => {
   const [currentTabRoute, setCurrentTabRoute] = useState<string>('browse');

frontend/src/steamfixes/index.ts

@@ -7,6 +7,6 @@ export function deinitSteamFixes() {
 }
 
 export async function initSteamFixes() {
-  fixes.push(reloadFix());
+  fixes.push(await reloadFix());
   fixes.push(await restartFix());
 }

frontend/src/steamfixes/reload.ts

@@ -1,10 +1,17 @@
+import { getFocusNavController, sleep } from 'decky-frontend-lib';
+
 import Logger from '../logger';
 
 const logger = new Logger('ReloadSteamFix');
 
-export default function reloadFix() {
+declare global {
+  var GamepadNavTree: any;
+}
+
+export default async function reloadFix() {
   // Hack to unbreak the ui when reloading it
-  if (window.FocusNavController?.m_rgAllContexts?.length == 0) {
+  await sleep(4000);
+  if (getFocusNavController()?.m_rgAllContexts?.length == 0) {
     SteamClient.URL.ExecuteSteamURL('steam://open/settings');
     logger.log('Applied UI reload fix.');
   }

frontend/src/steamfixes/restart.ts

@@ -4,13 +4,6 @@ import Logger from '../logger';
 
 const logger = new Logger('RestartSteamFix');
 
-declare global {
-  interface Window {
-    SteamClient: any;
-    appDetailsStore: any;
-  }
-}
-
 let patch: Patch;
 
 function rePatch() {

frontend/src/tabs-hook.tsx

@@ -35,7 +35,7 @@ class TabsHook extends Logger {
     const tree = (document.getElementById('root') as any)._reactRootContainer._internalRoot.current;
     let qAMRoot: any;
     const findQAMRoot = (currentNode: any, iters: number): any => {
-      if (iters >= 55) {
+      if (iters >= 65) {
         // currently 45
         return null;
       }
@@ -128,22 +128,23 @@ class TabsHook extends Logger {
     let deckyTabAmount = existingTabs.reduce((prev: any, cur: any) => (cur.decky ? prev + 1 : prev), 0);
     if (deckyTabAmount == this.tabs.length) {
       for (let tab of existingTabs) {
-        if (tab?.decky) tab.panel.props.setter[0](visible);
+        if (tab?.decky && tab?.qAMVisibilitySetter) tab?.qAMVisibilitySetter(visible);
       }
       return;
     }
     for (const { title, icon, content, id } of this.tabs) {
-      existingTabs.push({
+      const tab: any = {
         key: id,
         title,
         tab: icon,
         decky: true,
-        panel: (
-          <QuickAccessVisibleStateProvider initial={visible} setter={[]}>
-            {content}
-          </QuickAccessVisibleStateProvider>
-        ),
-      });
+      };
+      tab.panel = (
+        <QuickAccessVisibleStateProvider initial={visible} tab={tab}>
+          {content}
+        </QuickAccessVisibleStateProvider>
+      );
+      existingTabs.push(tab);
     }
   }
 }

frontend/src/toaster.tsx

@@ -45,6 +45,7 @@ class Toaster extends Logger {
         return null;
       }
       if (
+        currentNode?.memoizedProps?.className?.startsWith?.('gamepadtoasts_GamepadToastPlaceholder') ||
         currentNode?.memoizedProps?.className?.startsWith?.('toastmanager_ToastPlaceholder') ||
         currentNode?.memoizedProps?.className?.startsWith?.('toastmanager_ToastPopup')
       ) {

frontend/src/utils/windows.ts

@@ -1,7 +0,0 @@
-export function findSP(): Window {
-  // old (SP as host)
-  if (document.title == 'SP') return window;
-  // new (SP as popup)
-  return FocusNavController.m_ActiveContext.m_rgGamepadNavigationTrees.find((x: any) => x.m_ID == 'root_1_').Root
-    .Element.ownerDocument.defaultView;
-}

frontend/tsconfig.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "module": "ESNext",
-    "target": "ES2020",
+    "target": "ES2021",
     "jsx": "react",
     "jsxFactory": "window.SP_REACT.createElement",
     "jsxFragmentFactory": "window.SP_REACT.Fragment",