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

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

@@ -0,0 +1,63 @@
+import { ApiProfile } from './definition';
+export type ApiSnapshotConfig = NonNullable<ApiProfile['snapshot']>;
+/** How to reach the container engine: the compose binary with its fixed arguments, in the API's compose directory. */
+export type ComposeInvocation = {
+    binary: string;
+    prefix: string[];
+    cwd: string;
+    env: NodeJS.ProcessEnv;
+};
+export declare const SNAPSHOT_NAME: RegExp;
+export declare const snapshotsDirectory: (root: string, api: string) => string;
+export declare const snapshotFileName: (options: {
+    name: string;
+    fingerprint: string;
+}) => string;
+export declare const snapshotFilePath: (options: {
+    root: string;
+    api: string;
+    name: string;
+    fingerprint: string;
+}) => string;
+/** The snapshot files of one API, or only the ones made for `fingerprint`. */
+export declare const listSnapshots: (options: {
+    root: string;
+    api: string;
+    fingerprint?: string;
+}) => string[];
+/** Pipes `producer`'s stdout through gzip into `file`, which appears only when the producer exits 0. */
+export declare const pipeToGzipFile: (options: {
+    command: string;
+    args: string[];
+    cwd?: string;
+    env?: NodeJS.ProcessEnv;
+    file: string;
+}) => Promise<number>;
+/** Pipes the gunzipped `file` into the stdin of `consumer` and returns its exit code. */
+export declare const pipeFromGzipFile: (options: {
+    command: string;
+    args: string[];
+    cwd?: string;
+    env?: NodeJS.ProcessEnv;
+    file: string;
+}) => Promise<number>;
+/** Dumps the profile's databases into `file`. Safe to call while holding the API lock. */
+export declare const saveSnapshot: (options: {
+    file: string;
+    snapshot: ApiSnapshotConfig;
+    compose: ComposeInvocation;
+}) => Promise<number>;
+/**
+ * Loads `file` into the profile's databases. With `state`, a success records the API as clean for that
+ * profile and fingerprint and a failure marks it dirty. Safe to call while holding the API lock.
+ */
+export declare const restoreSnapshot: (options: {
+    file: string;
+    snapshot: ApiSnapshotConfig;
+    compose: ComposeInvocation;
+    state?: {
+        directory: string;
+        profile: string;
+        fingerprint: string;
+    };
+}) => Promise<number>;

package/src/lib/api/snapshot.js

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.restoreSnapshot = exports.saveSnapshot = exports.pipeFromGzipFile = exports.pipeToGzipFile = exports.listSnapshots = exports.snapshotFilePath = exports.snapshotFileName = exports.snapshotsDirectory = exports.SNAPSHOT_NAME = void 0;
+const tslib_1 = require("tslib");
+const child_process_1 = require("child_process");
+const crypto_1 = require("crypto");
+const fs_1 = require("fs");
+const path_1 = require("path");
+const promises_1 = require("stream/promises");
+const zlib_1 = require("zlib");
+const api_state_1 = require("./api-state");
+const clone_1 = require("./clone");
+const seeds_1 = require("./seeds");
+const SNAPSHOT_SUFFIX = '.sql.gz';
+exports.SNAPSHOT_NAME = /^[\w.-]+$/;
+const snapshotsDirectory = (root, api) => (0, path_1.join)(root, clone_1.DEFAULT_CHECKOUT_DIR, 'snapshots', api);
+exports.snapshotsDirectory = snapshotsDirectory;
+const snapshotFileName = (options) => `${options.name}-${options.fingerprint}${SNAPSHOT_SUFFIX}`;
+exports.snapshotFileName = snapshotFileName;
+const snapshotFilePath = (options) => (0, path_1.join)((0, exports.snapshotsDirectory)(options.root, options.api), (0, exports.snapshotFileName)(options));
+exports.snapshotFilePath = snapshotFilePath;
+/** The snapshot files of one API, or only the ones made for `fingerprint`. */
+const listSnapshots = (options) => {
+    const directory = (0, exports.snapshotsDirectory)(options.root, options.api);
+    if (!(0, fs_1.existsSync)(directory))
+        return [];
+    return (0, fs_1.readdirSync)(directory)
+        .filter((file) => file.endsWith(SNAPSHOT_SUFFIX))
+        .filter((file) => options.fingerprint === undefined || file.endsWith(`-${options.fingerprint}${SNAPSHOT_SUFFIX}`))
+        .sort();
+};
+exports.listSnapshots = listSnapshots;
+const snapshotScript = (snapshot, line) => `export DATABASES=${(0, seeds_1.shellQuote)(snapshot.databases.join(' '))}\n${line}`;
+const composeExecArgs = (options) => [
+    ...options.compose.prefix,
+    'exec',
+    '-T',
+    options.snapshot.service,
+    'sh',
+    '-c',
+    snapshotScript(options.snapshot, options.line),
+];
+const exitCodeOf = (child) => new Promise((resolve) => {
+    child.once('error', (error) => {
+        console.error(`Could not run ${(0, path_1.basename)(child.spawnfile)}: ${error.message}`);
+        resolve(127);
+    });
+    child.once('close', (code, signal) => resolve(code !== null && code !== void 0 ? code : (signal ? 128 : 1)));
+});
+/** Pipes `producer`'s stdout through gzip into `file`, which appears only when the producer exits 0. */
+const pipeToGzipFile = (options) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    const { command, args, cwd, env, file } = options;
+    const temporary = `${file}.${(0, crypto_1.randomUUID)()}.tmp`;
+    (0, fs_1.mkdirSync)((0, path_1.dirname)(file), { recursive: true });
+    const child = (0, child_process_1.spawn)(command, args, { cwd, env, stdio: ['ignore', 'pipe', 'inherit'] });
+    const code = exitCodeOf(child);
+    const written = child.stdout
+        ? (0, promises_1.pipeline)(child.stdout, (0, zlib_1.createGzip)(), (0, fs_1.createWriteStream)(temporary)).then(() => true, () => false)
+        : Promise.resolve(false);
+    const [exitCode, complete] = yield Promise.all([code, written]);
+    if (exitCode === 0 && complete) {
+        (0, fs_1.renameSync)(temporary, file);
+        return 0;
+    }
+    (0, fs_1.rmSync)(temporary, { force: true });
+    return exitCode === 0 ? 1 : exitCode;
+});
+exports.pipeToGzipFile = pipeToGzipFile;
+/** Pipes the gunzipped `file` into the stdin of `consumer` and returns its exit code. */
+const pipeFromGzipFile = (options) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    const { command, args, cwd, env, file } = options;
+    const child = (0, child_process_1.spawn)(command, args, { cwd, env, stdio: ['pipe', 'inherit', 'inherit'] });
+    const code = exitCodeOf(child);
+    const read = child.stdin
+        ? (0, promises_1.pipeline)((0, fs_1.createReadStream)(file), (0, zlib_1.createGunzip)(), child.stdin).then(() => true, () => false)
+        : Promise.resolve(false);
+    const [exitCode, complete] = yield Promise.all([code, read]);
+    return exitCode === 0 && !complete ? 1 : exitCode;
+});
+exports.pipeFromGzipFile = pipeFromGzipFile;
+/** Dumps the profile's databases into `file`. Safe to call while holding the API lock. */
+const saveSnapshot = (options) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    const { file, snapshot, compose } = options;
+    const code = yield (0, exports.pipeToGzipFile)({
+        command: compose.binary,
+        args: composeExecArgs({ compose, snapshot, line: snapshot.save }),
+        cwd: compose.cwd,
+        env: compose.env,
+        file,
+    });
+    if (code !== 0)
+        console.error(`Saving the snapshot failed with exit code ${code}. Nothing was written to ${file}.`);
+    return code;
+});
+exports.saveSnapshot = saveSnapshot;
+/**
+ * Loads `file` into the profile's databases. With `state`, a success records the API as clean for that
+ * profile and fingerprint and a failure marks it dirty. Safe to call while holding the API lock.
+ */
+const restoreSnapshot = (options) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+    const { file, snapshot, compose, state } = options;
+    if (!(0, fs_1.existsSync)(file)) {
+        const directory = (0, path_1.dirname)(file);
+        const names = (0, fs_1.existsSync)(directory) ? (0, fs_1.readdirSync)(directory).filter((name) => name.endsWith(SNAPSHOT_SUFFIX)) : [];
+        console.error(names.length === 0
+            ? `No snapshot at ${file}, and none exist for this API.`
+            : `No snapshot at ${file}. These exist:\n\n${names.map((name) => `  ${name}`).join('\n')}`);
+        return 1;
+    }
+    const code = yield (0, exports.pipeFromGzipFile)({
+        command: compose.binary,
+        args: composeExecArgs({ compose, snapshot, line: snapshot.restore }),
+        cwd: compose.cwd,
+        env: compose.env,
+        file,
+    });
+    if (code !== 0) {
+        console.error(`Restoring the snapshot failed with exit code ${code}.`);
+        if (state)
+            (0, api_state_1.markApiStateDirty)(state.directory);
+        return code;
+    }
+    if (state) {
+        (0, api_state_1.writeApiState)({
+            directory: state.directory,
+            state: { profile: state.profile, fingerprint: state.fingerprint, dirty: false },
+        });
+    }
+    return 0;
+});
+exports.restoreSnapshot = restoreSnapshot;
+//# sourceMappingURL=snapshot.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/snapshot.ts"],"names":[],"mappings":";;;;AAAA,iDAAoD;AACpD,mCAAoC;AACpC,2BAAiH;AACjH,+BAA+C;AAC/C,8CAA2C;AAC3C,+BAAgD;AAChD,2CAA+D;AAE/D,mCAA+C;AAC/C,mCAAqC;AAYrC,MAAM,eAAe,GAAG,SAAS,CAAC;AAErB,QAAA,aAAa,GAAG,WAAW,CAAC;AAElC,MAAM,kBAAkB,GAAG,CAAC,IAAY,EAAE,GAAW,EAAE,EAAE,CAAC,IAAA,WAAI,EAAC,IAAI,EAAE,4BAAoB,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC;AAAvG,QAAA,kBAAkB,sBAAqF;AAE7G,MAAM,gBAAgB,GAAG,CAAC,OAA8C,EAAE,EAAE,CACjF,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,WAAW,GAAG,eAAe,EAAE,CAAC;AADhD,QAAA,gBAAgB,oBACgC;AAEtD,MAAM,gBAAgB,GAAG,CAAC,OAAyE,EAAE,EAAE,CAC5G,IAAA,WAAI,EAAC,IAAA,0BAAkB,EAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,IAAA,wBAAgB,EAAC,OAAO,CAAC,CAAC,CAAC;AADpE,QAAA,gBAAgB,oBACoD;AAEjF,8EAA8E;AACvE,MAAM,aAAa,GAAG,CAAC,OAA4D,EAAE,EAAE;IAC5F,MAAM,SAAS,GAAG,IAAA,0BAAkB,EAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IAEhE,IAAI,CAAC,IAAA,eAAU,EAAC,SAAS,CAAC;QAAE,OAAO,EAAE,CAAC;IAEtC,OAAO,IAAA,gBAAW,EAAC,SAAS,CAAC;SAC1B,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;SAChD,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,OAAO,CAAC,WAAW,GAAG,eAAe,EAAE,CAAC,CAAC;SACjH,IAAI,EAAE,CAAC;AACZ,CAAC,CAAC;AATW,QAAA,aAAa,iBASxB;AAEF,MAAM,cAAc,GAAG,CAAC,QAA2B,EAAE,IAAY,EAAE,EAAE,CACnE,oBAAoB,IAAA,kBAAU,EAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;AAE1E,MAAM,eAAe,GAAG,CAAC,OAAkF,EAAE,EAAE,CAAC;IAC9G,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM;IACzB,MAAM;IACN,IAAI;IACJ,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,IAAI;IACJ,IAAI;IACJ,cAAc,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC;CAC/C,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,KAAmB,EAAE,EAAE,CACzC,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,EAAE;IAC9B,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;QAC5B,OAAO,CAAC,KAAK,CAAC,iBAAiB,IAAA,eAAQ,EAAC,KAAK,CAAC,SAAS,CAAC,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAC9E,OAAO,CAAC,GAAG,CAAC,CAAC;IACf,CAAC,CAAC,CAAC;IACH,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7E,CAAC,CAAC,CAAC;AAEL,wGAAwG;AACjG,MAAM,cAAc,GAAG,CAAO,OAMpC,EAAE,EAAE;IACH,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAClD,MAAM,SAAS,GAAG,GAAG,IAAI,IAAI,IAAA,mBAAU,GAAE,MAAM,CAAC;IAEhD,IAAA,cAAS,EAAC,IAAA,cAAO,EAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAE9C,MAAM,KAAK,GAAG,IAAA,qBAAK,EAAC,OAAO,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC;IACvF,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IAC/B,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM;QAC1B,CAAC,CAAC,IAAA,mBAAQ,EAAC,KAAK,CAAC,MAAM,EAAE,IAAA,iBAAU,GAAE,EAAE,IAAA,sBAAiB,EAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CACrE,GAAG,EAAE,CAAC,IAAI,EACV,GAAG,EAAE,CAAC,KAAK,CACZ;QACH,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC3B,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAEhE,IAAI,QAAQ,KAAK,CAAC,IAAI,QAAQ,EAAE,CAAC;QAC/B,IAAA,eAAU,EAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAE5B,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAA,WAAM,EAAC,SAAS,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAEnC,OAAO,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;AACvC,CAAC,CAAA,CAAC;AA/BW,QAAA,cAAc,kBA+BzB;AAEF,yFAAyF;AAClF,MAAM,gBAAgB,GAAG,CAAO,OAMtC,EAAE,EAAE;IACH,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAClD,MAAM,KAAK,GAAG,IAAA,qBAAK,EAAC,OAAO,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC;IACxF,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IAC/B,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK;QACtB,CAAC,CAAC,IAAA,mBAAQ,EAAC,IAAA,qBAAgB,EAAC,IAAI,CAAC,EAAE,IAAA,mBAAY,GAAE,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAChE,GAAG,EAAE,CAAC,IAAI,EACV,GAAG,EAAE,CAAC,KAAK,CACZ;QACH,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC3B,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IAE7D,OAAO,QAAQ,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;AACpD,CAAC,CAAA,CAAC;AAnBW,QAAA,gBAAgB,oBAmB3B;AAEF,0FAA0F;AACnF,MAAM,YAAY,GAAG,CAAO,OAIlC,EAAmB,EAAE;IACpB,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAC5C,MAAM,IAAI,GAAG,MAAM,IAAA,sBAAc,EAAC;QAChC,OAAO,EAAE,OAAO,CAAC,MAAM;QACvB,IAAI,EAAE,eAAe,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC;QACjE,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,IAAI;KACL,CAAC,CAAC;IAEH,IAAI,IAAI,KAAK,CAAC;QAAE,OAAO,CAAC,KAAK,CAAC,6CAA6C,IAAI,4BAA4B,IAAI,GAAG,CAAC,CAAC;IAEpH,OAAO,IAAI,CAAC;AACd,CAAC,CAAA,CAAC;AAjBW,QAAA,YAAY,gBAiBvB;AAEF;;;GAGG;AACI,MAAM,eAAe,GAAG,CAAO,OAKrC,EAAmB,EAAE;IACpB,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IAEnD,IAAI,CAAC,IAAA,eAAU,EAAC,IAAI,CAAC,EAAE,CAAC;QACtB,MAAM,SAAS,GAAG,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;QAChC,MAAM,KAAK,GAAG,IAAA,eAAU,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAA,gBAAW,EAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAEnH,OAAO,CAAC,KAAK,CACX,KAAK,CAAC,MAAM,KAAK,CAAC;YAChB,CAAC,CAAC,kBAAkB,IAAI,gCAAgC;YACxD,CAAC,CAAC,kBAAkB,IAAI,qBAAqB,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC7F,CAAC;QAEF,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,IAAA,wBAAgB,EAAC;QAClC,OAAO,EAAE,OAAO,CAAC,MAAM;QACvB,IAAI,EAAE,eAAe,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;QACpE,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,IAAI;KACL,CAAC,CAAC;IAEH,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,gDAAgD,IAAI,GAAG,CAAC,CAAC;QAEvE,IAAI,KAAK;YAAE,IAAA,6BAAiB,EAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAE9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,KAAK,EAAE,CAAC;QACV,IAAA,yBAAa,EAAC;YACZ,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,KAAK,EAAE,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE;SAChF,CAAC,CAAC;IACL,CAAC;IAED,OAAO,CAAC,CAAC;AACX,CAAC,CAAA,CAAC;AA7CW,QAAA,eAAe,mBA6C1B"}

package/src/lib/api/validate-definition.d.ts

@@ -0,0 +1,7 @@
+import { ApiDefinition } from './definition';
+/** Throws an error naming the file, the API and the path of the first field of `ready` and `doctor` that has the wrong shape. */
+export declare const validateApiDefinition: ({ fileName, name, api, }: {
+    fileName: string;
+    name: string;
+    api: ApiDefinition;
+}) => undefined;

package/src/lib/api/validate-definition.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateApiDefinition = void 0;
+const isRecord = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
+const isText = (value) => typeof value === 'string' && value.trim() !== '';
+/** Throws an error naming the file, the API and the path of the first field of `ready` and `doctor` that has the wrong shape. */
+const validateApiDefinition = ({ fileName, name, api, }) => {
+    const fail = (path, problem) => {
+        throw new Error(`${fileName}: ${name}${path} ${problem}`);
+    };
+    const definition = isRecord(api) ? api : {};
+    const { checks, profiles, migrationsDir } = definition;
+    const services = Array.isArray(definition['services']) ? definition['services'] : [];
+    if (migrationsDir !== undefined && !isText(migrationsDir))
+        fail('.migrationsDir', 'must be a non-empty path');
+    if (checks !== undefined) {
+        if (!Array.isArray(checks))
+            fail('.checks', 'must be a list');
+        const names = new Set();
+        checks.forEach((entry, index) => {
+            const path = `.checks[${index}]`;
+            if (!isRecord(entry))
+                return fail(path, 'must be an object');
+            if (!isText(entry['name']))
+                fail(`${path}.name`, 'must be a non-empty string');
+            if (names.has(entry['name']))
+                fail(`${path}.name`, `"${entry['name']}" is declared twice`);
+            names.add(entry['name']);
+            if (!isText(entry['check']))
+                fail(`${path}.check`, 'must be a shell line');
+            if (entry['fix'] !== undefined && !isText(entry['fix']))
+                fail(`${path}.fix`, 'must be a shell line');
+            if (entry['host'] !== undefined && typeof entry['host'] !== 'boolean')
+                fail(`${path}.host`, 'must be a boolean');
+            if (entry['service'] !== undefined && !services.includes(entry['service'])) {
+                fail(`${path}.service`, `must be one of services: ${services.join(', ')}`);
+            }
+        });
+    }
+    if (profiles !== undefined) {
+        if (!isRecord(profiles))
+            fail('.profiles', 'must be an object');
+        for (const [profileName, profile] of Object.entries(profiles)) {
+            const path = `.profiles.${profileName}`;
+            if (!isRecord(profile))
+                return fail(path, 'must be an object');
+            const { seeds, health, snapshot } = profile;
+            if (!Array.isArray(seeds) || seeds.length === 0 || !seeds.every(isText)) {
+                fail(`${path}.seeds`, 'must be a non-empty list of seed names');
+            }
+            if (health !== undefined) {
+                if (!isRecord(health))
+                    return fail(`${path}.health`, 'must be an object');
+                if (!isText(health['url']))
+                    fail(`${path}.health.url`, 'must be a string');
+                if (health['expect'] !== undefined && !Number.isInteger(health['expect'])) {
+                    fail(`${path}.health.expect`, 'must be an integer');
+                }
+            }
+            if (snapshot !== undefined) {
+                if (!isRecord(snapshot))
+                    return fail(`${path}.snapshot`, 'must be an object');
+                if (!isText(snapshot['service']))
+                    fail(`${path}.snapshot.service`, 'must be a service name');
+                if (!Array.isArray(snapshot['databases']) ||
+                    snapshot['databases'].length === 0 ||
+                    !snapshot['databases'].every(isText)) {
+                    fail(`${path}.snapshot.databases`, 'must be a non-empty list of database names');
+                }
+                if (!isText(snapshot['save']))
+                    fail(`${path}.snapshot.save`, 'must be a shell line');
+                if (!isText(snapshot['restore']))
+                    fail(`${path}.snapshot.restore`, 'must be a shell line');
+            }
+        }
+    }
+};
+exports.validateApiDefinition = validateApiDefinition;
+//# sourceMappingURL=validate-definition.js.map

package/src/lib/api/validate-definition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-definition.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/validate-definition.ts"],"names":[],"mappings":";;;AAEA,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAoC,EAAE,CACpE,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAEvE,MAAM,MAAM,GAAG,CAAC,KAAc,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;AAErG,iIAAiI;AAC1H,MAAM,qBAAqB,GAAG,CAAC,EACpC,QAAQ,EACR,IAAI,EACJ,GAAG,GAKJ,EAAE,EAAE;IACH,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,OAAe,EAAS,EAAE;QACpD,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,KAAK,IAAI,GAAG,IAAI,IAAI,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC,CAAC;IAEF,MAAM,UAAU,GAA4B,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACrE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,UAAU,CAAC;IACvD,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAErF,IAAI,aAAa,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC;QAAE,IAAI,CAAC,gBAAgB,EAAE,0BAA0B,CAAC,CAAC;IAE9G,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YAAE,IAAI,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QAE9D,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;QAE/B,MAAoB,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YAC7C,MAAM,IAAI,GAAG,WAAW,KAAK,GAAG,CAAC;YAEjC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;YAE7D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBAAE,IAAI,CAAC,GAAG,IAAI,OAAO,EAAE,4BAA4B,CAAC,CAAC;YAE/E,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAW,CAAC;gBAAE,IAAI,CAAC,GAAG,IAAI,OAAO,EAAE,IAAI,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;YAErG,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAW,CAAC,CAAC;YAEnC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAAE,IAAI,CAAC,GAAG,IAAI,QAAQ,EAAE,sBAAsB,CAAC,CAAC;YAE3E,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBAAE,IAAI,CAAC,GAAG,IAAI,MAAM,EAAE,sBAAsB,CAAC,CAAC;YAErG,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,SAAS;gBAAE,IAAI,CAAC,GAAG,IAAI,OAAO,EAAE,mBAAmB,CAAC,CAAC;YAEjH,IAAI,KAAK,CAAC,SAAS,CAAC,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;gBAC3E,IAAI,CAAC,GAAG,IAAI,UAAU,EAAE,4BAA4B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAC7E,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAAE,IAAI,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;QAEhE,KAAK,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAmC,CAAC,EAAE,CAAC;YACzF,MAAM,IAAI,GAAG,aAAa,WAAW,EAAE,CAAC;YAExC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAAE,OAAO,IAAI,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;YAE/D,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;YAE5C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;gBACxE,IAAI,CAAC,GAAG,IAAI,QAAQ,EAAE,wCAAwC,CAAC,CAAC;YAClE,CAAC;YAED,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;oBAAE,OAAO,IAAI,CAAC,GAAG,IAAI,SAAS,EAAE,mBAAmB,CAAC,CAAC;gBAE1E,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;oBAAE,IAAI,CAAC,GAAG,IAAI,aAAa,EAAE,kBAAkB,CAAC,CAAC;gBAE3E,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;oBAC1E,IAAI,CAAC,GAAG,IAAI,gBAAgB,EAAE,oBAAoB,CAAC,CAAC;gBACtD,CAAC;YACH,CAAC;YAED,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC3B,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;oBAAE,OAAO,IAAI,CAAC,GAAG,IAAI,WAAW,EAAE,mBAAmB,CAAC,CAAC;gBAE9E,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;oBAAE,IAAI,CAAC,GAAG,IAAI,mBAAmB,EAAE,wBAAwB,CAAC,CAAC;gBAE7F,IACE,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;oBACrC,QAAQ,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC;oBAClC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EACpC,CAAC;oBACD,IAAI,CAAC,GAAG,IAAI,qBAAqB,EAAE,4CAA4C,CAAC,CAAC;gBACnF,CAAC;gBAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;oBAAE,IAAI,CAAC,GAAG,IAAI,gBAAgB,EAAE,sBAAsB,CAAC,CAAC;gBAErF,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;oBAAE,IAAI,CAAC,GAAG,IAAI,mBAAmB,EAAE,sBAAsB,CAAC,CAAC;YAC7F,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AA1FW,QAAA,qBAAqB,yBA0FhC"}