about
', 'style.css': 'body{color:blue}' }, 'Add about page'); before = t.mutations(); await t.sync(); check('take in: the new file and the changed file land in the project', t.disk('about.html') === 'about
' && t.disk('style.css') === 'body{color:blue}'); check('take in: Builder writes nothing to GitHub', t.mutations() === before && t.head().sha === dev1); let idx = await t.index(); let cur = idx.versions.find((v) => v.id === idx.current); check('take in: a new version labelled in Builder\'s own words', cur.label === 'From GitHub (' + dev1.slice(0, 7) + ')', cur.label); const pullNote = t.imported[t.imported.length - 1]; check('take in: the AI is told which files changed, with the commit as data', pullNote.files.some((f) => f.path === APPDIR + '/about.html' && f.kind === 'added') && pullNote.files.some((f) => f.path === APPDIR + '/style.css' && f.kind === 'changed' && f.before === 'body{color:red}' && f.after === 'body{color:blue}') && pullNote.commits[0].subject === 'Add about page'); check('take in: the note is kept in the record for other devices', t.link().aiNotes.some((n) => n.id === pullNote.id)); check('take in: the base moves to GitHub\'s head', t.link().base.commit === dev1); check('take in: Puter\'s own folder in the project is untouched', !!t.disk('.puter/screenshots/index.png') && !!t.disk('manifest.json')); check('take in: a visible chat line in Builder\'s words', t.context.chatHistory.some((m) => m.versionNote && /Brought in changes from GitHub \(2 files\)/.test(m.content))); // --- both changed, different files: combined, linear history --- const dev2 = gh.push(gh.login, 'my-site', 'main', { 'README.md': '# My site' }, 'Docs'); await t.write('app.js', 'console.log(1)'); await t.version('Add app.js'); t.clock(61000); await t.sync(); files = t.files(); check('combine: GitHub gets Builder\'s file and keeps the developer\'s', files['app.js'] === 'console.log(1)' && files['README.md'] === '# My site'); check('combine: the project gets the developer\'s file', t.disk('README.md') === '# My site' && t.disk('app.js') === 'console.log(1)'); // The project's newest version is the one that brought the developer's // file in, but the commit carries Builder's change, so it is named after // Builder's version, never "From GitHub". check('combine: the commit is named after Builder\'s version', t.head().message === 'Add app.js', t.head().message); check('combine: Builder\'s commit sits on top of the developer\'s (no merge commit)', t.head().parents.length === 1 && t.head().parents[0] === dev2); check('combine: no card for changes to different files', t.state().kind === 'up-to-date' && t.link().conflicts.length === 0); // --- both changed the same file: the project keeps its copy, with a card --- const dev3 = gh.push(gh.login, 'my-site', 'main', { 'style.css': 'body{color:green}' }, 'Dev green'); await t.write('style.css', 'body{color:purple}'); await t.version('Purple'); t.clock(61000); await t.sync(); check('collision: the project keeps its copy', t.disk('style.css') === 'body{color:purple}' && t.files()['style.css'] === 'body{color:purple}'); check('collision: GitHub\'s copy stays in history, in the parent commit', t.head().parents[0] === dev3); check('collision: the commit says where GitHub\'s copy is', /GitHub also changed style\.css in [0-9a-f]{7}/.test(t.head().message), t.head().message); check('collision: a card is recorded and shown', t.link().conflicts.length === 1 && t.link().conflicts[0].path === 'style.css' && t.state().kind === 'collision'); await t.sync(); check('collision: the card survives the next sync (only an answer clears it)', t.link().conflicts.length === 1); await S.resolveConflict(CHAT, 'style.css', 'github'); await settle(); check('collision: "Use GitHub\'s copy" brings it back into the project and onto the branch', t.disk('style.css') === 'body{color:green}' && t.files()['style.css'] === 'body{color:green}' && t.link().conflicts.length === 0); // --- a race: someone pushes between Builder's read and its branch move --- await t.write('a.txt', 'one'); await t.version('Add a'); gh.hooks.beforeCommit = () => gh.push(gh.login, 'my-site', 'main', { 'b.txt': 'dev' }, 'Race'); t.clock(61000); await t.sync(); files = t.files(); check('race: the losing move changes nothing, and the next try combines both', files['a.txt'] === 'one' && files['b.txt'] === 'dev' && t.disk('b.txt') === 'dev'); // --- a rewritten history asks first and writes nothing --- const older = dev1; const diskBefore = JSON.stringify([...t.pfs.files.entries()].filter(([k]) => k.startsWith(APPDIR + '/')).map(([k, v]) => [k, dec(v)])); gh.forceBranch(gh.login, 'my-site', 'main', older); before = t.mutations(); t.clock(61000); await t.sync(); check('rewind: Builder stops and asks', t.state().kind === 'history' && t.link().pause && t.link().pause.reason === 'history'); check('rewind: nothing is written, here or on GitHub', t.mutations() === before && JSON.stringify([...t.pfs.files.entries()].filter(([k]) => k.startsWith(APPDIR + '/')).map(([k, v]) => [k, dec(v)])) === diskBefore); check('rewind: the branch is left where the user put it', t.head().sha === older); await t.sync(); check('rewind: later checks keep waiting for the choice', t.state().kind === 'history' && t.head().sha === older); await S.resolveHistory(CHAT, 'github'); await settle(); check("rewind: \"Use GitHub's version\" makes the project match GitHub exactly", t.disk('style.css') === 'body{color:blue}' && t.disk('app.js') === null && t.disk('README.md') === null && t.disk('a.txt') === null, JSON.stringify({ style: t.disk('style.css'), app: t.disk('app.js'), readme: t.disk('README.md'), a: t.disk('a.txt'), b: t.disk('b.txt') })); check('rewind: the removed commits stay removed', t.head().sha === older && t.state().kind === 'up-to-date', JSON.stringify(t.state())); idx = await t.index(); check('rewind: the work from before is still in Version history', idx.versions.some((v) => v.label === 'Add a')); // --- a key in a file never holds the save, and the AI asks in the chat --- // Builder used to hold the version and offer buttons. Now the version // goes as it is, and the AI hears about the file with the user's next // message, once. await t.write('config.js', `const stripe = "${FAKE_STRIPE}";`); await t.version('Config'); let notesBefore = t.imported.length; t.clock(61000); await t.sync(); check('key: the version goes to GitHub as it is', t.state().kind === 'up-to-date' && t.files()['config.js'] === `const stripe = "${FAKE_STRIPE}";`, JSON.stringify(t.state())); const keyNote = t.imported.slice(notesBefore).find((n) => n.keys && n.keys.length); check('key: the AI is told which file, on any device', !!keyNote && keyNote.keys.join() === APPDIR + '/config.js' && keyNote.publicRepo === false && t.link().aiNotes.some((n) => n.id === keyNote.id) && JSON.stringify(t.link().toldKeys) === '["config.js"]', JSON.stringify(keyNote)); check('key: the note never carries the key', !JSON.stringify(t.link()).includes(FAKE_STRIPE)); await t.write('config.js', `const stripe = "${FAKE_STRIPE}";\nconst more = 1;`); await t.version('Config again'); notesBefore = t.imported.length; t.clock(61000); await t.sync(); check('key: told once, not with every version of the file', t.state().kind === 'up-to-date' && !t.imported.slice(notesBefore).some((n) => n.keys && n.keys.length)); await t.write('config.js', "const stripe = await (await fetch('/api/key')).text();"); await t.version('Key moved'); t.clock(61000); await t.sync(); check('key: once the file goes out without it, it is forgotten', JSON.stringify(t.link().toldKeys) === '[]'); // --- busy: never written while the AI works --- gh.push(gh.login, 'my-site', 'main', { 'busy.txt': 'x' }, 'While busy'); t.context.isProcessing = true; await t.sync(); check('busy: GitHub\'s change waits while the AI works', t.disk('busy.txt') === null && t.state().kind === 'waiting' && t.state().reason === 'ai'); t.context.isProcessing = false; await t.sync(); check('busy: it comes in once the AI is done', t.disk('busy.txt') === 'x'); // --- a key from the repository comes in, and the AI warns the user --- // Builder used to leave such a file on GitHub. Holding it back isn't // Builder's call, warning about it in the chat is. notesBefore = t.imported.length; gh.push(gh.login, 'my-site', 'main', { 'server/db.js': `const aws = "${FAKE_AWS}";`, 'ok.txt': 'fine' }, 'Add db'); await t.sync(); check('pulled key: the file comes in like any file', t.disk('server/db.js') === `const aws = "${FAKE_AWS}";` && t.disk('ok.txt') === 'fine'); const pulledNote = t.imported.slice(notesBefore).find((n) => n.keys && n.keys.length); check('pulled key: the AI is told which file, with the pull\'s own note', !!pulledNote && pulledNote.keys.join() === APPDIR + '/server/db.js' && pulledNote.files.some((f) => f.path === APPDIR + '/server/db.js') && t.link().toldKeys.includes('server/db.js') && t.link().aiNotes.some((n) => n.id === pulledNote.id && n.keys.length === 1), JSON.stringify(pulledNote && pulledNote.keys)); check('pulled key: nothing is kept out for it', !t.link().keptOut.some((k) => k.path === 'server/db.js')); await t.write('more.txt', 'more'); await t.version('More'); notesBefore = t.imported.length; t.clock(61000); await t.sync(); check('pulled key: a later send keeps it on GitHub, and the AI isn\'t told again', 'server/db.js' in t.files() && t.files()['more.txt'] === 'more' && !t.imported.slice(notesBefore).some((n) => n.keys && n.keys.length)); // --- Builder's install tags, added after a pull, go with the next change --- // The Code view shows them, so GitHub gets them too. gh.push(gh.login, 'my-site', 'main', { 'index.html': PAGE.replace('hi', 'hello') }, 'Edit page'); await t.sync(); const pulledPage = t.disk('index.html'); const restamped = W.stampManifestTags(pulledPage, W.deriveManifestMeta(pulledPage, 'Shop'), ''); await t.pfs.write(APPDIR + '/index.html', restamped); // the preview refresh, which marks nothing dirty await t.write('note.txt', 'n'); await t.version('Note'); const headBefore = t.head().sha; t.clock(61000); await t.sync(); check('restamp: the next send carries the tags with the real change', t.head().parents[0] === headBefore && t.files()['index.html'] === restamped && t.files()['note.txt'] === 'n'); // --- another device's saved edit that is in no version yet --- // It is already in the shared project folder. A pull must not write over // it: Builder saves it as a version first, then combines. await t.pfs.write(APPDIR + '/local.txt', 'from my laptop'); // no dirty mark: another device wrote it gh.push(gh.login, 'my-site', 'main', { 'remote.txt': 'from github' }, 'Remote file'); t.clock(61000); await t.sync(); idx = await t.index(); check('foreign edit: it is saved as a version before anything is written', idx.versions.some((v) => v.label === 'Saved before update from GitHub')); check('foreign edit: it survives, and GitHub\'s change comes in', t.disk('local.txt') === 'from my laptop' && t.disk('remote.txt') === 'from github'); check('foreign edit: it then goes to GitHub like any change', t.files()['local.txt'] === 'from my laptop' && t.files()['remote.txt'] === 'from github'); // --- the turn rule: a pull from another device lands while a turn runs --- // The turn started before the pull (its version carries the older // pullSeq) and rewrote the pulled file from its memory of the old one. const seqAtTurnStart = t.link().pullSeq; gh.push(gh.login, 'my-site', 'main', { 'ok.txt': 'fixed on github' }, 'Fix ok.txt'); await t.sync(); check('turn rule: the pull landed', t.disk('ok.txt') === 'fixed on github' && t.link().pullSeq === seqAtTurnStart + 1); await t.write('ok.txt', 'fine, edited by the AI from memory'); await t.version('AI turn', { pullSeq: seqAtTurnStart }); t.clock(61000); await t.sync(); check('turn rule: the AI\'s rewrite of the pulled file shows a card, not a silent revert', t.link().conflicts.some((c) => c.path === 'ok.txt' && c.kind === 'turn') && t.state().kind === 'collision', JSON.stringify(t.link().conflicts)); check('turn rule: the commit names the file and where GitHub\'s copy is', /GitHub also changed ok\.txt/.test(t.head().message), t.head().message); await S.resolveConflict(CHAT, 'ok.txt', 'keep'); await settle(); check('turn rule: "Keep this copy" closes the card', t.link().conflicts.length === 0); // --- a lapsed plan pauses both ways, with no requests --- W.user.subscribed = false; const requests = gh.log.length; await t.sync(); check('lapsed: no request reaches GitHub', gh.log.length === requests && t.state().kind === 'lapsed'); check('lapsed: the pause is remembered for the next sync', t.link().lastPause === 'lapsed'); W.user.subscribed = true; // --- delete forgets the link, never the repository --- await S.forgetProject(CHAT); check('delete: the link record is gone and the repository stays', t.link() === null && !!gh.repos.get(gh.login + '/my-site')); } // ===== Every file syncs, and an older record keeps what GitHub has ===== // GitHub gets the files the Code view shows, .github, __workers, .env and // Builder's install files included. A record whose base was agreed while // Builder still left some of those out reads that base under the old rules // once, so a file only GitHub had comes in instead of being deleted there. { const t = await setup(); const { S, gh } = t; await t.write('index.html', 'site
'); await t.version('Site'); await S.auth.signInWithToken(gh.token); await S.connect(CHAT, { mode: 'new', name: 'My Site', isPrivate: true }); await settle(); // A developer adds files Builder used to leave out, and the record says // Builder agreed to that commit under the old rules. gh.push(gh.login, 'my-site', 'main', { '.github/workflows/ci.yml': 'on: push', '__workers/api.worker.js': 'export default {}', '.env.example': 'A=1' }, 'Tooling'); const head = await S.api.getHead(t.link().repo, 'main'); const old = t.link(); old.base = { commit: head.commit, tree: head.tree, versionId: null, at: Date.now() }; delete old.rules; await t.pfs.write(`/${USER}/AppData/${APP}/.repos/${CHAT}.json`, JSON.stringify(old)); t.clock(61000); await t.sync(); let files = t.files(); check('older record: what Builder used to leave out comes in, and stays on GitHub', t.disk('.github/workflows/ci.yml') === 'on: push' && t.disk('__workers/api.worker.js') === 'export default {}' && t.disk('.env.example') === 'A=1' && files['.github/workflows/ci.yml'] === 'on: push' && files['__workers/api.worker.js'] === 'export default {}' && files['.env.example'] === 'A=1', JSON.stringify({ disk: [t.disk('.github/workflows/ci.yml'), t.disk('__workers/api.worker.js'), t.disk('.env.example')], github: Object.keys(files) })); check('older record: it is on the current rules after that', t.link().rules === 2, String(t.link().rules)); // From here they sync like any file, both ways. let notesBefore = t.imported.length; await t.write('__workers/api.worker.js', 'export default { fetch() {} }'); await t.write('.env', 'TOKEN=abc'); await t.version('Worker and env'); t.clock(61000); await t.sync(); files = t.files(); check('every file: __workers and .env go up like any file', files['__workers/api.worker.js'] === 'export default { fetch() {} }' && files['.env'] === 'TOKEN=abc'); const envNote = t.imported.slice(notesBefore).find((n) => n.keys && n.keys.length); check('every file: a key file by its name alone gets the AI\'s warning', !!envNote && envNote.keys.includes(APPDIR + '/.env') && !envNote.keys.includes(APPDIR + '/__workers/api.worker.js'), JSON.stringify(envNote && envNote.keys)); // The common older record has nothing for Builder to bring in. One pass // still moves it to the current rules, without a write anywhere. const again = t.link(); delete again.rules; await t.pfs.write(`/${USER}/AppData/${APP}/.repos/${CHAT}.json`, JSON.stringify(again)); const writesBefore = t.mutations(); const headBefore = t.head().sha; t.clock(61000); await t.sync(); check('older record: with nothing to bring in, it moves to the current rules and writes nothing', t.link().rules === 2 && t.mutations() === writesBefore && t.head().sha === headBefore && t.state().kind === 'up-to-date', JSON.stringify({ rules: t.link().rules, state: t.state() })); } // ===== A save is a few requests however many files, and checked ===== // Text files go inside the tree request instead of one blob request each // (GitHub asks for a second between content requests once there are many), // and the tree is read back before the branch moves. { // A failed save retries 30 s later. That timer is dropped here. const t = await setup({ setTimeout: (fn, ms) => (ms >= 20000 ? 0 : setTimeout(fn, ms)) }); const { S, gh } = t; for (let i = 0; i < 30; i++) await t.write(`pages/p${i}.html`, `${i}
`); await t.write('img/logo.png', new Uint8Array([137, 80, 78, 71, 1, 2, 3])); await t.version('Many files'); await S.auth.signInWithToken(gh.token); const posts = (re) => gh.log.filter((r) => r.method === 'POST' && re.test(r.path)).length; await S.connect(CHAT, { mode: 'new', name: 'My Site', isPrivate: true }); await settle(); let files = t.files(); check('few requests: 30 text files go in one tree request, and only the image is a blob of its own', posts(/\/git\/trees$/) === 1 && posts(/\/git\/blobs$/) === 1 && files['pages/p29.html'] === '29
' && 'img/logo.png' in files, JSON.stringify({ trees: posts(/\/git\/trees$/), blobs: posts(/\/git\/blobs$/) })); // More text than one request carries goes in a few, each on the last. const big = 'x'.repeat(300 * 1024); for (let i = 0; i < 5; i++) await t.write(`data/d${i}.txt`, big + i); await t.version('Big text'); const treesBefore = posts(/\/git\/trees$/); t.clock(61000); await t.sync(); files = t.files(); check('few requests: 1.5 MB of text goes in two tree requests', posts(/\/git\/trees$/) - treesBefore === 2 && files['data/d4.txt'] === big + '4' && files['data/d0.txt'] === big + '0', String(posts(/\/git\/trees$/) - treesBefore)); // GitHub writes inline text itself. A tree that doesn't match the // version never moves the branch. gh.hooks.corruptInline = true; await t.write('pages/p0.html', 'changed
'); await t.version('Change'); const headBefore = t.head().sha; t.clock(61000); await t.sync(); check('checked: a tree that differs from the version never moves the branch', t.head().sha === headBefore && t.state().kind === 'waiting', JSON.stringify(t.state())); t.clock(61000); await t.sync(); check('checked: the next try saves it', t.files()['pages/p0.html'] === 'changed
' && t.head().sha !== headBefore); } // ===== Signing in and out reaches every tab ===== // Each tab kept its own copy of the sign-in, so after Disconnect GitHub in // one tab another kept saving with its copy, and a sign-in elsewhere wasn't // seen. Every check and every panel opening reads the store again. { const t = await setup(); const { S, gh } = t; await t.write('index.html', 'a
'); await t.version('A'); await S.auth.signInWithToken(gh.token); await S.connect(CHAT, { mode: 'new', name: 'My Site', isPrivate: true }); await settle(); const saved = t.kv.get('github:auth'); // Another tab disconnects GitHub. t.kv.delete('github:auth'); await t.write('index.html', 'b
'); await t.version('B'); const writesBefore = t.mutations(); t.clock(61000); await t.sync(); check('another tab: after Disconnect GitHub there, this tab stops saving', t.state().kind === 'signed-out' && t.mutations() === writesBefore, JSON.stringify(t.state())); // It signs in again there. t.kv.set('github:auth', saved); check('another tab: a sign-in there shows here', (await S.signedInAs()) === gh.login); t.clock(61000); await t.sync(); check('another tab: saving picks up again', t.state().kind === 'up-to-date' && t.files()['index.html'] === 'b
', JSON.stringify(t.state())); // A store that can't be read keeps the last answer. const realGet = t.context.puter.kv.get; t.context.puter.kv.get = async () => { throw new Error('kv down'); }; await t.write('index.html', 'c
'); await t.version('C'); t.clock(61000); await t.sync(); t.context.puter.kv.get = realGet; check('a store blip: the last sign-in stands, and the save goes', t.state().kind === 'up-to-date' && t.files()['index.html'] === 'c
', JSON.stringify(t.state())); } // ===== Backend code with a key written in it goes to GitHub too ===== // Older projects wrote keys into their backend's code. That file used to be // left out without a word. Now it goes up like any code, and the AI asks the // user about the key in the chat. { const t = await setup({ workers: [{ name: 'pay', file_path: APPDIR + '/workers/pay.js' }] }); const { S, gh } = t; await t.write('index.html', PAGE); await t.write('workers/pay.js', `const KEY = "${FAKE_STRIPE}";\nrouter.post('/pay', async () => ({ ok: !!KEY }));`); await t.version('Shop'); await S.auth.signInWithToken(gh.token); await S.connect(CHAT, { mode: 'new', name: 'My Site', isPrivate: false }); await settle(); const files = t.files(); check('backend key: the backend goes up like any code, nothing held', t.state().kind === 'up-to-date' && !!files['workers/pay.js'] && files['index.html'] === PAGE, JSON.stringify(t.state())); const note = t.imported.find((n) => n.keys && n.keys.length); check('backend key: the AI is told to ask, and that the repository is public', !!note && note.keys.join() === APPDIR + '/workers/pay.js' && note.publicRepo === true, JSON.stringify(t.imported)); } // ===== The wiring ============================================================== { const src = read('../src/js/github-sync.js'); check('wiring: branches move only through the compare-and-swap', src.includes('updateRefs') && src.includes('beforeOid') && !/git\/refs/.test(src) && !/force:\s*true/.test(src)); check('wiring: pulls write files, never copy or move over them', !/puter\.fs\.(copy|move)\(/.test(read('../src/js/versions.js').slice(read('../src/js/versions.js').indexOf('window.applyExternalUpdate'), read('../src/js/versions.js').indexOf('// ----- panel UI')))); check('wiring: the plan is checked fresh at the start of every pass', /async function pass\(chatId, trigger\) \{\s*const user = window\.refreshUserPlan/.test(src)); check('wiring: the sign-in is stored with disableSharing', /puter\.kv\.set\(AUTH_KEY, value, \{ disableSharing: true \}\)/.test(src)); check('wiring: the engine needs the Code view flag', /!F\.githubSync \|\| !F\.codeEditor/.test(src)); // The panel: clicking Connect closed it and lost the pasted token. The // action redrew the panel at once, which emptied the token field and took // the clicked button out of the page, so the close-on-outside-click // handler read the click as outside. const ui = read('../src/js/github-ui.js'); const actBody = ui.slice(ui.indexOf('async function act(fn)'), ui.indexOf('async function loadRepos()')); check('panel: an action disables controls in place and never redraws before it runs', !/render\(\);\s*try \{/.test(actBody) && /prop\('disabled', true\)/.test(actBody)); check('panel: clicks inside the panel stop there', /const on = \(selector, handler\) => \$\(document\)\.on\('click', '\.preview-github-panel ' \+ selector, function \(e\) \{\s*e\.preventDefault\(\);\s*e\.stopPropagation\(\);/.test(ui)); // ...but a click in the preview reaches this page only as a click ui.js // replays on the document itself, and the document is not inside its // own root element, so that check ignored it and the panel stayed open. check('panel: a click on a removed element is not "outside", a click in the preview is', /if \(!document\.contains\(e\.target\)\) return;/.test(ui) && !/documentElement\.contains/.test(ui) && /document\.dispatchEvent\(new MouseEvent\('click'/.test(read('../src/js/ui.js'))); check('panel: the token is read before the action starts', /const token = String\(\$\('\.preview-github-panel \.gh-token-input'\)\.val\(\)[^;]*;\s*act\(/.test(ui)); check('panel: typed values survive a redraw', /value="\$\{esc\(_form\.token\)\}"/.test(ui) && /value="\$\{esc\(_form\.name\)\}"/.test(ui) && /_form\.isPrivate \? ' checked' : ''/.test(ui)); // There was no way to disconnect GitHub while the project wasn't saving // to it, and once GitHub was disconnected a project set up to save showed // a dot it couldn't get rid of without connecting again. const accountRow = ui.slice(ui.indexOf('function accountRow()'), ui.indexOf('function connectForm(')); const connectBody = ui.slice(ui.indexOf('function connectForm('), ui.indexOf('function stateView(')); const renderBody = ui.slice(ui.indexOf('function render()'), ui.indexOf('function paintButton()')); check('panel: Disconnect GitHub signs out after asking', /gh-signout">Disconnect GitHub act\(async \(\) => \{\s*const ok = [^;]*puterConfirm\('Disconnect GitHub[^;]*;\s*if \(!ok\) return;\s*await Sync\.auth\.signOut\(\);/.test(ui)); check('panel: Disconnect GitHub shows wherever Builder is signed in', connectBody.includes('accountRow()') && (renderBody.match(/accountRow\(\)/g) || []).length === 2); check('panel: a project can stop saving while GitHub is disconnected', /body = linked \? tokenForm\(link\) \+ '