pursor 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +654 -595
- package/bin/pursor.mjs +226 -190
- package/package.json +75 -73
- package/src/auth.js +92 -0
- package/src/har.js +159 -0
- package/src/index.js +94 -89
- package/src/runway.js +5 -2
- package/src/shoot.js +13 -1
- package/src/sweep.js +118 -104
package/src/sweep.js
CHANGED
|
@@ -1,105 +1,119 @@
|
|
|
1
|
-
// Sweep: batch capture plan. Each step is one of:
|
|
2
|
-
// { name, shoot: { url?, preset?, ...flags } }
|
|
3
|
-
// { name, hover: { url?, selector } }
|
|
4
|
-
// { name, frames: { url?, count, intervalMs } }
|
|
5
|
-
// { name, diff: { url?, ref, threshold? } }
|
|
6
|
-
// { name, <customOp>: { ... } } // from a registered plugin
|
|
7
|
-
|
|
8
|
-
import { readFileSync, writeFileSync, mkdirSync } from "node:fs";
|
|
9
|
-
import { join, resolve as pathResolve } from "node:path";
|
|
10
|
-
import { runShootWithSidecar } from "./shoot.js";
|
|
11
|
-
import { runFrames } from "./frames.js";
|
|
12
|
-
import { runDiff } from "./diff.js";
|
|
13
|
-
import { launch, newPage } from "./runway.js";
|
|
14
|
-
import { resolveViewport } from "./viewport.js";
|
|
15
|
-
import { gotoOrThrow, settle, CLICK_TIMEOUT_MS } from "./overlays.js";
|
|
16
|
-
import { resolveLocator } from "./selector.js";
|
|
17
|
-
import { resolveHealedSelector } from "./selector-heal.js";
|
|
18
|
-
import { asNum, nowIso, findStepPng, renderSweepHtml } from "./util.js";
|
|
19
|
-
import { getSweepOp } from "./plugin.js";
|
|
20
|
-
import { writeCiOutput } from "./ci-output.js";
|
|
21
|
-
|
|
22
|
-
export async function runSweep(planPath, outDirArg) {
|
|
23
|
-
const plan = JSON.parse(readFileSync(planPath, "utf8"));
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
const
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
const
|
|
41
|
-
const
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
if (s.
|
|
50
|
-
const url = s.
|
|
51
|
-
if (!url) throw new Error("
|
|
52
|
-
const
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
const
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
const
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
await
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
const
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
const
|
|
80
|
-
if (
|
|
81
|
-
const
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
1
|
+
// Sweep: batch capture plan. Each step is one of:
|
|
2
|
+
// { name, shoot: { url?, preset?, ...flags } }
|
|
3
|
+
// { name, hover: { url?, selector } }
|
|
4
|
+
// { name, frames: { url?, count, intervalMs } }
|
|
5
|
+
// { name, diff: { url?, ref, threshold? } }
|
|
6
|
+
// { name, <customOp>: { ... } } // from a registered plugin
|
|
7
|
+
|
|
8
|
+
import { readFileSync, writeFileSync, mkdirSync } from "node:fs";
|
|
9
|
+
import { join, resolve as pathResolve } from "node:path";
|
|
10
|
+
import { runShootWithSidecar } from "./shoot.js";
|
|
11
|
+
import { runFrames } from "./frames.js";
|
|
12
|
+
import { runDiff } from "./diff.js";
|
|
13
|
+
import { launch, newPage } from "./runway.js";
|
|
14
|
+
import { resolveViewport } from "./viewport.js";
|
|
15
|
+
import { gotoOrThrow, settle, CLICK_TIMEOUT_MS } from "./overlays.js";
|
|
16
|
+
import { resolveLocator } from "./selector.js";
|
|
17
|
+
import { resolveHealedSelector } from "./selector-heal.js";
|
|
18
|
+
import { asNum, nowIso, findStepPng, renderSweepHtml } from "./util.js";
|
|
19
|
+
import { getSweepOp } from "./plugin.js";
|
|
20
|
+
import { writeCiOutput } from "./ci-output.js";
|
|
21
|
+
|
|
22
|
+
export async function runSweep(planPath, outDirArg) {
|
|
23
|
+
const plan = JSON.parse(readFileSync(planPath, "utf8"));
|
|
24
|
+
if (!plan || typeof plan !== "object" || !Array.isArray(plan.steps)) throw new Error("sweep plan: missing steps[]");
|
|
25
|
+
if (!plan.steps.length) throw new Error("sweep plan: steps[] is empty");
|
|
26
|
+
const dir = outDirArg ?? plan.outDir ?? join(plan.outBase || ".", `sweep-${plan.name || "plan"}`);
|
|
27
|
+
mkdirSync(dir, { recursive: true });
|
|
28
|
+
const summary = { plan: pathResolve(planPath), outDir: dir, name: plan.name || null, steps: [], ts: nowIso() };
|
|
29
|
+
const browser = await launch();
|
|
30
|
+
try {
|
|
31
|
+
// Per-step runner: returns an entry for the summary.
|
|
32
|
+
async function runStep(i) {
|
|
33
|
+
const s = plan.steps[i] || {};
|
|
34
|
+
const stepName = s.name || `step-${i}`;
|
|
35
|
+
const stepOut = join(dir, `${String(i).padStart(2, "0")}-${stepName}.png`);
|
|
36
|
+
const t0 = Date.now();
|
|
37
|
+
const stepKeys = Object.keys(s).filter(k => k !== "name");
|
|
38
|
+
if (!stepKeys.length) throw new Error(`step ${i} has no operation key (only "name"?)`);
|
|
39
|
+
if (stepKeys.length > 1) throw new Error(`step ${i} has ${stepKeys.length} operation keys (${stepKeys.join(", ")}). Only one allowed per step.`);
|
|
40
|
+
const opKey = stepKeys[0];
|
|
41
|
+
const entry = { i, name: stepName, op: opKey };
|
|
42
|
+
try {
|
|
43
|
+
if (s.shoot) {
|
|
44
|
+
const url = s.shoot.url || (plan.base ? plan.base : null);
|
|
45
|
+
if (!url) throw new Error("shoot: missing url (and no plan.base)");
|
|
46
|
+
const flags = Object.fromEntries(Object.entries(s.shoot).filter(([k]) => k !== "url").map(([k, v]) => [k, v]));
|
|
47
|
+
const meta = await runShootWithSidecar({ url, out: stepOut, flags, browser });
|
|
48
|
+
entry.meta = meta;
|
|
49
|
+
} else if (s.hover) {
|
|
50
|
+
const url = s.hover.url || (plan.base ? plan.base : null);
|
|
51
|
+
if (!url) throw new Error("hover: missing url (and no plan.base)");
|
|
52
|
+
const selector = s.hover.selector;
|
|
53
|
+
if (!selector) throw new Error("hover: missing selector");
|
|
54
|
+
const viewport = resolveViewport(s.hover);
|
|
55
|
+
const page = await newPage(browser, viewport);
|
|
56
|
+
const r = await gotoOrThrow(page, url); await settle(page);
|
|
57
|
+
const healed = await resolveHealedSelector(page, selector);
|
|
58
|
+
await healed.locator.first().hover({ timeout: CLICK_TIMEOUT_MS });
|
|
59
|
+
await page.waitForTimeout(asNum(s.hover.settleMs, 300));
|
|
60
|
+
await page.screenshot({ path: stepOut, fullPage: false });
|
|
61
|
+
await page.close();
|
|
62
|
+
entry.meta = { ...r, url, out: stepOut, selector, viewport };
|
|
63
|
+
} else if (s.frames) {
|
|
64
|
+
const url = s.frames.url || (plan.base ? plan.base : null);
|
|
65
|
+
if (!url) throw new Error("frames: missing url (and no plan.base)");
|
|
66
|
+
const subDir = join(dir, `${String(i).padStart(2, "0")}-${stepName}-frames`);
|
|
67
|
+
const meta = await runFrames({ url, count: asNum(s.frames.count, 8), intervalMs: asNum(s.frames.intervalMs, 200), outDir: subDir, flags: s.frames, browser });
|
|
68
|
+
entry.meta = meta;
|
|
69
|
+
} else if (s.diff) {
|
|
70
|
+
const refName = s.diff.ref;
|
|
71
|
+
if (!refName) throw new Error("diff: missing ref (step name or filename)");
|
|
72
|
+
const refPath = findStepPng(dir, refName);
|
|
73
|
+
if (!refPath) throw new Error(`diff: ref not found in dir: ${refName}`);
|
|
74
|
+
const url = s.diff.url || (plan.base ? plan.base : null);
|
|
75
|
+
if (!url) throw new Error("diff: missing url (and no plan.base)");
|
|
76
|
+
const meta = await runDiff(url, refPath, stepOut, asNum(s.diff.threshold, 0.1), browser);
|
|
77
|
+
entry.meta = meta;
|
|
78
|
+
} else if (opKey && getSweepOp(opKey)) {
|
|
79
|
+
const customOp = getSweepOp(opKey);
|
|
80
|
+
if (typeof customOp !== "function") throw new Error(`custom op "${opKey}" is not a function`);
|
|
81
|
+
const ctx = { url: plan.base, out: stepOut, browser, page: null };
|
|
82
|
+
const result = await customOp(ctx, s[opKey] || {});
|
|
83
|
+
entry.meta = result != null ? result : { out: stepOut };
|
|
84
|
+
} else {
|
|
85
|
+
throw new Error(`step "${opKey}": unknown or unregistered operation`);
|
|
86
|
+
}
|
|
87
|
+
entry.ms = Date.now() - t0; entry.ok = true;
|
|
88
|
+
} catch (e) {
|
|
89
|
+
entry.ok = false; entry.error = e.message; entry.ms = Date.now() - t0;
|
|
90
|
+
}
|
|
91
|
+
return entry;
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
// Schedule: serial by default, or via a worker pool when plan.parallel > 1.
|
|
95
|
+
const poolSize = Math.max(1, Number(plan.parallel) || 1);
|
|
96
|
+
const results = new Array(plan.steps.length);
|
|
97
|
+
if (poolSize === 1) {
|
|
98
|
+
for (let i = 0; i < plan.steps.length; i++) {
|
|
99
|
+
results[i] = await runStep(i);
|
|
100
|
+
}
|
|
101
|
+
} else {
|
|
102
|
+
let cursor = 0;
|
|
103
|
+
async function worker() {
|
|
104
|
+
while (true) {
|
|
105
|
+
const idx = cursor++;
|
|
106
|
+
if (idx >= plan.steps.length) return;
|
|
107
|
+
results[idx] = await runStep(idx);
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
const workers = Array.from({ length: Math.min(poolSize, plan.steps.length) }, () => worker());
|
|
111
|
+
await Promise.all(workers);
|
|
112
|
+
}
|
|
113
|
+
for (const r of results) summary.steps.push(r);
|
|
114
|
+
} finally { try { await browser.close(); } catch {} }
|
|
115
|
+
writeFileSync(join(dir, "sweep.json"), JSON.stringify(summary, null, 2));
|
|
116
|
+
writeFileSync(join(dir, "index.html"), renderSweepHtml(summary));
|
|
117
|
+
try { writeCiOutput(summary, dir); } catch (e) { console.error("[pursor] CI output error:", e.message); }
|
|
118
|
+
return summary;
|
|
105
119
|
}
|