@ethlete/cli 3.0.0-next.25 → 3.0.0-next.27

package/src/lib/design/system/ready-command.js

@@ -0,0 +1,82 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.designReady = exports.READY_USAGE = void 0;
+const actions_command_1 = require("./actions-command");
+const open_points_1 = require("./open-points");
+const part_ready_1 = require("./part-ready");
+const check_system_1 = require("./check-system");
+const part_build_ready_1 = require("./part-build-ready");
+const resolve_product_1 = require("./resolve-product");
+const slow_run_1 = require("./slow-run");
+const slow_checks_1 = require("./slow-checks");
+const stale_dist_1 = require("./stale-dist");
+const cli_args_1 = require("./sketch/cli-args");
+const sketch_1 = require("./sketch/sketch");
+exports.READY_USAGE = 'ready <layer>/<name> --product <name> [--url <app dev server url>]';
+/**
+ * `et design ready <layer>/<name> …` checks a part and writes its check record, and exits 1 with its open points, its
+ * other blockers or its failed `design actions` lines while it has any. It runs the slow rules of the part first when
+ * their result is missing or stale.
+ */
+const designReady = (options) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
+    const { target, argv, invocation } = options;
+    const args = (0, cli_args_1.argsOf)(argv, { values: ['--product', '--url'], switches: [] });
+    const usage = `usage: ${invocation} ${exports.READY_USAGE}`;
+    if (typeof args === 'string' || args.positional.length !== 1) {
+        if (typeof args === 'string')
+            console.error(args);
+        console.error(usage);
+        return 2;
+    }
+    const config = (0, cli_args_1.configOf)(target);
+    const parsed = (0, sketch_1.parseTarget)(args.positional[0]);
+    if (typeof config === 'string' || typeof parsed === 'string') {
+        console.error(typeof config === 'string' ? config : parsed);
+        return 1;
+    }
+    const product = (0, cli_args_1.oneProductOf)({ target, config, asked: args.values['--product'] });
+    if (typeof product === 'string') {
+        console.error(product);
+        return 1;
+    }
+    for (const line of (0, stale_dist_1.staleDistWarningsOf)({ target, config }))
+        console.warn(line);
+    const part = (0, resolve_product_1.partKeyOf)(parsed);
+    const located = (0, part_ready_1.readyPartOf)({ product, part });
+    const marked = yield (0, part_ready_1.markPartReady)(Object.assign({ product,
+        part, hash: typeof located === 'string' ? '-' : located.hash, pointsOf: () => __awaiter(void 0, void 0, void 0, function* () {
+            const points = yield (0, part_ready_1.drawnPartPointsOf)({ target, config, product, part });
+            return 'unavailable' in points ? { status: 503, error: `cannot draw ${part}: ${points.unavailable}` } : points;
+        }), blockersOf: () => __awaiter(void 0, void 0, void 0, function* () {
+            if ((0, slow_checks_1.slowProblemsOf)({ product, part }) === 'pending')
+                yield (0, slow_run_1.runSlowChecks)({ target, config, product, parts: [part] });
+            return (0, part_build_ready_1.checkBlockersOf)({ product, part, inputs: Object.assign(Object.assign({}, (0, check_system_1.buildReadyInputsOf)(product)), { pointsOf: () => [] }) });
+        }), actionsOf: () => __awaiter(void 0, void 0, void 0, function* () {
+            const failures = yield (0, actions_command_1.partActionFailuresOf)({ target, config, product, part, url: args.values['--url'] });
+            return Array.isArray(failures)
+                ? failures
+                : { status: 503, error: `cannot check the actions of ${part}: ${failures.unavailable}` };
+        }) }, (args.values['--url'] ? {} : { actionsNote: actions_command_1.PART_HARNESS_ONLY })));
+    if ('status' in marked) {
+        if (marked.points)
+            (0, open_points_1.openPointsText)(product.name, [{ part, points: marked.points }]).forEach((line) => console.error(line));
+        (_a = marked.blockers) === null || _a === void 0 ? void 0 : _a.forEach((blocker) => console.error(`  ${blocker.kind}: ${blocker.text}${blocker.part ? ` (${blocker.part})` : ''}`));
+        (_b = marked.actions) === null || _b === void 0 ? void 0 : _b.forEach((line) => console.error(`  ${line}`));
+        console.error(marked.error);
+        return 1;
+    }
+    console.log(`${part} is build-ready in ${product.name}`);
+    return 0;
+});
+exports.designReady = designReady;
+//# sourceMappingURL=ready-command.js.map

package/src/lib/design/system/ready-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ready-command.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/design/system/ready-command.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uDAA4E;AAC5E,+CAA+C;AAC/C,6CAA6E;AAC7E,iDAAoD;AACpD,yDAAqD;AACrD,uDAA8C;AAC9C,yCAA2C;AAC3C,+CAA+C;AAC/C,6CAAmD;AACnD,gDAAmE;AACnE,4CAA8C;AAEjC,QAAA,WAAW,GAAG,oEAAoE,CAAC;AAEhG;;;;GAIG;AACI,MAAM,WAAW,GAAG,CAAO,OAA+D,EAAE,EAAE;;IACnG,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IAC7C,MAAM,IAAI,GAAG,IAAA,iBAAM,EAAC,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5E,MAAM,KAAK,GAAG,UAAU,UAAU,IAAI,mBAAW,EAAE,CAAC;IAEpD,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7D,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAElD,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAErB,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,MAAM,GAAG,IAAA,mBAAQ,EAAC,MAAM,CAAC,CAAC;IAChC,MAAM,MAAM,GAAG,IAAA,oBAAW,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IAE/C,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC7D,OAAO,CAAC,KAAK,CAAC,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAE5D,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,OAAO,GAAG,IAAA,uBAAY,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAElF,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEvB,OAAO,CAAC,CAAC;IACX,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,IAAA,gCAAmB,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAE/E,MAAM,IAAI,GAAG,IAAA,2BAAS,EAAC,MAAM,CAAC,CAAC;IAC/B,MAAM,OAAO,GAAG,IAAA,wBAAW,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/C,MAAM,MAAM,GAAG,MAAM,IAAA,0BAAa,kBAChC,OAAO;QACP,IAAI,EACJ,IAAI,EAAE,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EACtD,QAAQ,EAAE,GAAS,EAAE;YACnB,MAAM,MAAM,GAAG,MAAM,IAAA,8BAAiB,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;YAE1E,OAAO,aAAa,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,eAAe,IAAI,KAAK,MAAM,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;QACjH,CAAC,CAAA,EACD,UAAU,EAAE,GAAS,EAAE;YACrB,IAAI,IAAA,4BAAc,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,KAAK,SAAS;gBACjD,MAAM,IAAA,wBAAa,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAElE,OAAO,IAAA,kCAAe,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,kCAAO,IAAA,iCAAkB,EAAC,OAAO,CAAC,KAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,EAAE,GAAE,EAAE,CAAC,CAAC;QAC5G,CAAC,CAAA,EACD,SAAS,EAAE,GAAS,EAAE;YACpB,MAAM,QAAQ,GAAG,MAAM,IAAA,sCAAoB,EAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAE1G,OAAO,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;gBAC5B,CAAC,CAAC,QAAQ;gBACV,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,+BAA+B,IAAI,KAAK,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC;QAC7F,CAAC,CAAA,IACE,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,mCAAiB,EAAE,CAAC,EACnE,CAAC;IAEH,IAAI,QAAQ,IAAI,MAAM,EAAE,CAAC;QACvB,IAAI,MAAM,CAAC,MAAM;YACf,IAAA,4BAAc,EAAC,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAEzG,MAAA,MAAM,CAAC,QAAQ,0CAAE,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CACnC,OAAO,CAAC,KAAK,CAAC,KAAK,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAC/F,CAAC;QACF,MAAA,MAAM,CAAC,OAAO,0CAAE,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC;QAE9D,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAE5B,OAAO,CAAC,CAAC;IACX,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,sBAAsB,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAEzD,OAAO,CAAC,CAAC;AACX,CAAC,CAAA,CAAC;AA5EW,QAAA,WAAW,eA4EtB"}

package/src/lib/design/system/render-check.d.ts

@@ -1,5 +1,8 @@
 import { chromiumOf } from '../browser';
 import { DesignConfig } from '../paths';
+import { ContrastOptions } from './contrast-check';
+import { PartAddress } from '../shot';
+import { Browser } from '../thumb';
 import { SketchVariant } from './system-modules';
 /** One drawing of one state that breaks a render rule. `path` is a short selector path to the element. */
 export type RenderIssue = {
@@ -14,17 +17,60 @@ export type RenderIssue = {
 };
 /** One state of a part that was drawn, at the size it was drawn in. */
 export type RenderedState = Pick<RenderIssue, 'product' | 'part' | 'state' | 'size' | 'sketch'>;
+/** One drawn state of a part whose render holds `aria-busy="true"` or a loading button, so it shows ongoing work. */
+export type BusyState = Pick<RenderIssue, 'product' | 'part' | 'state' | 'sketch'>;
+/** @internal The states the busy marks of `issues` name, once each. */
+export declare const busyStatesOf: (issues: RenderIssue[]) => BusyState[];
 /** The parts of one product to draw, as it draws or as one sketch variant draws it; every part when `parts` is null. */
 export type RenderJob = {
     product: string;
     sketch: SketchVariant | null;
     parts: string[] | null;
 };
+type Frame = {
+    address: PartAddress;
+    size: string;
+    search: string;
+    viewport: {
+        width: number;
+        height: number;
+    };
+    fixed: boolean;
+    fit: boolean;
+    skips: Record<string, string[]>;
+    namespaces: string[];
+    contrast: ContrastOptions;
+    controlInputs: boolean;
+    embedControls: string[];
+};
 /** The summary line of the `grid` of a drawn part. */
 export type RenderedGrid = Pick<RenderIssue, 'product' | 'part' | 'sketch'> & {
     line: string;
 };
 export declare const renderIssueLineOf: (issue: RenderIssue) => string;
+/** The part whose code draws the element of an issue: the innermost embedded part on its path, else the drawn part. */
+export declare const ownerPartOf: (issue: RenderIssue) => string;
+/** The render issues as lines, one per finding that repeats across states, sizes, schemes and variants, with where it was found. */
+export declare const groupedIssueLinesOf: (issues: RenderIssue[]) => string[];
+export declare const uniqueIssuesOf: (issues: RenderIssue[]) => RenderIssue[];
+/** The render rule of a part whose drawing did not finish in time, apart from a part that failed to draw. */
+export declare const RENDER_TIMEOUT = "RENDER-TIMEOUT";
+/** @internal Inspects `frames`, then the parts that timed out once more alone, and keeps that second answer. */
+export declare const inspectRetryingTimeouts: (options: Parameters<typeof inspect>[0] & {
+    inspectOf?: typeof inspect;
+}) => Promise<RenderIssue[]>;
+declare const inspect: (options: {
+    browser: Browser;
+    base: string;
+    frames: Frame[];
+    timeoutMs?: number;
+    onPart?: (progress: {
+        done: number;
+        total: number;
+        part: string;
+        ms: number;
+    }) => void;
+}) => Promise<RenderIssue[]>;
 /**
  * Draws every state of the parts of each job in one headless Chromium, on one page of a design server of
  * its own: a page at each product preset, a part with `widths` at each width, any other part fitted to
@@ -34,12 +80,18 @@ export declare const renderIssuesOf: (options: {
     target: string;
     config: DesignConfig;
     jobs: RenderJob[];
+    before?: Pick<RenderIssue, "product" | "part">[];
     chromiumOf?: typeof chromiumOf;
+    partTimeoutMs?: number;
+    onProgress?: (line: string) => void;
 }) => Promise<{
     issues: RenderIssue[];
     warnings: RenderIssue[];
     grids: RenderedGrid[];
     drawn: RenderedState[];
+    busy?: BusyState[];
+    before?: RenderIssue[];
 } | {
     unavailable: string;
 }>;
+export {};