Merge pull request #404 from saphid/fix/framey-storage-cleaner-delete

fix(framey): make Storage Cleaner deletion bounded and reliable

docs/evidence/framey-storage-cleaner-native-2026-10-29.md

@@ -0,0 +1,27 @@
+# Storage Cleaner 1.4.0 managed backend, 29 October 2026
+
+The exact official store archive for ID 50 has SHA-256
+`1afa1a6f129c5d419de0e0bf0f6db8d8e50385a5659179346e996031ea372591`.
+Its `decky-storage-cleaner/main.py` has SHA-256
+`6fd4d012568edae22ba421495455b3c02899155e4c7484f5aa5be6ce9b14dd5f`.
+The original `delete_cache` awaits synchronous `shutil.rmtree`: a disposable
+fixture was deleted, then the method raised `TypeError`. The managed installer
+checks both digests before adapting its private copy. It calls `rmtree`
+synchronously and accepts only `shadercache`, `compatdata`, or a numeric app-ID
+child under either. It rejects traversal and symlink paths. The official ZIP
+is unchanged; an already installed managed copy needs Update.
+
+`python3 scripts/framey-test-decky-runtime.py --case 50 --output /tmp/framey-storage-cleaner-native-20261029.json`
+passed on native x86_64 with the published Decky 3.3.0 loader. Its disposable
+container had no external network, host devices, session bus, or user home.
+Decky discovered the official plugin, returned the private fixture's size
+and game-list row, deleted one selected shader-cache app directory, then
+deleted the whole private compatdata fixture. Both RPCs completed without
+the previous error. The 41 store transaction tests passed, including guard
+checks for traversal and symlink paths, install receipt, and remove. The
+container and image were removed. No real Frame lock or device was used.
+
+The deletion fixture does not prove real Steam cache cleanup or recovery.
+Real Frame ARM64 backend, frontend confirmation flow, worn VR and physical
+controller behavior remain unverified. Storage Cleaner stays **partial**;
+the compatibility counts do not change.

docs/framey-compatibility.md

@@ -72,7 +72,7 @@ The API column shows manifest / actual bundled frontend API. Many manifests say
 | 46: Steamback 1.0.0-1 | legacy / legacy | partial | Panel opens using the real Frame current-user/library snapshot. Account setup and empty save-list reads pass through actual Decky 3.3.0 amd64 in isolation. ARM64 backend, supported-save discovery, automatic backups and restore remain unverified; no backup/restore ran. | static archive, local browser, fake-Frame, real Frame SSH |
 | 48: Quick Launch 1.2.1 | legacy / legacy | broken | This plugin needs root and is not supported by the Frame user service. | static archive, local browser, fake-Frame |
 | 49: Decky Cloud Save 1.4.2 | legacy / legacy | broken | The exact official ZIP contains a 60,776,600-byte x86_64 rclone member, above the 30 MiB member limit and unusable on ARM64. Installation remains blocked. | static archive, local browser, fake-Frame |
-| 50: Storage Cleaner 1.4.0 | 1 / 2 | partial | Empty-data panel rendered; cleanup was deliberately not run because it can remove local data. | static archive, local browser, fake-Frame |
+| 50: Storage Cleaner 1.4.0 | 1 / 2 | partial | The empty-data panel renders locally. Exact managed 1.4.0 installs repair the backend delete-then-TypeError bug and restrict deletion to shadercache/compatdata or numeric app-ID children. Published Decky 3.3.0 x86_64 RPC passes private size/list and selected/whole fixture deletion in a network-isolated container. Real Steam cache deletion, Frame ARM64 backend, frontend confirmation flow and worn VR remain unverified; older copies need Update. | static archive, local browser, fake-Frame, isolated Decky 3.3.0 x86_64 backend |
 | 52: Game Theme Music 1.7.1-1 | 1 / 2 | partial | An inert local component lets the exact frontend initialize and render its Settings view in opaque Chromium. Backend get_setting and plugin network were denied in the audit; Steam game-page theme injection has no verified target in Framey. Music search, playback, downloads, settings persistence and worn VR remain unverified. | static archive, local browser, fake-Frame |
 | 53: Shotty 0.1.0 | legacy / legacy | partial | The frontend starts with the read-only Frame library snapshot. The exact-digest click.get_app_dir shim lets actual Decky 3.3.0 in isolated amd64 and ARM64 containers discover Shotty and complete empty screenshot RPCs; isolated Python also copied a synthetic screenshot into a temporary Pictures folder. The managed backend on the real Frame, live screenshots/rescue, in-VR panel and physical controller use remain unverified. | static archive, local browser, fake-Frame, real Frame SSH, isolated Python backend, isolated Decky 3.3.0 amd64/ARM64 empty backend RPCs |
 | 56: MangoPeel 0.0.7 | 1 / 2 | partial | Initializer succeeds; gamescope/MangoHud actions and backend are unverified. | static archive, local browser, fake-Frame |

tests/decky-runtime/cases.json

@@ -24,6 +24,11 @@
     "shim": null,
     "probe": "shelves-settings"
   },
+  {
+    "id": 50,
+    "shim": "storage-cleaner-bounded-delete",
+    "probe": "storage-cleaner"
+  },
   {
     "id": 104,
     "shim": null,

tests/decky-runtime/check.py

@@ -373,6 +373,29 @@ def main():
                 assert restored[0]['id'] == shelf['id'] and restored[0]['title'] == shelf['title'], restored
                 report['result'] = ('published Decky discovery, private shelf settings and restart persistence passed; '
                     'Steam Home injection, real Frame and VR unverified')
+            elif case['probe'] == 'storage-cleaner':
+                # The only deletion is an owned marker under this disposable
+                # container's private Steam fixture, never a real game cache.
+                apps = home/'.steam/steam/steamapps'
+                selected = apps/'shadercache/424242'
+                selected.mkdir(parents=True)
+                marker = b'Framey private cache fixture\n'
+                (selected/'marker').write_bytes(marker)
+                assert current('get_size', 'shadercache/424242') == len(marker)
+                rows = json.loads(current('list_games_with_temp_data', 'shadercache'))
+                assert rows == [{'appid': '424242', 'size': len(marker),
+                                 'size_readable': f'{len(marker)}.0 B'}], rows
+                assert current('delete_cache', 'shadercache/424242') is None
+                assert not selected.exists()
+                assert apps.joinpath('shadercache').is_dir()
+                whole = apps/'compatdata'
+                whole.mkdir()
+                (whole/'marker').write_bytes(marker)
+                assert current('get_size', 'compatdata') == len(marker)
+                assert current('delete_cache', 'compatdata') is None
+                assert not whole.exists()
+                report['result'] = ('published Decky discovery, private size/list and selected/whole fixture deletion passed; '
+                    'real Steam caches, Frame and VR unverified')
             elif case['probe'] == 'toggle-settings':
                 def call(method, *values):
                     result = rpc('loader/call_plugin_method', record['name'], method, *values)

tests/fixtures/framey-official/README.md

@@ -68,6 +68,10 @@ and redirect, and rejects a self-signed loopback HTTPS endpoint from both
 methods. The certificate and private key under `tests/decky-runtime/fixtures`
 are public test fixtures; they grant no trusted access. External radio, trusted
 HTTPS and audio playback remain unverified.
+Storage Cleaner runs through the published Decky loader with only disposable
+cache markers: size/list, selected-app delete and whole-directory delete pass.
+The managed copy rejects traversal and symlink delete paths. No real game or
+Steam cache is deleted.
 Game Sync runs through actual published Decky 3.3.0 instance RPC in the same
 isolation. Only default configuration and a private setting surviving restart
 are checked. No rclone, cloud sync, process signal, Frame backend or VR action

tests/test_frame_decky_store.py

@@ -212,6 +212,46 @@ class StoreTransaction(unittest.TestCase):
         self.assertEqual(result.returncode, 0, result.stderr)
         self.assertFalse(folder.exists())
 
+    def test_exact_storage_cleaner_deletes_only_private_cache_fixture(self):
+        from framey_official import PLUGINS, archive as official_archive
+        plugin = next(p for p in PLUGINS if p['id'] == 50)
+        data = official_archive(plugin)
+        self.assertEqual(frame_decky_store.archive_info(data, plugin['sha256'], plugin['name']), plugin['folder'])
+        result = self.apply('install', data, plugin_id=50,
+                            folder=plugin['folder'], version=plugin['version'])
+        self.assertEqual(result.returncode, 0, result.stderr)
+        folder = self.folder.parent/plugin['folder']
+        receipt = json.loads((folder/'.frame-control-store.json').read_text())
+        self.assertEqual(receipt['compatShims'], ['storage-cleaner-bounded-delete'])
+        source = (folder/'main.py').read_text(encoding='utf-8')
+        self.assertNotIn('await shutil.rmtree', source)
+        steamapps = Path(self.tmp.name)/'.steam/steam/steamapps'
+        selected = steamapps/'shadercache/424242'
+        selected.mkdir(parents=True)
+        (selected/'marker').write_text('private fixture')
+        outside = Path(self.tmp.name)/'outside'
+        outside.mkdir()
+        (outside/'marker').write_text('must survive')
+        namespace = {'__name__': 'storage_cleaner_fixture'}
+        fake_decky = types.SimpleNamespace(DECKY_USER_HOME=self.tmp.name,
+                                           DECKY_PLUGIN_DIR=str(folder))
+        with patch.dict(sys.modules, {'decky': fake_decky}):
+            exec(compile(source, str(folder/'main.py'), 'exec'), namespace)
+        plugin_class = namespace['Plugin']
+        for name in ('../outside', 'shadercache/../outside', 'compatdata/../../outside',
+                     'shadercache/not-an-app', '/tmp/outside'):
+            with self.subTest(name=name), self.assertRaisesRegex(ValueError, 'Invalid cache path'):
+                asyncio.run(plugin_class.delete_cache(name))
+        (steamapps/'compatdata').symlink_to(outside, target_is_directory=True)
+        with self.assertRaisesRegex(ValueError, 'symbolic link'):
+            asyncio.run(plugin_class.delete_cache('compatdata'))
+        self.assertTrue((outside/'marker').is_file())
+        self.assertIsNone(asyncio.run(plugin_class.delete_cache('shadercache/424242')))
+        self.assertFalse(selected.exists())
+        self.assertTrue((outside/'marker').is_file())
+        result = self.apply('remove', plugin_id=50, folder=plugin['folder'])
+        self.assertEqual(result.returncode, 0, result.stderr)
+
     def test_modified_fileserver_archive_does_not_inherit_exception(self):
         from framey_official import PLUGINS, archive as official_archive
         record = next(p for p in PLUGINS if p['id'] == 60)

tests/test_framey_decky_runtime.py

@@ -22,7 +22,7 @@ class RuntimeCoverage(unittest.TestCase):
             self.assertIn(case['probe'], ('mpris', 'screenshots', 'system-monitor', 'timer-lifecycle',
                                          'toggle-settings', 'fileserver', 'localsend', 'network-sentinel',
                                          'battery-tracker', 'free-loader', 'radio-local', 'game-sync-config',
-                                         'shelves-settings'))
+                                         'shelves-settings', 'storage-cleaner'))
 
     def test_new_shim_without_runtime_case_fails_coverage(self):
         import frame_decky_store

ui/frame_decky_store.py

@@ -43,6 +43,8 @@ BATTERY_TRACKER_DIGEST = '91c388d3c1b52079314045b79671ad55c767510658b6193f6936ed
 BATTERY_TRACKER_MAIN = '2303ec70c262f1cbfe1c8c138770c6e7c3496827e748e679c94ca43ff9f28725'
 RADIYO_DIGEST = '647111578aa7a5ecd16af8d7fe6c068a6d7ea8737c6dce5ac2d52e84a549ec43'
 RADIYO_MAIN = '868332dbe3feb1e7a81e35a0c01fdc0a6b68421ec1f84e238564bfad4946e87e'
+STORAGE_CLEANER_DIGEST = '1afa1a6f129c5d419de0e0bf0f6db8d8e50385a5659179346e996031ea372591'
+STORAGE_CLEANER_MAIN = '6fd4d012568edae22ba421495455b3c02899155e4c7484f5aa5be6ce9b14dd5f'
 
 VERSION = re.compile(r'[A-Za-z0-9][A-Za-z0-9._+\-]{0,39}\Z')
 
@@ -176,6 +178,10 @@ def archive_info(data, expected_hash, expected_name):
         if (expected_hash == RADIYO_DIGEST and expected_name == 'RadiYo!' and folder == 'radiyo-steam-deck'
                 and hashlib.sha256(archive.read(folder+'/main.py')).hexdigest() != RADIYO_MAIN):
             raise ValueError('RadiYo source differs from the pinned archive')
+        if (expected_hash == STORAGE_CLEANER_DIGEST and expected_name == 'Storage Cleaner'
+                and folder == 'decky-storage-cleaner'
+                and hashlib.sha256(archive.read(folder+'/main.py')).hexdigest() != STORAGE_CLEANER_MAIN):
+            raise ValueError('Storage Cleaner source differs from the pinned archive')
         return folder
 
 
@@ -730,6 +736,36 @@ def split_by_app(data):
                 data=data.replace(unsafe,b'').replace(broken,b"'URL Error: ' + str(error.reason)")
                 main.write_bytes(data)
                 compat_shims.append('radiyo-verified-tls')
+            # The exact published backend awaits synchronous shutil.rmtree:
+            # it deletes the cache then reports TypeError. Restrict deletion
+            # to the two directories selected by its UI and their numeric app IDs.
+            if int(plugin_id)==50 and digest=='1afa1a6f129c5d419de0e0bf0f6db8d8e50385a5659179346e996031ea372591' and folder=='decky-storage-cleaner':
+                main=unpacked/'main.py'
+                data=main.read_bytes()
+                if hashlib.sha256(data).hexdigest()!='6fd4d012568edae22ba421495455b3c02899155e4c7484f5aa5be6ce9b14dd5f':
+                    raise RuntimeError('Storage Cleaner source differs from pinned archive')
+                old=b"    @classmethod\n    async def delete_cache(cls, dirName):\n        await shutil.rmtree(homeDir + '/.steam/steam/steamapps/' + dirName)"
+                new=b"""    @classmethod
+    async def delete_cache(cls, dirName):
+        if not isinstance(dirName, str):
+            raise ValueError('Invalid cache path')
+        parts = dirName.split('/')
+        if (len(parts) not in (1, 2) or parts[0] not in ('shadercache', 'compatdata')
+                or (len(parts) == 2 and (not parts[1].isascii() or not parts[1].isdecimal()))):
+            raise ValueError('Invalid cache path')
+        root = os.path.realpath(os.path.join(homeDir, '.steam', 'steam', 'steamapps'))
+        target = os.path.join(root, *parts)
+        cursor = root
+        for part in parts:
+            cursor = os.path.join(cursor, part)
+            if os.path.islink(cursor):
+                raise ValueError('Cache path is a symbolic link')
+        if os.path.commonpath((root, os.path.realpath(target))) != root:
+            raise ValueError('Cache path escapes Steam apps')
+        shutil.rmtree(target)"""
+                if data.count(old)!=1: raise RuntimeError('Storage Cleaner delete source changed')
+                main.write_bytes(data.replace(old,new))
+                compat_shims.append('storage-cleaner-bounded-delete')
             # Recheck under the transaction lock. Another store operation may
             # have installed a colliding name while this archive downloaded.
             proposed_name=json.loads((unpacked/'plugin.json').read_text()).get('name')

ui/framey-compatibility.json

@@ -3714,12 +3714,13 @@
         "https://github.com/mcarlucci/decky-storage-cleaner.git"
       ],
       "status": "partial",
-      "reason": "Empty-data panel rendered; cleanup was deliberately not run because it can remove local data.",
+      "reason": "The empty-data panel renders locally. Exact managed 1.4.0 installs repair the backend delete-then-TypeError bug and restrict deletion to shadercache/compatdata or numeric app-ID children. Published Decky 3.3.0 x86_64 RPC passes private size/list and selected/whole fixture deletion in a network-isolated container. Real Steam cache deletion, Frame ARM64 backend, frontend confirmation flow and worn VR remain unverified; older copies need Update.",
       "blockInstall": false,
       "verification": [
         "static archive",
         "local browser",
-        "fake-Frame"
+        "fake-Frame",
+        "isolated Decky 3.3.0 x86_64 backend"
       ],
       "browser": {
         "id": 50,