@rightkit/release 0.2.142 → 0.2.143
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/install-app.mjs +132 -22
- package/package.json +1 -1
- package/rightkit-versions.json +8 -6
package/install-app.mjs
CHANGED
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
// Sanctioned, non-intrusive local app install from a signed DMG (macOS); --dev also accepts a
|
|
3
3
|
// Developer ID-signed, not-notarized zip or .app.
|
|
4
4
|
// Never uses a shell, osascript, AppleEvents, or foreground activation.
|
|
5
|
-
import { execFile as nodeExecFile } from "./background-process.mjs";
|
|
5
|
+
import { execFile as nodeExecFile, execFileSync as nodeExecFileSync } from "./background-process.mjs";
|
|
6
6
|
import { detachWithRetry } from "./hdiutil-detach.mjs";
|
|
7
7
|
import fs from "node:fs";
|
|
8
8
|
import os from "node:os";
|
|
9
9
|
import path from "node:path";
|
|
10
|
-
import { pathToFileURL } from "node:url";
|
|
10
|
+
import { fileURLToPath, pathToFileURL } from "node:url";
|
|
11
11
|
|
|
12
12
|
const SIGTERM_WAIT_MS = 15_000;
|
|
13
13
|
const POLL_MS = 250;
|
|
@@ -194,6 +194,59 @@ export function writeJournal(fsImpl, file, data) {
|
|
|
194
194
|
} catch { /* directory fsync is best effort */ }
|
|
195
195
|
}
|
|
196
196
|
|
|
197
|
+
// --- atomic swap helper (rightkit-swap: renamex_np(RENAME_SWAP)) -------------
|
|
198
|
+
|
|
199
|
+
// Errors that mean "no atomic swap here": fall back to the two-rename + journal path.
|
|
200
|
+
const SWAP_FALLBACK_CODES = new Set(["ENOHELPER", "ENOTSUP", "EINVAL", "ENOSYS"]);
|
|
201
|
+
const SWAP_HELPER_NAME = "rightkit-swap";
|
|
202
|
+
|
|
203
|
+
// Resolve order: env RIGHTKIT_SWAP, then <package>/bin/darwin/rightkit-swap, then PATH.
|
|
204
|
+
export function resolveSwapHelper({ env = process.env, fsImpl = fs, pkgDir = path.dirname(fileURLToPath(import.meta.url)) } = {}) {
|
|
205
|
+
const usable = (p) => { try { return fsImpl.statSync(p).isFile(); } catch { return false; } };
|
|
206
|
+
if (env.RIGHTKIT_SWAP && usable(env.RIGHTKIT_SWAP)) return env.RIGHTKIT_SWAP;
|
|
207
|
+
const shipped = path.join(pkgDir, "bin", "darwin", SWAP_HELPER_NAME);
|
|
208
|
+
if (usable(shipped)) return shipped;
|
|
209
|
+
for (const dir of String(env.PATH || "").split(path.delimiter)) {
|
|
210
|
+
if (dir && path.isAbsolute(dir) && usable(path.join(dir, SWAP_HELPER_NAME))) return path.join(dir, SWAP_HELPER_NAME);
|
|
211
|
+
}
|
|
212
|
+
return null;
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
function coded(code, message) {
|
|
216
|
+
const error = new Error(message);
|
|
217
|
+
error.code = code;
|
|
218
|
+
return error;
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
// Sync on purpose: signal-handler rollback must be able to swap back. Throws an error whose `code`
|
|
222
|
+
// is in SWAP_FALLBACK_CODES when no atomic swap is possible here (no helper, or exit 3 / ENOTSUP / EINVAL).
|
|
223
|
+
export function createSwapPaths({ env = process.env, resolve = resolveSwapHelper, execFileSync = nodeExecFileSync } = {}) {
|
|
224
|
+
return (a, b) => {
|
|
225
|
+
const helper = resolve({ env });
|
|
226
|
+
if (!helper) throw coded("ENOHELPER", `${SWAP_HELPER_NAME} helper not found`);
|
|
227
|
+
try { execFileSync(helper, [a, b], { encoding: "utf8", stdio: ["ignore", "pipe", "pipe"] }); }
|
|
228
|
+
catch (error) {
|
|
229
|
+
const text = `${error?.stderr || ""}`.trim();
|
|
230
|
+
if (error?.code === "ENOENT" || error?.code === "EACCES") throw coded("ENOHELPER", `${helper} cannot run: ${error.code}`);
|
|
231
|
+
if (error?.status === 3 || /SWAP_UNSUPPORTED/.test(text)) throw coded("ENOTSUP", text || "atomic swap unsupported on this volume");
|
|
232
|
+
throw coded("EIO", text || error?.message || "rightkit-swap failed");
|
|
233
|
+
}
|
|
234
|
+
};
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
// Exchange two paths, falling back to three renames only when no atomic swap exists (roll-back/recovery).
|
|
238
|
+
function swapBack(swapPaths, fsImpl, a, b) {
|
|
239
|
+
try { swapPaths(a, b); return "atomic"; }
|
|
240
|
+
catch (error) {
|
|
241
|
+
if (!SWAP_FALLBACK_CODES.has(error?.code)) throw error;
|
|
242
|
+
const tmp = `${a}.swapback`;
|
|
243
|
+
fsImpl.renameSync(a, tmp);
|
|
244
|
+
fsImpl.renameSync(b, a);
|
|
245
|
+
fsImpl.renameSync(tmp, b);
|
|
246
|
+
return "two-rename";
|
|
247
|
+
}
|
|
248
|
+
}
|
|
249
|
+
|
|
197
250
|
const defaultIsAlive = (pid) => {
|
|
198
251
|
try { process.kill(pid, 0); return true; } catch (e) { return e.code === "EPERM"; }
|
|
199
252
|
};
|
|
@@ -207,7 +260,7 @@ async function trashBundle(run, fsImpl, home, now, bundle, appName) {
|
|
|
207
260
|
}
|
|
208
261
|
|
|
209
262
|
// Deterministic roll-forward/back of any interrupted install journal in `dest`. Idempotent.
|
|
210
|
-
export async function recoverInstalls({ dest, appName = null, run, fsImpl, home, now, event, sleep, isAlive = defaultIsAlive, selfPid = process.pid }) {
|
|
263
|
+
export async function recoverInstalls({ dest, appName = null, run, fsImpl, home, now, event, sleep, isAlive = defaultIsAlive, selfPid = process.pid, swapPaths = createSwapPaths() }) {
|
|
211
264
|
let names = [];
|
|
212
265
|
try { names = fsImpl.readdirSync(dest).filter((n) => JOURNAL_RE.test(n)); } catch { return []; }
|
|
213
266
|
if (appName) names = names.filter((n) => n === path.basename(journalPathFor(dest, appName)));
|
|
@@ -225,8 +278,28 @@ export async function recoverInstalls({ dest, appName = null, run, fsImpl, home,
|
|
|
225
278
|
const rm = (p) => { if (p) { try { fsImpl.rmSync(p, { recursive: true, force: true }); } catch { /* best effort */ } } };
|
|
226
279
|
let action;
|
|
227
280
|
let keepJournal = false;
|
|
281
|
+
let keepStaged = false;
|
|
228
282
|
try {
|
|
229
|
-
if (
|
|
283
|
+
if (j.swap === "atomic") {
|
|
284
|
+
// Atomic mode: `installed` is never absent. After the exchange, `staged` holds the OLD bundle;
|
|
285
|
+
// before it, `staged` holds the new copy. The staged copy's inode (journaled) tells them apart.
|
|
286
|
+
const swapped = has(j.installed) && Number.isFinite(j.stagedIno) && fsImpl.statSync(j.installed).ino === j.stagedIno;
|
|
287
|
+
if (!has(j.installed)) {
|
|
288
|
+
if (has(j.staged)) { fsImpl.renameSync(j.staged, j.installed); action = "restored-backup"; }
|
|
289
|
+
else action = "cleared";
|
|
290
|
+
} else if (!swapped || !has(j.staged)) action = "cleared";
|
|
291
|
+
else {
|
|
292
|
+
let ok = j.phase === "verified";
|
|
293
|
+
if (!ok) { try { await verifyBundle(run, j.installed, { assess: !j.dev, staple: false }); ok = true; } catch { ok = false; } }
|
|
294
|
+
if (ok) {
|
|
295
|
+
try { await trashBundle(run, fsImpl, home, now, j.staged, path.basename(j.installed)); action = "rolled-forward"; }
|
|
296
|
+
catch { action = "rolled-forward-trash-pending"; keepJournal = true; keepStaged = true; }
|
|
297
|
+
} else {
|
|
298
|
+
swapBack(swapPaths, fsImpl, j.staged, j.installed); // staged now holds the bad new bundle
|
|
299
|
+
action = "rolled-back";
|
|
300
|
+
}
|
|
301
|
+
}
|
|
302
|
+
} else if (!has(j.installed)) {
|
|
230
303
|
if (has(j.backup)) { fsImpl.renameSync(j.backup, j.installed); action = "restored-backup"; }
|
|
231
304
|
else action = "cleared";
|
|
232
305
|
} else if (has(j.backup)) {
|
|
@@ -245,7 +318,7 @@ export async function recoverInstalls({ dest, appName = null, run, fsImpl, home,
|
|
|
245
318
|
event("recovery-failed", { journal: file, reason: errText(error) });
|
|
246
319
|
continue; // leave the journal for the next run
|
|
247
320
|
}
|
|
248
|
-
rm(j.staged);
|
|
321
|
+
if (!keepStaged) rm(j.staged);
|
|
249
322
|
if (j.mount && has(j.mount)) {
|
|
250
323
|
const out = await detachWithRetry({ mount: j.mount, log: (e) => event(e.event, e), sleep, detach: (args) => run("/usr/bin/hdiutil", args) });
|
|
251
324
|
if (out.ok) rm(j.mountRoot);
|
|
@@ -258,9 +331,9 @@ export async function recoverInstalls({ dest, appName = null, run, fsImpl, home,
|
|
|
258
331
|
}
|
|
259
332
|
|
|
260
333
|
export async function recoverApp(opts, deps = {}) {
|
|
261
|
-
const { execFile = realExecFile, fsImpl = fs, home = os.homedir(), now = () => new Date(), sleep = (ms) => new Promise((r) => setTimeout(r, ms)), emit = () => {}, isAlive, platform = process.platform } = deps;
|
|
334
|
+
const { execFile = realExecFile, fsImpl = fs, home = os.homedir(), now = () => new Date(), sleep = (ms) => new Promise((r) => setTimeout(r, ms)), emit = () => {}, isAlive, platform = process.platform, env = process.env, swapPaths = createSwapPaths({ env }) } = deps;
|
|
262
335
|
if (platform !== "darwin") throw new InstallAppError("unsupported", `install-app is not implemented on ${platform}`);
|
|
263
|
-
const results = await recoverInstalls({ dest: opts.dest, appName: opts.appName, run: (c, a) => execFile(c, a), fsImpl, home, now, event: (name, data = {}) => emit({ event: name, ...data }), sleep, isAlive });
|
|
336
|
+
const results = await recoverInstalls({ dest: opts.dest, appName: opts.appName, run: (c, a) => execFile(c, a), fsImpl, home, now, event: (name, data = {}) => emit({ event: name, ...data }), sleep, isAlive, swapPaths });
|
|
264
337
|
emit({ event: "recover-done", dest: opts.dest, recovered: results.length });
|
|
265
338
|
return { ok: true, recovered: results };
|
|
266
339
|
}
|
|
@@ -280,6 +353,8 @@ export async function installApp(opts, deps = {}) {
|
|
|
280
353
|
isAlive = defaultIsAlive,
|
|
281
354
|
signalTarget = process,
|
|
282
355
|
exit = (code) => process.exit(code),
|
|
356
|
+
env = process.env,
|
|
357
|
+
swapPaths = createSwapPaths({ env }),
|
|
283
358
|
} = deps;
|
|
284
359
|
const dev = opts.dev === true;
|
|
285
360
|
const event = (name, data = {}) => emit({ event: name, ...(dev ? { dev: true } : {}), ...data });
|
|
@@ -298,7 +373,16 @@ export async function installApp(opts, deps = {}) {
|
|
|
298
373
|
const s = swap;
|
|
299
374
|
swap = null;
|
|
300
375
|
try {
|
|
301
|
-
if (
|
|
376
|
+
if (s.mode === "atomic") {
|
|
377
|
+
// installed was never absent. Before the exchange only the staged copy needs removing; after it,
|
|
378
|
+
// exchange back (installed = old again, staged = the new copy) and drop the new copy. Once final,
|
|
379
|
+
// staged holds the verified-old bundle awaiting the Trash, so it must not be touched.
|
|
380
|
+
if (!s.final) {
|
|
381
|
+
if (s.swapped) swapBack(swapPaths, fsImpl, s.staged, s.installed);
|
|
382
|
+
removeQuiet(s.staged);
|
|
383
|
+
removeQuiet(s.journal);
|
|
384
|
+
}
|
|
385
|
+
} else if (!s.final) {
|
|
302
386
|
if (s.stagedIn) removeQuiet(s.installed);
|
|
303
387
|
if (s.backedUp && !fsImpl.existsSync(s.installed)) fsImpl.renameSync(s.backup, s.installed);
|
|
304
388
|
removeQuiet(s.staged);
|
|
@@ -346,7 +430,7 @@ export async function installApp(opts, deps = {}) {
|
|
|
346
430
|
if (!fsImpl.existsSync(inputPath)) throw new InstallAppError(`${inputKind}-missing`, `${inputKind.toUpperCase()} not found: ${inputPath}`);
|
|
347
431
|
if (!fsImpl.existsSync(opts.dest)) throw new InstallAppError("dest-missing", `destination not found: ${opts.dest}`);
|
|
348
432
|
|
|
349
|
-
await recoverInstalls({ dest: opts.dest, appName: opts.appName, run, fsImpl, home, now, event, sleep, isAlive, selfPid: pid });
|
|
433
|
+
await recoverInstalls({ dest: opts.dest, appName: opts.appName, run, fsImpl, home, now, event, sleep, isAlive, selfPid: pid, swapPaths });
|
|
350
434
|
|
|
351
435
|
let sourceApp = null;
|
|
352
436
|
const pickApp = (dir, label) => {
|
|
@@ -408,7 +492,7 @@ export async function installApp(opts, deps = {}) {
|
|
|
408
492
|
const journalData = { schema: 1, appName, pid, phase: "staging", dev, installed, backup, staged, mount: mountPoint, mountRoot };
|
|
409
493
|
removeQuiet(staged);
|
|
410
494
|
writeJournal(fsImpl, journal, journalData);
|
|
411
|
-
swap = { installed, backup, staged, journal, backedUp: false, stagedIn: false, final: false };
|
|
495
|
+
swap = { installed, backup, staged, journal, mode: null, swapped: false, backedUp: false, stagedIn: false, final: false };
|
|
412
496
|
try { await run("/usr/bin/ditto", [sourceApp, staged]); }
|
|
413
497
|
catch (error) {
|
|
414
498
|
rollbackSwap();
|
|
@@ -426,12 +510,37 @@ export async function installApp(opts, deps = {}) {
|
|
|
426
510
|
const quit = hadInstalled ? await quitApp(run, kill, sleep, installed) : { pids: [], killed: [] };
|
|
427
511
|
event("quit", { wasRunning, pids: quit.pids, forced: quit.killed });
|
|
428
512
|
|
|
429
|
-
// Swap:
|
|
513
|
+
// Swap. Preferred: one atomic exchange (renamex_np RENAME_SWAP), so `installed` is never absent even
|
|
514
|
+
// under SIGKILL; the old bundle then sits at the staged path. Fallback (no helper, or a volume without
|
|
515
|
+
// RENAME_SWAP): old -> backup, staged -> installed, journaled. The old bundle is never trashed before
|
|
516
|
+
// the new one is verified.
|
|
430
517
|
failedStage = "replace";
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
518
|
+
let jd = journalData;
|
|
519
|
+
let swapMode;
|
|
520
|
+
if (!hadInstalled) {
|
|
521
|
+
swapMode = "rename"; // nothing to exchange: a single rename onto an absent name is atomic
|
|
522
|
+
swap.mode = "two-rename";
|
|
523
|
+
writeJournal(fsImpl, journal, { ...jd, phase: "swapping", swap: swapMode });
|
|
524
|
+
fsImpl.renameSync(staged, installed);
|
|
525
|
+
swap.stagedIn = true;
|
|
526
|
+
} else {
|
|
527
|
+
jd = { ...journalData, swap: "atomic", backup: null, stagedIno: fsImpl.statSync(staged).ino };
|
|
528
|
+
writeJournal(fsImpl, journal, { ...jd, phase: "swapping" });
|
|
529
|
+
swap.mode = "atomic";
|
|
530
|
+
try { swapPaths(staged, installed); swap.swapped = true; swapMode = "atomic"; }
|
|
531
|
+
catch (error) {
|
|
532
|
+
if (!SWAP_FALLBACK_CODES.has(error?.code)) throw new InstallAppError("swap-failed", `atomic swap failed (${errText(error)}); previous app untouched`);
|
|
533
|
+
event("swap-fallback", { reason: error.code, detail: errText(error) });
|
|
534
|
+
swapMode = "two-rename";
|
|
535
|
+
swap.mode = "two-rename";
|
|
536
|
+
jd = { ...journalData, swap: "two-rename" };
|
|
537
|
+
writeJournal(fsImpl, journal, { ...jd, phase: "swapping" });
|
|
538
|
+
fsImpl.renameSync(installed, backup); swap.backedUp = true;
|
|
539
|
+
fsImpl.renameSync(staged, installed);
|
|
540
|
+
swap.stagedIn = true;
|
|
541
|
+
}
|
|
542
|
+
if (swapMode === "atomic") writeJournal(fsImpl, journal, { ...jd, phase: "swapped" });
|
|
543
|
+
}
|
|
435
544
|
// Dev builds are not notarized: clear quarantine on the NEW bundle only so Gatekeeper does not block it.
|
|
436
545
|
if (dev) {
|
|
437
546
|
try { await run("/usr/bin/xattr", ["-dr", "com.apple.quarantine", installed]); }
|
|
@@ -443,18 +552,19 @@ export async function installApp(opts, deps = {}) {
|
|
|
443
552
|
// Re-verify installed copy; on failure the catch below rolls back to the backup.
|
|
444
553
|
failedStage = "reverify";
|
|
445
554
|
await verifyBundle(run, installed, { assess: !dev, staple: false });
|
|
446
|
-
writeJournal(fsImpl, journal, { ...
|
|
555
|
+
writeJournal(fsImpl, journal, { ...jd, phase: "verified", mount: null, mountRoot: null });
|
|
447
556
|
swap.final = true;
|
|
448
557
|
|
|
449
558
|
// Only now does the old bundle go to the Trash.
|
|
450
559
|
let trashed = null;
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
560
|
+
const oldBundle = swapMode === "atomic" ? staged : backup; // atomic: the exchange left the old bundle at the staged path
|
|
561
|
+
if (hadInstalled && oldBundle) {
|
|
562
|
+
try { trashed = await trashBundle(run, fsImpl, home, now, oldBundle, appName); }
|
|
563
|
+
catch (error) { event("backup-trash-failed", { backup: oldBundle, reason: errText(error) }); trashed = oldBundle; }
|
|
454
564
|
}
|
|
455
|
-
if (!
|
|
565
|
+
if (!oldBundle || trashed !== oldBundle) removeQuiet(journal);
|
|
456
566
|
swap = null;
|
|
457
|
-
event("replaced", { installed, previous: trashed });
|
|
567
|
+
event("replaced", { installed, previous: trashed, swap: swapMode });
|
|
458
568
|
|
|
459
569
|
// Relaunch hidden and in the background only.
|
|
460
570
|
const relaunch = opts.relaunch === null ? wasRunning : opts.relaunch;
|
|
@@ -463,7 +573,7 @@ export async function installApp(opts, deps = {}) {
|
|
|
463
573
|
await run("/usr/bin/open", ["-g", "-j", "-b", bundleId]);
|
|
464
574
|
event("relaunched", { bundleId });
|
|
465
575
|
}
|
|
466
|
-
const result = { ok: true, app: appName, installed, bundleId, teamId: newTeam, previous: trashed, relaunched: relaunch, ...(dev ? { dev: true } : {}) };
|
|
576
|
+
const result = { ok: true, app: appName, installed, bundleId, teamId: newTeam, previous: trashed, swap: swapMode, relaunched: relaunch, ...(dev ? { dev: true } : {}) };
|
|
467
577
|
event("done", result);
|
|
468
578
|
return result;
|
|
469
579
|
} catch (error) {
|
package/package.json
CHANGED
package/rightkit-versions.json
CHANGED
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
"@rightkit/platform-ui": "0.2.0",
|
|
30
30
|
"@rightkit/qa": "0.4.0",
|
|
31
31
|
"@rightkit/qa-chrome": "0.1.3",
|
|
32
|
-
"@rightkit/release": "0.2.
|
|
32
|
+
"@rightkit/release": "0.2.143",
|
|
33
33
|
"@rightkit/settings-ui": "0.3.0",
|
|
34
34
|
"@rightkit/shell": "0.1.0",
|
|
35
35
|
"@rightkit/tauri": "0.2.0",
|
|
@@ -174,7 +174,8 @@
|
|
|
174
174
|
"0.2.138",
|
|
175
175
|
"0.2.139",
|
|
176
176
|
"0.2.140",
|
|
177
|
-
"0.2.141"
|
|
177
|
+
"0.2.141",
|
|
178
|
+
"0.2.142"
|
|
178
179
|
],
|
|
179
180
|
"@rightkit/qa": [
|
|
180
181
|
"0.1.0",
|
|
@@ -279,7 +280,7 @@
|
|
|
279
280
|
"rightkit-db": "0.3.2",
|
|
280
281
|
"rightkit-embed": "0.3.1",
|
|
281
282
|
"rightkit-framed-sidecar": "0.1.0",
|
|
282
|
-
"rightkit-fs": "0.3.
|
|
283
|
+
"rightkit-fs": "0.3.3",
|
|
283
284
|
"rightkit-fsindex": "0.1.0",
|
|
284
285
|
"rightkit-http": "0.2.4",
|
|
285
286
|
"rightkit-jobs": "0.2.6",
|
|
@@ -336,7 +337,7 @@
|
|
|
336
337
|
"rightkit-db": "0.3.2",
|
|
337
338
|
"rightkit-embed": "0.3.1",
|
|
338
339
|
"rightkit-framed-sidecar": "0.1.0",
|
|
339
|
-
"rightkit-fs": "0.3.
|
|
340
|
+
"rightkit-fs": "0.3.3",
|
|
340
341
|
"rightkit-fsindex": "0.1.0",
|
|
341
342
|
"rightkit-http": "0.2.4",
|
|
342
343
|
"rightkit-jobs": "0.2.6",
|
|
@@ -386,7 +387,7 @@
|
|
|
386
387
|
"@rightkit/platform-ui": "0.2.0",
|
|
387
388
|
"@rightkit/qa": "0.4.0",
|
|
388
389
|
"@rightkit/qa-chrome": "0.1.3",
|
|
389
|
-
"@rightkit/release": "0.2.
|
|
390
|
+
"@rightkit/release": "0.2.143",
|
|
390
391
|
"@rightkit/settings-ui": "0.3.0",
|
|
391
392
|
"@rightkit/shell": "0.1.0",
|
|
392
393
|
"@rightkit/tauri": "0.2.0",
|
|
@@ -519,7 +520,8 @@
|
|
|
519
520
|
"0.1.0",
|
|
520
521
|
"0.2.0",
|
|
521
522
|
"0.3.0",
|
|
522
|
-
"0.3.1"
|
|
523
|
+
"0.3.1",
|
|
524
|
+
"0.3.2"
|
|
523
525
|
],
|
|
524
526
|
"rightkit-service": [
|
|
525
527
|
"0.1.0",
|