Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/decompnet/app/repository_setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def status(net, slug):
if head and net.is_rom(proj):
manifest = (path.relative_to(root)/saves.MANIFEST).as_posix()
checkpoint = manifest in git(root, 'ls-tree', '-r', '--name-only', 'HEAD', '--', manifest).splitlines()
return {'folder': str(path), 'save_folder':str(saves.save_folder(net, slug).expanduser().resolve()),
return {'slug':slug, 'folder': str(path), 'save_folder':str(saves.save_folder(net, slug).expanduser().resolve()),
'root': str(root) if root else '', 'repository': bool(root),
'github_create': True, 'origin': origin, 'checkpoint': checkpoint, 'portable': net.is_rom(proj),
'linked': path == saves.default_folder(net, slug).resolve(),
Expand Down
2 changes: 2 additions & 0 deletions src/decompnet/app/repository_sync.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,8 @@ def checkout(folder, *, clean=True, blocking=None):
root = Path(folder).expanduser().resolve()
if not root.is_dir() or Path(git(root,'rev-parse','--show-toplevel').decode().strip()).resolve() != root:
raise NetworkError('Choose the root folder of a local Git checkout.')
if not clean:
return root # Metadata-only callers do not need a potentially huge worktree/untracked scan.
raw = git(root, 'status', '--porcelain=v1', '-z', '--untracked-files=all')
if raw and clean:
changes = checkout_changes(raw, only=blocking)
Expand Down
2 changes: 1 addition & 1 deletion src/decompnet/app/routes/repository_sync.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ async def setup(request):
slug = str(request.query_params.get('slug', ''))
with app.jobs._lock:
if job := active_setup(slug):return JSONResponse({'job':job})
return JSONResponse(await app.call(repository_setup.status, app.net, slug))
return JSONResponse(await (app.fast_call or app.ui_call or app.call)(repository_setup.status, app.net, slug))
data = await app.body(request)
slug = str(data.get('slug', ''))
with app.jobs._lock:
Expand Down
2 changes: 2 additions & 0 deletions src/decompnet/app/static/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -692,6 +692,8 @@ <h3 id="repositorySyncTitle">Version history and sharing</h3>
<p id="repositorySyncAbout">Commit your saved progress, or copy matching C into a rebuildable export checkout.</p>
</header>
<p class="small muted" id="repositorySetupState" role="status"></p>
<progress class="workbar" id="repositorySetupLoading" aria-label="Checking this project’s save repository" hidden></progress>
<button class="ghost small-btn" id="repositorySetupRetry" type="button" hidden>Check save repository again</button>
<div class="row"><button class="ghost small-btn" id="repositoryInit" type="button" hidden>Create Git repository</button><button class="ghost small-btn" id="repositoryCheckpoint" type="button" hidden>Commit saved progress</button></div>
<div id="repositoryOriginGroup" hidden><label class="field"><span>Origin repository URL</span><input id="repositoryOrigin" placeholder="https://github.com/you/project.git" autocomplete="off" spellcheck="false"></label><button class="ghost small-btn" id="repositoryOriginGo" type="button">Add origin</button><p class="small muted">Origin is where Push sends your commits. Adding it does not fetch or push.</p>
<details id="repositoryGithubDetails"><summary>Create a new GitHub repository</summary>
Expand Down
49 changes: 44 additions & 5 deletions src/decompnet/app/static/js/repository-setup.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/* The save is the primary destination; an export checkout remains an explicit advanced tool. */
let repositorySetupSlug = "", repositorySaveRoot = "", repositorySetupBusy = false, repositorySetupChecked = 0, repositorySetupRequest = 0, repositorySetupJob = null;
let repositorySaveEdited = false, repositorySetupState = null;
let repositorySaveEdited = false, repositorySetupState = null, repositorySetupLoading = false;
let repositorySetupAbort = null;
function repositorySavedFolder(state) {
return state.save_folder ?? (state.portable ? state.folder : S.ov?.save_folder) ?? "";
}
Expand All @@ -17,6 +18,7 @@ $("saveFolder").oninput = () => {
if (repositorySetupState) renderRepositorySetup(repositorySetupState);
};
function renderRepositorySetup(state) {
if (state.slug && state.slug !== S.slug) return;
repositorySetupState = state;
if (!repositorySaveEdited) $("saveFolder").value = repositorySavedFolder(state);
const unsaved = state.portable && $("saveFolder").value.trim() !== state.folder;
Expand Down Expand Up @@ -46,8 +48,13 @@ function renderRepositorySetup(state) {
async function refreshRepositorySetup() {
const slug = S.slug;
if (!slug) return;
if (repositorySetupSlug === slug && repositorySetupLoading) return;
if (repositorySetupSlug === slug && Date.now() - repositorySetupChecked < 10000) return;
if (repositorySetupSlug !== slug) {
repositorySetupAbort?.abort();
repositorySetupLoading = false;
$("repositorySetupLoading").hidden = true;
$("repositorySetupRetry").hidden = true;
repositorySetupSlug = slug; repositorySaveRoot = "";
repositorySaveEdited = false; repositorySetupState = null; ++repositorySetupRequest;
if ($("repositorySetupLog")._workStatus) $("repositorySetupLog")._workStatus.hidden = true;
Expand All @@ -63,20 +70,52 @@ async function refreshRepositorySetup() {
$("saveFolder").value = S.ov?.save_folder || "";
$("repositoryInit").hidden = true; $("repositoryCheckpoint").hidden = true;
$("repositoryOriginGroup").hidden = true;
$("repositoryAutoCommit").disabled = true;
for (const id of ["repositoryAutoCommit", "repositoryScoreCommits", "repositoryAutoPush"]) $(id).disabled = true;
$("repositorySetupState").textContent = "Checking this project’s save repository…";
$("repositoryFolder").value = "";
$("repositoryBuildPath").textContent = "";
$("repositoryDestination").hidden = true;
}
if (repositorySetupBusy) return;
repositorySetupChecked = Date.now();
const request = ++repositorySetupRequest;
repositorySetupLoading = true;
$("repositorySetupLoading").hidden = false;
$("repositorySetupRetry").hidden = true;
const controller = typeof AbortController !== "undefined" ? new AbortController() : null;
repositorySetupAbort = controller;
let timeout;
try {
const state = await api(`/api/repository-setup?slug=${encodeURIComponent(slug)}`);
const expired = new Promise((_, reject) => {
timeout = setTimeout(() => {
controller?.abort();
reject(new Error("Checking the save repository took too long. Check again to enable automatic commits."));
}, 15000);
timeout?.unref?.();
});
const state = await Promise.race([api(`/api/repository-setup?slug=${encodeURIComponent(slug)}`, controller ? {signal:controller.signal} : undefined), expired]);
if (S.slug !== slug || request !== repositorySetupRequest) return;
if (state.job) { setupRepository(null, state.job); return; }
if (state.job) {
repositorySetupLoading = false; $("repositorySetupLoading").hidden = true;
setupRepository(null, state.job); return;
}
renderRepositorySetup(state);
} catch (error) {
if (S.slug === slug && request === repositorySetupRequest) $("repositorySetupState").textContent = error.message;
if (S.slug === slug && request === repositorySetupRequest) {
$("repositorySetupState").textContent = error.message;
$("repositorySetupRetry").hidden = false;
repositorySetupChecked = 0;
}
} finally {
clearTimeout(timeout);
if (S.slug === slug && request === repositorySetupRequest) {
repositorySetupLoading = false;
repositorySetupAbort = null;
$("repositorySetupLoading").hidden = true;
}
}
}
$("repositorySetupRetry").onclick = () => { repositorySetupChecked = 0; return refreshRepositorySetup(); };
async function setupRepository(action, existingJob = null) {
if (repositorySetupBusy) return;
const slug = S.slug, log = $("repositorySetupLog");
Expand Down
46 changes: 41 additions & 5 deletions tests/gui_repository_setup.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const ctx={$,S:{slug:'game',ov:{save_folder:'/save'}},Date,encodeURIComponent,re
api(url,options){if(options){posted=options.body;return Promise.resolve({job:'setup'});}return new Promise(r=>resolve=r);},
beginWork(log,label,fields){fields.forEach(f=>f.disabled=true);return()=>{finish++;fields.forEach(f=>f.disabled=false);};},
showJobError(log,message){log.textContent=message;},followJob(id,log,onUpdate){assert.equal(log,null);update=onUpdate;return Promise.resolve({folder:'/save',root:'/save',repository:true,portable:true,checkpoint:false,linked:true,origin:false});}};
vm.createContext(ctx);vm.runInContext(source,ctx);
Object.assign(ctx,{setTimeout,clearTimeout});vm.createContext(ctx);vm.runInContext(source,ctx);
(async()=>{
const load=ctx.refreshRepositorySetup();
resolve({folder:'/save',root:'',repository:false,portable:true,checkpoint:false,linked:true,origin:false});await load;
Expand All @@ -25,6 +25,7 @@ vm.createContext(ctx);vm.runInContext(source,ctx);
ctx.renderRepositorySetup({folder:'/source',root:'/source',repository:true,portable:false,checkpoint:true,linked:false,origin:false});assert.equal($('repositoryOriginGo').disabled,false);
update(['Old project secret'],{});assert.doesNotMatch($('repositorySetupLog').textContent,/Old project/);
await loadingRegression();
await stalePathAndTimeoutRegression();
await simpleSetupRegression();
})().catch(e=>{console.error(e);process.exit(1);});

Expand All @@ -33,7 +34,7 @@ async function loadingRegression() {
const pending=[];
const context={$:field,S:{slug:'first',ov:{overview_pending:true}},Date,encodeURIComponent,
refreshRepositoryPush(){},api(){return new Promise(resolve=>pending.push(resolve));}};
vm.createContext(context);vm.runInContext(source,context);
Object.assign(context,{setTimeout,clearTimeout});vm.createContext(context);vm.runInContext(source,context);
const state=(folder,extra={})=>({folder,save_folder:folder,root:folder,repository:true,portable:true,checkpoint:true,linked:true,origin:true,...extra});
// The quick overview used to leave the field blank forever, even after Git status found its path.
const first=context.refreshRepositorySetup();pending.shift()(state('/remembered/first'));await first;
Expand Down Expand Up @@ -103,7 +104,7 @@ async function simpleSetupRegression() {
const context={$:get,S:{slug:'game',ov:{}},Date,encodeURIComponent,refreshRepositoryPush(){},updateWorkProgress(){},
api:async(url,options)=>{actions.push(options.body.action);return{job:'setup'};},
followJob:async()=>{if(failure)throw Error('Review staged changes');if(projectSwitch)context.S.slug='other';return{...state,linked:true};}};
vm.createContext(context);vm.runInContext(source,context);
Object.assign(context,{setTimeout,clearTimeout});vm.createContext(context);vm.runInContext(source,context);
context.renderRepositorySetup(state);
assert.equal(get('repositoryAutoCommit').disabled,false,'a saved folder can prepare its first checkpoint when enabled');
assert.equal(get('repositoryDestination').hidden,false);assert.equal(get('repositoryFolder').value,'/repo');
Expand Down Expand Up @@ -147,7 +148,7 @@ async function simpleSetupRegression() {
beginWork(){return()=>{};},
api(url,options){if(options)posts++;return Promise.resolve({job:'existing'});},
followJob(job){assert.equal(job,'existing');follows++;return new Promise(resolve=>complete=resolve);}};
vm.createContext(context);vm.runInContext(source,context);
Object.assign(context,{setTimeout,clearTimeout});vm.createContext(context);vm.runInContext(source,context);
await context.refreshRepositorySetup();
assert.equal(posts,0);assert.equal(follows,1);assert.equal(field('repositorySetupStop').hidden,false);
await field('repositoryGithubGo').onclick();assert.equal(posts,0);
Expand All @@ -162,7 +163,7 @@ async function simpleSetupRegression() {
const context={$:field,S:{slug:'game'},Date,encodeURIComponent,document:{createElement(){return{};}},
refreshRepositoryPush(){},showJobError(log,message){log.textContent=message;},
beginWork(){return()=>{};},api(url,options){if(options)posts++;return Promise.resolve({owners:['person','Studio'],warning:''});}};
vm.createContext(context);vm.runInContext(source,context);
Object.assign(context,{setTimeout,clearTimeout});vm.createContext(context);vm.runInContext(source,context);
context.renderRepositorySetup({folder:'/save',root:'/save',repository:true,portable:true,origin:false});
await field('repositoryGithubGo').onclick();
assert.match(field('repositorySetupLog').textContent,/Close and reopen/);assert.equal(posts,0);
Expand All @@ -173,3 +174,38 @@ async function simpleSetupRegression() {
assert.deepEqual(field('repositoryGithubOwners').items.map(item=>item.value),['person','Studio']);
assert.equal(field('repositoryGithubOwner').value,''); // Choosing an owner is deliberate.
})().catch(e=>{console.error(e);process.exit(1);});


async function stalePathAndTimeoutRegression() {
const fields={}, get=id=>fields[id]??={value:'',textContent:'',hidden:true,disabled:false,replaceChildren(){}};
const requests=[];let timeout;
const context={$:get,S:{slug:'old',ov:{save_folder:'/old/progress'}},Date,encodeURIComponent,
setTimeout(fn){timeout=fn;return 1;},clearTimeout(){},refreshRepositoryPush(){},
api(){return new Promise(resolve=>requests.push(resolve));}};
vm.createContext(context);vm.runInContext(source,context);
const state=(slug)=>({slug,folder:`/${slug}/progress`,save_folder:`/${slug}/progress`,root:`/${slug}`,
repository:true,portable:true,checkpoint:true,linked:true,origin:true});
const old=context.refreshRepositorySetup();requests.shift()(state('old'));await old;
assert.equal(get('repositorySetupState').textContent,'Git repository: /old');
context.S.slug='v-rally';context.S.ov={save_folder:'/v-rally/progress'};
const loading=context.refreshRepositorySetup();const late=requests.shift();
assert.match(get('repositorySetupState').textContent,/Checking this project/);
assert.doesNotMatch(get('repositorySetupState').textContent,/\/old/);
assert.equal(vm.runInContext('repositorySaveRoot',context),'');
assert.equal(get('repositoryFolder').value,'');
assert.equal(get('repositorySetupLoading').hidden,false);
for(const id of ['repositoryAutoCommit','repositoryScoreCommits','repositoryAutoPush']) assert.equal(get(id).disabled,true);
// Repeated dashboard renders must not duplicate an outstanding status read.
await context.refreshRepositorySetup();assert.equal(requests.length,0);
timeout();await loading;
assert.match(get('repositorySetupState').textContent,/took too long/);
assert.equal(get('repositorySetupRetry').hidden,false);
assert.equal(get('repositorySetupLoading').hidden,true);
const retry=get('repositorySetupRetry').onclick();requests.shift()(state('v-rally'));await retry;
assert.equal(get('repositoryAutoCommit').disabled,false);
assert.equal(get('repositorySetupState').textContent,'Git repository: /v-rally');
assert.equal(get('repositorySetupRetry').hidden,true);
late(state('old'));await Promise.resolve();
context.renderRepositorySetup(state('old'));
assert.equal(get('repositorySetupState').textContent,'Git repository: /v-rally');
}
11 changes: 11 additions & 0 deletions tests/test_repository_sync.py
Original file line number Diff line number Diff line change
Expand Up @@ -423,3 +423,14 @@ def test_blocking_path_preview_filters_generated_changes_and_keeps_rename_source
raw = b' M README.md\0R new name.c\0old name.c\0?? private.rom\0'
assert sync.checkout_changes(raw, only={'private.rom'}) == [' untracked: "private.rom"']
assert sync.checkout_changes(raw, only={'old name.c'}) == [' renamed (staged): "old name.c" -> "new name.c"']


def test_metadata_checkout_does_not_scan_worktree(tmp_path,monkeypatch):
calls=[]
def metadata(root,*args):
calls.append(args)
assert args==('rev-parse','--show-toplevel'), 'Metadata lookup scanned worktree changes'
return str(tmp_path).encode()
monkeypatch.setattr(sync,'git',metadata)
assert sync.checkout(tmp_path,clean=False)==tmp_path.resolve()
assert calls==[('rev-parse','--show-toplevel')]
Loading