@makechart/viewer 0.0.0-stage → 0.0.1

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/CHANGELOG.md ADDED
@@ -0,0 +1,16 @@
1
+ # Change Logs
2
+
3
+ ## v0.0.1
4
+
5
+ - init release
6
+ - `mctest` cli: run test cases of a makechart chart in a headless browser and compare the output with
7
+ snapshots in `test/snapshot` ( `-u` to update, `-g` to filter, `--ci`, `--loose`, `--dpr` )
8
+ - `mctest serve`: UI showing current and baseline side by side; accept re-runs the case headlessly
9
+ so snapshots always come from the same environment
10
+ - resolve frontend dependencies at runtime under `/assets/lib/<name>/<ver>/<path>`, with local
11
+ overrides via `-l name:dir` ( same syntax as `fedep -l` ) or `MCTEST_LINK`
12
+ - test case API ( `mctest.suite` ): data sets, per-case config, steps with intermediate snaps,
13
+ pointer drag helper, `combo` / `label` / seeded `random` helpers
14
+ - crossfilter cases via `@plotdb/dash` boards
15
+ - deterministic output: `chart.anim` is switched to manual and flushed, capture waits for a quiet DOM,
16
+ markup is serialized with sorted attributes and rounded numbers, volatile ids are normalized
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 zbryikt
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,94 @@
1
- # Temporary Holding Version
1
+ # @makechart/viewer
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ makechart 圖表的 test suite engine。每張圖在自己的 repo 放 test case,engine 用 headless 瀏覽器以各種資料、參數跑過,把輸出跟存下來的 snapshot 比對;也能用 `@plotdb/dash` 把幾張圖串起來測 crossfilter。
4
+
5
+
6
+ ## 安裝
7
+
8
+ 在 chart repo 裡:
9
+
10
+ npm install -D @makechart/viewer
11
+
12
+ 本地開發 engine 時可以改用 `npm link` 或 `npm install -D <path-to-viewer>`。
13
+
14
+ 需要一個 headless 瀏覽器:預設用 playwright 的 chromium ( `npx playwright install chromium-headless-shell` ),沒裝就用系統的 Chrome。
15
+
16
+
17
+ ## 使用
18
+
19
+ 在 chart repo 的根目錄:
20
+
21
+ npx mctest # 跑全部 case. 沒有 snapshot 的會直接存起來
22
+ npx mctest -u # 不一致的也更新 snapshot
23
+ npx mctest -g stack # 只跑名字含 stack 的 ( 也可以是 regexp )
24
+ npx mctest --ci # 沒有 snapshot 也算失敗
25
+ npx mctest serve -o # 開 UI: 並排看 current / baseline, accept
26
+
27
+ `npx mctest -h` 看全部選項。結束碼不是 0 代表有 case 失敗,失敗的 markup 與截圖放在 `test/output/`。
28
+
29
+
30
+ ## 依賴從哪裡來
31
+
32
+ engine 自己起一個 server,前端依賴走與 makechart 相同的路徑 `/assets/lib/<name>/<version>/<path>`,版本一律忽略,依序找:
33
+
34
+ 1. `-l name:dir` ( 或環境變數 `MCTEST_LINK` ) 指定的本地目錄,有 `dist/` 先找 `dist/`
35
+ 2. 受測的圖自己 ( package.json 的 name -> `./dist` )
36
+ 3. `node_modules`,先 chart repo 再 engine 自己的 ( npm link 的 symlink 一樣適用 )
37
+
38
+ 所以本地開發不必每張圖都 clone,要改的那幾個連過去就好:
39
+
40
+ npx mctest -l "@makechart/base:../base;@plotdb/chart:~/workspace/plotdb/projects/chart"
41
+
42
+ `-l` 的寫法同 `fedep -l`。`@plotdb/dash` 目前沒有發佈,dash 的 case 要把它連過來,沒連的話這些 case 會是 error。
43
+
44
+
45
+ ## 寫 test case
46
+
47
+ `test/index.ls` ( 或 `test/index.js` ),在瀏覽器裡執行,可以用全域的 `mctest`:
48
+
49
+ mctest.suite do
50
+ size: [480 300] # 預設的圖大小 ( px )
51
+ config: {} # 所有 case 共用的 config
52
+ data:
53
+ fruit: {raw: [...], binding: {...}} # 也可以是回傳 {raw, binding, subset?} 的 function
54
+ cases:
55
+ * name: "stack", data: \fruit, config: {multiple: \stack}
56
+ * name: "filter"
57
+ steps:
58
+ * (chart, ctx) ->
59
+ chart.filter {name: {type: \index, value: <[A B]>}}
60
+ ctx.snap \filtered # 在這裡多存一格
61
+ * (chart) -> chart.filter {name: undefined}
62
+ * name: "dash" # 多張圖, 用 @plotdb/dash 的 board
63
+ dash: {def: {...}, size: [900 320]}
64
+ steps: [(board, ctx) -> board.set-filter \a, {field: \region, values: <[North]>}]
65
+
66
+ - `name` 是 snapshot 的檔名,要唯一。
67
+ - `steps` 依序執行,每一步之後等畫面穩定。可以回傳 promise。
68
+ - `ctx`:`root` ( 這個 case 的容器 )、`snap(label)`、`drag(node, [x0, y0], [x1, y1])` ( 相對座標 0~1,送 pointer 事件 )、`chart(id)` ( dash 時取某個 panel 的圖 )、`wait(ms)`、`random(seed)`。
69
+ - helper:`mctest.combo {type: <[column bar]>, multiple: <[stack group]>}` 產生所有組合,`mctest.label o` 把組合轉成名字,`mctest.random seed` 是固定種子的亂數。
70
+ - `skip: true` 略過。`suite.chart` 預設是 package.json 的 name。
71
+
72
+ 資料請用固定種子產生,否則每次跑都不一樣。
73
+
74
+
75
+ ## 怎麼比對
76
+
77
+ - 動畫:有 `chart.anim` 的圖 ( @plotdb/chart 的補間時鐘 ) 一律切成 manual,再直接 flush 到終點,所以結果跟機器快慢無關。還在用 d3 transition 的圖只能等它跑完。
78
+ - 穩定:DOM 連續 `quiet` ms ( 預設 250 ) 沒有變動才擷取,要比圖裡的 debounce 長。
79
+ - markup:自己序列化 DOM,屬性依名字排序,一個 tag 一行,數字取到小數兩位,並把每次都會變的亂數 id 換掉 ( ldview scope、legend id;圖表自己的用 `suite.normalize: [[regexp, 取代字串]]` 補 )。
80
+ - 每個 case 都在固定於頁面 (0, 0) 的位置執行,版面不受前面的 case 影響。
81
+ - 結果:`pass` 完全相同;`near` 結構相同、只差數字,而且差距在 `tolerance` 內 ( 預設 1 );`diff`;`new` 沒有 snapshot。cli 預設把 `near` 也算失敗,加 `--loose` 才放過。`near` 多半出現在 UI:你的瀏覽器跟 headless 的 DPR、視窗不同,文字寬度會有小數誤差。
82
+
83
+ snapshot 一律由 headless 產生 ( viewport 1600x1000,DPR 預設 2,`--dpr` 可改 )。UI 的 accept 也是請 server 用 headless 重跑那幾個 case 再存,不會存 UI 所在瀏覽器畫出來的版本。
84
+
85
+ 文字寬度跟字型、瀏覽器版本有關,不同機器 ( 例如 CI 的 linux ) 需要各自的 baseline,或固定瀏覽器與字型。
86
+
87
+
88
+ ## 檔案
89
+
90
+ - `bin/cli.js` — 指令
91
+ - `lib/server.js` — http server:依賴解析、test case 編譯、snapshot API
92
+ - `lib/runner.js` — headless 瀏覽器 ( playwright-core )
93
+ - `src/suite.ls` — 瀏覽器端 engine:case 定義、執行、正規化、比對
94
+ - `src/ui.ls`、`web/index.html` — UI ( headless 也是跑這頁 )
package/bin/cli.js ADDED
@@ -0,0 +1,112 @@
1
+ #!/usr/bin/env node
2
+ // mctest - makechart 圖表的 test suite. 在 chart repo 的根目錄執行:
3
+ //
4
+ // npx mctest headless 跑全部 case, 跟 test/snapshot 比對. 沒有 snapshot 的會直接存起來
5
+ // npx mctest -u 不一致的也直接更新 snapshot
6
+ // npx mctest -g stack 只跑名字含 stack 的 ( 也可以是 regexp )
7
+ // npx mctest serve [-o] 開 UI 看圖、比對、accept ( accept 時用 headless 重跑再存 )
8
+ //
9
+ // 共用選項:
10
+ // -l name:dir[;name:dir] 本地目錄取代 node_modules 裡的版本 ( 同 fedep -l, 有 dist/ 用 dist/ )
11
+ // 也可以用環境變數 MCTEST_LINK
12
+ // -p port serve 的 port ( 預設 8722 ), run 預設隨機
13
+ // --ci 沒有 snapshot 的 case 算失敗, 不自動存
14
+ // --browser chrome|<path> 指定瀏覽器. 預設用 playwright 的 chromium, 沒裝就用系統的 Chrome
15
+ // --loose 數字差在 tolerance 內 ( near ) 也算過. 預設不算: 真的差 1px 的改動也要抓到
16
+ // --dpr n headless 的 devicePixelRatio ( 預設 2, 同 Mac 螢幕 ). 文字寬度會隨它有小數誤差
17
+ // --headed run 時顯示瀏覽器視窗
18
+ // -v 印出 404 與頁面的 console
19
+ const fs = require('fs'), path = require('path');
20
+ const {create, parseLinks} = require('../lib/server');
21
+ const {Runner, writeSnapshot} = require('../lib/runner');
22
+
23
+ function parseArgs(argv) {
24
+ const o = {cmd: 'run', links: {}, grep: '', update: false, ci: false, loose: false, dpr: 2, headed: false, verbose: false, open: false};
25
+ const links = [process.env.MCTEST_LINK || ''];
26
+ for (let i = 0; i < argv.length; i++) {
27
+ const a = argv[i], next = () => argv[++i];
28
+ if (a === 'serve' || a === 'run') o.cmd = a;
29
+ else if (a === '-u' || a === '--update') o.update = true;
30
+ else if (a === '-g' || a === '--grep') o.grep = next();
31
+ else if (a === '-l' || a === '--link') links.push(next());
32
+ else if (a === '-p' || a === '--port') o.port = +next();
33
+ else if (a === '-o' || a === '--open') o.open = true;
34
+ else if (a === '--ci') o.ci = true;
35
+ else if (a === '--loose') o.loose = true;
36
+ else if (a === '--dpr') o.dpr = +next();
37
+ else if (a === '--browser') o.browser = next();
38
+ else if (a === '--headed') o.headed = true;
39
+ else if (a === '-v' || a === '--verbose') o.verbose = true;
40
+ else if (a === '-h' || a === '--help') o.cmd = 'help';
41
+ else { console.error(`[mctest] unknown option: ${a}`); process.exit(2); }
42
+ }
43
+ o.links = parseLinks(links.join(';'));
44
+ return o;
45
+ }
46
+
47
+ async function run(o, srv) {
48
+ const port = await srv.listen(o.port);
49
+ const outDir = path.join(srv.testDir, 'output');
50
+ fs.rmSync(outDir, {recursive: true, force: true});
51
+ const runner = new Runner(o, port);
52
+ let code = 0;
53
+ try {
54
+ const results = await runner.run({grep: o.grep, keepPage: true});
55
+ const cnt = {};
56
+ for (const r of results) {
57
+ let s = r.status;
58
+ if (s === 'near' && !o.loose) s = 'diff';
59
+ if (s === 'diff' && o.update) s = 'updated';
60
+ else if (s === 'new' && !o.ci) s = 'added';
61
+ cnt[s] = (cnt[s] || 0) + 1;
62
+ if (s === 'updated' || s === 'added') writeSnapshot(srv, r);
63
+ if (['diff', 'new', 'error'].includes(s)) {
64
+ // 失敗的留下目前的 markup 跟截圖 ( 給 CI 當 artifact ), 對照用 serve 看比較方便
65
+ fs.mkdirSync(outDir, {recursive: true});
66
+ if (r.current) fs.writeFileSync(path.join(outDir, r.file + '.html'), r.current);
67
+ await runner.shot(r.file, path.join(outDir, r.file + '.png'));
68
+ code = 1;
69
+ }
70
+ const mark = {pass: '✓', near: '≈', updated: '↻', added: '+', skip: '-', diff: '✗', new: '✗', error: '✗'}[s];
71
+ const note = s === 'pass' ? '' : ` ( ${r.status}${r.status === 'near' ? ` ±${r.delta}` : ''}${s !== r.status ? ` -> ${s}` : ''} )`;
72
+ if (!['pass', 'near'].includes(s) || o.verbose) console.log(` ${mark} ${r.name}${note}`);
73
+ if (s === 'diff' || s === 'updated') console.log(` line ${r.line}\n - ${r.expect}\n + ${r.actual}`);
74
+ if (s === 'new') console.log(' no snapshot ( run without --ci to save it )');
75
+ if (s === 'error') console.log(' ' + String(r.error).split('\n').slice(0, 4).join('\n '));
76
+ }
77
+ console.log(`\n${results.length} cases: ` + Object.entries(cnt).map(([k, v]) => `${k} ${v}`).join(', '));
78
+ if (code) console.log(`\n失敗的 case 輸出在 ${path.relative(process.cwd(), outDir)}/. 用 \`npx mctest serve\` 對照, 確認沒問題再 \`npx mctest -u\``);
79
+ } finally {
80
+ await runner.close();
81
+ await srv.close();
82
+ }
83
+ return code;
84
+ }
85
+
86
+ async function serve(o, srv) {
87
+ const port = await srv.listen(o.port || 8722);
88
+ // UI 的 accept: 用 headless 重跑那幾個 case 再存, 不收 UI 所在瀏覽器畫的版本
89
+ const runner = new Runner(o, port);
90
+ srv.accept = async (names) => {
91
+ const rs = await runner.run({names});
92
+ rs.filter(r => r.current).forEach(r => writeSnapshot(srv, r));
93
+ return rs.map(r => ({name: r.name, file: r.file, status: r.current ? 'saved' : r.status, error: r.error}));
94
+ };
95
+ const url = `http://localhost:${port}/`;
96
+ console.log(`[mctest] ${srv.pkg.name} -> ${url}`);
97
+ for (const [k, v] of Object.entries(srv.links)) console.log(`[mctest] link ${k} -> ${v}`);
98
+ if (o.open) {
99
+ const cmd = process.platform === 'darwin' ? 'open' : process.platform === 'win32' ? 'start' : 'xdg-open';
100
+ require('child_process').exec(`${cmd} ${url}`);
101
+ }
102
+ }
103
+
104
+ const o = parseArgs(process.argv.slice(2));
105
+ if (o.cmd === 'help') {
106
+ console.log(fs.readFileSync(__filename, 'utf8').split('\n').slice(1).filter(l => l.startsWith('//')).map(l => l.slice(3)).join('\n'));
107
+ process.exit(0);
108
+ }
109
+ if (!fs.existsSync('package.json')) { console.error('[mctest] run it in the root of a chart repo ( package.json not found )'); process.exit(2); }
110
+ const srv = create({links: o.links, verbose: o.verbose});
111
+ (o.cmd === 'serve' ? serve(o, srv) : run(o, srv).then(c => process.exit(c)))
112
+ .catch(e => { console.error(e.stack || e); process.exit(1); });
package/lib/runner.js ADDED
@@ -0,0 +1,64 @@
1
+ // 用 headless 瀏覽器跑 case. cli 的 run 與 serve 的 accept 共用, 所以 snapshot 一律出自同一種環境
2
+ // ( 同一個瀏覽器、viewport、DPR ). UI 所在的瀏覽器只拿來看, 不寫 snapshot.
3
+ const fs = require('fs'), path = require('path');
4
+
5
+ async function launch(o = {}) {
6
+ const {chromium} = require('playwright-core');
7
+ const base = {headless: !o.headed};
8
+ if (o.browser && o.browser !== 'chrome') return chromium.launch({...base, executablePath: o.browser});
9
+ if (o.browser === 'chrome') return chromium.launch({...base, channel: 'chrome'});
10
+ try { return await chromium.launch(base); } catch (e) {
11
+ // playwright 的 chromium 沒裝 ( 或版本對不上 ): 改用系統的 Chrome.
12
+ // Chrome 會自動更新, 文字寬度可能因此有小數誤差 ( 見 near )
13
+ return chromium.launch({...base, channel: 'chrome'});
14
+ }
15
+ }
16
+
17
+ class Runner {
18
+ constructor(o, port) { this.o = o; this.port = port; this.queue = Promise.resolve(); }
19
+
20
+ async _open() {
21
+ if (this.browser) return;
22
+ this.browser = await launch(this.o);
23
+ this.ctx = await this.browser.newContext({viewport: {width: 1600, height: 1000}, deviceScaleFactor: this.o.dpr || 2});
24
+ }
25
+
26
+ // opt: {grep} 或 {names: [...]} ( 完整名字 ). 每次都開新頁, 拿到 test/index.ls 的最新版
27
+ run(opt = {}) {
28
+ const job = this.queue.then(() => this._run(opt));
29
+ this.queue = job.catch(() => {});
30
+ return job;
31
+ }
32
+
33
+ async _run(opt) {
34
+ await this._open();
35
+ const page = this.page = await this.ctx.newPage();
36
+ page.on('pageerror', e => console.error('[page error]', e.message));
37
+ if (this.o.verbose) page.on('console', m => console.log('[page]', m.text()));
38
+ await page.goto(`http://127.0.0.1:${this.port}/?headless`);
39
+ await page.waitForFunction(() => window.mctest && mctest.ui && (mctest.ui.ready || mctest.ui.error), null, {timeout: 30000});
40
+ const err = await page.evaluate(() => mctest.ui.error);
41
+ if (err) throw new Error(err);
42
+ const results = await page.evaluate((opt) => mctest.ui.run(opt), opt);
43
+ if (opt.keepPage) return results;
44
+ await page.close();
45
+ this.page = null;
46
+ return results;
47
+ }
48
+
49
+ // 失敗的 case 截圖 ( 要在 run 時帶 keepPage )
50
+ async shot(file, dest) {
51
+ if (!this.page) return;
52
+ await this.page.locator(`.case[data-file="${file}"] .pane.current`).screenshot({path: dest}).catch(() => {});
53
+ }
54
+
55
+ async closePage() { if (this.page) await this.page.close(); this.page = null; }
56
+ async close() { if (this.browser) await this.browser.close(); this.browser = null; }
57
+ }
58
+
59
+ function writeSnapshot(srv, r) {
60
+ fs.mkdirSync(srv.snapDir, {recursive: true});
61
+ fs.writeFileSync(path.join(srv.snapDir, r.file + '.html'), r.current);
62
+ }
63
+
64
+ module.exports = {Runner, launch, writeSnapshot};
package/lib/server.js ADDED
@@ -0,0 +1,174 @@
1
+ // mctest server: 在受測 chart 的 repo ( cwd ) 裡起一個 http server.
2
+ //
3
+ // / engine 的 UI ( web/index.html )
4
+ // /engine/<file> engine 的前端檔案 ( <name>.js 由 src/<name>.ls 即時編譯, 其餘在 web/ )
5
+ // /assets/lib/<name>/<ver>/<path>
6
+ // 前端依賴, 規則同 makechart server / fedep ( 版本一律忽略, 用找到的那份 ):
7
+ // 1. -l 指定的本地目錄 ( 有 dist/ 先找 dist/ )
8
+ // 2. 受測的 chart 自己 ( package.json name -> cwd/dist )
9
+ // 3. node_modules ( 先 cwd 再 engine 自己的 ), 含 npm link 的 symlink
10
+ // /test/index.js chart 的 test case ( test/index.ls 即時編譯, 或 test/index.js )
11
+ // /test/<path> chart 的 test/ 目錄 ( 放資料檔用 )
12
+ // /api/info {name, version, links}
13
+ // GET /api/snapshot/<name> 讀 test/snapshot/<name>.html ( 沒有回 204 )
14
+ // POST /api/accept {names} 用 headless 重跑這些 case 並存成 snapshot ( serve 才有, 見 bin/cli.js )
15
+ const http = require('http'), fs = require('fs'), path = require('path');
16
+
17
+ const engineRoot = path.resolve(__dirname, '..');
18
+ const types = {
19
+ '.js': 'application/javascript', '.css': 'text/css', '.html': 'text/html', '.json': 'application/json',
20
+ '.svg': 'image/svg+xml', '.png': 'image/png', '.csv': 'text/csv', '.woff2': 'font/woff2', '.txt': 'text/plain'
21
+ };
22
+
23
+ // "name:dir;name:dir" ( 同 fedep -l ) -> {name: absdir}
24
+ function parseLinks(s) {
25
+ const ret = {};
26
+ (s || '').split(';').map(v => v.trim()).filter(v => v).forEach(v => {
27
+ const i = v.lastIndexOf(':');
28
+ if (i <= 0) throw new Error(`[mctest] bad link spec: ${v} ( expect name:dir )`);
29
+ ret[v.slice(0, i)] = path.resolve(v.slice(i + 1).replace(/^~/, require('os').homedir()));
30
+ });
31
+ return ret;
32
+ }
33
+
34
+ function findModule(name, from) {
35
+ for (let d = from; ; d = path.dirname(d)) {
36
+ const p = path.join(d, 'node_modules', name);
37
+ if (fs.existsSync(path.join(p, 'package.json'))) return p;
38
+ if (d === path.dirname(d)) return null;
39
+ }
40
+ }
41
+
42
+ function isFile(f) { try { return fs.statSync(f).isFile(); } catch (e) { return false; } }
43
+
44
+ function create(opt = {}) {
45
+ const cwd = path.resolve(opt.cwd || '.');
46
+ const pkg = JSON.parse(fs.readFileSync(path.join(cwd, 'package.json')));
47
+ const links = Object.assign({}, opt.links || {});
48
+ const testDir = path.join(cwd, opt.testDir || 'test');
49
+ const snapDir = path.join(testDir, 'snapshot');
50
+
51
+ // 一個模組可能的根目錄, 依序嘗試
52
+ const roots = (name) => {
53
+ const dev = (d) => [path.join(d, 'dist'), d];
54
+ if (links[name]) return dev(links[name]);
55
+ if (name === pkg.name) return dev(cwd);
56
+ const ret = [];
57
+ for (const from of [cwd, engineRoot]) {
58
+ const m = findModule(name, from);
59
+ if (m) ret.push(m, path.join(m, 'dist'));
60
+ }
61
+ return ret;
62
+ };
63
+ const resolveLib = (name, rest) => {
64
+ for (const r of roots(name)) {
65
+ const f = path.join(r, rest);
66
+ if (!f.startsWith(r + path.sep)) return null;
67
+ if (isFile(f)) return f;
68
+ // block 的 path 可以是目錄 ( 例如 @plotdb/konfig 的 base ), 同 registry 補 index.html
69
+ if (isFile(path.join(f, 'index.html'))) return path.join(f, 'index.html');
70
+ }
71
+ return null;
72
+ };
73
+
74
+ // <name>.js 由 src/<name>.ls 即時編譯 ( 依 mtime 快取 ), 開發 engine 時改了重新整理即生效
75
+ const compiled = {};
76
+ const engineFile = (p) => {
77
+ const src = /^[\w-]+\.js$/.test(p) && path.join(engineRoot, 'src', p.replace(/\.js$/, '.ls'));
78
+ if (src && isFile(src)) {
79
+ const m = fs.statSync(src).mtimeMs;
80
+ if (!compiled[p] || compiled[p].m !== m) {
81
+ compiled[p] = {m, code: require('livescript').compile(fs.readFileSync(src, 'utf8'), {filename: src})};
82
+ }
83
+ return {body: compiled[p].code, type: types['.js']};
84
+ }
85
+ const f = path.join(engineRoot, 'web', p);
86
+ if (!f.startsWith(path.join(engineRoot, 'web') + path.sep) || !isFile(f)) return null;
87
+ return {file: f};
88
+ };
89
+
90
+ const caseFile = () => {
91
+ const ls = path.join(testDir, 'index.ls'), js = path.join(testDir, 'index.js');
92
+ if (isFile(ls)) return require('livescript').compile(fs.readFileSync(ls, 'utf8'), {filename: ls});
93
+ if (isFile(js)) return fs.readFileSync(js, 'utf8');
94
+ return 'console.warn("[mctest] no test/index.ls or test/index.js found")';
95
+ };
96
+
97
+ const snapName = (n) => {
98
+ if (!/^[\w.=,+@-]+$/.test(n)) return null;
99
+ return path.join(snapDir, n + '.html');
100
+ };
101
+
102
+ const send = (res, code, body, type) => {
103
+ res.writeHead(code, {'Content-Type': type || 'text/plain; charset=utf-8', 'Cache-Control': 'no-store'});
104
+ res.end(body);
105
+ };
106
+ const sendFile = (res, f) => {
107
+ res.writeHead(200, {'Content-Type': types[path.extname(f)] || 'application/octet-stream', 'Cache-Control': 'no-store'});
108
+ fs.createReadStream(f).pipe(res);
109
+ };
110
+
111
+ const handle = (req, res) => {
112
+ let p;
113
+ try { p = decodeURIComponent(req.url.split('?')[0]); } catch (e) { return send(res, 400, 'bad url'); }
114
+ let m;
115
+ if (p === '/' || p === '/index.html') return sendFile(res, path.join(engineRoot, 'web', 'index.html'));
116
+ if ((m = /^\/engine\/(.+)$/.exec(p))) {
117
+ let r;
118
+ try { r = engineFile(m[1]); } catch (e) { return send(res, 500, String(e.stack || e)); }
119
+ if (!r) return send(res, 404, 'not found');
120
+ return r.file ? sendFile(res, r.file) : send(res, 200, r.body, r.type);
121
+ }
122
+ if ((m = /^\/assets\/lib\/((?:@[^/]+\/)?[^/]+)\/[^/]+\/(.+)$/.exec(p))) {
123
+ const f = resolveLib(m[1], m[2]);
124
+ if (!f) { if (opt.verbose) console.log('[mctest] 404', p); return send(res, 404, 'not found'); }
125
+ return sendFile(res, f);
126
+ }
127
+ if (p === '/test/index.js') {
128
+ try { return send(res, 200, caseFile(), types['.js']); } catch (e) {
129
+ return send(res, 200, `console.error(${JSON.stringify('[mctest] compile test case failed:\n' + (e.stack || e))})`, types['.js']);
130
+ }
131
+ }
132
+ if (p === '/api/info') {
133
+ return send(res, 200, JSON.stringify({name: pkg.name, version: pkg.version, links}), types['.json']);
134
+ }
135
+ if ((m = /^\/api\/snapshot\/(.+)$/.exec(p))) {
136
+ const f = snapName(m[1]);
137
+ if (!f) return send(res, 400, 'bad name');
138
+ // 沒有 snapshot 回 204 而不是 404, 免得瀏覽器 console 每個新 case 都噴一行錯
139
+ return isFile(f) ? sendFile(res, f) : send(res, 204, '');
140
+ }
141
+ if (p === '/api/accept' && req.method === 'POST') {
142
+ if (!api.accept) return send(res, 501, 'accept is only available in `mctest serve`');
143
+ const buf = [];
144
+ req.on('data', d => buf.push(d));
145
+ req.on('end', () => {
146
+ let names;
147
+ try { names = JSON.parse(Buffer.concat(buf).toString()).names; } catch (e) { return send(res, 400, 'bad body'); }
148
+ api.accept(names)
149
+ .then(r => send(res, 200, JSON.stringify(r), types['.json']))
150
+ .catch(e => send(res, 500, String(e.stack || e)));
151
+ });
152
+ return;
153
+ }
154
+ if ((m = /^\/test\/(.+)$/.exec(p))) {
155
+ const f = path.join(testDir, m[1]);
156
+ if (f.startsWith(testDir + path.sep) && isFile(f)) return sendFile(res, f);
157
+ return send(res, 404, 'not found');
158
+ }
159
+ send(res, 404, 'not found');
160
+ };
161
+
162
+ const server = http.createServer(handle);
163
+ const api = {
164
+ server, pkg, cwd, links, snapDir, testDir,
165
+ listen: (port) => new Promise((res, rej) => {
166
+ server.once('error', rej);
167
+ server.listen(port || 0, '127.0.0.1', () => res(server.address().port));
168
+ }),
169
+ close: () => new Promise(res => server.close(res))
170
+ };
171
+ return api;
172
+ }
173
+
174
+ module.exports = {create, parseLinks};
package/package.json CHANGED
@@ -1,6 +1,51 @@
1
1
  {
2
2
  "name": "@makechart/viewer",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.0.1",
4
+ "description": "makechart 圖表的 test suite engine: 用不同資料、參數跑圖, 比對輸出 snapshot, 並以 @plotdb/dash 測 crossfilter",
5
+ "homepage": "https://github.com/makechart/viewer",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "https://github.com/makechart/viewer"
9
+ },
10
+ "bin": {
11
+ "mctest": "bin/cli.js"
12
+ },
13
+ "files": [
14
+ "bin",
15
+ "lib",
16
+ "src",
17
+ "web",
18
+ "CHANGELOG.md"
19
+ ],
20
+ "scripts": {
21
+ "release": "npm publish --access public"
22
+ },
23
+ "keywords": [
24
+ "makechart",
25
+ "chart",
26
+ "test",
27
+ "snapshot"
28
+ ],
29
+ "author": "zbryikt",
30
+ "license": "MIT",
31
+ "dependencies": {
32
+ "@loadingio/ldquery": "^3.0.7",
33
+ "@makechart/base": "^0.1.1",
34
+ "@plotdb/block": "^5.3.0",
35
+ "@plotdb/chart": "^3.5.0",
36
+ "@plotdb/csscope": "^5.0.3",
37
+ "@plotdb/konfig": "^4.11.1",
38
+ "@plotdb/layout": "^0.0.12",
39
+ "@plotdb/rescope": "^5.0.12",
40
+ "@plotdb/semver": "^0.0.3",
41
+ "@xlfont/choose": "^0.0.32",
42
+ "@xlfont/load": "^2.1.6",
43
+ "ldcolor": "^1.1.3",
44
+ "ldview": "^1.7.2",
45
+ "livescript": "^1.6.0",
46
+ "playwright-core": "^1.65.0",
47
+ "proxise": "^1.0.1",
48
+ "wrap-svg-text": "^0.0.8",
49
+ "zmgr": "^2.2.3"
50
+ }
51
+ }
package/src/suite.ls ADDED
@@ -0,0 +1,296 @@
1
+ # mctest - makechart 圖表的 test suite engine ( 瀏覽器端 )
2
+ #
3
+ # chart 的 test/index.ls 用 `mctest.suite {...}` 宣告 case, engine 負責:
4
+ # - 每個 case 建一個新的 chart 實例 ( 或一個 @plotdb/dash board ), 套資料與設定, 跑 steps
5
+ # - 動畫一律切到 manual 再 flush 到終點, 所以輸出跟機器快慢無關
6
+ # - 把圖的 DOM 正規化成 markup ( 數字取到小數兩位、一個 tag 一行 ), 跟 test/snapshot 比對
7
+ #
8
+ # 一個 case:
9
+ # name 唯一的名字, 也是 snapshot 的檔名
10
+ # data suite.data 裡的名字, 或直接給 {raw, binding}
11
+ # config chart.config 的內容 ( 會跟 suite.config 深層合併 )
12
+ # size [w, h] px, 預設 suite.size
13
+ # steps [(chart, ctx) -> ...] 依序執行, 每步之後等畫面穩定. 可回傳 promise
14
+ # ctx.snap(label) 在當下多存一格 ( 預設只存最後的樣子 ). ctx.root 是這個 case 的容器
15
+ # dash {def, size} 用 @plotdb/dash 的 board 跑多張圖 ( 測 crossfilter ).
16
+ # 此時 steps 拿到的是 (board, ctx), ctx.chart(id) 取得某個 panel 的圖
17
+ # skip true 時略過
18
+ #
19
+ # suite 層級: data, cases, config, size, chart ( 預設是 package.json 的 name ), normalize ( [[regexp, 取代字串]] ),
20
+ # tolerance ( 數字容許的誤差, 預設 1 ), quiet ( DOM 多久沒變算穩定, 預設 250ms ). 這兩個 case 也可以各自設
21
+
22
+ mctest = {cases: [], suites: []}
23
+
24
+ registry = ({url, name, version, path, type}) ->
25
+ if url => return url
26
+ if type == \block => return "/assets/lib/#name/#{version or \main}/#{path or \index.html}"
27
+ "/assets/lib/#name/#{version or \main}/#{path or (if type == \css => \index.min.css else \index.min.js)}"
28
+
29
+ mctest.manager = mgr = new block.manager {registry}
30
+
31
+ # ---------------------------------------------------------------- helpers
32
+
33
+ mctest.merge = merge = (a = {}, ...bs) ->
34
+ for b in bs => for k, v of (b or {}) =>
35
+ a[k] = if v and typeof(v) == \object and !Array.isArray(v) =>
36
+ merge (if a[k] and typeof(a[k]) == \object and !Array.isArray(a[k]) => a[k] else {}), v
37
+ else v
38
+ a
39
+
40
+ # 參數的所有組合: combo {type: <[column bar]>, multiple: <[stack group]>}
41
+ # -> [{type: \column, multiple: \stack}, ...] 共 4 組
42
+ mctest.combo = (o = {}) ->
43
+ ret = [{}]
44
+ for k, vs of o =>
45
+ nxt = []
46
+ for r in ret => for v in vs =>
47
+ c = {} <<< r
48
+ c[k] = v
49
+ nxt.push c
50
+ ret = nxt
51
+ ret
52
+
53
+ # 組合轉成名字: {type: \column, multiple: \stack} -> "type=column,multiple=stack"
54
+ mctest.label = (o = {}) -> ["#k=#v" for k, v of o].join \,
55
+
56
+ # 固定種子的亂數 ( 產生測試資料用, 每次都一樣 )
57
+ mctest.random = (seed = 1) ->
58
+ s = seed .>>>. 0
59
+ -> (s := (1664525 * s + 1013904223) .>>>. 0) / 4294967296
60
+
61
+ mctest.file = (n) -> n.replace /[^\w.=,+@-]+/g, \_
62
+
63
+ wait = (t = 0) -> new Promise (res) -> setTimeout res, t
64
+
65
+ # 模擬拖曳 ( 例如 brush ). p0 / p1 是 node 內的相對座標 ( 0 ~ 1 )
66
+ mctest.drag = (node, p0, p1, n = 6) ->
67
+ r = node.getBoundingClientRect!
68
+ pt = ([x, y]) -> {clientX: r.left + r.width * x, clientY: r.top + r.height * y}
69
+ opt = {bubbles: true, cancelable: true, pointerId: 1, isPrimary: true, button: 0, buttons: 1}
70
+ node.dispatchEvent new PointerEvent \pointerdown, ({} <<< opt <<< pt p0)
71
+ for i from 1 to n =>
72
+ p = [p0.0 + (p1.0 - p0.0) * i / n, p0.1 + (p1.1 - p0.1) * i / n]
73
+ window.dispatchEvent new PointerEvent \pointermove, ({} <<< opt <<< pt p)
74
+ window.dispatchEvent new PointerEvent \pointerup, ({} <<< opt <<< pt(p1) <<< {buttons: 0})
75
+ node.dispatchEvent new MouseEvent \click, ({bubbles: true, cancelable: true} <<< pt p1)
76
+
77
+ # ---------------------------------------------------------------- normalize
78
+
79
+ # 每次執行都會變的東西, 換成固定字串. 圖表若有自己的亂數 id, 在 suite.normalize 裡補
80
+ volatile = [
81
+ # ldview 的 scope 屬性名字是亂數
82
+ [/ld-scope-ld-[a-z0-9]+/g, \ld-scope-ld-x]
83
+ # @plotdb/chart 的 legend id ( Math.random )
84
+ [/(pdlg-[a-z]+-)[a-z0-9]+(-)/g, '$1x$2']
85
+ ]
86
+
87
+ # DOM -> markup. 自己序列化而不用 innerHTML: 屬性依名字排序 ( 設定順序會隨執行順序變, 例如頁面上
88
+ # 第一張圖跟之後的不同 ), 一個 tag 一行方便 diff. 產生的 markup 可以直接塞回 innerHTML 重現畫面
89
+ void-tags = <[area base br col embed hr img input link meta source track wbr]>
90
+ esc-attr = (v) -> v.replace(/&/g, \&amp;).replace(/"/g, \&quot;).replace(/</g, \&lt;)
91
+ esc-text = (v) -> v.replace(/&/g, \&amp;).replace(/</g, \&lt;).replace(/>/g, \&gt;)
92
+ mctest.serialize = serialize = (root) ->
93
+ out = []
94
+ walk = (n) ->
95
+ if n.nodeType == 3 =>
96
+ if (t = n.textContent.trim!) => out.push esc-text(t)
97
+ return
98
+ if n.nodeType != 1 => return
99
+ tag = n.tagName
100
+ if !n.namespaceURI or n.namespaceURI == "http://www.w3.org/1999/xhtml" => tag = tag.toLowerCase!
101
+ attrs = Array.from(n.attributes)
102
+ .map -> [it.name, it.value]
103
+ .sort (a, b) -> if a.0 < b.0 => -1 else if a.0 > b.0 => 1 else 0
104
+ .map ([k, v]) -> " #k=\"#{esc-attr v}\""
105
+ .join ''
106
+ out.push "<#tag#attrs>"
107
+ if tag in void-tags => return
108
+ Array.from(n.childNodes).map walk
109
+ out.push "</#tag>"
110
+ Array.from(root.childNodes).map walk
111
+ out.join \\n
112
+
113
+ # 數字取到小數兩位 ( 去掉尾端 0 )
114
+ mctest.normalize = normalize = (node, extra = []) ->
115
+ html = serialize node
116
+ for [re, v] in volatile ++ extra => html = html.replace re, v
117
+ html
118
+ .replace /-?\d+\.\d+(e-?\d+)?/g, (m) ->
119
+ v = +(+m).toFixed(2)
120
+ if v == 0 => \0 else String(v)
121
+
122
+ sep = (label) -> "<!-- mctest:snap #label -->"
123
+ mctest.join-snaps = (snaps) -> snaps.map((s) -> "#{sep s.label}\n#{s.markup}").join("\n")
124
+ mctest.split-snaps = (text) ->
125
+ ret = []
126
+ text.split(/^<!-- mctest:snap (.*?) -->$/m).slice(1).map (v, i, a) ->
127
+ if i % 2 == 0 => ret.push {label: v, markup: (a[i + 1] or '').trim!}
128
+ ret
129
+
130
+ # ---------------------------------------------------------------- settle
131
+
132
+ # 等畫面穩定: 有 anim 的圖直接 flush 到終點; 沒有的 ( 還在用 d3 transition ) 只能等.
133
+ # render 可能是 debounce / ResizeObserver 觸發的, 所以 flush 後要再看 markup 有沒有變
134
+ # 等到 DOM 連續 quiet ms 沒有變動才算穩定 ( 預設 250, 要比圖裡的 debounce 長 - 例如 bar 的 brush
135
+ # 150ms 後才發 filter, board 再重畫 ). 期間每一幀都 flush, 有 anim 的圖補間會直接跳到終點.
136
+ # list 是回傳目前所有圖的 function ( dash 的 panel 圖是非同步建立的, 每次都重抓 ),
137
+ # 新抓到的圖一律切 manual. 沒有 anim 的圖 ( 還在用 d3 transition ) 只能靠 quiet 等它跑完
138
+ settle = (root, list, quiet = 250, limit = 10000) ->
139
+ new Promise (res) ->
140
+ last = performance.now!
141
+ t0 = last
142
+ mo = new MutationObserver -> last := performance.now!
143
+ mo.observe root, {subtree: true, childList: true, attributes: true, characterData: true}
144
+ tick = ->
145
+ charts = list!filter -> it
146
+ charts.map ->
147
+ if !it.anim => return
148
+ if !it.anim._manual => it.anim.manual true
149
+ it.anim.flush!
150
+ now = performance.now!
151
+ if now - last >= quiet or now - t0 > limit =>
152
+ mo.disconnect!
153
+ return res!
154
+ requestAnimationFrame tick
155
+ requestAnimationFrame tick
156
+
157
+ # ---------------------------------------------------------------- suite
158
+
159
+ mctest.suite = (s = {}) ->
160
+ s.size = s.size or [480, 320]
161
+ mctest.suites.push s
162
+ (s.cases or []).map (c) ->
163
+ mctest.cases.push ({} <<< c <<< {suite: s, file: mctest.file(c.name)})
164
+ s
165
+
166
+ get-data = (s, d) ->
167
+ if !d => d = Object.keys(s.data or {}).0
168
+ if typeof(d) == \string =>
169
+ if !(s.data and s.data[d]) => throw new Error("[mctest] unknown data `#d`")
170
+ d = s.data[d]
171
+ if typeof(d) == \function => d = d!
172
+ JSON.parse JSON.stringify d
173
+
174
+ chart-ref = (s) -> ({version: \main} <<< (s.chart or {name: mctest.info.name}))
175
+
176
+ make-chart = (s, root) ->
177
+ mgr.get chart-ref(s)
178
+ .then (bc) -> bc.create {data: {}}
179
+ .then (bi) -> bi.attach {root} .then -> bi.interface!
180
+ .then (chart) ->
181
+ if chart.anim => chart.anim.manual true
182
+ chart
183
+
184
+ load-dash = ->
185
+ if mctest._dash => return mctest._dash
186
+ base = "/assets/lib/@plotdb/dash/main/web/static"
187
+ mctest._dash = new Promise (res, rej) ->
188
+ css = document.createElement \link
189
+ css <<< {rel: \stylesheet, href: "#base/css/dash.css"}
190
+ document.head.appendChild css
191
+ js = document.createElement \script
192
+ js.src = "#base/js/dash.js"
193
+ js.onload = -> res window.dash
194
+ js.onerror = -> rej new Error("[mctest] @plotdb/dash not found - link it with `-l @plotdb/dash:<dir>`")
195
+ document.head.appendChild js
196
+
197
+ # 跑一個 case. root 是給它用的容器 ( 大小由這裡設 ). 回傳 {snaps, chart | board}
198
+ mctest.run-case = (c, root) ->
199
+ s = c.suite
200
+ [w, h] = c.size or (c.dash and c.dash.size) or s.size
201
+ root.style <<< {width: "#{w}px", height: "#{h}px"}
202
+ snaps = []
203
+ charts = []
204
+ list = -> charts
205
+ q = c.quiet ? s.quiet
206
+ ctx =
207
+ root: root
208
+ snap: (label) ->
209
+ settle(root, list, q).then -> snaps.push {label: (label or "step#{snaps.length}"), markup: normalize(root, s.normalize)}
210
+ drag: mctest.drag
211
+ wait: wait
212
+ random: mctest.random
213
+ run-steps = (target) ->
214
+ # 先等第一次畫完, step 才找得到節點
215
+ (c.steps or []).reduce ((p, f) -> p.then(-> f target, ctx).then -> settle(root, list, q)), settle(root, list, q)
216
+ .then -> snaps.push {label: \final, markup: normalize(root, s.normalize)}
217
+ .then -> {snaps, target}
218
+ if c.dash => return load-dash!then (dash) ->
219
+ board = new dash.board do
220
+ root: root
221
+ manager: mgr
222
+ def: JSON.parse(JSON.stringify(c.dash.def))
223
+ panel: {name: "@plotdb/dash", version: \main, path: "web/static/initiative/1st/block/panel/0.0.1/index.html"}
224
+ ctx.chart = (id) -> ((board.panels.filter(-> it.id == id).0 or {}).itf or {}).chart
225
+ list := -> board.panels.map -> (it.itf or {}).chart
226
+ board.init!then -> settle root, list, q
227
+ .then -> run-steps board
228
+ make-chart s, root
229
+ .then (chart) ->
230
+ charts.push chart
231
+ cfg = merge {}, (s.config or {}), (c.config or {})
232
+ chart.config cfg
233
+ d = get-data s, c.data
234
+ chart.set-raw d.raw, d.binding
235
+ if d.subset => chart.subset.set d.subset
236
+ run-steps chart
237
+
238
+ # 跟 snapshot 比對. 回傳 {status, current, baseline, line, expect, actual, delta}
239
+ # - pass 完全相同
240
+ # - near 結構相同, 數字差都在 tolerance 內 ( 預設 1 ). 不同 DPR / 瀏覽器版本的文字寬度會有小數誤差,
241
+ # html 版面換算到 svg 的位置取整後就會差 1px - 這種不算壞掉, 但會標出來
242
+ # - diff 其他. line / expect / actual 是第一個不同的行
243
+ # - new 還沒有 snapshot
244
+ num = /-?\d+(?:\.\d+)?/g
245
+ near-line = (a, b, tol) ->
246
+ if a.replace(num, \#) != b.replace(num, \#) => return null
247
+ [na, nb] = [(a.match(num) or []), (b.match(num) or [])]
248
+ d = 0
249
+ for v, i in na => d >?= Math.abs(+v - +nb[i])
250
+ if d <= tol => d else null
251
+
252
+ mctest.compare = (c, snaps) ->
253
+ current = mctest.join-snaps snaps
254
+ tol = c.tolerance ? c.suite.tolerance ? 1
255
+ fetch "/api/snapshot/#{c.file}"
256
+ .then (r) -> if r.status == 204 => null else r.text!
257
+ .then (baseline) ->
258
+ if !(baseline?) => return {status: \new, current}
259
+ if baseline.trim! == current.trim! => return {status: \pass, current, baseline}
260
+ a = baseline.trim!split \\n
261
+ b = current.trim!split \\n
262
+ first = null
263
+ delta = 0
264
+ for i from 0 til Math.max(a.length, b.length) =>
265
+ if a[i] == b[i] => continue
266
+ if !(first?) => first = i
267
+ d = if a[i]? and b[i]? => near-line(a[i], b[i], tol) else null
268
+ if !(d?) => return {status: \diff, current, baseline, line: i + 1, expect: a[i], actual: b[i]}
269
+ delta >?= d
270
+ {status: \near, current, baseline, delta, line: first + 1, expect: a[first], actual: b[first]}
271
+
272
+ # 存 snapshot 一律交給 server 用 headless 重跑 ( 見 lib/runner.js ), 不存 UI 所在瀏覽器畫的版本
273
+ mctest.accept = (names) ->
274
+ fetch \/api/accept, {method: \POST, headers: {"Content-Type": "application/json"}, body: JSON.stringify({names})}
275
+ .then (r) -> if r.ok => r.json! else r.text!then -> throw new Error(it)
276
+
277
+ mctest.match = (c, grep, names) ->
278
+ if names => return c.name in names
279
+ if !grep or c.name.indexOf(grep) >= 0 => return true
280
+ try
281
+ new RegExp(grep).test c.name
282
+ catch e
283
+ false
284
+
285
+ mctest.boot = ->
286
+ mgr.init!
287
+ .then -> fetch \/api/info
288
+ .then (r) -> r.json!
289
+ .then (info) -> mctest.info = info
290
+ .then ->
291
+ new Promise (res, rej) ->
292
+ s = document.createElement \script
293
+ s <<< {src: \/test/index.js, onload: res, onerror: -> rej new Error("[mctest] load test/index.js failed")}
294
+ document.head.appendChild s
295
+
296
+ window.mctest = mctest
package/src/ui.ls ADDED
@@ -0,0 +1,148 @@
1
+ # mctest UI: 列出所有 case, 跑完跟 snapshot 比對.
2
+ # - 一般開啟: 每個 case 並排顯示 current ( 目前的程式畫的, 最後一格是活的, 可以操作 ) 與 baseline
3
+ # ( 存下來的 markup 直接塞回頁面, chart 的 css 已經載入, 所以看起來就是當時的樣子 ). 可以 accept
4
+ # - ?headless: 不自動跑, 由 cli 呼叫 mctest.ui.run 拿結果 ( cli 自己寫檔、截圖 )
5
+
6
+ $ = (s) -> document.querySelector s
7
+ el = (tag, cls, txt) ->
8
+ n = document.createElement tag
9
+ if cls => n.className = cls
10
+ if txt? => n.textContent = txt
11
+ n
12
+
13
+ ui = mctest.ui = {results: {}}
14
+ params = new URLSearchParams(location.search)
15
+ headless = params.has \headless
16
+
17
+ frame-of = (c, markup) ->
18
+ [w, h] = c.size or (c.dash and c.dash.size) or c.suite.size
19
+ f = el \div, \frame
20
+ f.style <<< {width: "#{w}px", height: "#{h}px"}
21
+ if markup? => f.innerHTML = markup
22
+ f
23
+
24
+ snap-node = (label, node) ->
25
+ s = el \div, \snap
26
+ s.appendChild el(\div, \label, label)
27
+ s.appendChild node
28
+ s
29
+
30
+ card = (c) ->
31
+ n = el \div, \case
32
+ n.dataset.file = c.file
33
+ head = el \div, \head
34
+ head.appendChild el(\span, \name, c.name)
35
+ head.appendChild (n._badge = el \span, \badge, \running)
36
+ head.appendChild (n._accept = el \button, '', \accept)
37
+ n._accept.style.display = \none
38
+ head.appendChild (n._info = el \span, \info)
39
+ n.appendChild head
40
+ panes = el \div, \panes
41
+ cur = el \div, 'pane current'
42
+ cur.appendChild el(\div, \t, \current)
43
+ cur.appendChild (n._cur = el \div, \snaps)
44
+ base = el \div, 'pane baseline'
45
+ base.appendChild el(\div, \t, \baseline)
46
+ base.appendChild (n._base = el \div, \snaps)
47
+ panes.appendChild cur
48
+ panes.appendChild base
49
+ n.appendChild panes
50
+ n.appendChild (n._diff = el \pre, \diff)
51
+ n
52
+
53
+ set-status = (n, r) ->
54
+ n.className = "case #{r.status}"
55
+ n._badge.className = "badge #{r.status}"
56
+ n._badge.textContent = r.status
57
+ # near 是這個瀏覽器跟 headless 的誤差, accept 也只會存回一樣的東西
58
+ n._accept.style.display = if r.status in <[diff new]> => '' else \none
59
+ n._diff.textContent = if r.status == \near =>
60
+ "跟 snapshot 只差在數字 ( 最多 #{r.delta} ) - 多半是這個瀏覽器跟 headless 的文字寬度誤差. cli 預設仍算失敗, 以 cli 為準. 第一處在 line #{r.line}\n- #{r.expect}\n+ #{r.actual}"
61
+ else if r.status == \diff =>
62
+ "first diff at line #{r.line}\n- #{r.expect ? '( none )'}\n+ #{r.actual ? '( none )'}"
63
+ else if r.status == \error => r.error
64
+ else ''
65
+
66
+ # case 一律在固定於 (0, 0) 的 stage 上跑, 跑完才搬進卡片. 圖的版面 ( 例如 legend 從 html 換算到 svg 的位置 )
67
+ # 會受頁面上絕對座標的小數部分影響 ( 各自取整 ), 不固定的話前面的卡片高度一變, 後面的數字就差 1px
68
+ stage = el \div, \stage
69
+ document.body.appendChild stage
70
+
71
+ run-one = (c, n) ->
72
+ # 最後一格用活的 chart; 中間的 snap 跟 baseline 都是靜態的 markup
73
+ live = frame-of c
74
+ stage.appendChild live
75
+ Promise.resolve!
76
+ .then -> mctest.run-case c, live
77
+ .finally -> n._cur.appendChild snap-node(\final, live)
78
+ .then ({snaps}) ->
79
+ snaps.slice(0, -1).map (s) -> n._cur.insertBefore snap-node(s.label, frame-of(c, s.markup)), n._cur.lastChild
80
+ mctest.compare c, snaps
81
+ .catch (e) -> {status: \error, error: String(e.stack or e)}
82
+ .then (r) ->
83
+ if r.baseline and !headless =>
84
+ mctest.split-snaps(r.baseline).map (s) -> n._base.appendChild snap-node(s.label, frame-of(c, s.markup))
85
+ set-status n, r
86
+ n._accept.onclick = -> ui.accept [c]
87
+ ui.results[c.file] = r <<< {name: c.name, file: c.file}
88
+
89
+ summary = ->
90
+ cnt = {}
91
+ for k, r of ui.results => cnt[r.status] = (cnt[r.status] or 0) + 1
92
+ $(\#summary).innerHTML = ''
93
+ for k in <[pass near diff new error skip]> => if cnt[k] =>
94
+ $(\#summary).appendChild el(\span, "badge #k", "#k #{cnt[k]}")
95
+
96
+ # headless 重跑後存檔, 再用新的 snapshot 重新比對畫面上這次的結果 ( 這個瀏覽器可能是 near )
97
+ ui.accept = (cs) ->
98
+ if !cs.length => return
99
+ nodes = cs.map (c) -> document.querySelector ".case[data-file=\"#{c.file}\"]"
100
+ nodes.map -> if it => it._badge.textContent = \saving
101
+ mctest.accept cs.map(-> it.name)
102
+ .then -> Promise.all cs.map (c, i) ->
103
+ r = ui.results[c.file]
104
+ n = nodes[i]
105
+ mctest.compare c, mctest.split-snaps(r.current) .then (nr) ->
106
+ n._base.innerHTML = ''
107
+ if nr.baseline => mctest.split-snaps(nr.baseline).map (s) -> n._base.appendChild snap-node(s.label, frame-of(c, s.markup))
108
+ ui.results[c.file] = nr <<< {name: c.name, file: c.file}
109
+ set-status n, nr
110
+ .catch (e) -> nodes.map -> if it => set-status it, {status: \error, error: "accept failed: #{e.message or e}"}
111
+ .then -> summary!
112
+
113
+ # 依序跑 ( 同時跑會互相搶 rAF / 版面, 數字也比較難重現 )
114
+ ui.run = (opt = {}) ->
115
+ root = $(\#cases)
116
+ root.innerHTML = ''
117
+ ui.results = {}
118
+ list = mctest.cases.filter -> mctest.match it, opt.grep, opt.names
119
+ list.reduce ((p, c) ->
120
+ n = card c
121
+ root.appendChild n
122
+ if c.skip =>
123
+ ui.results[c.file] = {name: c.name, file: c.file, status: \skip}
124
+ set-status n, {status: \skip}
125
+ return p
126
+ p.then -> run-one c, n .then -> summary!
127
+ ), Promise.resolve!
128
+ .then -> [v for k, v of ui.results]
129
+
130
+ mctest.boot!
131
+ .then ->
132
+ $(\#target).textContent = "#{mctest.info.name}@#{mctest.info.version} · #{mctest.cases.length} cases"
133
+ $(\#grep).value = params.get(\grep) or ''
134
+ $(\#run).onclick = ->
135
+ u = new URL(location.href)
136
+ if $(\#grep).value => u.searchParams.set \grep, $(\#grep).value else u.searchParams.delete \grep
137
+ history.replaceState null, '', u.toString!
138
+ ui.run grep: $(\#grep).value
139
+ $(\#grep).onkeydown = (e) -> if e.key == \Enter => $(\#run).click!
140
+ $(\#only-fail).onchange = -> document.body.classList.toggle \only-fail, $(\#only-fail).checked
141
+ $(\#accept-all).onclick = ->
142
+ files = Array.from(document.querySelectorAll '.case.diff, .case.new').map -> it.dataset.file
143
+ ui.accept mctest.cases.filter -> it.file in files
144
+ ui.ready = true
145
+ if !headless => ui.run grep: $(\#grep).value
146
+ .catch (e) ->
147
+ ui.error = String(e.stack or e)
148
+ $(\#cases).textContent = ui.error
package/web/index.html ADDED
@@ -0,0 +1,58 @@
1
+ <!doctype html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <title>mctest</title>
7
+ <style>
8
+ :root { --fg: #222; --dim: #888; --line: #ddd; --bg: #fff; --pass: #2b8a3e; --diff: #c92a2a; --new: #e67700; --near: #74b816; }
9
+ * { box-sizing: border-box; }
10
+ body { margin: 0; font: 13px/1.5 system-ui, sans-serif; color: var(--fg); background: var(--bg); }
11
+ header { position: sticky; top: 0; z-index: 10; display: flex; gap: .6em; align-items: center; flex-wrap: wrap;
12
+ padding: .6em 1em; background: #f8f9fa; border-bottom: 1px solid var(--line); }
13
+ header b { font-size: 1.1em; }
14
+ header input { width: 16em; padding: .2em .4em; }
15
+ button { padding: .15em .7em; font: inherit; border: 1px solid var(--line); border-radius: 3px; background: #fff; cursor: pointer; }
16
+ button:hover { border-color: var(--fg); }
17
+ #summary span { margin-right: .8em; }
18
+ main { padding: 1em; display: flex; flex-direction: column; gap: 1.2em; }
19
+ .case { border: 1px solid var(--line); border-radius: 4px; }
20
+ .case > .head { display: flex; gap: .6em; align-items: center; padding: .4em .8em; border-bottom: 1px solid var(--line); background: #fcfcfc; }
21
+ .case > .head .name { font-weight: bold; font-family: ui-monospace, monospace; }
22
+ .badge { padding: 0 .5em; border-radius: 1em; color: #fff; background: var(--dim); font-size: .85em; }
23
+ .badge.pass { background: var(--pass); } .badge.diff, .badge.error { background: var(--diff); } .badge.new { background: var(--new); } .badge.near { background: var(--near); }
24
+ .case .panes { display: flex; gap: 1em; padding: .8em; overflow-x: auto; }
25
+ .pane > .t { color: var(--dim); font-size: .85em; margin-bottom: .3em; }
26
+ .snaps { display: flex; flex-direction: column; gap: .6em; }
27
+ .snap > .label { color: var(--dim); font-size: .8em; font-family: ui-monospace, monospace; }
28
+ .frame { position: relative; border: 1px dashed var(--line); overflow: hidden; }
29
+ .case pre.diff { margin: 0; padding: .6em .8em; border-top: 1px solid var(--line); background: #fff5f5; white-space: pre-wrap; font-size: 12px; }
30
+ .case pre.diff:empty { display: none; }
31
+ .case.pass .panes .pane.baseline { display: none; }
32
+ .case.near pre.diff { background: #f4fce3; }
33
+ body.only-fail .case.pass, body.only-fail .case.near { display: none; }
34
+ .stage { position: absolute; left: 0; top: 0; z-index: 100; background: var(--bg); }
35
+ .stage:empty { display: none; }
36
+ </style>
37
+ </head>
38
+ <body>
39
+ <header>
40
+ <b>mctest</b><span id="target"></span>
41
+ <input id="grep" placeholder="filter ( substring / regexp )">
42
+ <button id="run">run</button>
43
+ <label><input type="checkbox" id="only-fail"> 只看沒過的</label>
44
+ <button id="accept-all">accept all</button>
45
+ <span id="summary"></span>
46
+ </header>
47
+ <main id="cases"></main>
48
+ <script src="/assets/lib/proxise/main/index.min.js"></script>
49
+ <script src="/assets/lib/@loadingio/ldquery/main/index.min.js"></script>
50
+ <script src="/assets/lib/ldview/main/index.min.js"></script>
51
+ <script src="/assets/lib/@plotdb/semver/main/index.min.js"></script>
52
+ <script src="/assets/lib/@plotdb/csscope/main/index.min.js"></script>
53
+ <script src="/assets/lib/@plotdb/rescope/main/index.min.js"></script>
54
+ <script src="/assets/lib/@plotdb/block/main/index.min.js"></script>
55
+ <script src="/engine/suite.js"></script>
56
+ <script src="/engine/ui.js"></script>
57
+ </body>
58
+ </html>