From 205759783c42366a93cd5a1ed0c924003a462b89 Mon Sep 17 00:00:00 2001 From: RetroGameDeveloper <40120498+RetroGameDeveloper@users.noreply.github.com> Date: Sun, 8 Nov 2026 17:22:25 +0000 Subject: [PATCH 1/2] Add remembered project directories and runtime switching --- ROADMAP.md | 6 + src/decompnet/app/cli.py | 12 +- src/decompnet/app/data_directories.py | 149 ++++++++++++++++++ src/decompnet/app/edition.py | 5 +- src/decompnet/app/routes/data_directories.py | 24 +++ src/decompnet/app/routes/life.py | 1 + src/decompnet/app/server.py | 16 +- src/decompnet/app/source_runtime.py | 2 +- src/decompnet/app/static/index.html | 1 + .../app/static/js/data-directories.js | 67 ++++++++ src/decompnet/app/static/js/pages.js | 3 +- src/decompnet/app/thread_activity.py | 1 + src/decompnet/app/updates.py | 10 +- tests/gui_data_directories.js | 33 ++++ tests/test_app_server.py | 19 +++ tests/test_data_directories.py | 140 ++++++++++++++++ 16 files changed, 478 insertions(+), 11 deletions(-) create mode 100644 src/decompnet/app/data_directories.py create mode 100644 src/decompnet/app/routes/data_directories.py create mode 100644 src/decompnet/app/static/js/data-directories.js create mode 100644 tests/gui_data_directories.js create mode 100644 tests/test_data_directories.py diff --git a/ROADMAP.md b/ROADMAP.md index 7515d256a..0f16a9cde 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -3227,3 +3227,9 @@ broad header-qualifier guard. Macro-expanded pointer expressions still need alia proof. The frozen exported-ROM CLI is MIPS-only; other targets need their copied ordinary build/objdiff evaluator. Neither diagnostic expansion nor recipe hashes replace that exact judge. + +- Done: Settings offers a project-directory picker and machine-local remembered directories. + Desktop users can switch between independent project catalogues at runtime through a graceful + save/stop/reopen handoff. Files stay in place; the successfully opened directory becomes the + next-launch default. Explicit DECOMP_HOME retains precedence, release/development histories + are separate, unavailable drives are not recreated, and switching rotates window credentials. diff --git a/src/decompnet/app/cli.py b/src/decompnet/app/cli.py index 5ae4de0b4..a40275931 100644 --- a/src/decompnet/app/cli.py +++ b/src/decompnet/app/cli.py @@ -163,6 +163,11 @@ def run(args) -> int: os.environ.update(DECOMP_SERVE='1', DECOMP_WINDOW='0', DECOMP_TRAY='0') use_own_wine_prefix() home = home_dir() + from .data_directories import preferred + if not os.environ.get('DECOMP_HOME') and preferred() and not home.is_dir(): + message = f'The remembered project directory is unavailable: {home}. Connect its drive or choose a directory using DECOMP_HOME.' + print(message, file=sys.stderr);window.tell_desktop(edition.NAME, message) + return 1 internal = home / ".decomp" internal.mkdir(parents=True, exist_ok=True) log = file_log(internal / "logs" / "decomp.log") # from the first line on: whatever stops the app is in it @@ -198,7 +203,7 @@ def run(args) -> int: # launcher from starting a second server/workers while this home is opening. from ..writer_gate import WriterGate instance = WriterGate(internal / 'server-instance') - with instance.hold(blocking=bool(restarted)) as admitted: + with instance.hold(blocking=bool(restarted) and not restarted.get('switch_home',False)) as admitted: if not admitted: print('decompdecomp is already starting for this home. Wait for its database upgrade to finish.') return 0 @@ -229,13 +234,16 @@ def _start(args,home,internal,state_file,log,restarted,headless): print(str(error), file=sys.stderr, flush=True) return 1 mcp, manager, security, quit_app = build(net, internal, port, secret, **({"headless":True} if headless else {})) + if restarted and restarted.get('switch_home'): + from .data_directories import remember + remember(home,selected=True) app = mcp.streamable_http_app(transport_security=security, max_request_body_size=REQUEST_BODY_LIMIT, host="127.0.0.1") from ..ui_diagnostics import Diagnostics app = Diagnostics(app, stack_path=internal / "logs" / "event-loop-stacks.log") # with a tray icon, helpers kept working without the window have a way back to it window.IN_TRAY = False if headless else tray.start(window.open_app, quit_app) print(f"{edition.NAME} {__import__('decompnet').__version__}\nyour projects: {hostenv.shown_path(home)}" - + ("\nupdated and restarted" if restarted else "" if headless else "\nstop with Ctrl-C, or quit it in its window"), flush=True) + + ("\nproject directory switched" if restarted and restarted.get("switch_home") else "\nupdated and restarted" if restarted else "" if headless else "\nstop with Ctrl-C, or quit it in its window"), flush=True) # (1.0.2 and older restart into a new version without saying: they had a browser tab, which can't follow) if headless: print(f"Server: http://127.0.0.1:{port}/\nWeb sign-in code: {net.web_login.code}\nStop with Ctrl-C or `decomp stop`.", flush=True) diff --git a/src/decompnet/app/data_directories.py b/src/decompnet/app/data_directories.py new file mode 100644 index 000000000..afaf6279a --- /dev/null +++ b/src/decompnet/app/data_directories.py @@ -0,0 +1,149 @@ +"""Machine-local project directory history and explicit, isolated runtime handoffs.""" +import json +import os +import secrets +import sqlite3 +import tempfile +import threading +from contextlib import closing, nullcontext +from pathlib import Path + +from .. import toolchains +from ..network import NetworkError +from ..writer_gate import WriterGate +from . import edition, updates, window + + +def registry_path(): + override = os.environ.get('DECOMP_DIRECTORIES_FILE') + return Path(override).expanduser() if override else toolchains.data_dir() / ('RetroReversing-directories-dev.json' if edition.DEV else 'RetroReversing-directories.json') + + +def read(): + path = registry_path() + if not path.exists():return {'directories':[], 'selected':''} + try: + value = json.loads(path.read_text(encoding='utf-8')) + if not isinstance(value, dict) or not isinstance(value.get('directories'), list):raise ValueError() + if any(not isinstance(p,str) or not Path(p).is_absolute() for p in value['directories']):raise ValueError() + selected = value.get('selected','') + if not isinstance(selected,str) or (selected and (not Path(selected).is_absolute() or selected not in value['directories'])):raise ValueError() + return value + except (ValueError, TypeError): + raise NetworkError('The remembered project directories file is invalid: '+str(path)) from None + + +def preferred(): + try:return read().get('selected') or None + except (NetworkError, OSError):return None # A damaged history must not prevent access to the default home. + + +def remember(path, *, selected=False, current=None): + file = registry_path() + file.parent.mkdir(parents=True, exist_ok=True) + with WriterGate(file).hold(): + data = read() + paths = [str(Path(p).resolve()) for p in (current, path) if p] + data['directories'] = list(dict.fromkeys(paths+data['directories'])) + if selected:data['selected'] = str(Path(path).resolve()) + fd, temporary = tempfile.mkstemp(prefix=file.name+'.',dir=file.parent) + try: + with os.fdopen(fd,'w',encoding='utf-8') as stream:json.dump(data,stream) + os.replace(temporary,file) + finally:Path(temporary).unlink(missing_ok=True) + + +def validate(raw): + if not isinstance(raw,str) or not raw.strip() or any(c in raw for c in '\0\r\n'): + raise NetworkError('Choose a project directory.') + path = Path(raw.strip()).expanduser() + if not path.is_absolute():raise NetworkError('Choose a full directory path.') + path = path.resolve() + if not path.is_dir():raise NetworkError('This directory is not available. Connect its drive or choose an existing folder.') + if any(part.lower()=='.decomp' for part in path.parts):raise NetworkError('Choose the project directory containing .decomp, not its internal app-state folder.') + internal = path/'.decomp' + if internal.is_symlink():raise NetworkError('The .decomp app-state directory must not be a symbolic link.') + # Check access before stopping any work. Never create a missing mount or copy projects. + fd, probe = tempfile.mkstemp(prefix='.decomp-write-check-',dir=path) + os.close(fd);Path(probe).unlink() + database = internal/'decomp.db' + if database.is_symlink():raise NetworkError('The app database must not be a symbolic link.') + if database.exists(): + try: + with closing(sqlite3.connect(database.as_uri()+'?mode=ro',uri=True)) as db:db.execute('PRAGMA schema_version').fetchone() + except sqlite3.DatabaseError: + raise NetworkError('This directory’s app database could not be read. Repair it before switching directories.') from None + return path + + +class Controller: + def __init__(self, app): + self.app = app + self.lock = threading.Lock() + self.job = {'state':'idle'} + self.previous_update = None + + def status(self): + current = str(self.app.home.parent.resolve()) + paths = list(dict.fromkeys([current,str(edition.default_home().resolve())]+read()['directories'])) + return {'current':current, 'directories':[{'path':p,'available':Path(p).is_dir()} for p in paths], 'job':dict(self.job)} + + def choose(self, raw, switch=False): + target = validate(raw) + current = self.app.home.parent.resolve() + with self.lock: + if self.job['state'] in ('queued','restarting'): + if self.job.get('target') == str(target):return self.status() + raise NetworkError('A directory switch is already in progress.') + if switch and target != current: + if self.app.headless:raise NetworkError('Switch project directories in the desktop app.') + runtime = getattr(self.app,'source_runtime',None) + if getattr(self.app.jobs,'source_update_pending',False) or self.app.updater.job.get('state') in ('installing','restarting','switching-directory') or (runtime and runtime.job.get('state') in ('preparing','waiting','deferred','updating','restarting')): + raise NetworkError('Wait for the app update or restart to finish before switching directories.') + remember(target,current=current) + if not switch:return {**self.status(),'chosen':str(target)} + if target == current: + remember(target,selected=True) + return self.status() + with runtime.lock if runtime else nullcontext(), self.app.updater._lock: + if runtime and runtime.job.get('state') in ('preparing','waiting','deferred','updating','restarting'): + raise NetworkError('Wait for the source runtime update to finish before switching directories.') + if self.app.updater.job.get('state') in ('installing','restarting','switching-directory'): + raise NetworkError('Wait for the current app update to finish before switching directories.') + self.previous_update = dict(self.app.updater.job) + self.app.updater.job = {'state':'switching-directory','log':['Switching project directory…'],'error':None} + self.app.jobs.source_update_pending = True # Block new jobs during the handoff. + self.job = {'state':'queued','target':str(target),'message':'Preparing to save work and switch project directory…'} + try:threading.Thread(target=self.run,args=(target,),daemon=True,name='data-directory-switch').start() + except (RuntimeError,OSError): + self.job = {'state':'idle'} + self.app.jobs.source_update_pending = False + with self.app.updater._lock:self.app.updater.job = self.previous_update + raise NetworkError('Could not start the directory switch. Current work continues; retry shortly.') from None + return self.status() + + def run(self, target): + stopped = False + try: + # Let the initiating request return before closing its window. + threading.Event().wait(.3) + internal = target/'.decomp' + internal.mkdir(exist_ok=True) + with WriterGate(internal/'server-instance').hold(blocking=False) as admitted: + if not admitted:raise NetworkError('This directory is already open or starting in another app. Switch to that window first.') + self.job.update(state='restarting',message='Saving current work and stopping agents and room connections…') + was_open = window.is_open() + stopped = True + self.app.updater.before_restart() + state_file = self.app.home/'server.json' + if state_file.is_file(): + state = json.loads(state_file.read_text()) + if state.get('secret') == self.app.secret:state_file.unlink() + # New identity rejects stale window/browser requests aimed at the previous data. + window.close_app() + updates.restart(self.app.port,secrets.token_urlsafe(24),was_open,home=target) + except (OSError,ValueError,NetworkError) as error: + self.job.update(state='error',message=str(error)+(' Current work may have stopped; quit and reopen the app to resume this directory.' if stopped else ' Current work continues.')) + self.app.jobs.source_update_pending = False + if self.previous_update is not None: + with self.app.updater._lock:self.app.updater.job = self.previous_update diff --git a/src/decompnet/app/edition.py b/src/decompnet/app/edition.py index e8a932a75..299d92d52 100644 --- a/src/decompnet/app/edition.py +++ b/src/decompnet/app/edition.py @@ -32,8 +32,9 @@ def default_home(*, dev: bool | None = None) -> Path: def home_dir() -> Path: - """Use an explicit DECOMP_HOME, otherwise this fork's own installed or development home.""" - return Path(os.environ.get("DECOMP_HOME") or default_home()).expanduser() + """Use DECOMP_HOME, a remembered directory, or this fork's edition-specific default.""" + from .data_directories import preferred + return Path(os.environ.get("DECOMP_HOME") or preferred() or default_home()).expanduser() def icon_svg() -> str: diff --git a/src/decompnet/app/routes/data_directories.py b/src/decompnet/app/routes/data_directories.py new file mode 100644 index 000000000..eea2cce43 --- /dev/null +++ b/src/decompnet/app/routes/data_directories.py @@ -0,0 +1,24 @@ +"""Directory history is local to this machine; switching requires the desktop window.""" +from starlette.responses import JSONResponse + +from ...network import NetworkError +from .. import data_directories, window + + +def register(app): + controller = data_directories.Controller(app) + + @app.mcp.custom_route('/api/data-directories', methods=['GET','POST']) + async def directories(request): + if bad := app.guard(request,write=request.method=='POST'):return bad + try: + if request.method=='GET':result = await app.call(controller.status) + else: + data = await app.body(request) + action = data.get('action') + if action not in ('remember','switch'):raise NetworkError('Choose Remember directory or Switch directory.') + if action=='switch' and window.token_of(request.headers.get('user-agent','')) != app.secret: + raise NetworkError('Switch project directories in the desktop app.') + result = await app.call(controller.choose,str(data.get('path') or ''),action=='switch') + return JSONResponse({**result,'switchable':not app.headless and window.token_of(request.headers.get('user-agent','')) == app.secret}) + except (NetworkError,OSError,ValueError) as error:return app.fail(error) diff --git a/src/decompnet/app/routes/life.py b/src/decompnet/app/routes/life.py index 4043ec9f6..6f6436fe5 100644 --- a/src/decompnet/app/routes/life.py +++ b/src/decompnet/app/routes/life.py @@ -66,6 +66,7 @@ async def api_checkout(request: Request) -> Response: from ..source_runtime import ACTIVE, Runtime runtime = Runtime(app) + app.source_runtime = runtime @mcp.custom_route("/api/update/runtime", methods=["GET", "POST"]) async def api_runtime(request: Request) -> Response: diff --git a/src/decompnet/app/server.py b/src/decompnet/app/server.py index 314dd37c7..c446edbc0 100644 --- a/src/decompnet/app/server.py +++ b/src/decompnet/app/server.py @@ -28,7 +28,19 @@ from ..network import NetworkError from . import agents, collab, maintenance, routes, saves, tools, updates, window, workers from .engine import RomNetwork -from .routes import browser_bridge, forks, life, pages, projects, repair_feedback, repository_sync, rooms, setup, state +from .routes import ( + browser_bridge, + data_directories, + forks, + life, + pages, + projects, + repair_feedback, + repository_sync, + rooms, + setup, + state, +) from .shutdown_progress import RUNTIME_STOP_SECONDS, SHUTDOWN_SECONDS, terminal_note from .shutdown_progress import Progress as ShutdownProgress from .support import Jobs, Settings, session_options @@ -336,7 +348,7 @@ def before_restart() -> None: busy=busy, quit_app=quit_app, web_login=net.web_login, headless=headless) from . import web_login web_login.register(app) - for part in (pages, state, projects, repair_feedback, repository_sync, forks, setup, life, rooms, pairing, browser_bridge): + for part in (pages, state, projects, repair_feedback, repository_sync, forks, setup, life, rooms, pairing, browser_bridge, data_directories): part.register(app) security = TransportSecuritySettings(enable_dns_rebinding_protection=True, allowed_hosts=sorted(allowed_hosts), diff --git a/src/decompnet/app/source_runtime.py b/src/decompnet/app/source_runtime.py index 6f574390c..43c02382d 100644 --- a/src/decompnet/app/source_runtime.py +++ b/src/decompnet/app/source_runtime.py @@ -213,7 +213,7 @@ def start(self,path,data_mode): with self.lock: if self.job['state'] in ACTIVE: raise ValueError('A source handoff is already queued.') - if self.app.updater.job['state'] in ('installing','restarting'): + if self.app.updater.job['state'] in ('installing','restarting','switching-directory'): raise ValueError('Wait for the packaged update to finish first.') self.cancel.clear() self.app.settings.data['source_runtime_path']=str(folder) diff --git a/src/decompnet/app/static/index.html b/src/decompnet/app/static/index.html index 4accd0e18..9d73f7956 100644 --- a/src/decompnet/app/static/index.html +++ b/src/decompnet/app/static/index.html @@ -1104,6 +1104,7 @@
+ diff --git a/src/decompnet/app/static/js/data-directories.js b/src/decompnet/app/static/js/data-directories.js new file mode 100644 index 000000000..41600d3b7 --- /dev/null +++ b/src/decompnet/app/static/js/data-directories.js @@ -0,0 +1,67 @@ +/* Each location is a separate project catalogue. The desktop runtime owns switching. */ +let dataDirectoryRequest=0, dataDirectoryBusy=false; +async function renderDataDirectories(){ + const request=++dataDirectoryRequest, root=$('dataDirectories'); + if(!root)return; + root.innerHTML='Loading project directories…
'; + try{ + const info=await api('/api/data-directories'); + if(request!==dataDirectoryRequest || $('dataDirectories')!==root)return; + root.innerHTML=`Each directory has its own projects and app state. Switching saves and stops current work, then reopens the app on the selected directory. Existing files stay in place.
+ + ${info.switchable ? '' : 'Switch directories from the desktop app.
'}`; + wireCopies(root); + const field=$('dataDirectoryPath'),known=$('dataDirectoryKnown'),log=$('dataDirectoryLog'); + known.onchange=()=>{field.value=known.value;}; + $('dataDirectoryPick').onclick=async()=>{ + const button=$('dataDirectoryPick');button.disabled=true; + try{const result=await api('/api/pick',{method:'POST',body:{kind:'folder',title:'Choose project directory'}});if(result.path && $('dataDirectories')===root)field.value=result.path;} + catch(error){if($('dataDirectories')===root)showJobError(log,error.message);} + finally{button.disabled=false;} + }; + async function choose(action){ + if(dataDirectoryBusy)return; + dataDirectoryBusy=true; + const controls=[field,known,$('dataDirectoryPick'),$('dataDirectorySwitch'),$('dataDirectoryRemember')]; + const finish=beginWork(log,action==='switch' ? 'Preparing directory switch' : 'Remembering directory',controls,'Directory remembered.'); + showJobError(log,''); + try{ + const chosen=field.value.trim(); + const state=await api('/api/data-directories',{method:'POST',body:{action,path:chosen}}); + if(action==='switch' && ['queued','restarting'].includes(state.job.state)){ + if($('dataDirectories')===root)log.textContent=state.job.message; + const error=await followDirectorySwitch(state.job.target); + if(error && $('dataDirectories')===root)showJobError(log,error); + }else if($('dataDirectories')===root){dataDirectoryBusy=false;await renderDataDirectories();if($('dataDirectoryPath')){$('dataDirectoryPath').value=state.chosen || chosen;$('dataDirectoryKnown').value=state.chosen || chosen;}} + }catch(error){if($('dataDirectories')===root)showJobError(log,error.message);} + finally{dataDirectoryBusy=false;finish();if(!info.switchable && $('dataDirectories')===root && $('dataDirectorySwitch'))$('dataDirectorySwitch').disabled=true;} + } + $('dataDirectoryRemember').onclick=()=>choose('remember'); + $('dataDirectorySwitch').onclick=()=>choose('switch'); + if(['queued','restarting'].includes(info.job.state))followDirectorySwitch(info.job.target); + else if(info.job.state==='error')showJobError(log,info.job.message); + }catch(error){if(request===dataDirectoryRequest && $('dataDirectories')===root){root.textContent='';showJobError(root,error.message);}} +} +let dataDirectoryFollowing=false; +async function followDirectorySwitch(target){ + if(dataDirectoryFollowing)return; + dataDirectoryFollowing=true; + const body=dialog('Switching project directory','Saving current work and reopening the app on the selected directory…
'); + const log=body.querySelector('#dataDirectorySwitchLog'); + const finish=beginWork(log,'Switching project directory',[],'Directory opened.'); + try{ + for(let count=0;count<180;count++){ + await sleep(1000); + let state; + try{state=await api('/api/data-directories');}catch{continue;} // The native window reopens with a new connection identity. + if(state.current===target){location.hash='#/settings';location.reload();return;} + log.textContent=state.job.message || 'Waiting for the selected directory to open…'; + if(state.job.state==='error')throw new Error(state.job.message); + } + throw new Error('The directory switch has not reconnected. Reopen the desktop app to check its selected directory.'); + }catch(error){showJobError(log,error.message);return error.message;} + finally{finish();dataDirectoryFollowing=false;} +} diff --git a/src/decompnet/app/static/js/pages.js b/src/decompnet/app/static/js/pages.js index 751dbfcc7..954acb9aa 100644 --- a/src/decompnet/app/static/js/pages.js +++ b/src/decompnet/app/static/js/pages.js @@ -285,9 +285,10 @@ async function showSettingsPage() { const theme = savedTheme(); $("setComputer").innerHTML = `${value}`,wireCopies(){},
+ beginWork(log,label,controls){controls.forEach(c=>c.disabled=true);return()=>controls.forEach(c=>c.disabled=false);},showJobError(log,error){log.textContent=String(error);},
+ async api(url,options){
+ requests.push({url,options});
+ if(url==='/api/pick')return {path:'/picked directory'};
+ if(options?.method==='POST'){
+ await new Promise(resolve=>release=resolve);
+ if(failure)throw Error('Directory unavailable');
+ return info;
+ }
+ return info;
+ }};
+ vm.createContext(ctx);vm.runInContext(fs.readFileSync('src/decompnet/app/static/js/data-directories.js','utf8'),ctx);
+ await ctx.renderDataDirectories();assert.match($('dataDirectories').innerHTML,/Remembered directories/);
+ if(!switchable)assert.match($('dataDirectories').innerHTML,/id="dataDirectorySwitch" disabled/);
+ $('dataDirectoryKnown').value='/other';$('dataDirectoryKnown').onchange();assert.equal($('dataDirectoryPath').value,'/other');
+ await $('dataDirectoryPick').onclick();assert.equal($('dataDirectoryPath').value,'/picked directory');
+ const pending=$('dataDirectoryRemember').onclick();
+ assert.equal($('dataDirectoryRemember').disabled,true);
+ await $('dataDirectoryRemember').onclick();assert.equal(requests.filter(r=>r.options?.method==='POST'&&r.url==='/api/data-directories').length,1);
+ assert.equal(requests.at(-1).options.body.path,'/picked directory');
+ release();await pending;
+ if(failure)assert.match($('dataDirectoryLog').textContent,/unavailable/);
+ else assert.equal(requests.at(-1).options,undefined,'remember refreshes history without switching runtime');
+}
+(async()=>{await run();await run({failure:true});await run({switchable:false});})().catch(error=>{console.error(error);process.exit(1);});
diff --git a/tests/test_app_server.py b/tests/test_app_server.py
index 457464948..ddb7e3543 100644
--- a/tests/test_app_server.py
+++ b/tests/test_app_server.py
@@ -3128,3 +3128,22 @@ def run(net,slug,folder,owner,revision,log):
assert client.get('/api/job?id='+job).json()['scope']=={'slug':'game','folder':'/repo'}
assert calls==[('game','/repo','team','revision')]
finally:release.set()
+
+
+def test_project_directory_history_requires_guard_and_native_switch(app,tmp_path,monkeypatch):
+ from decompnet.app import data_directories
+ client,net,_=app
+ monkeypatch.setenv('DECOMP_DIRECTORIES_FILE',str(tmp_path/'locations.json'))
+ state=client.get('/api/data-directories').json()
+ assert state['current']==str(net.workspace.resolve()) and state['switchable']
+ calls=[]
+ def choose(self,path,switch=False):
+ calls.append((path,switch))
+ return self.status()
+ monkeypatch.setattr(data_directories.Controller,'choose',choose)
+ payload={'path':str(tmp_path),'action':'switch'}
+ assert client.post('/api/data-directories',json=payload).status_code==403
+ assert client.post('/api/data-directories',json=payload,headers={'X-Decomp':'1'}).status_code==200
+ assert calls==[(str(tmp_path),True)]
+ assert client.post('/api/data-directories',json={**payload,'action':'unsafe'},headers={'X-Decomp':'1'}).status_code==400
+ assert not (tmp_path/'locations.json').exists()
diff --git a/tests/test_data_directories.py b/tests/test_data_directories.py
new file mode 100644
index 000000000..0e027a323
--- /dev/null
+++ b/tests/test_data_directories.py
@@ -0,0 +1,140 @@
+import json
+from types import SimpleNamespace
+
+import pytest
+
+from decompnet.app import data_directories as dirs
+from decompnet.app import edition, updates
+from decompnet.network import NetworkError
+from decompnet.writer_gate import WriterGate
+
+
+@pytest.fixture
+def locations(tmp_path,monkeypatch):
+ monkeypatch.setenv('DECOMP_DIRECTORIES_FILE',str(tmp_path/'machine/locations.json'))
+ current,target=tmp_path/'current',tmp_path/'second directory'
+ (current/'.decomp').mkdir(parents=True);target.mkdir()
+ return current,target
+
+
+def test_history_deduplicates_and_explicit_home_overrides_preference(locations,monkeypatch):
+ current,target=locations
+ dirs.remember(target,current=current)
+ assert dirs.preferred() is None
+ dirs.remember(target,selected=True,current=current)
+ dirs.remember(target,current=current)
+ assert dirs.read()['directories']==[str(current),str(target)]
+ monkeypatch.delenv('DECOMP_HOME',raising=False)
+ assert edition.home_dir()==target
+ monkeypatch.setenv('DECOMP_HOME',str(current))
+ assert edition.home_dir()==current
+ assert 'secret' not in dirs.registry_path().read_text()
+
+
+def test_registry_is_separate_for_release_and_development(monkeypatch,tmp_path):
+ monkeypatch.delenv('DECOMP_DIRECTORIES_FILE',raising=False)
+ monkeypatch.setattr(dirs.toolchains,'data_dir',lambda:tmp_path)
+ monkeypatch.setattr(edition,'DEV',True);development=dirs.registry_path()
+ monkeypatch.setattr(edition,'DEV',False)
+ assert dirs.registry_path()!=development
+ assert 'RetroReversing' in str(development)
+
+
+@pytest.mark.parametrize('bad',['relative','/missing/directory',''])
+def test_unavailable_directories_are_not_created_or_remembered(locations,bad):
+ with pytest.raises(NetworkError):dirs.validate(bad)
+ assert not dirs.registry_path().exists()
+
+
+def test_internal_or_corrupt_database_is_rejected(locations):
+ current,target=locations
+ with pytest.raises(NetworkError,match='internal'):dirs.validate(str(current/'.decomp'))
+ (target/'.decomp').mkdir();database=target/'.decomp/decomp.db'
+ database.write_bytes(b'not a database')
+ with pytest.raises(NetworkError,match='could not be read'):dirs.validate(str(target))
+ assert database.read_bytes()==b'not a database'
+
+
+def controller(current):
+ return dirs.Controller(SimpleNamespace(home=current/'.decomp',port=1234,secret='old-secret',headless=False,
+ jobs=SimpleNamespace(source_update_pending=False),updater=SimpleNamespace(job={'state':'idle'},before_restart=lambda:None)))
+
+
+def test_remember_does_not_stop_work_or_move_files(locations):
+ current,target=locations
+ (current/'project').write_text('saved work')
+ runtime=controller(current)
+ info=runtime.choose(str(target))
+ assert info['current']==str(current) and info['job']['state']=='idle'
+ assert (current/'project').read_text()=='saved work' and not (target/'project').exists()
+ assert not runtime.app.jobs.source_update_pending
+
+
+def test_handoff_checks_target_lock_before_shutdown_and_preserves_preference(locations):
+ current,target=locations
+ runtime=controller(current);stops=[]
+ runtime.app.updater.before_restart=lambda:stops.append(True)
+ (target/'.decomp').mkdir()
+ with WriterGate(target/'.decomp/server-instance').hold():runtime.run(target)
+ assert runtime.job['state']=='error' and 'already open' in runtime.job['message']
+ assert not stops and dirs.preferred() is None
+
+
+def test_handoff_preserves_files_rotates_identity_and_removes_only_own_marker(locations,monkeypatch):
+ current,target=locations
+ runtime=controller(current);calls=[]
+ state=current/'.decomp/server.json';state.write_text(json.dumps({'secret':'old-secret'}))
+ (current/'saved.c').write_text('work')
+ monkeypatch.setattr(dirs.window,'is_open',lambda:True)
+ monkeypatch.setattr(dirs.window,'close_app',lambda:calls.append('close'))
+ runtime.app.updater.before_restart=lambda:calls.append('save-stop')
+ monkeypatch.setattr(dirs.updates,'restart',lambda port,secret,opened,**kwargs:calls.append((port,secret,opened,kwargs)))
+ runtime.run(target)
+ assert calls[:2]==['save-stop','close']
+ assert calls[2][0]==1234 and calls[2][1]!='old-secret' and calls[2][2]
+ assert calls[2][3]=={'home':target}
+ assert not state.exists() and (current/'saved.c').read_text()=='work'
+ assert dirs.preferred() is None # The new runtime selects it only after successful startup.
+
+
+def test_restart_sets_target_without_mutating_current_environment(locations,monkeypatch):
+ current,target=locations
+ monkeypatch.setenv('DECOMP_HOME',str(current))
+ calls=[]
+ monkeypatch.setattr(updates.os,'execve',lambda *args:calls.append(args))
+ updates.restart(1234,'new-secret',True,home=target)
+ environment=calls[0][2]
+ assert environment['DECOMP_HOME']==str(target)
+ assert json.loads(environment['DECOMP_RESTART'])['switch_home']
+ assert dirs.os.environ['DECOMP_HOME']==str(current)
+
+
+def test_queued_switch_deduplicates_and_reserves_update_admission(locations,monkeypatch):
+ import threading
+ current,target=locations
+ runtime=controller(current)
+ runtime.app.updater._lock=threading.Lock()
+ starts=[]
+ class Thread:
+ def __init__(self,**kwargs):self.target=kwargs
+ def start(self):starts.append(self.target)
+ monkeypatch.setattr(dirs.threading,'Thread',Thread)
+ first=runtime.choose(str(target),True)
+ assert first['job']['state']=='queued' and runtime.app.jobs.source_update_pending
+ assert runtime.app.updater.job['state']=='switching-directory'
+ runtime.choose(str(target),True)
+ assert len(starts)==1
+ with pytest.raises(NetworkError,match='already in progress'):runtime.choose(str(current),True)
+
+
+def test_missing_saved_drive_is_not_created_on_launch(locations,monkeypatch):
+ from decompnet.app import cli
+ _,target=locations
+ dirs.remember(target,selected=True)
+ target.rmdir()
+ monkeypatch.delenv('DECOMP_HOME',raising=False)
+ monkeypatch.setattr(cli,'use_own_wine_prefix',lambda:None)
+ messages=[]
+ monkeypatch.setattr(cli.window,'tell_desktop',lambda *args:messages.append(args))
+ assert cli.run(SimpleNamespace())==1
+ assert messages and not target.exists()
From 63426f7011565910c7a8745913b6c8a068095589 Mon Sep 17 00:00:00 2001
From: RetroGameDeveloper
<40120498+RetroGameDeveloper@users.noreply.github.com>
Date: Sun, 8 Nov 2026 17:26:13 +0000
Subject: [PATCH 2/2] Cover directory switch reconnect and error states
---
tests/gui_data_directories.js | 19 ++++++++++++-------
1 file changed, 12 insertions(+), 7 deletions(-)
diff --git a/tests/gui_data_directories.js b/tests/gui_data_directories.js
index 6cd04e236..07a67c173 100644
--- a/tests/gui_data_directories.js
+++ b/tests/gui_data_directories.js
@@ -1,11 +1,11 @@
'use strict';
const fs=require('node:fs'),vm=require('node:vm'),assert=require('node:assert/strict');
-async function run({switchable=true,failure=false}={}){
+async function run({switchable=true,failure=false,switching=false,followFailure=false}={}){
const elements={},$=id=>elements[id]??={value:'',disabled:false,hidden:true,innerHTML:'',textContent:''};
const requests=[];
const info={current:'/current',directories:[{path:'/current',available:true},{path:'/other',available:true}],job:{state:'idle'},switchable};
- let release;
- const ctx={$,esc:value=>String(value).replaceAll('&','&').replaceAll('"','"').replaceAll('<','<'),cmdBox:value=>`${value}`,wireCopies(){},
+ let release,started=false,reloaded=0;
+ const ctx={$,esc:value=>String(value).replaceAll('&','&').replaceAll('"','"').replaceAll('<','<'),cmdBox:value=>`${value}`,wireCopies(){},sleep:async()=>{},location:{hash:'',reload(){reloaded++;}},dialog(){return {querySelector:()=>({textContent:''})};},
beginWork(log,label,controls){controls.forEach(c=>c.disabled=true);return()=>controls.forEach(c=>c.disabled=false);},showJobError(log,error){log.textContent=String(error);},
async api(url,options){
requests.push({url,options});
@@ -13,8 +13,10 @@ async function run({switchable=true,failure=false}={}){
if(options?.method==='POST'){
await new Promise(resolve=>release=resolve);
if(failure)throw Error('Directory unavailable');
- return info;
+ started=switching;
+ return switching ? {...info,job:{state:'queued',target:'/picked directory'}} : info;
}
+ if(started)return followFailure ? {...info,job:{state:'error',message:'Target already open'}} : {...info,current:'/picked directory'};
return info;
}};
vm.createContext(ctx);vm.runInContext(fs.readFileSync('src/decompnet/app/static/js/data-directories.js','utf8'),ctx);
@@ -22,12 +24,15 @@ async function run({switchable=true,failure=false}={}){
if(!switchable)assert.match($('dataDirectories').innerHTML,/id="dataDirectorySwitch" disabled/);
$('dataDirectoryKnown').value='/other';$('dataDirectoryKnown').onchange();assert.equal($('dataDirectoryPath').value,'/other');
await $('dataDirectoryPick').onclick();assert.equal($('dataDirectoryPath').value,'/picked directory');
- const pending=$('dataDirectoryRemember').onclick();
+ const button=$(switching ? 'dataDirectorySwitch' : 'dataDirectoryRemember');
+ const pending=button.onclick();
assert.equal($('dataDirectoryRemember').disabled,true);
- await $('dataDirectoryRemember').onclick();assert.equal(requests.filter(r=>r.options?.method==='POST'&&r.url==='/api/data-directories').length,1);
+ await button.onclick();assert.equal(requests.filter(r=>r.options?.method==='POST'&&r.url==='/api/data-directories').length,1);
assert.equal(requests.at(-1).options.body.path,'/picked directory');
release();await pending;
+ if(switching && !followFailure)assert.equal(reloaded,1);
+ if(followFailure)assert.match($('dataDirectoryLog').textContent,/Target already open/);
if(failure)assert.match($('dataDirectoryLog').textContent,/unavailable/);
else assert.equal(requests.at(-1).options,undefined,'remember refreshes history without switching runtime');
}
-(async()=>{await run();await run({failure:true});await run({switchable:false});})().catch(error=>{console.error(error);process.exit(1);});
+(async()=>{await run();await run({failure:true});await run({switchable:false});await run({switching:true});await run({switching:true,followFailure:true});})().catch(error=>{console.error(error);process.exit(1);});