@ethlete/cli 3.0.0-next.16 → 3.0.0-next.18

package/src/lib/api/run-ready.js

@@ -0,0 +1,212 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runReadyCommand = exports.waitForHealth = exports.resolveProfileSeeds = exports.HEALTH_RETRY_MS = exports.HEALTH_TIMEOUT_MS = void 0;
+const tslib_1 = require("tslib");
+const fs_1 = require("fs");
+const promises_1 = require("timers/promises");
+const api_context_1 = require("./api-context");
+const api_state_1 = require("./api-state");
+const compose_1 = require("./compose");
+const doctor_1 = require("./doctor");
+const fingerprint_1 = require("./fingerprint");
+const lock_1 = require("./lock");
+const resolve_checkout_1 = require("./resolve-checkout");
+const run_locked_1 = require("./run-locked");
+const run_snapshot_1 = require("./run-snapshot");
+const seeds_1 = require("./seeds");
+const suggest_1 = require("./suggest");
+const snapshot_1 = require("./snapshot");
+exports.HEALTH_TIMEOUT_MS = 60000;
+exports.HEALTH_RETRY_MS = 2000;
+const has = (record, key) => Object.prototype.hasOwnProperty.call(record, key);
+/** Each name is `fixtures`, a seed of `.ethlete/seeds/<api>/seeds.json`, or an `exec` entry, checked in that order. */
+const resolveProfileSeeds = (options) => {
+    var _a, _b;
+    const { root, name, api, profileName, seeds } = options;
+    const manifest = (0, seeds_1.readSeedManifest)(root, name);
+    const units = [];
+    for (const seed of seeds) {
+        const fromManifest = manifest.ok && (seed === 'fixtures' ? manifest.value.fixtures !== undefined : has(manifest.value.seeds, seed))
+            ? (0, seeds_1.seedSteps)({
+                manifest: manifest.value,
+                names: seed === 'fixtures' ? [] : [seed],
+                withFixtures: seed === 'fixtures',
+                api: name,
+            })
+            : undefined;
+        if (fromManifest === null || fromManifest === void 0 ? void 0 : fromManifest.ok) {
+            const last = units[units.length - 1];
+            if ((last === null || last === void 0 ? void 0 : last.kind) === 'steps')
+                last.steps.push(...fromManifest.value);
+            else
+                units.push({ kind: 'steps', steps: [...fromManifest.value] });
+            continue;
+        }
+        if (((_a = api.exec) === null || _a === void 0 ? void 0 : _a[seed]) !== undefined) {
+            units.push({ kind: 'exec', name: seed });
+            continue;
+        }
+        const candidates = [
+            ...(manifest.ok && manifest.value.fixtures ? ['fixtures'] : []),
+            ...(manifest.ok ? Object.keys(manifest.value.seeds) : []),
+            ...Object.keys((_b = api.exec) !== null && _b !== void 0 ? _b : {}),
+        ];
+        return {
+            ok: false,
+            problem: `The ${profileName} profile of the ${name} API names "${seed}", which is no seed, fixtures list or exec entry.` +
+                `${(0, suggest_1.didYouMean)(seed, candidates)}\n\nKnown: ${candidates.length > 0 ? candidates.join(', ') : 'none'}` +
+                (manifest.ok ? '' : `\n\n${manifest.problem}`),
+        };
+    }
+    return { ok: true, value: units };
+};
+exports.resolveProfileSeeds = resolveProfileSeeds;
+/** GETs `url` until it answers `expect`, every `retryMs` for up to `timeoutMs`. */
+const waitForHealth = (options) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    const { url, expect, fetch: get = fetch, sleep = (ms) => tslib_1.__awaiter(void 0, void 0, void 0, function* () { return void (yield (0, promises_1.setTimeout)(ms)); }), now = Date.now, timeoutMs = exports.HEALTH_TIMEOUT_MS, retryMs = exports.HEALTH_RETRY_MS, } = options;
+    const startedAt = now();
+    for (;;) {
+        let last;
+        try {
+            const left = Math.max(1, timeoutMs - (now() - startedAt));
+            const response = yield get(url, { signal: AbortSignal.timeout(Math.min(retryMs * 5, left)) });
+            if (response.status === expect)
+                return { ok: true };
+            last = `status ${response.status}`;
+        }
+        catch (error) {
+            last = error.message;
+        }
+        if (now() - startedAt >= timeoutMs)
+            return { ok: false, last };
+        yield sleep(retryMs);
+    }
+});
+exports.waitForHealth = waitForHealth;
+const step = (text) => console.error(`\n==> ${text}`);
+/** Runs `ready <api> --profile <p>` and returns the exit code. */
+const runReadyCommand = (options) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c, _d, _e;
+    const { root, name, api, invocation, profile: profileName, wait, now = Date.now } = options;
+    const startedAt = now();
+    const profileNames = Object.keys((_a = api.profiles) !== null && _a !== void 0 ? _a : {});
+    const profile = profileName === undefined ? undefined : (_b = api.profiles) === null || _b === void 0 ? void 0 : _b[profileName];
+    if (profileName === undefined || profile === undefined) {
+        console.error((profileName === undefined
+            ? `ready needs a profile: ${invocation} ready ${name} --profile <profile>.`
+            : `The ${name} API has no profile "${profileName}".${(0, suggest_1.didYouMean)(profileName, profileNames)}`) +
+            `\n\nProfiles: ${profileNames.length > 0 ? profileNames.join(', ') : 'none'}`);
+        return 1;
+    }
+    const units = (0, exports.resolveProfileSeeds)({ root, name, api, profileName, seeds: profile.seeds });
+    if (!units.ok) {
+        console.error(units.problem);
+        return 1;
+    }
+    const context = (0, api_context_1.stateDirectoryOf)({ root, name, api });
+    if (!context.ok) {
+        console.error((0, resolve_checkout_1.checkoutProblem)({ failure: context, name, invocation }));
+        return 1;
+    }
+    const tool = (0, compose_1.resolveComposeTool)();
+    if (!tool) {
+        console.error(`No compose tool found. Tried: ${(0, compose_1.composeToolNames)().join(', ')}.`);
+        return 1;
+    }
+    const { checkout, directory } = context;
+    const env = Object.assign(Object.assign(Object.assign({}, (0, compose_1.engineEnv)(tool.engine)), process.env), (0, api_context_1.definedEntries)((_d = (_c = api.env) === null || _c === void 0 ? void 0 : _c.call(api)) !== null && _d !== void 0 ? _d : {}));
+    let token;
+    if ((0, lock_1.heldLockFromEnv)(directory)) {
+        step('Using the API lock this command runs under');
+    }
+    else {
+        step('Taking the API lock');
+        const acquired = yield (0, lock_1.acquireApiLock)({
+            directory,
+            command: `${invocation} ready ${name} --profile ${profileName}`,
+            cwd: root,
+            wait,
+            system: options.lockSystem,
+            onHeld: (holder) => console.error(`Waiting for the API lock, held by ${(0, lock_1.describeApiLock)(holder, directory)}.`),
+        });
+        if (!acquired.ok) {
+            console.error(`Gave up after ${wait} s. The API lock is held by ${(0, lock_1.describeApiLock)(acquired.holder, directory)}.`);
+            return run_locked_1.LOCK_TIMEOUT_EXIT_CODE;
+        }
+        token = acquired.lock.token;
+    }
+    try {
+        step(`Starting ${name}`);
+        const upCode = yield options.up();
+        if (upCode !== 0)
+            return upCode;
+        step('Checking the API (doctor --fix)');
+        if (!(0, doctor_1.runDoctor)({ name, api, tool, cwd: checkout.composePath, env, invocation, fix: true }).ok)
+            return 1;
+        const fingerprint = (0, fingerprint_1.fingerprintApi)({
+            root,
+            name,
+            repoPath: checkout.repoPath,
+            migrationsDir: api.migrationsDir,
+            seeds: profile.seeds,
+        });
+        const state = (0, api_state_1.readApiState)(directory);
+        const [binary, ...prefix] = tool.compose;
+        const compose = { binary, prefix, cwd: checkout.composePath, env };
+        const file = (0, snapshot_1.snapshotFilePath)({ root, api: name, name: profileName, fingerprint });
+        if (state && !state.dirty && state.profile === profileName && state.fingerprint === fingerprint) {
+            step(`Already ready: ${profileName} at ${fingerprint}`);
+        }
+        else if (profile.snapshot && (0, fs_1.existsSync)(file)) {
+            step(`Restoring the ${profileName} snapshot ${fingerprint}`);
+            const restored = yield (0, snapshot_1.restoreSnapshot)({
+                file,
+                snapshot: profile.snapshot,
+                compose,
+                state: { directory, profile: profileName, fingerprint },
+            });
+            if (restored !== 0)
+                return restored;
+        }
+        else {
+            (0, api_state_1.markApiStateDirty)(directory);
+            for (const unit of units.value) {
+                step(`Seeding ${unit.kind === 'exec' ? unit.name : unit.steps.map(({ label }) => label).join(', ')}`);
+                const seeded = yield options.runSeeds(unit);
+                if (seeded !== 0)
+                    return seeded;
+            }
+            if (profile.snapshot) {
+                step(`Saving the ${profileName} snapshot ${fingerprint}`);
+                (0, run_snapshot_1.warnUnlessSnapshotIgnored)(root, file);
+                const saved = yield (0, snapshot_1.saveSnapshot)({ file, snapshot: profile.snapshot, compose });
+                if (saved !== 0)
+                    return saved;
+            }
+            (0, api_state_1.writeApiState)({ directory, state: { profile: profileName, fingerprint, dirty: false } });
+        }
+        if (profile.health) {
+            const expect = (_e = profile.health.expect) !== null && _e !== void 0 ? _e : 200;
+            step(`Waiting for ${profile.health.url} to answer ${expect}`);
+            const health = yield (0, exports.waitForHealth)({
+                url: profile.health.url,
+                expect,
+                fetch: options.fetch,
+                sleep: options.sleep,
+                now,
+            });
+            if (!health.ok) {
+                console.error(`${profile.health.url} did not answer ${expect} within ${exports.HEALTH_TIMEOUT_MS / 1000} s. Last: ${health.last}.`);
+                return 1;
+            }
+        }
+        console.log(`${name} is ready: profile ${profileName}, fingerprint ${fingerprint}, in ${((now() - startedAt) / 1000).toFixed(1)} s.`);
+        return 0;
+    }
+    finally {
+        if (token !== undefined)
+            (0, lock_1.releaseApiLock)(directory, token);
+    }
+});
+exports.runReadyCommand = runReadyCommand;
+//# sourceMappingURL=run-ready.js.map

package/src/lib/api/run-ready.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run-ready.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/run-ready.ts"],"names":[],"mappings":";;;;AAAA,2BAAgC;AAChC,8CAAsD;AACtD,+CAAiE;AACjE,2CAA6E;AAC7E,uCAA4E;AAE5E,qCAAqC;AACrC,+CAA+C;AAC/C,iCAAsG;AACtG,yDAAqD;AACrD,6CAAsD;AACtD,iDAA2D;AAC3D,mCAAgE;AAChE,uCAAuC;AACvC,yCAA6E;AAOhE,QAAA,iBAAiB,GAAG,KAAM,CAAC;AAC3B,QAAA,eAAe,GAAG,IAAK,CAAC;AAErC,MAAM,GAAG,GAAG,CAAC,MAAc,EAAE,GAAW,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE/F,uHAAuH;AAChH,MAAM,mBAAmB,GAAG,CAAC,OAMnC,EAA2B,EAAE;;IAC5B,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IACxD,MAAM,QAAQ,GAAG,IAAA,wBAAgB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9C,MAAM,KAAK,GAAoB,EAAE,CAAC;IAElC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,YAAY,GAChB,QAAQ,CAAC,EAAE,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAC5G,CAAC,CAAC,IAAA,iBAAS,EAAC;gBACR,QAAQ,EAAE,QAAQ,CAAC,KAAK;gBACxB,KAAK,EAAE,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gBACxC,YAAY,EAAE,IAAI,KAAK,UAAU;gBACjC,GAAG,EAAE,IAAI;aACV,CAAC;YACJ,CAAC,CAAC,SAAS,CAAC;QAEhB,IAAI,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,EAAE,EAAE,CAAC;YACrB,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAErC,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,MAAK,OAAO;gBAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;;gBAC9D,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAEnE,SAAS;QACX,CAAC;QAED,IAAI,CAAA,MAAA,GAAG,CAAC,IAAI,0CAAG,IAAI,CAAC,MAAK,SAAS,EAAE,CAAC;YACnC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YAEzC,SAAS;QACX,CAAC;QAED,MAAM,UAAU,GAAG;YACjB,GAAG,CAAC,QAAQ,CAAC,EAAE,IAAI,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/D,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACzD,GAAG,MAAM,CAAC,IAAI,CAAC,MAAA,GAAG,CAAC,IAAI,mCAAI,EAAE,CAAC;SAC/B,CAAC;QAEF,OAAO;YACL,EAAE,EAAE,KAAK;YACT,OAAO,EACL,OAAO,WAAW,mBAAmB,IAAI,eAAe,IAAI,mDAAmD;gBAC/G,GAAG,IAAA,oBAAU,EAAC,IAAI,EAAE,UAAU,CAAC,cAAc,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE;gBACrG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,QAAQ,CAAC,OAAO,EAAE,CAAC;SACjD,CAAC;IACJ,CAAC;IAED,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AACpC,CAAC,CAAC;AArDW,QAAA,mBAAmB,uBAqD9B;AAEF,mFAAmF;AAC5E,MAAM,aAAa,GAAG,CAAO,OAQnC,EAAuD,EAAE;IACxD,MAAM,EACJ,GAAG,EACH,MAAM,EACN,KAAK,EAAE,GAAG,GAAG,KAAK,EAClB,KAAK,GAAG,CAAO,EAAE,EAAE,EAAE,0DAAC,OAAA,KAAK,CAAC,MAAM,IAAA,qBAAK,EAAC,EAAE,CAAC,CAAC,CAAA,GAAA,EAC5C,GAAG,GAAG,IAAI,CAAC,GAAG,EACd,SAAS,GAAG,yBAAiB,EAC7B,OAAO,GAAG,uBAAe,GAC1B,GAAG,OAAO,CAAC;IACZ,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC;IAExB,SAAS,CAAC;QACR,IAAI,IAAY,CAAC;QAEjB,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC;YAC1D,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;YAE9F,IAAI,QAAQ,CAAC,MAAM,KAAK,MAAM;gBAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC;YAEpD,IAAI,GAAG,UAAU,QAAQ,CAAC,MAAM,EAAE,CAAC;QACrC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,GAAI,KAAe,CAAC,OAAO,CAAC;QAClC,CAAC;QAED,IAAI,GAAG,EAAE,GAAG,SAAS,IAAI,SAAS;YAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAE/D,MAAM,KAAK,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC;AACH,CAAC,CAAA,CAAC;AAtCW,QAAA,aAAa,iBAsCxB;AAiBF,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;AAE9D,kEAAkE;AAC3D,MAAM,eAAe,GAAG,CAAO,OAAwB,EAAmB,EAAE;;IACjF,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC;IAC5F,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC;IACxB,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,MAAA,GAAG,CAAC,QAAQ,mCAAI,EAAE,CAAC,CAAC;IACrD,MAAM,OAAO,GAA2B,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAA,GAAG,CAAC,QAAQ,0CAAG,WAAW,CAAC,CAAC;IAE5G,IAAI,WAAW,KAAK,SAAS,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QACvD,OAAO,CAAC,KAAK,CACX,CAAC,WAAW,KAAK,SAAS;YACxB,CAAC,CAAC,0BAA0B,UAAU,UAAU,IAAI,uBAAuB;YAC3E,CAAC,CAAC,OAAO,IAAI,wBAAwB,WAAW,KAAK,IAAA,oBAAU,EAAC,WAAW,EAAE,YAAY,CAAC,EAAE,CAAC;YAC7F,iBAAiB,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAChF,CAAC;QAEF,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,KAAK,GAAG,IAAA,2BAAmB,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;IAE1F,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;QACd,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAE7B,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,OAAO,GAAG,IAAA,8BAAgB,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;IAEtD,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QAChB,OAAO,CAAC,KAAK,CAAC,IAAA,kCAAe,EAAC,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;QAEvE,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,IAAI,GAAG,IAAA,4BAAkB,GAAE,CAAC;IAElC,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,CAAC,KAAK,CAAC,iCAAiC,IAAA,0BAAgB,GAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEjF,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IACxC,MAAM,GAAG,iDAAQ,IAAA,mBAAS,EAAC,IAAI,CAAC,MAAM,CAAC,GAAK,OAAO,CAAC,GAAG,GAAK,IAAA,4BAAc,EAAC,MAAA,MAAA,GAAG,CAAC,GAAG,mDAAI,mCAAI,EAAE,CAAC,CAAE,CAAC;IAChG,IAAI,KAAyB,CAAC;IAE9B,IAAI,IAAA,sBAAe,EAAC,SAAS,CAAC,EAAE,CAAC;QAC/B,IAAI,CAAC,4CAA4C,CAAC,CAAC;IACrD,CAAC;SAAM,CAAC;QACN,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAE5B,MAAM,QAAQ,GAAG,MAAM,IAAA,qBAAc,EAAC;YACpC,SAAS;YACT,OAAO,EAAE,GAAG,UAAU,UAAU,IAAI,cAAc,WAAW,EAAE;YAC/D,GAAG,EAAE,IAAI;YACT,IAAI;YACJ,MAAM,EAAE,OAAO,CAAC,UAAU;YAC1B,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,qCAAqC,IAAA,sBAAe,EAAC,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC;SAC9G,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,OAAO,CAAC,KAAK,CAAC,iBAAiB,IAAI,+BAA+B,IAAA,sBAAe,EAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC;YAElH,OAAO,mCAAsB,CAAC;QAChC,CAAC;QAED,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;IAC9B,CAAC;IAED,IAAI,CAAC;QACH,IAAI,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;QAEzB,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,EAAE,EAAE,CAAC;QAElC,IAAI,MAAM,KAAK,CAAC;YAAE,OAAO,MAAM,CAAC;QAEhC,IAAI,CAAC,iCAAiC,CAAC,CAAC;QAExC,IAAI,CAAC,IAAA,kBAAS,EAAC,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE;YAAE,OAAO,CAAC,CAAC;QAExG,MAAM,WAAW,GAAG,IAAA,4BAAc,EAAC;YACjC,IAAI;YACJ,IAAI;YACJ,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,aAAa,EAAE,GAAG,CAAC,aAAa;YAChC,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,IAAA,wBAAY,EAAC,SAAS,CAAC,CAAC;QACtC,MAAM,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;QACzC,MAAM,OAAO,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC;QACnE,MAAM,IAAI,GAAG,IAAA,2BAAgB,EAAC,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,CAAC;QAEnF,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO,KAAK,WAAW,IAAI,KAAK,CAAC,WAAW,KAAK,WAAW,EAAE,CAAC;YAChG,IAAI,CAAC,kBAAkB,WAAW,OAAO,WAAW,EAAE,CAAC,CAAC;QAC1D,CAAC;aAAM,IAAI,OAAO,CAAC,QAAQ,IAAI,IAAA,eAAU,EAAC,IAAI,CAAC,EAAE,CAAC;YAChD,IAAI,CAAC,iBAAiB,WAAW,aAAa,WAAW,EAAE,CAAC,CAAC;YAE7D,MAAM,QAAQ,GAAG,MAAM,IAAA,0BAAe,EAAC;gBACrC,IAAI;gBACJ,QAAQ,EAAE,OAAO,CAAC,QAAQ;gBAC1B,OAAO;gBACP,KAAK,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE;aACxD,CAAC,CAAC;YAEH,IAAI,QAAQ,KAAK,CAAC;gBAAE,OAAO,QAAQ,CAAC;QACtC,CAAC;aAAM,CAAC;YACN,IAAA,6BAAiB,EAAC,SAAS,CAAC,CAAC;YAE7B,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;gBAC/B,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAEtG,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAE5C,IAAI,MAAM,KAAK,CAAC;oBAAE,OAAO,MAAM,CAAC;YAClC,CAAC;YAED,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACrB,IAAI,CAAC,cAAc,WAAW,aAAa,WAAW,EAAE,CAAC,CAAC;gBAC1D,IAAA,wCAAyB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAEtC,MAAM,KAAK,GAAG,MAAM,IAAA,uBAAY,EAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;gBAEhF,IAAI,KAAK,KAAK,CAAC;oBAAE,OAAO,KAAK,CAAC;YAChC,CAAC;YAED,IAAA,yBAAa,EAAC,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAC3F,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YACnB,MAAM,MAAM,GAAG,MAAA,OAAO,CAAC,MAAM,CAAC,MAAM,mCAAI,GAAG,CAAC;YAE5C,IAAI,CAAC,eAAe,OAAO,CAAC,MAAM,CAAC,GAAG,cAAc,MAAM,EAAE,CAAC,CAAC;YAE9D,MAAM,MAAM,GAAG,MAAM,IAAA,qBAAa,EAAC;gBACjC,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG;gBACvB,MAAM;gBACN,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,GAAG;aACJ,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CACX,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,mBAAmB,MAAM,WAAW,yBAAiB,GAAG,IAAI,aAAa,MAAM,CAAC,IAAI,GAAG,CAC7G,CAAC;gBAEF,OAAO,CAAC,CAAC;YACX,CAAC;QACH,CAAC;QAED,OAAO,CAAC,GAAG,CACT,GAAG,IAAI,sBAAsB,WAAW,iBAAiB,WAAW,QAAQ,CAAC,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CACzH,CAAC;QAEF,OAAO,CAAC,CAAC;IACX,CAAC;YAAS,CAAC;QACT,IAAI,KAAK,KAAK,SAAS;YAAE,IAAA,qBAAc,EAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAC5D,CAAC;AACH,CAAC,CAAA,CAAC;AA7JW,QAAA,eAAe,mBA6J1B"}

package/src/lib/api/run-snapshot.d.ts

@@ -0,0 +1,33 @@
+import { ApiDefinition, ApiProfile } from './definition';
+type Parsed<T> = {
+    ok: true;
+    value: T;
+} | {
+    ok: false;
+    problem: string;
+};
+/** `requested`, or the one profile with a `snapshot` block. */
+export declare const chooseSnapshotProfile: (options: {
+    name: string;
+    api: ApiDefinition;
+    requested: string | undefined;
+}) => Parsed<{
+    profileName: string;
+    profile: ApiProfile & {
+        snapshot: NonNullable<ApiProfile["snapshot"]>;
+    };
+}>;
+export declare const warnUnlessSnapshotIgnored: (root: string, file: string) => void;
+export type RunSnapshotOptions = {
+    root: string;
+    name: string;
+    api: ApiDefinition;
+    invocation: string;
+    action: string | undefined;
+    snapshotName: string | undefined;
+    profile: string | undefined;
+    wait: number | undefined;
+};
+/** Runs `snapshot save|restore <api> <name>` and returns the exit code. */
+export declare const runSnapshotCommand: (options: RunSnapshotOptions) => Promise<number>;
+export {};

package/src/lib/api/run-snapshot.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runSnapshotCommand = exports.warnUnlessSnapshotIgnored = exports.chooseSnapshotProfile = void 0;
+const tslib_1 = require("tslib");
+const path_1 = require("path");
+const api_context_1 = require("./api-context");
+const fingerprint_1 = require("./fingerprint");
+const git_1 = require("./git");
+const lock_1 = require("./lock");
+const run_locked_1 = require("./run-locked");
+const resolve_checkout_1 = require("./resolve-checkout");
+const compose_1 = require("./compose");
+const snapshot_1 = require("./snapshot");
+/** `requested`, or the one profile with a `snapshot` block. */
+const chooseSnapshotProfile = (options) => {
+    var _a, _b;
+    const { name, api, requested } = options;
+    const profiles = Object.entries((_a = api.profiles) !== null && _a !== void 0 ? _a : {});
+    const withSnapshot = profiles.filter(([, profile]) => profile.snapshot !== undefined);
+    const pick = (profileName, profile) => {
+        if (!profile) {
+            return {
+                ok: false,
+                problem: `The ${name} API has no profile "${profileName}". Profiles: ${profiles.map(([key]) => key).join(', ') || 'none'}`,
+            };
+        }
+        return profile.snapshot
+            ? { ok: true, value: { profileName, profile: Object.assign(Object.assign({}, profile), { snapshot: profile.snapshot }) } }
+            : { ok: false, problem: `The profile "${profileName}" of the ${name} API declares no snapshot.` };
+    };
+    if (requested !== undefined)
+        return pick(requested, (_b = api.profiles) === null || _b === void 0 ? void 0 : _b[requested]);
+    if (withSnapshot.length === 1) {
+        const [[profileName, profile]] = withSnapshot;
+        return pick(profileName, profile);
+    }
+    return {
+        ok: false,
+        problem: withSnapshot.length === 0
+            ? `The ${name} API has no profile with a snapshot block.`
+            : `The ${name} API has several profiles with a snapshot block. Choose one with --profile <name>: ${withSnapshot
+                .map(([key]) => key)
+                .join(', ')}`,
+    };
+};
+exports.chooseSnapshotProfile = chooseSnapshotProfile;
+const warnUnlessSnapshotIgnored = (root, file) => {
+    if ((0, git_1.ignoredByGit)(root, (0, path_1.relative)(root, file)) === false) {
+        console.warn(`${(0, path_1.relative)(root, file)} is not gitignored, so a snapshot could be committed. ` +
+            `Add "/.ethlete/snapshots/" to .gitignore.\n`);
+    }
+};
+exports.warnUnlessSnapshotIgnored = warnUnlessSnapshotIgnored;
+/** Runs `snapshot save|restore <api> <name>` and returns the exit code. */
+const runSnapshotCommand = (options) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
+    const { root, name, api, invocation, action, snapshotName, profile: requested, wait } = options;
+    const usage = `${invocation} snapshot save|restore <api> <name> [--profile <profile>]`;
+    if ((action !== 'save' && action !== 'restore') || snapshotName === undefined) {
+        console.error(`snapshot needs an action and a name: ${usage}`);
+        return 1;
+    }
+    if (!snapshot_1.SNAPSHOT_NAME.test(snapshotName)) {
+        console.error(`"${snapshotName}" is not a snapshot name. Use letters, digits, ".", "-" and "_".`);
+        return 1;
+    }
+    const chosen = (0, exports.chooseSnapshotProfile)({ name, api, requested });
+    if (!chosen.ok) {
+        console.error(chosen.problem);
+        return 1;
+    }
+    const context = (0, api_context_1.stateDirectoryOf)({ root, name, api, needs: 'env' });
+    if (!context.ok) {
+        console.error((0, resolve_checkout_1.checkoutProblem)({ failure: context, name, invocation }));
+        return 1;
+    }
+    const tool = (0, compose_1.resolveComposeTool)();
+    if (!tool) {
+        console.error(`No compose tool found. Tried: ${(0, compose_1.composeToolNames)().join(', ')}.`);
+        return 1;
+    }
+    const { profileName, profile } = chosen.value;
+    const { checkout, directory } = context;
+    const fingerprint = (0, fingerprint_1.fingerprintApi)({
+        root,
+        name,
+        repoPath: checkout.repoPath,
+        migrationsDir: api.migrationsDir,
+        seeds: profile.seeds,
+    });
+    const file = (0, snapshot_1.snapshotFilePath)({ root, api: name, name: snapshotName, fingerprint });
+    const [binary, ...prefix] = tool.compose;
+    const compose = {
+        binary,
+        prefix,
+        cwd: checkout.composePath,
+        env: Object.assign(Object.assign(Object.assign({}, (0, compose_1.engineEnv)(tool.engine)), process.env), (0, api_context_1.definedEntries)((_b = (_a = api.env) === null || _a === void 0 ? void 0 : _a.call(api)) !== null && _b !== void 0 ? _b : {})),
+    };
+    (0, exports.warnUnlessSnapshotIgnored)(root, file);
+    if (action === 'save')
+        return (0, snapshot_1.saveSnapshot)({ file, snapshot: profile.snapshot, compose });
+    const state = { directory, profile: profileName, fingerprint };
+    if ((0, lock_1.heldLockFromEnv)(directory))
+        return (0, snapshot_1.restoreSnapshot)({ file, snapshot: profile.snapshot, compose, state });
+    const acquired = yield (0, lock_1.acquireApiLock)({
+        directory,
+        command: `${invocation} snapshot restore ${name} ${snapshotName}`,
+        cwd: root,
+        wait,
+        onHeld: (holder) => console.error(`Waiting for the API lock, held by ${(0, lock_1.describeApiLock)(holder, directory)}.`),
+    });
+    if (!acquired.ok) {
+        console.error(`Gave up after ${wait} s. The API lock is held by ${(0, lock_1.describeApiLock)(acquired.holder, directory)}.`);
+        return run_locked_1.LOCK_TIMEOUT_EXIT_CODE;
+    }
+    try {
+        return yield (0, snapshot_1.restoreSnapshot)({ file, snapshot: profile.snapshot, compose, state });
+    }
+    finally {
+        (0, lock_1.releaseApiLock)(directory, acquired.lock.token);
+    }
+});
+exports.runSnapshotCommand = runSnapshotCommand;
+//# sourceMappingURL=run-snapshot.js.map

package/src/lib/api/run-snapshot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run-snapshot.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/run-snapshot.ts"],"names":[],"mappings":";;;;AAAA,+BAAgC;AAChC,+CAAiE;AAEjE,+CAA+C;AAC/C,+BAAqC;AACrC,iCAA0F;AAC1F,6CAAsD;AACtD,yDAAqD;AACrD,uCAA4E;AAC5E,yCAA4F;AAI5F,+DAA+D;AACxD,MAAM,qBAAqB,GAAG,CAAC,OAIrC,EAA4G,EAAE;;IAC7G,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IACzC,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,MAAA,GAAG,CAAC,QAAQ,mCAAI,EAAE,CAAC,CAAC;IACpD,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC;IAEtF,MAAM,IAAI,GAAG,CAAC,WAAmB,EAAE,OAA+B,EAA4C,EAAE;QAC9G,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO;gBACL,EAAE,EAAE,KAAK;gBACT,OAAO,EAAE,OAAO,IAAI,wBAAwB,WAAW,gBAAgB,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,EAAE;aAC3H,CAAC;QACJ,CAAC;QAED,OAAO,OAAO,CAAC,QAAQ;YACrB,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,WAAW,EAAE,OAAO,kCAAO,OAAO,KAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,GAAE,EAAE,EAAE;YAC3F,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,gBAAgB,WAAW,YAAY,IAAI,4BAA4B,EAAE,CAAC;IACtG,CAAC,CAAC;IAEF,IAAI,SAAS,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC,SAAS,EAAE,MAAA,GAAG,CAAC,QAAQ,0CAAG,SAAS,CAAC,CAAC,CAAC;IAE/E,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,MAAM,CAAC,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,GAAG,YAAsC,CAAC;QAExE,OAAO,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IACpC,CAAC;IAED,OAAO;QACL,EAAE,EAAE,KAAK;QACT,OAAO,EACL,YAAY,CAAC,MAAM,KAAK,CAAC;YACvB,CAAC,CAAC,OAAO,IAAI,4CAA4C;YACzD,CAAC,CAAC,OAAO,IAAI,sFAAsF,YAAY;iBAC1G,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC;iBACnB,IAAI,CAAC,IAAI,CAAC,EAAE;KACtB,CAAC;AACJ,CAAC,CAAC;AAvCW,QAAA,qBAAqB,yBAuChC;AAEK,MAAM,yBAAyB,GAAG,CAAC,IAAY,EAAE,IAAY,EAAE,EAAE;IACtE,IAAI,IAAA,kBAAY,EAAC,IAAI,EAAE,IAAA,eAAQ,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;QACvD,OAAO,CAAC,IAAI,CACV,GAAG,IAAA,eAAQ,EAAC,IAAI,EAAE,IAAI,CAAC,wDAAwD;YAC7E,6CAA6C,CAChD,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AAPW,QAAA,yBAAyB,6BAOpC;AAaF,2EAA2E;AACpE,MAAM,kBAAkB,GAAG,CAAO,OAA2B,EAAmB,EAAE;;IACvF,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAChG,MAAM,KAAK,GAAG,GAAG,UAAU,2DAA2D,CAAC;IAEvF,IAAI,CAAC,MAAM,KAAK,MAAM,IAAI,MAAM,KAAK,SAAS,CAAC,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;QAC9E,OAAO,CAAC,KAAK,CAAC,wCAAwC,KAAK,EAAE,CAAC,CAAC;QAE/D,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,CAAC,wBAAa,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;QACtC,OAAO,CAAC,KAAK,CAAC,IAAI,YAAY,kEAAkE,CAAC,CAAC;QAElG,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,MAAM,GAAG,IAAA,6BAAqB,EAAC,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC;IAE/D,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE9B,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,OAAO,GAAG,IAAA,8BAAgB,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAEpE,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QAChB,OAAO,CAAC,KAAK,CAAC,IAAA,kCAAe,EAAC,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;QAEvE,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,IAAI,GAAG,IAAA,4BAAkB,GAAE,CAAC;IAElC,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,CAAC,KAAK,CAAC,iCAAiC,IAAA,0BAAgB,GAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEjF,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC;IAC9C,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IACxC,MAAM,WAAW,GAAG,IAAA,4BAAc,EAAC;QACjC,IAAI;QACJ,IAAI;QACJ,QAAQ,EAAE,QAAQ,CAAC,QAAQ;QAC3B,aAAa,EAAE,GAAG,CAAC,aAAa;QAChC,KAAK,EAAE,OAAO,CAAC,KAAK;KACrB,CAAC,CAAC;IACH,MAAM,IAAI,GAAG,IAAA,2BAAgB,EAAC,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAC;IACpF,MAAM,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;IACzC,MAAM,OAAO,GAAG;QACd,MAAM;QACN,MAAM;QACN,GAAG,EAAE,QAAQ,CAAC,WAAW;QACzB,GAAG,gDAAO,IAAA,mBAAS,EAAC,IAAI,CAAC,MAAM,CAAC,GAAK,OAAO,CAAC,GAAG,GAAK,IAAA,4BAAc,EAAC,MAAA,MAAA,GAAG,CAAC,GAAG,mDAAI,mCAAI,EAAE,CAAC,CAAE;KACzF,CAAC;IAEF,IAAA,iCAAyB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAEtC,IAAI,MAAM,KAAK,MAAM;QAAE,OAAO,IAAA,uBAAY,EAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;IAE1F,MAAM,KAAK,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC;IAE/D,IAAI,IAAA,sBAAe,EAAC,SAAS,CAAC;QAAE,OAAO,IAAA,0BAAe,EAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IAE7G,MAAM,QAAQ,GAAG,MAAM,IAAA,qBAAc,EAAC;QACpC,SAAS;QACT,OAAO,EAAE,GAAG,UAAU,qBAAqB,IAAI,IAAI,YAAY,EAAE;QACjE,GAAG,EAAE,IAAI;QACT,IAAI;QACJ,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,qCAAqC,IAAA,sBAAe,EAAC,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC;KAC9G,CAAC,CAAC;IAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,KAAK,CAAC,iBAAiB,IAAI,+BAA+B,IAAA,sBAAe,EAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC;QAElH,OAAO,mCAAsB,CAAC;IAChC,CAAC;IAED,IAAI,CAAC;QACH,OAAO,MAAM,IAAA,0BAAe,EAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IACrF,CAAC;YAAS,CAAC;QACT,IAAA,qBAAc,EAAC,SAAS,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjD,CAAC;AACH,CAAC,CAAA,CAAC;AArFW,QAAA,kBAAkB,sBAqF7B"}

package/src/lib/api/run-status.d.ts

@@ -0,0 +1,9 @@
+import { ApiDefinition } from './definition';
+/** Prints profile, fingerprints, dirty flag, snapshot and lock holder of one API. Always exit 0 unless the checkout is missing. */
+export declare const runStatusCommand: (options: {
+    root: string;
+    name: string;
+    api: ApiDefinition;
+    invocation: string;
+    profile: string | undefined;
+}) => 0 | 1;

package/src/lib/api/run-status.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runStatusCommand = void 0;
+const api_context_1 = require("./api-context");
+const api_state_1 = require("./api-state");
+const fingerprint_1 = require("./fingerprint");
+const fs_1 = require("fs");
+const lock_1 = require("./lock");
+const resolve_checkout_1 = require("./resolve-checkout");
+const snapshot_1 = require("./snapshot");
+/** Prints profile, fingerprints, dirty flag, snapshot and lock holder of one API. Always exit 0 unless the checkout is missing. */
+const runStatusCommand = (options) => {
+    var _a, _b, _c;
+    const { root, name, api, invocation, profile: requested } = options;
+    const context = (0, api_context_1.stateDirectoryOf)({ root, name, api });
+    if (!context.ok) {
+        console.error((0, resolve_checkout_1.checkoutProblem)({ failure: context, name, invocation }));
+        return 1;
+    }
+    const { checkout, directory } = context;
+    const state = (0, api_state_1.readApiState)(directory);
+    const profileName = (_a = requested !== null && requested !== void 0 ? requested : state === null || state === void 0 ? void 0 : state.profile) !== null && _a !== void 0 ? _a : undefined;
+    const profile = profileName === undefined ? undefined : (_b = api.profiles) === null || _b === void 0 ? void 0 : _b[profileName];
+    const current = profile
+        ? (0, fingerprint_1.fingerprintApi)({
+            root,
+            name,
+            repoPath: checkout.repoPath,
+            migrationsDir: api.migrationsDir,
+            seeds: profile.seeds,
+        })
+        : undefined;
+    const snapshots = current === undefined ? [] : (0, snapshot_1.listSnapshots)({ root, api: name, fingerprint: current });
+    const lock = (0, lock_1.readApiLock)(directory);
+    const rows = [
+        ['profile', profileName !== null && profileName !== void 0 ? profileName : 'none'],
+        ['stored', (_c = state === null || state === void 0 ? void 0 : state.fingerprint) !== null && _c !== void 0 ? _c : 'none'],
+        ['current', current !== null && current !== void 0 ? current : (profileName === undefined ? 'none' : `no profile "${profileName}"`)],
+        ['dirty', state ? (state.dirty ? 'yes' : 'no') : 'unknown'],
+        ['snapshot', snapshots.length > 0 ? snapshots.join(', ') : 'none for the current fingerprint'],
+        [
+            'lock',
+            lock
+                ? (0, lock_1.describeApiLock)(lock, directory)
+                : (0, fs_1.existsSync)((0, lock_1.lockPath)(directory))
+                    ? `unreadable (${(0, lock_1.lockPath)(directory)})`
+                    : 'free',
+        ],
+    ];
+    const width = Math.max(...rows.map(([label]) => label.length));
+    console.log(rows.map(([label, value]) => `  ${label.padEnd(width)}  ${value}`).join('\n'));
+    return 0;
+};
+exports.runStatusCommand = runStatusCommand;
+//# sourceMappingURL=run-status.js.map

package/src/lib/api/run-status.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run-status.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/run-status.ts"],"names":[],"mappings":";;;AAAA,+CAAiD;AACjD,2CAA2C;AAE3C,+CAA+C;AAC/C,2BAAgC;AAChC,iCAAgE;AAChE,yDAAqD;AACrD,yCAA2C;AAE3C,mIAAmI;AAC5H,MAAM,gBAAgB,GAAG,CAAC,OAMhC,EAAE,EAAE;;IACH,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IACpE,MAAM,OAAO,GAAG,IAAA,8BAAgB,EAAC,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;IAEtD,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QAChB,OAAO,CAAC,KAAK,CAAC,IAAA,kCAAe,EAAC,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;QAEvE,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IACxC,MAAM,KAAK,GAAG,IAAA,wBAAY,EAAC,SAAS,CAAC,CAAC;IACtC,MAAM,WAAW,GAAG,MAAA,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,mCAAI,SAAS,CAAC;IAC7D,MAAM,OAAO,GAAG,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAA,GAAG,CAAC,QAAQ,0CAAG,WAAW,CAAC,CAAC;IACpF,MAAM,OAAO,GAAG,OAAO;QACrB,CAAC,CAAC,IAAA,4BAAc,EAAC;YACb,IAAI;YACJ,IAAI;YACJ,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,aAAa,EAAE,GAAG,CAAC,aAAa;YAChC,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC;QACJ,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,SAAS,GAAG,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAA,wBAAa,EAAC,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;IACxG,MAAM,IAAI,GAAG,IAAA,kBAAW,EAAC,SAAS,CAAC,CAAC;IACpC,MAAM,IAAI,GAAuB;QAC/B,CAAC,SAAS,EAAE,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,MAAM,CAAC;QAClC,CAAC,QAAQ,EAAE,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,WAAW,mCAAI,MAAM,CAAC;QACxC,CAAC,SAAS,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,eAAe,WAAW,GAAG,CAAC,CAAC;QAC5F,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3D,CAAC,UAAU,EAAE,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,kCAAkC,CAAC;QAC9F;YACE,MAAM;YACN,IAAI;gBACF,CAAC,CAAC,IAAA,sBAAe,EAAC,IAAI,EAAE,SAAS,CAAC;gBAClC,CAAC,CAAC,IAAA,eAAU,EAAC,IAAA,eAAQ,EAAC,SAAS,CAAC,CAAC;oBAC/B,CAAC,CAAC,eAAe,IAAA,eAAQ,EAAC,SAAS,CAAC,GAAG;oBACvC,CAAC,CAAC,MAAM;SACb;KACF,CAAC;IACF,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IAE/D,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAE3F,OAAO,CAAC,CAAC;AACX,CAAC,CAAC;AAnDW,QAAA,gBAAgB,oBAmD3B"}

package/src/lib/api/run.d.ts

@@ -7,4 +7,4 @@ export type RunApiCommandOptions = {
     /** How the caller is invoked, used in the usage line. */
     invocation?: string;
 };
-export declare const runApiCommand: ({ apis, argv, root, invocation, }: RunApiCommandOptions) => Promise<number>;
+export declare const runApiCommand: ({ apis, argv: rawArgv, root, invocation, }: RunApiCommandOptions) => Promise<number>;