litmus-cli 1.4.6 → 1.4.7-eng1502.0

package/dist/lib/session.js

@@ -0,0 +1,212 @@
+/**
+ * The assessment shell — how `litmus init` puts the candidate *inside* their
+ * assessment folder, and how `litmus submit` takes them back out.
+ *
+ * A process cannot change its parent shell's working directory, so "cd into the
+ * folder for them" has exactly one honest implementation: init spawns an
+ * interactive shell rooted in the assessment directory and waits on it. The
+ * candidate works in that shell. When submit succeeds it hangs that shell up,
+ * the shell exits, init's wait returns, and the candidate is back at the prompt
+ * they started from, in the directory they started in — the `cd ..` they never
+ * had to type.
+ *
+ * Two independent facts have to line up before we signal anything:
+ *   - LITMUS_ASSESSMENT_SHELL=1 in our own environment, which only a shell we
+ *     spawned can have set, and
+ *   - a .litmus/shell.pid written by that same init, for this same folder,
+ *     naming a process that is genuinely one of our ancestors.
+ * Either alone could be stale; together they can only describe the shell we are
+ * actually standing in.
+ */
+import path from "path";
+import { existsSync, readFileSync, writeFileSync, unlinkSync } from "fs";
+import { spawn, execFileSync } from "child_process";
+import chalk from "chalk";
+/** Set in the spawned shell's environment; read back by `litmus submit`. */
+export const SHELL_ENV_MARKER = "LITMUS_ASSESSMENT_SHELL";
+const SHELL_PID_FILE = "shell.pid";
+function shellPidPath(projectRoot) {
+    return path.join(projectRoot, ".litmus", SHELL_PID_FILE);
+}
+/**
+ * Whether init should hand the candidate a shell at all. Piped stdin (the e2e
+ * suite, a CI script, `litmus init | tee`) must never get one — it would hang
+ * forever on a shell nobody can type into.
+ */
+export function shouldEnterShell(optIn) {
+    if (optIn === false)
+        return false;
+    if (process.env.LITMUS_NO_SHELL === "1")
+        return false;
+    return Boolean(process.stdin.isTTY && process.stdout.isTTY);
+}
+/** The candidate's own shell, falling back to something that certainly exists. */
+export function resolveShell() {
+    if (process.platform === "win32") {
+        return { command: process.env.ComSpec || "cmd.exe", args: [] };
+    }
+    // -i because stdio is inherited but the shell is not the session leader; zsh
+    // and bash both need it to read their interactive rc files and print a prompt.
+    return { command: process.env.SHELL || "/bin/sh", args: ["-i"] };
+}
+/**
+ * Drop the candidate into `projectRoot` in their own shell and block until they
+ * leave it — by typing exit, or by `litmus submit` hanging it up.
+ *
+ * Resolves to "submitted" when the folder is gone by the time the shell exits
+ * (submit deleted it), "exited" when the candidate just left.
+ *
+ * Closing the shell has two triggers, because the two cases know different
+ * things: an in-shell `litmus submit` signals it directly (instant, and ordered
+ * against its own output), while a submit that happens elsewhere — the deadline
+ * auto-submit in the watcher, or a second terminal — is noticed here by the
+ * assessment folder disappearing.
+ */
+export async function enterAssessmentShell(projectRoot, folderName) {
+    const { command, args } = resolveShell();
+    console.log(chalk.dim(`  You're in ${folderName}/ — a shell opened here for you.`));
+    console.log(chalk.dim(`  Type ${chalk.reset(chalk.cyan("exit"))}${chalk.dim(" to leave it; your assessment keeps running either way.")}`));
+    console.log();
+    const child = spawn(command, args, {
+        cwd: projectRoot,
+        stdio: "inherit",
+        env: {
+            ...process.env,
+            [SHELL_ENV_MARKER]: "1",
+            LITMUS_ASSESSMENT_DIR: projectRoot,
+        },
+    });
+    if (child.pid) {
+        try {
+            writeFileSync(shellPidPath(projectRoot), String(child.pid), "utf8");
+        }
+        catch {
+            // Without the pid file submit just skips the hang-up and tells the
+            // candidate to cd out themselves. Not worth failing init over.
+        }
+    }
+    // Not every submit can hang this shell up itself. The deadline auto-submit
+    // runs in the detached watcher, and a candidate can run `litmus submit` from
+    // a second terminal; neither is standing in this shell, so neither is allowed
+    // to signal it — and both delete the folder, which would leave the candidate
+    // sitting in a shell whose working directory no longer exists.
+    //
+    // This process is the one that can always fix that: it spawned the shell, so
+    // it knows the pid for certain, with no pid file and no ancestry to infer.
+    // The folder going away IS the signal, whoever caused it.
+    const folderWatch = setInterval(() => {
+        if (existsSync(projectRoot))
+            return;
+        clearInterval(folderWatch);
+        try {
+            child.kill("SIGHUP");
+        }
+        catch {
+            // Already gone — the in-shell submit path beat us to it.
+        }
+    }, 2000);
+    // The shell is the foreground job; Ctrl-C at its prompt reaches this process
+    // too. Ignoring it here means the candidate's ^C interrupts what they're
+    // running, not the init that is holding their session open.
+    const swallowSigint = () => { };
+    process.on("SIGINT", swallowSigint);
+    try {
+        await new Promise((resolve) => {
+            child.on("exit", () => resolve());
+            child.on("error", () => resolve());
+        });
+    }
+    finally {
+        clearInterval(folderWatch);
+        process.off("SIGINT", swallowSigint);
+    }
+    if (!existsSync(projectRoot))
+        return "submitted";
+    try {
+        unlinkSync(shellPidPath(projectRoot));
+    }
+    catch {
+        // already gone
+    }
+    return "exited";
+}
+/** The pid init recorded for this folder's shell, if there is one. */
+export function readAssessmentShellPid(projectRoot) {
+    try {
+        const pid = parseInt(readFileSync(shellPidPath(projectRoot), "utf8").trim(), 10);
+        return Number.isFinite(pid) && pid > 1 ? pid : null;
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * Is `target` one of our ancestors? Guards against a recycled pid: the pid file
+ * outlives the shell that wrote it if init was killed outright.
+ */
+function isAncestorPid(target) {
+    if (process.platform === "win32") {
+        // No cheap ancestor walk here; the env marker plus a per-folder pid file is
+        // the gate on Windows.
+        return true;
+    }
+    let pid = process.ppid;
+    for (let depth = 0; depth < 8 && pid > 1; depth++) {
+        if (pid === target)
+            return true;
+        try {
+            const out = execFileSync("ps", ["-o", "ppid=", "-p", String(pid)], {
+                encoding: "utf8",
+                timeout: 3000,
+            });
+            pid = parseInt(out.trim(), 10);
+        }
+        catch {
+            return false;
+        }
+        if (!Number.isFinite(pid))
+            return false;
+    }
+    return false;
+}
+/**
+ * Are we running inside the shell init opened for this folder? Both the
+ * environment marker and an ancestry check have to agree — see the file header.
+ *
+ * Callers use this before printing anything about where the candidate will end
+ * up, since leaving the shell moves them out of the folder for free.
+ */
+export function inAssessmentShell(shellPid) {
+    if (process.env[SHELL_ENV_MARKER] !== "1")
+        return false;
+    if (shellPid === null)
+        return false;
+    return isAncestorPid(shellPid);
+}
+/**
+ * End the assessment shell. Returns true when the hang-up went out.
+ *
+ * Call this LAST and print nothing after it: the shell hangs up its jobs on the
+ * way out, and this process is one of them.
+ */
+export function hangUpAssessmentShell(shellPid) {
+    if (!inAssessmentShell(shellPid))
+        return false;
+    // zsh forwards SIGHUP to its jobs, and we are one. Ignore it so this process
+    // finishes on its own terms instead of dying between two writes.
+    process.on("SIGHUP", () => { });
+    try {
+        if (process.platform === "win32") {
+            // No /T: that would take this process down with the shell.
+            execFileSync("taskkill", ["/PID", String(shellPid), "/F"], { stdio: "ignore", timeout: 5000 });
+        }
+        else {
+            process.kill(shellPid, "SIGHUP");
+        }
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+//# sourceMappingURL=session.js.map

package/dist/lib/session.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"session.js","sourceRoot":"","sources":["../../src/lib/session.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,IAAI,CAAA;AACxE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AACnD,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,4EAA4E;AAC5E,MAAM,CAAC,MAAM,gBAAgB,GAAG,yBAAyB,CAAA;AAEzD,MAAM,cAAc,GAAG,WAAW,CAAA;AAElC,SAAS,YAAY,CAAC,WAAmB;IACvC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,EAAE,cAAc,CAAC,CAAA;AAC1D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAA0B;IACzD,IAAI,KAAK,KAAK,KAAK;QAAE,OAAO,KAAK,CAAA;IACjC,IAAI,OAAO,CAAC,GAAG,CAAC,eAAe,KAAK,GAAG;QAAE,OAAO,KAAK,CAAA;IACrD,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC7D,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,YAAY;IAC1B,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;QACjC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,SAAS,EAAE,IAAI,EAAE,EAAE,EAAE,CAAA;IAChE,CAAC;IACD,6EAA6E;IAC7E,+EAA+E;IAC/E,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,SAAS,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,CAAA;AAClE,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,WAAmB,EACnB,UAAkB;IAElB,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,YAAY,EAAE,CAAA;IAExC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,eAAe,UAAU,kCAAkC,CAAC,CAAC,CAAA;IACnF,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,yDAAyD,CAAC,EAAE,CAAC,CAAC,CAAA;IAC1I,OAAO,CAAC,GAAG,EAAE,CAAA;IAEb,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE;QACjC,GAAG,EAAE,WAAW;QAChB,KAAK,EAAE,SAAS;QAChB,GAAG,EAAE;YACH,GAAG,OAAO,CAAC,GAAG;YACd,CAAC,gBAAgB,CAAC,EAAE,GAAG;YACvB,qBAAqB,EAAE,WAAW;SACnC;KACF,CAAC,CAAA;IAEF,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;QACd,IAAI,CAAC;YACH,aAAa,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAA;QACrE,CAAC;QAAC,MAAM,CAAC;YACP,mEAAmE;YACnE,+DAA+D;QACjE,CAAC;IACH,CAAC;IAED,2EAA2E;IAC3E,6EAA6E;IAC7E,8EAA8E;IAC9E,6EAA6E;IAC7E,+DAA+D;IAC/D,EAAE;IACF,6EAA6E;IAC7E,2EAA2E;IAC3E,0DAA0D;IAC1D,MAAM,WAAW,GAAG,WAAW,CAAC,GAAG,EAAE;QACnC,IAAI,UAAU,CAAC,WAAW,CAAC;YAAE,OAAM;QACnC,aAAa,CAAC,WAAW,CAAC,CAAA;QAC1B,IAAI,CAAC;YACH,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACtB,CAAC;QAAC,MAAM,CAAC;YACP,yDAAyD;QAC3D,CAAC;IACH,CAAC,EAAE,IAAI,CAAC,CAAA;IAER,6EAA6E;IAC7E,yEAAyE;IACzE,4DAA4D;IAC5D,MAAM,aAAa,GAAG,GAAG,EAAE,GAAE,CAAC,CAAA;IAC9B,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAA;IACnC,IAAI,CAAC;QACH,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YAClC,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAA;YACjC,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAA;QACpC,CAAC,CAAC,CAAA;IACJ,CAAC;YAAS,CAAC;QACT,aAAa,CAAC,WAAW,CAAC,CAAA;QAC1B,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAA;IACtC,CAAC;IAED,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;QAAE,OAAO,WAAW,CAAA;IAChD,IAAI,CAAC;QACH,UAAU,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAA;IACvC,CAAC;IAAC,MAAM,CAAC;QACP,eAAe;IACjB,CAAC;IACD,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED,sEAAsE;AACtE,MAAM,UAAU,sBAAsB,CAAC,WAAmB;IACxD,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,QAAQ,CAAC,YAAY,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAA;QAChF,OAAO,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAA;IACrD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAA;IACb,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,aAAa,CAAC,MAAc;IACnC,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;QACjC,4EAA4E;QAC5E,uBAAuB;QACvB,OAAO,IAAI,CAAA;IACb,CAAC;IACD,IAAI,GAAG,GAAG,OAAO,CAAC,IAAI,CAAA;IACtB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;QAClD,IAAI,GAAG,KAAK,MAAM;YAAE,OAAO,IAAI,CAAA;QAC/B,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,YAAY,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE;gBACjE,QAAQ,EAAE,MAAM;gBAChB,OAAO,EAAE,IAAI;aACd,CAAC,CAAA;YACF,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAA;QAChC,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAA;QACd,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAA;IACzC,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAAC,QAAuB;IACvD,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,KAAK,GAAG;QAAE,OAAO,KAAK,CAAA;IACvD,IAAI,QAAQ,KAAK,IAAI;QAAE,OAAO,KAAK,CAAA;IACnC,OAAO,aAAa,CAAC,QAAQ,CAAC,CAAA;AAChC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAC,QAAuB;IAC3D,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC;QAAE,OAAO,KAAK,CAAA;IAE9C,6EAA6E;IAC7E,iEAAiE;IACjE,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;IAE9B,IAAI,CAAC;QACH,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;YACjC,2DAA2D;YAC3D,YAAY,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;QAChG,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CAAC,QAAkB,EAAE,QAAQ,CAAC,CAAA;QAC5C,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "litmus-cli",
-  "version": "1.4.6",
+  "version": "1.4.7-eng1502.0",
   "description": "CLI tool for Litmus engineering assessments",
   "license": "MIT",
   "author": "elenazhao",