charness 3.6.1 → 3.8.0

package/dist/remoteRun/sendPlan.js

@@ -0,0 +1,139 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rsyncNanosecondWindowArg = void 0;
+exports.checkIsSecretLookingFile = checkIsSecretLookingFile;
+exports.planSendList = planSendList;
+exports.formatNulSeparatedList = formatNulSeparatedList;
+exports.formatManifest = formatManifest;
+exports.buildRsyncSendArgs = buildRsyncSendArgs;
+exports.buildRsyncGitArgs = buildRsyncGitArgs;
+exports.buildRsyncMetaArgs = buildRsyncMetaArgs;
+exports.buildRsyncFetchArgs = buildRsyncFetchArgs;
+const path = __importStar(require("path"));
+const pathPatterns_1 = require("./pathPatterns");
+/**
+ * @description What goes to the runner and how: the file list (git decides, `.remote-run` trims and opts in), the files held back
+ * because they look like secrets, and the rsync argument lists. Pure — the git calls and the process spawns are elsewhere.
+ *
+ * Sent: tracked and untracked-not-ignored files, submodules included. Never sent: what `.gitignore` names (the runner keeps its own
+ * `node_modules`, `build`, caches), `.git` unless `--with-git`, `exclude:` paths, and secret-looking files unless `send:` names them.
+ */
+/**
+ * rsync decides a file is unchanged when its size and mtime match, and by default the mtime is compared in WHOLE SECONDS: an edit of the
+ * same length within the second of the previous version would be skipped, and the runner would keep the old file. A negative modify
+ * window compares the nanoseconds too (rsync 3.1.3 or newer on both ends; older ones fall back to seconds).
+ */
+exports.rsyncNanosecondWindowArg = '--modify-window=-1';
+/** A secret-looking file that is only a template of one (`.env.example`) is sent: it holds no secret. */
+const templateEnvSuffixes = ['.example', '.sample', '.template'];
+const secretFileExtensions = ['.pem', '.p12', '.key'];
+/** @description Does the NAME of `relativePath` look like a secret (`.env`, `.env.*` but not its templates, `*.pem`, `*.p12`, `*.key`, `.npmrc`)? */
+function checkIsSecretLookingFile(relativePath) {
+    const name = path.posix.basename(relativePath);
+    if (name === '.npmrc' || name === '.env')
+        return true;
+    if (name.startsWith('.env.'))
+        return !templateEnvSuffixes.some((suffix) => name.endsWith(suffix));
+    return secretFileExtensions.some((extension) => name.endsWith(extension) && name.length > extension.length);
+}
+/** @description Turn git's lists into the send plan. `exclude:` beats `send:`; a name with a newline that is not excluded is refused. */
+function planSendList(input) {
+    const isExcluded = (0, pathPatterns_1.createPathMatcher)(input.exclude);
+    const isOptedIn = (0, pathPatterns_1.createPathMatcher)(input.send);
+    const candidates = new Set(input.files);
+    for (const ignoredFile of input.ignoredFiles) {
+        if (isOptedIn(ignoredFile))
+            candidates.add(ignoredFile);
+    }
+    const plan = { files: [], heldBack: [], refused: [] };
+    for (const file of [...candidates].sort()) {
+        if (isExcluded(file))
+            continue;
+        if (file.includes('\n'))
+            plan.refused.push(file);
+        else if (checkIsSecretLookingFile(file) && !isOptedIn(file))
+            plan.heldBack.push(file);
+        else
+            plan.files.push(file);
+    }
+    return plan;
+}
+/** @description The NUL-separated list `rsync --files-from=- --from0` reads. */
+function formatNulSeparatedList(files) {
+    return files.map((file) => `${file}\0`).join('');
+}
+/** @description The list the runner diffs between two submits to find deletions: one path per line. */
+function formatManifest(files) {
+    return files.map((file) => `${file}\n`).join('');
+}
+/**
+ * @description `rsync` of the listed files into the job's stage dir. `--copy-dest` (not `--link-dest`): a staged file is a real copy,
+ * so a job that rewrites a file in place (`jest -u`) can never change what a queued job of the same project is going to apply.
+ */
+function buildRsyncSendArgs(params) {
+    return [
+        '-a',
+        exports.rsyncNanosecondWindowArg,
+        '--from0',
+        '--files-from=-',
+        ...(params.copyDestination === null ? [] : [`--copy-dest=${params.copyDestination}`]),
+        '-e',
+        params.sshCommand,
+        `${params.sourceRoot}/`,
+        params.destination,
+    ];
+}
+/** @description `rsync` of the project's `.git` directory into the stage dir (`--with-git`). */
+function buildRsyncGitArgs(params) {
+    return [
+        '-a',
+        exports.rsyncNanosecondWindowArg,
+        ...(params.copyDestination === null ? [] : [`--copy-dest=${params.copyDestination}`]),
+        '-e',
+        params.sshCommand,
+        `${params.sourceRoot}/.git/`,
+        `${params.destination}.git/`,
+    ];
+}
+/** @description `rsync` of a small local folder (the job's meta files) to `destination`. */
+function buildRsyncMetaArgs(params) {
+    return ['-rt', '-e', params.sshCommand, `${params.sourceDirectory}/`, params.destination];
+}
+/** @description `rsync` of a job's result files into a local temp folder: no symlinks at all, the runner is not trusted to write into the main box. */
+function buildRsyncFetchArgs(params) {
+    return ['-rt', '--no-links', '-e', params.sshCommand, `${params.source}/`, `${params.destinationDirectory}/`];
+}
+//# sourceMappingURL=sendPlan.js.map

package/dist/remoteRun/sendPlan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendPlan.js","sourceRoot":"","sources":["../../src/remoteRun/sendPlan.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuBA,4DAKC;AAqBD,oCAeC;AAGD,wDAEC;AAGD,wCAEC;AAiBD,gDAYC;AAGD,8CAUC;AAGD,gDAEC;AAGD,kDAEC;AA9HD,2CAA6B;AAC7B,iDAAmD;AAEnD;;;;;;GAMG;AAEH;;;;GAIG;AACU,QAAA,wBAAwB,GAAG,oBAAoB,CAAC;AAE7D,yGAAyG;AACzG,MAAM,mBAAmB,GAAsB,CAAC,UAAU,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;AACpF,MAAM,oBAAoB,GAAsB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAEzE,qJAAqJ;AACrJ,SAAgB,wBAAwB,CAAC,YAAoB;IAC3D,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IAC/C,IAAI,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,MAAM;QAAE,OAAO,IAAI,CAAC;IACtD,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;QAAE,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IAClG,OAAO,oBAAoB,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;AAC9G,CAAC;AAoBD,yIAAyI;AACzI,SAAgB,YAAY,CAAC,KAAoB;IAC/C,MAAM,UAAU,GAAG,IAAA,gCAAiB,EAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACpD,MAAM,SAAS,GAAG,IAAA,gCAAiB,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAChD,MAAM,UAAU,GAAG,IAAI,GAAG,CAAS,KAAK,CAAC,KAAK,CAAC,CAAC;IAChD,KAAK,MAAM,WAAW,IAAI,KAAK,CAAC,YAAY,EAAE,CAAC;QAC7C,IAAI,SAAS,CAAC,WAAW,CAAC;YAAE,UAAU,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC1D,CAAC;IACD,MAAM,IAAI,GAAa,EAAE,KAAK,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IAChE,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;QAC1C,IAAI,UAAU,CAAC,IAAI,CAAC;YAAE,SAAS;QAC/B,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC5C,IAAI,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;;YACjF,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,gFAAgF;AAChF,SAAgB,sBAAsB,CAAC,KAAwB;IAC7D,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACnD,CAAC;AAED,uGAAuG;AACvG,SAAgB,cAAc,CAAC,KAAwB;IACrD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACnD,CAAC;AAaD;;;GAGG;AACH,SAAgB,kBAAkB,CAAC,MAAuB;IACxD,OAAO;QACL,IAAI;QACJ,gCAAwB;QACxB,SAAS;QACT,gBAAgB;QAChB,GAAG,CAAC,MAAM,CAAC,eAAe,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,eAAe,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC;QACrF,IAAI;QACJ,MAAM,CAAC,UAAU;QACjB,GAAG,MAAM,CAAC,UAAU,GAAG;QACvB,MAAM,CAAC,WAAW;KACnB,CAAC;AACJ,CAAC;AAED,gGAAgG;AAChG,SAAgB,iBAAiB,CAAC,MAAuB;IACvD,OAAO;QACL,IAAI;QACJ,gCAAwB;QACxB,GAAG,CAAC,MAAM,CAAC,eAAe,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,eAAe,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC;QACrF,IAAI;QACJ,MAAM,CAAC,UAAU;QACjB,GAAG,MAAM,CAAC,UAAU,QAAQ;QAC5B,GAAG,MAAM,CAAC,WAAW,OAAO;KAC7B,CAAC;AACJ,CAAC;AAED,4FAA4F;AAC5F,SAAgB,kBAAkB,CAAC,MAA4E;IAC7G,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,UAAU,EAAE,GAAG,MAAM,CAAC,eAAe,GAAG,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;AAC5F,CAAC;AAED,uJAAuJ;AACvJ,SAAgB,mBAAmB,CAAC,MAA4E;IAC9G,OAAO,CAAC,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,CAAC,UAAU,EAAE,GAAG,MAAM,CAAC,MAAM,GAAG,EAAE,GAAG,MAAM,CAAC,oBAAoB,GAAG,CAAC,CAAC;AAChH,CAAC"}

package/dist/remoteRun/ssh.d.ts

@@ -0,0 +1,82 @@
+import { type ChildProcessWithoutNullStreams } from 'child_process';
+import type { RunnerConfig } from './runnersConfig';
+/** @description Where remote-run keeps its local cache (ssh control sockets, the last probe of each runner): `${XDG_CACHE_HOME:-~/.cache}/charness/remote-run`. */
+export declare function getRemoteRunCacheDir(env?: NodeJS.ProcessEnv, homeDir?: string): string;
+/** @description Create the cache dir (mode 0700) and its ssh folder. */
+export declare function ensureRemoteRunCacheDir(cacheDir: string): void;
+/** @description Can `value` be put into an ssh option or a command line that ssh and rsync's `-e` both read back as one word? (Whitespace can; a quote, a backslash, a `$`, a backtick or a line break cannot.) */
+export declare function checkIsSshPathQuotable(value: string): boolean;
+/** @description ssh expands `%`-tokens in a ProxyCommand, an identity file, a known-hosts path and a ControlPath: a literal `%` is written `%%`. */
+export declare function escapeSshTokens(value: string): string;
+/**
+ * @description A path as the VALUE of an `-o` option. ssh reads `-o` like a line of its config file: `UserKnownHostsFile` there is a LIST of
+ * files separated by whitespace and `ControlPath` takes one word followed by nothing, so `/home/my user/…` would be two words and ssh would
+ * fail or look in the wrong place. Double quotes keep one path one word (ssh_config(5): «arguments may optionally be enclosed in double
+ * quotes»); `-i` takes its path as a plain argument and needs none.
+ */
+export declare function quoteSshOptionPath(value: string): string;
+/**
+ * @description The ssh options of every call to `runner` (without the destination): the operator's own first — ssh keeps the first value of an
+ * option — then ours. The shared connection is an optimisation: a cache path that is too long for a unix socket, or holds a character that
+ * cannot be quoted, turns it off instead of failing the call.
+ */
+export declare function buildSshArgs(runner: Pick<RunnerConfig, 'sshOptions'>, cacheDir: string): string[];
+/** @description Is `word` one that needs no quoting for a POSIX shell (and for ssh's and rsync's own parsers)? */
+export declare function checkIsPlainShellWord(word: string): boolean;
+/** @description One word quoted for a POSIX shell (`shellSingleQuote`; an already plain word stays as it is, so the commands read well in a log). */
+export declare function quoteShellWord(word: string): string;
+/** @description The words of an argument list as one string rsync's `-e` and a shell both read back as the same words. */
+export declare function joinShellWords(words: readonly string[]): string;
+/** @description The `-e` command of rsync: `ssh <options> <destination>` is rsync's to complete, so this is `ssh <options>`. */
+export declare function buildRsyncSshCommand(runner: Pick<RunnerConfig, 'sshOptions'>, cacheDir: string): string;
+/** @description A path for the REMOTE shell: a leading `~` stays unquoted so the runner's shell expands it. */
+export declare function quoteRemotePath(remotePath: string): string;
+export interface RunnerScriptCall {
+    runner: Pick<RunnerConfig, 'workDir' | 'pueue'>;
+    /** `runner-<sha8>.sh` */
+    scriptName: string;
+    subcommand: string;
+    /** After the work dir the script always gets first. */
+    args: readonly string[];
+}
+/** @description The command line that runs one subcommand of the uploaded script on the runner (Pueue's binary and config through the environment). */
+export declare function buildRunnerScriptCommand(call: RunnerScriptCall): string;
+/** @description The command that writes the script from stdin into `<workDir>/bin/` unless it is already there (a temp file and a rename, so a half upload is never run). */
+export declare function buildScriptUploadCommand(runner: Pick<RunnerConfig, 'workDir'>, scriptName: string): string;
+export declare function buildScriptExistsCommand(runner: Pick<RunnerConfig, 'workDir'>, scriptName: string): string;
+/** The exit status ssh itself reports when it could not run the command. */
+export declare const sshFailureExitCode = 255;
+/**
+ * @description Did the ssh call end because the CONNECTION failed (ssh's own status 255, or a process that was killed), rather than
+ * because the command on the runner ended with a status of its own? The runner script's refusals exit 125 and a job's code is whatever its
+ * command returned, so only this one is worth opening the connection again for.
+ */
+export declare function checkIsConnectionLost(exitCode: number | null): boolean;
+export interface SshRunResult {
+    /**
+     * `null` when the call was cut off (a timeout, or the caller's own stop) — also when the ssh client had already exited by itself: its pipes are let go
+     * before `close` then, the output can be a part of what a master connection was still sending, and the client's own code must not vouch for it.
+     */
+    exitCode: number | null;
+    stdout: string;
+    stderr: string;
+    isTimedOut: boolean;
+}
+export interface SshRunParams {
+    runner: Pick<RunnerConfig, 'ssh' | 'sshOptions'>;
+    cacheDir: string;
+    remoteCommand: string;
+    /** Written to the command's stdin, then closed. */
+    input?: string;
+    /** The deadline; the ssh process is killed when it passes. */
+    timeoutMs: number;
+    /** Ends the call from outside (a caller's own, shared deadline): the ssh process is killed and the result says it was cut off. */
+    signal?: AbortSignal;
+}
+/** @description Run one command on the runner and collect its output, with a deadline. */
+export declare function runSshCommand(params: SshRunParams): Promise<SshRunResult>;
+/** @description Start a long-lived ssh command whose streams the caller handles itself (the lease, `exec`, `wait`); the caller owns its deadline and its end. */
+export declare function spawnSshStream(params: Omit<SshRunParams, 'input' | 'timeoutMs'>): ChildProcessWithoutNullStreams;
+/** @description Close the master connection of a runner (`ssh -O exit`), best effort: a lingering master is harmless (ControlPersist ends it) but a test wants none left. */
+export declare function closeSshMaster(runner: Pick<RunnerConfig, 'ssh' | 'sshOptions'>, cacheDir: string): Promise<void>;
+//# sourceMappingURL=ssh.d.ts.map

package/dist/remoteRun/ssh.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ssh.d.ts","sourceRoot":"","sources":["../../src/remoteRun/ssh.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,KAAK,8BAA8B,EAAE,MAAM,eAAe,CAAC;AAM3E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAmBpD,mKAAmK;AACnK,wBAAgB,oBAAoB,CAAC,GAAG,GAAE,MAAM,CAAC,UAAwB,EAAE,OAAO,GAAE,MAAqB,GAAG,MAAM,CAGjH;AAED,wEAAwE;AACxE,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAI9D;AAKD,mNAAmN;AACnN,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAE7D;AAED,oJAAoJ;AACpJ,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAErD;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAExD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,YAAY,CAAC,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAajG;AAID,kHAAkH;AAClH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAE3D;AAED,qJAAqJ;AACrJ,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEnD;AAED,0HAA0H;AAC1H,wBAAgB,cAAc,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAE/D;AAED,gIAAgI;AAChI,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,YAAY,CAAC,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEvG;AAED,+GAA+G;AAC/G,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAI1D;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,SAAS,GAAG,OAAO,CAAC,CAAC;IAChD,yBAAyB;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,uDAAuD;IACvD,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;CACzB;AAED,uJAAuJ;AACvJ,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,gBAAgB,GAAG,MAAM,CAOvE;AAED,6KAA6K;AAC7K,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAK1G;AAED,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAE1G;AAED,4EAA4E;AAC5E,eAAO,MAAM,kBAAkB,MAAM,CAAC;AAEtC;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAEtE;AAED,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,KAAK,GAAG,YAAY,CAAC,CAAC;IACjD,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,mDAAmD;IACnD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8DAA8D;IAC9D,SAAS,EAAE,MAAM,CAAC;IAClB,kIAAkI;IAClI,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,0FAA0F;AAC1F,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,CAkCzE;AAED,iKAAiK;AACjK,wBAAgB,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,WAAW,CAAC,GAAG,8BAA8B,CAEhH;AAED,6KAA6K;AAC7K,wBAAgB,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,KAAK,GAAG,YAAY,CAAC,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAahH"}

package/dist/remoteRun/ssh.js

@@ -0,0 +1,236 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sshFailureExitCode = void 0;
+exports.getRemoteRunCacheDir = getRemoteRunCacheDir;
+exports.ensureRemoteRunCacheDir = ensureRemoteRunCacheDir;
+exports.checkIsSshPathQuotable = checkIsSshPathQuotable;
+exports.escapeSshTokens = escapeSshTokens;
+exports.quoteSshOptionPath = quoteSshOptionPath;
+exports.buildSshArgs = buildSshArgs;
+exports.checkIsPlainShellWord = checkIsPlainShellWord;
+exports.quoteShellWord = quoteShellWord;
+exports.joinShellWords = joinShellWords;
+exports.buildRsyncSshCommand = buildRsyncSshCommand;
+exports.quoteRemotePath = quoteRemotePath;
+exports.buildRunnerScriptCommand = buildRunnerScriptCommand;
+exports.buildScriptUploadCommand = buildScriptUploadCommand;
+exports.buildScriptExistsCommand = buildScriptExistsCommand;
+exports.checkIsConnectionLost = checkIsConnectionLost;
+exports.runSshCommand = runSshCommand;
+exports.spawnSshStream = spawnSshStream;
+exports.closeSshMaster = closeSshMaster;
+const child_process_1 = require("child_process");
+const fs = __importStar(require("fs"));
+const os = __importStar(require("os"));
+const path = __importStar(require("path"));
+const tmuxExec_1 = require("../utils/tmuxExec");
+const interrupts_1 = require("./interrupts");
+/**
+ * @description Everything that touches ssh: the argument lists (pure, unit-tested), the quoting for the remote shell, and the process
+ * helpers. Always non-interactive (`BatchMode`: a password or an unknown host key is an error, never a prompt), host keys checked as the
+ * operator's ssh config says (never `StrictHostKeyChecking=no`), one master connection per runner shared by the several short calls of a
+ * run (`ControlMaster`), and every spawned command with a deadline: a blocked connection must end in time, not hang the agent.
+ */
+const connectTimeoutSeconds = 15;
+const serverAliveIntervalSeconds = 15;
+const serverAliveCountMax = 3;
+const controlPersistSeconds = 60;
+/** The longest a unix socket path may be (sun_path, with a margin); ssh refuses a longer ControlPath. */
+const unixSocketPathLimit = 100;
+/** `%C` in a ControlPath expands to a 40-character hash. */
+const controlPathHashLength = 40;
+const cacheDirectoryMode = 0o700;
+/** @description Where remote-run keeps its local cache (ssh control sockets, the last probe of each runner): `${XDG_CACHE_HOME:-~/.cache}/charness/remote-run`. */
+function getRemoteRunCacheDir(env = process.env, homeDir = os.homedir()) {
+    const cacheHome = env.XDG_CACHE_HOME !== undefined && env.XDG_CACHE_HOME !== '' ? env.XDG_CACHE_HOME : path.join(homeDir, '.cache');
+    return path.join(cacheHome, 'charness', 'remote-run');
+}
+/** @description Create the cache dir (mode 0700) and its ssh folder. */
+function ensureRemoteRunCacheDir(cacheDir) {
+    fs.mkdirSync(path.join(cacheDir, 'ssh'), { recursive: true, mode: cacheDirectoryMode });
+    fs.chmodSync(cacheDir, cacheDirectoryMode);
+    fs.chmodSync(path.join(cacheDir, 'ssh'), cacheDirectoryMode);
+}
+/** A path that holds one of these cannot reach ssh's option parser AND rsync's `-e` parser as the same single word. */
+const unquotablePathPattern = /["'\\$`\r\n]/;
+/** @description Can `value` be put into an ssh option or a command line that ssh and rsync's `-e` both read back as one word? (Whitespace can; a quote, a backslash, a `$`, a backtick or a line break cannot.) */
+function checkIsSshPathQuotable(value) {
+    return !unquotablePathPattern.test(value);
+}
+/** @description ssh expands `%`-tokens in a ProxyCommand, an identity file, a known-hosts path and a ControlPath: a literal `%` is written `%%`. */
+function escapeSshTokens(value) {
+    return value.replace(/%/g, '%%');
+}
+/**
+ * @description A path as the VALUE of an `-o` option. ssh reads `-o` like a line of its config file: `UserKnownHostsFile` there is a LIST of
+ * files separated by whitespace and `ControlPath` takes one word followed by nothing, so `/home/my user/…` would be two words and ssh would
+ * fail or look in the wrong place. Double quotes keep one path one word (ssh_config(5): «arguments may optionally be enclosed in double
+ * quotes»); `-i` takes its path as a plain argument and needs none.
+ */
+function quoteSshOptionPath(value) {
+    return /\s/.test(value) ? `"${value}"` : value;
+}
+/**
+ * @description The ssh options of every call to `runner` (without the destination): the operator's own first — ssh keeps the first value of an
+ * option — then ours. The shared connection is an optimisation: a cache path that is too long for a unix socket, or holds a character that
+ * cannot be quoted, turns it off instead of failing the call.
+ */
+function buildSshArgs(runner, cacheDir) {
+    const controlDirectory = path.join(cacheDir, 'ssh');
+    const isControlPathUsable = controlDirectory.length + 1 + controlPathHashLength <= unixSocketPathLimit && checkIsSshPathQuotable(controlDirectory);
+    return [
+        ...(runner.sshOptions ?? []),
+        '-o', 'BatchMode=yes',
+        '-o', `ConnectTimeout=${connectTimeoutSeconds}`,
+        '-o', `ServerAliveInterval=${serverAliveIntervalSeconds}`,
+        '-o', `ServerAliveCountMax=${serverAliveCountMax}`,
+        ...(isControlPathUsable
+            ? ['-o', 'ControlMaster=auto', '-o', `ControlPath=${quoteSshOptionPath(path.join(escapeSshTokens(controlDirectory), '%C'))}`, '-o', `ControlPersist=${controlPersistSeconds}`]
+            : ['-o', 'ControlMaster=no']),
+    ];
+}
+const safeWordPattern = /^[A-Za-z0-9_@%+=:,./-]+$/;
+/** @description Is `word` one that needs no quoting for a POSIX shell (and for ssh's and rsync's own parsers)? */
+function checkIsPlainShellWord(word) {
+    return safeWordPattern.test(word);
+}
+/** @description One word quoted for a POSIX shell (`shellSingleQuote`; an already plain word stays as it is, so the commands read well in a log). */
+function quoteShellWord(word) {
+    return word !== '' && checkIsPlainShellWord(word) ? word : (0, tmuxExec_1.shellSingleQuote)(word);
+}
+/** @description The words of an argument list as one string rsync's `-e` and a shell both read back as the same words. */
+function joinShellWords(words) {
+    return words.map(quoteShellWord).join(' ');
+}
+/** @description The `-e` command of rsync: `ssh <options> <destination>` is rsync's to complete, so this is `ssh <options>`. */
+function buildRsyncSshCommand(runner, cacheDir) {
+    return joinShellWords(['ssh', ...buildSshArgs(runner, cacheDir)]);
+}
+/** @description A path for the REMOTE shell: a leading `~` stays unquoted so the runner's shell expands it. */
+function quoteRemotePath(remotePath) {
+    if (remotePath === '~')
+        return '~';
+    if (remotePath.startsWith('~/'))
+        return `~/${quoteShellWord(remotePath.slice(2))}`;
+    return quoteShellWord(remotePath);
+}
+/** @description The command line that runs one subcommand of the uploaded script on the runner (Pueue's binary and config through the environment). */
+function buildRunnerScriptCommand(call) {
+    const environment = [
+        ...(call.runner.pueue?.bin === undefined ? [] : [`PUEUE_BIN=${quoteRemotePath(call.runner.pueue.bin)}`]),
+        ...(call.runner.pueue?.config === undefined ? [] : [`PUEUE_CONFIG=${quoteRemotePath(call.runner.pueue.config)}`]),
+    ];
+    const scriptPath = `${quoteRemotePath(call.runner.workDir)}/bin/${call.scriptName}`;
+    return [...environment, 'bash', scriptPath, call.subcommand, quoteRemotePath(call.runner.workDir), ...call.args.map(quoteShellWord)].join(' ');
+}
+/** @description The command that writes the script from stdin into `<workDir>/bin/` unless it is already there (a temp file and a rename, so a half upload is never run). */
+function buildScriptUploadCommand(runner, scriptName) {
+    const binDirectory = `${quoteRemotePath(runner.workDir)}/bin`;
+    const target = `${binDirectory}/${scriptName}`;
+    const temporary = `${binDirectory}/.${scriptName}.$$`;
+    return `mkdir -p ${binDirectory} && cat > ${temporary} && chmod 755 ${temporary} && mv -f ${temporary} ${target}`;
+}
+function buildScriptExistsCommand(runner, scriptName) {
+    return `test -f ${quoteRemotePath(runner.workDir)}/bin/${scriptName}`;
+}
+/** The exit status ssh itself reports when it could not run the command. */
+exports.sshFailureExitCode = 255;
+/**
+ * @description Did the ssh call end because the CONNECTION failed (ssh's own status 255, or a process that was killed), rather than
+ * because the command on the runner ended with a status of its own? The runner script's refusals exit 125 and a job's code is whatever its
+ * command returned, so only this one is worth opening the connection again for.
+ */
+function checkIsConnectionLost(exitCode) {
+    return exitCode === null || exitCode === exports.sshFailureExitCode;
+}
+/** @description Run one command on the runner and collect its output, with a deadline. */
+function runSshCommand(params) {
+    return new Promise((resolve) => {
+        const child = (0, child_process_1.spawn)('ssh', [...buildSshArgs(params.runner, params.cacheDir), params.runner.ssh, params.remoteCommand], { stdio: ['pipe', 'pipe', 'pipe'] });
+        let stdout = '';
+        let stderr = '';
+        let isTimedOut = false;
+        const cutOff = () => {
+            isTimedOut = true;
+            child.kill('SIGKILL');
+        };
+        const timer = setTimeout(cutOff, params.timeoutMs);
+        if (params.signal?.aborted === true)
+            cutOff();
+        else
+            params.signal?.addEventListener('abort', cutOff, { once: true });
+        const settle = () => {
+            clearTimeout(timer);
+            params.signal?.removeEventListener('abort', cutOff);
+        };
+        child.stdout.setEncoding('utf8');
+        child.stderr.setEncoding('utf8');
+        child.stdout.on('data', (chunk) => { stdout += chunk; });
+        child.stderr.on('data', (chunk) => { stderr += chunk; });
+        child.stdin.on('error', () => { });
+        child.on('error', (error) => {
+            settle();
+            resolve({ exitCode: exports.sshFailureExitCode, stdout, stderr: `${stderr}${error.message}\n`, isTimedOut });
+        });
+        // Once cut off, its `exit` is enough: after login this ssh is only a client of a ControlPersist master that holds its pipes, so `close` would
+        // come when the remote command ends (or the master gives up), not when the client is gone — the call, a probe's deadline or a Ctrl-C, would hang.
+        void (0, interrupts_1.waitForChildEnd)(child, () => isTimedOut).then((exitCode) => {
+            settle();
+            resolve({ exitCode: isTimedOut ? null : exitCode, stdout, stderr, isTimedOut });
+        });
+        child.stdin.end(params.input ?? '');
+    });
+}
+/** @description Start a long-lived ssh command whose streams the caller handles itself (the lease, `exec`, `wait`); the caller owns its deadline and its end. */
+function spawnSshStream(params) {
+    return (0, child_process_1.spawn)('ssh', [...buildSshArgs(params.runner, params.cacheDir), params.runner.ssh, params.remoteCommand], { stdio: ['pipe', 'pipe', 'pipe'] });
+}
+/** @description Close the master connection of a runner (`ssh -O exit`), best effort: a lingering master is harmless (ControlPersist ends it) but a test wants none left. */
+function closeSshMaster(runner, cacheDir) {
+    return new Promise((resolve) => {
+        const child = (0, child_process_1.spawn)('ssh', [...buildSshArgs(runner, cacheDir), '-O', 'exit', runner.ssh], { stdio: 'ignore' });
+        const timer = setTimeout(() => child.kill('SIGKILL'), connectTimeoutSeconds * 1000);
+        child.on('close', () => {
+            clearTimeout(timer);
+            resolve();
+        });
+        child.on('error', () => {
+            clearTimeout(timer);
+            resolve();
+        });
+    });
+}
+//# sourceMappingURL=ssh.js.map

package/dist/remoteRun/ssh.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ssh.js","sourceRoot":"","sources":["../../src/remoteRun/ssh.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,oDAGC;AAGD,0DAIC;AAMD,wDAEC;AAGD,0CAEC;AAQD,gDAEC;AAOD,oCAaC;AAKD,sDAEC;AAGD,wCAEC;AAGD,wCAEC;AAGD,oDAEC;AAGD,0CAIC;AAYD,4DAOC;AAGD,4DAKC;AAED,4DAEC;AAUD,sDAEC;AA0BD,sCAkCC;AAGD,wCAEC;AAGD,wCAaC;AAxOD,iDAA2E;AAC3E,uCAAyB;AACzB,uCAAyB;AACzB,2CAA6B;AAC7B,gDAAqD;AACrD,6CAA+C;AAG/C;;;;;GAKG;AAEH,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AACtC,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAC9B,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,yGAAyG;AACzG,MAAM,mBAAmB,GAAG,GAAG,CAAC;AAChC,4DAA4D;AAC5D,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,kBAAkB,GAAG,KAAK,CAAC;AAEjC,mKAAmK;AACnK,SAAgB,oBAAoB,CAAC,MAAyB,OAAO,CAAC,GAAG,EAAE,UAAkB,EAAE,CAAC,OAAO,EAAE;IACvG,MAAM,SAAS,GAAG,GAAG,CAAC,cAAc,KAAK,SAAS,IAAI,GAAG,CAAC,cAAc,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACpI,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;AACxD,CAAC;AAED,wEAAwE;AACxE,SAAgB,uBAAuB,CAAC,QAAgB;IACtD,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAC;IACxF,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;IAC3C,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,kBAAkB,CAAC,CAAC;AAC/D,CAAC;AAED,uHAAuH;AACvH,MAAM,qBAAqB,GAAG,cAAc,CAAC;AAE7C,mNAAmN;AACnN,SAAgB,sBAAsB,CAAC,KAAa;IAClD,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC5C,CAAC;AAED,oJAAoJ;AACpJ,SAAgB,eAAe,CAAC,KAAa;IAC3C,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AACnC,CAAC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,KAAa;IAC9C,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC;AACjD,CAAC;AAED;;;;GAIG;AACH,SAAgB,YAAY,CAAC,MAAwC,EAAE,QAAgB;IACrF,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACpD,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,MAAM,GAAG,CAAC,GAAG,qBAAqB,IAAI,mBAAmB,IAAI,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;IACnJ,OAAO;QACL,GAAG,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC;QAC5B,IAAI,EAAE,eAAe;QACrB,IAAI,EAAE,kBAAkB,qBAAqB,EAAE;QAC/C,IAAI,EAAE,uBAAuB,0BAA0B,EAAE;QACzD,IAAI,EAAE,uBAAuB,mBAAmB,EAAE;QAClD,GAAG,CAAC,mBAAmB;YACrB,CAAC,CAAC,CAAC,IAAI,EAAE,oBAAoB,EAAE,IAAI,EAAE,eAAe,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,kBAAkB,qBAAqB,EAAE,CAAC;YAC9K,CAAC,CAAC,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;KAChC,CAAC;AACJ,CAAC;AAED,MAAM,eAAe,GAAG,0BAA0B,CAAC;AAEnD,kHAAkH;AAClH,SAAgB,qBAAqB,CAAC,IAAY;IAChD,OAAO,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,qJAAqJ;AACrJ,SAAgB,cAAc,CAAC,IAAY;IACzC,OAAO,IAAI,KAAK,EAAE,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,2BAAgB,EAAC,IAAI,CAAC,CAAC;AACpF,CAAC;AAED,0HAA0H;AAC1H,SAAgB,cAAc,CAAC,KAAwB;IACrD,OAAO,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7C,CAAC;AAED,gIAAgI;AAChI,SAAgB,oBAAoB,CAAC,MAAwC,EAAE,QAAgB;IAC7F,OAAO,cAAc,CAAC,CAAC,KAAK,EAAE,GAAG,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;AACpE,CAAC;AAED,+GAA+G;AAC/G,SAAgB,eAAe,CAAC,UAAkB;IAChD,IAAI,UAAU,KAAK,GAAG;QAAE,OAAO,GAAG,CAAC;IACnC,IAAI,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,cAAc,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACnF,OAAO,cAAc,CAAC,UAAU,CAAC,CAAC;AACpC,CAAC;AAWD,uJAAuJ;AACvJ,SAAgB,wBAAwB,CAAC,IAAsB;IAC7D,MAAM,WAAW,GAAG;QAClB,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,aAAa,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACxG,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,gBAAgB,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;KAClH,CAAC;IACF,MAAM,UAAU,GAAG,GAAG,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,IAAI,CAAC,UAAU,EAAE,CAAC;IACpF,OAAO,CAAC,GAAG,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACjJ,CAAC;AAED,6KAA6K;AAC7K,SAAgB,wBAAwB,CAAC,MAAqC,EAAE,UAAkB;IAChG,MAAM,YAAY,GAAG,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;IAC9D,MAAM,MAAM,GAAG,GAAG,YAAY,IAAI,UAAU,EAAE,CAAC;IAC/C,MAAM,SAAS,GAAG,GAAG,YAAY,KAAK,UAAU,KAAK,CAAC;IACtD,OAAO,YAAY,YAAY,aAAa,SAAS,iBAAiB,SAAS,aAAa,SAAS,IAAI,MAAM,EAAE,CAAC;AACpH,CAAC;AAED,SAAgB,wBAAwB,CAAC,MAAqC,EAAE,UAAkB;IAChG,OAAO,WAAW,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,UAAU,EAAE,CAAC;AACxE,CAAC;AAED,4EAA4E;AAC/D,QAAA,kBAAkB,GAAG,GAAG,CAAC;AAEtC;;;;GAIG;AACH,SAAgB,qBAAqB,CAAC,QAAuB;IAC3D,OAAO,QAAQ,KAAK,IAAI,IAAI,QAAQ,KAAK,0BAAkB,CAAC;AAC9D,CAAC;AAyBD,0FAA0F;AAC1F,SAAgB,aAAa,CAAC,MAAoB;IAChD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,KAAK,GAAG,IAAA,qBAAK,EAAC,KAAK,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QAC5J,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,IAAI,UAAU,GAAG,KAAK,CAAC;QACvB,MAAM,MAAM,GAAG,GAAS,EAAE;YACxB,UAAU,GAAG,IAAI,CAAC;YAClB,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACxB,CAAC,CAAC;QACF,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QACnD,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI;YAAE,MAAM,EAAE,CAAC;;YACzC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACtE,MAAM,MAAM,GAAG,GAAS,EAAE;YACxB,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACtD,CAAC,CAAC;QACF,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACjC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACjC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE,GAAG,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACjE,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE,GAAG,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACjE,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,GAAoD,CAAC,CAAC,CAAC;QACpF,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC1B,MAAM,EAAE,CAAC;YACT,OAAO,CAAC,EAAE,QAAQ,EAAE,0BAAkB,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,KAAK,CAAC,OAAO,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;QACvG,CAAC,CAAC,CAAC;QACH,8IAA8I;QAC9I,kJAAkJ;QAClJ,KAAK,IAAA,4BAAe,EAAC,KAAK,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC9D,MAAM,EAAE,CAAC;YACT,OAAO,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;QAClF,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,iKAAiK;AACjK,SAAgB,cAAc,CAAC,MAAiD;IAC9E,OAAO,IAAA,qBAAK,EAAC,KAAK,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;AACvJ,CAAC;AAED,6KAA6K;AAC7K,SAAgB,cAAc,CAAC,MAAgD,EAAE,QAAgB;IAC/F,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,KAAK,GAAG,IAAA,qBAAK,EAAC,KAAK,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC/G,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC,CAAC;QACpF,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACrB,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACrB,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/remoteRun/submit.d.ts

@@ -0,0 +1,29 @@
+import type { RemoteRunOptions } from './cliArgs';
+import { type ProjectContext } from './project';
+import type { RunnerClient } from './runnerClient';
+/**
+ * @description Stage a job on a runner: send the project's files into `stage/<job>/` (only what changed crosses the network — unchanged
+ * files are copied from the runner's own copy), write the job's small files next to it, and leave it there. The job itself is added to
+ * Pueue by the caller (`lease` for a foreground run, `submit` for `--bg`); applying the files to the runner's copy is the JOB's step, so
+ * two runs of one project queue and each runs the tree as it was when IT was staged.
+ */
+export interface StagedJob {
+    jobId: string;
+    slug: string;
+    group: string;
+    timeoutSeconds: number;
+    /** The runner's work dir, absolute. */
+    workDir: string;
+}
+export declare function getJobOwner(): string;
+/** @description Stage the project for `command` on `client`'s runner; progress lines go through `say` (stderr). */
+export declare function stageJob(params: {
+    client: RunnerClient;
+    project: ProjectContext;
+    command: string;
+    options: RemoteRunOptions;
+    /** An empty folder the job's small files are written to before they are sent; the CALLER removes it (also when an interrupt ends the run). */
+    metaDirectory: string;
+    say: (line: string) => void;
+}): Promise<StagedJob>;
+//# sourceMappingURL=submit.d.ts.map

package/dist/remoteRun/submit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"submit.d.ts","sourceRoot":"","sources":["../../src/remoteRun/submit.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAOlD,OAAO,EAAmB,KAAK,cAAc,EAAE,MAAM,WAAW,CAAC;AAGjE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAInD;;;;;GAKG;AAEH,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,CAAC;IACvB,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAC;CACjB;AAID,wBAAgB,WAAW,IAAI,MAAM,CAEpC;AAeD,mHAAmH;AACnH,wBAAsB,QAAQ,CAAC,MAAM,EAAE;IACrC,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,EAAE,cAAc,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,gBAAgB,CAAC;IAC1B,8IAA8I;IAC9I,aAAa,EAAE,MAAM,CAAC;IACtB,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CAC7B,GAAG,OAAO,CAAC,SAAS,CAAC,CA2ErB"}