Files
void 17217dbeb1 feat: 考试结果页去重与跳课,构建镜像脚本支持国内换源
考试:
- 新增 src/exam-plan.js(纯函数)判定结果页处置:只有本页确实点过
  「提交考试/确定交卷」才算一次空卷交卷,平台恢复的旧结果页先回
  「考试说明页」重进,不再在结果页和课程页之间空转
- 重试也不会好的确定性失败(交卷次数到上限、说明页无「开始考试」、
  答卷页无「提交考试」、结果页反复回退)改为本轮跳过该课继续下一门,
  记录在 S.skippedCourses(sessionStorage),不会停下整轮刷课
- 新一轮开跑时清空 skippedCourses / examEmptySubmits,人工处理后可重试
- 补 dev/tests/exam-test.mjs(npm run test:exam,5 条用例)

构建:
- 新增 scripts/build-docker.mjs/.cmd/.sh(npm run docker:build):
  国内换源、按包版本打标签、构建后自检、--dry-run
- Dockerfile 增加 APT_MIRROR / NPM_REGISTRY 构建参数,
  docker-compose.yml 透传三个 build args,.env.example 补说明
2026-10-29 21:31:45 +08:00

343 lines
13 KiB
JavaScript
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
#!/usr/bin/env node
/**
* 构建 Docker 镜像的便捷入口。
*
* 为什么要有这层脚本,而不是让人手敲 `docker build`:
* 1. Dockerfile 里有三个构建参数(APT_MIRROR / NPM_REGISTRY / CHROME_DEB_URL),
* 国内机器几乎必须换源才能构建成功,但每次手写 `--build-arg` 又长又容易漏;
* 这里统一从命令行、环境变量、.env 三处按优先级取值。
* 2. 镜像标签跟着 package.json 的 version 走,顺手再打一个 latest;
* 版本号只在 package.json 维护一处,不靠人记。
* 3. 构建完能直接 `--check`(只读自检:不登录、不动进度),一步验证镜像真的能起来。
*
* 用法:
* npm run docker:build # 默认标签 = 包里版本号 + latest
* npm run docker:build -- --mirror # 一键换国内源(apt 清华 + npm npmmirror)
* npm run docker:build -- --check # 构建完立刻跑一次 --check 自检
* npm run docker:build -- --tag my/yxt:dev # 只打指定标签
* npm run docker:build -- --dry-run # 只打印将要执行的 docker 命令
* npm run docker:build -- --help
*
* 退出码与仓库其它脚本保持一致:0 成功 / 1 构建失败 / 2 环境或参数问题。
*/
import fs from 'node:fs';
import path from 'node:path';
import { spawnSync } from 'node:child_process';
import { fileURLToPath } from 'node:url';
const ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
/** 国内常用镜像源预设(--mirror 一键套用);Chrome 的 deb 没有公认镜像,只能由使用者用 --chrome-url 指定 */
const MIRROR_PRESET = {
apt: 'mirrors.tuna.tsinghua.edu.cn',
npm: 'https://registry.npmmirror.com',
};
const HELP = `构建云学堂助手 Docker 镜像
用法:node scripts/build-docker.mjs [选项]
选项:
-t, --tag <名称:标签> 镜像标签;可重复给多次。默认 <包名>:<package.json 版本> 加 <包名>:latest
--mirror 一键套用国内镜像源(apt = ${MIRROR_PRESET.apt},npm = ${MIRROR_PRESET.npm})
--apt-mirror <host> Debian 源地址,对应 Dockerfile 的 APT_MIRROR
--npm-registry <url> npm 源地址,对应 NPM_REGISTRY
--chrome-url <url> Chrome deb 直链,对应 CHROME_DEB_URL(国内下不动 dl.google.com 时用)
--platform <平台> 如 linux/amd64、linux/arm64(默认用构建机架构)
--build-arg <K=V> 透传任意额外构建参数,可重复
--no-cache 不用构建缓存
--pull 先拉取最新的基础镜像
--check 构建成功后跑一次 \`docker run --rm <镜像> --check\` 自检
--dry-run 只打印 docker 命令,不真正构建
-h, --help 显示本帮助
取值优先级:命令行 > 同名环境变量 > 仓库根目录 .env > 默认值
(只从 .env 读 APT_MIRROR / NPM_REGISTRY / CHROME_DEB_URL 三个键,凭据类变量一律不读)
示例:
node scripts/build-docker.mjs --mirror --check
node scripts/build-docker.mjs -t yun-xue-tang-assistant:test --no-cache
APT_MIRROR=mirrors.aliyun.com node scripts/build-docker.mjs
`;
/** 解析成 { options, error } —— 手写解析而非引入依赖,仓库唯一的 devDependency 是 esbuild */
function parseArgs(argv) {
const opts = {
tags: [],
mirror: false,
aptMirror: '',
npmRegistry: '',
chromeUrl: '',
platform: '',
buildArgs: [],
noCache: false,
pull: false,
check: false,
dryRun: false,
help: false,
};
const needValue = (i, name) => {
const v = argv[i + 1];
if (v === undefined || v.startsWith('-')) {
throw new Error(`选项 ${name} 需要一个值`);
}
return v;
};
for (let i = 0; i < argv.length; i++) {
const arg = argv[i];
// 支持 --key=value 与 --key value 两种写法
const eq = arg.indexOf('=');
const key = arg.startsWith('--') && eq > 0 ? arg.slice(0, eq) : arg;
const inline = arg.startsWith('--') && eq > 0 ? arg.slice(eq + 1) : null;
const take = (name) => (inline !== null ? inline : needValue(i, name));
const takeAndSkip = (name) => {
const v = take(name);
if (inline === null) i++;
return v;
};
switch (key) {
case '-t':
case '--tag': {
const v = takeAndSkip(key);
if (!v.trim()) throw new Error('镜像标签不能为空');
opts.tags.push(v.trim());
break;
}
case '--mirror':
opts.mirror = true;
break;
case '--apt-mirror':
opts.aptMirror = takeAndSkip(key);
break;
case '--npm-registry':
opts.npmRegistry = takeAndSkip(key);
break;
case '--chrome-url':
opts.chromeUrl = takeAndSkip(key);
break;
case '--platform':
opts.platform = takeAndSkip(key);
break;
case '--build-arg':
opts.buildArgs.push(takeAndSkip(key));
break;
case '--no-cache':
opts.noCache = true;
break;
case '--pull':
opts.pull = true;
break;
case '--check':
opts.check = true;
break;
case '--dry-run':
opts.dryRun = true;
break;
case '-h':
case '--help':
opts.help = true;
break;
default:
throw new Error(`未知选项:${arg}`);
}
}
return opts;
}
/** 极简 .env 解析:只认 KEY=VALUE / KEY="VALUE",忽略注释与空行 */
function readDotEnv(file) {
const out = {};
if (!fs.existsSync(file)) return out;
let text = '';
try {
text = fs.readFileSync(file, 'utf8');
} catch {
return out;
}
for (const raw of text.split(/\r?\n/)) {
const line = raw.trim();
if (!line || line.startsWith('#')) continue;
const m = /^(?:export\s+)?([A-Za-z_][A-Za-z0-9_]*)\s*=\s*(.*)$/.exec(line);
if (!m) continue;
let v = m[2].trim();
if ((v.startsWith('"') && v.endsWith('"')) || (v.startsWith("'") && v.endsWith("'"))) {
v = v.slice(1, -1);
}
out[m[1]] = v;
}
return out;
}
function readPackage(file) {
try {
return JSON.parse(fs.readFileSync(file, 'utf8'));
} catch (e) {
throw new Error(`读不出 ${path.relative(ROOT, file)}:${e.message}`);
}
}
/** 把参数数组还原成可以直接粘进终端的命令行(仅用于日志展示) */
function quote(argv) {
return argv
.map((a) => (/^[\w@%+=:,./-]+$/.test(a) ? a : `'${a.replace(/'/g, `'\\''`)}'`))
.join(' ');
}
function run(cmd, args, { capture = false } = {}) {
return spawnSync(cmd, args, {
cwd: ROOT,
stdio: capture ? ['ignore', 'pipe', 'pipe'] : 'inherit',
encoding: 'utf8',
});
}
function main() {
let opts;
try {
opts = parseArgs(process.argv.slice(2));
} catch (e) {
console.error('[错误] ' + e.message);
console.error('用 --help 查看用法。');
return 2;
}
if (opts.help) {
process.stdout.write(HELP);
return 0;
}
if (!fs.existsSync(path.join(ROOT, 'Dockerfile'))) {
console.error('[错误] 找不到 Dockerfile,请在仓库根目录运行。');
return 2;
}
// ---- 1. 检查 docker 是否可用(CLI 缺失和守护进程没起来,处理方式完全不同,分开报) ----
// --dry-run 只打印命令、不真的构建,所以这里只警告不拦截,方便在没有 docker 的机器上预览
const cli = run('docker', ['--version'], { capture: true });
const cliOk = !cli.error && cli.status === 0;
if (!cliOk) {
const msg = '找不到可用的 docker 命令,请先安装 Docker Desktop / Docker Engine。';
if (!opts.dryRun) {
console.error('[错误] ' + msg);
if (cli.stderr) console.error(String(cli.stderr).trim());
return 2;
}
console.log('[警告] ' + msg + '(dry-run 继续)');
} else {
console.log('[环境] ' + String(cli.stdout).trim());
}
// 守护进程没启动时,docker build 会报一长串语焉不详的连接错误,这里提前拦下
if (cliOk) {
const daemon = run('docker', ['info', '--format', '{{.ServerVersion}}'], { capture: true });
if (daemon.status !== 0) {
const detail = String(daemon.stderr || '').trim();
if (!opts.dryRun) {
console.error('[错误] docker 守护进程未运行(Docker Desktop 没启动 / 当前用户没权限连 socket)。');
if (detail) console.error(detail);
return 2;
}
console.log('[警告] docker 守护进程未运行(dry-run 继续)');
} else {
console.log('[环境] 守护进程 ' + String(daemon.stdout).trim());
}
}
// ---- 2. 收集构建参数:命令行 > 环境变量 > .env > 默认 ----
const pkg = readPackage(path.join(ROOT, 'package.json'));
const dotenv = readDotEnv(path.join(ROOT, '.env'));
const pick = (cliValue, envKey) =>
cliValue || process.env[envKey] || dotenv[envKey] || '';
let aptMirror = pick(opts.aptMirror, 'APT_MIRROR');
let npmRegistry = pick(opts.npmRegistry, 'NPM_REGISTRY');
const chromeUrl = pick(opts.chromeUrl, 'CHROME_DEB_URL');
if (opts.mirror) {
// --mirror 只填空位,不覆盖使用者显式给的值
if (!aptMirror) aptMirror = MIRROR_PRESET.apt;
if (!npmRegistry) npmRegistry = MIRROR_PRESET.npm;
}
const buildArgs = [];
if (aptMirror) buildArgs.push('--build-arg', 'APT_MIRROR=' + aptMirror);
if (npmRegistry) buildArgs.push('--build-arg', 'NPM_REGISTRY=' + npmRegistry);
if (chromeUrl) buildArgs.push('--build-arg', 'CHROME_DEB_URL=' + chromeUrl);
// 额外的 --build-arg 放最后,允许覆盖上面的预设
for (const kv of opts.buildArgs) buildArgs.push('--build-arg', kv);
// ---- 3. 标签:没给就按 package.json 的版本号打 version + latest ----
const repoName = (pkg.name || 'yun-xue-tang-assistant').toLowerCase();
const version = pkg.version || 'dev';
const tags = opts.tags.length ? opts.tags : [`${repoName}:${version}`, `${repoName}:latest`];
const args = ['build'];
if (opts.platform) args.push('--platform', opts.platform);
if (opts.noCache) args.push('--no-cache');
if (opts.pull) args.push('--pull');
for (const t of tags) args.push('-t', t);
args.push(...buildArgs, '.');
const cmdline = 'docker ' + quote(args);
console.log('[构建] 镜像标签:' + tags.join('、'));
console.log('[构建] 上下文:' + ROOT);
if (aptMirror) console.log('[构建] APT_MIRROR = ' + aptMirror);
if (npmRegistry) console.log('[构建] NPM_REGISTRY = ' + npmRegistry);
if (chromeUrl) console.log('[构建] CHROME_DEB_URL= ' + chromeUrl);
if (!chromeUrl) console.log('[构建] CHROME_DEB_URL 未指定,将从 dl.google.com 下载(国内网络可能失败,见 README 常见问题)');
console.log('[构建] 命令:' + cmdline);
console.log('[构建] 首次构建约 3-5 分钟(主要是下 Chrome 的 deb),后续走缓存会快很多。\n');
if (opts.dryRun) {
console.log('[dry-run] 未执行构建。');
return 0;
}
// ---- 4. 真正构建 ----
const build = run('docker', args);
if (build.error) {
console.error('[错误] 启动 docker build 失败:' + build.error.message);
return 2;
}
if (build.status !== 0) {
console.error('\n[失败] 构建未通过(退出码 ' + build.status + ')。常见原因:');
console.error(' · 拉不到 Chrome deb → 加 --chrome-url <你的镜像地址>,或先配好代理');
console.error(' · apt / npm 太慢 → 加 --mirror 换国内源');
console.error(' · 依赖变了但缓存没失效 → 加 --no-cache 重来一次');
return 1;
}
const primary = tags[0];
console.log('\n[完成] 已构建:' + tags.join('、'));
// ---- 5. 可选自检:只读,不登录、不动课程进度,用来确认镜像真的能起来 ----
if (opts.check) {
console.log('[自检] 运行 docker run --rm ' + primary + ' --check ...\n');
const chk = run('docker', ['run', '--rm', primary, '--check']);
if (chk.status !== 0) {
console.error('\n[失败] 镜像自检未通过(退出码 ' + chk.status + ')。');
return 1;
}
console.log('\n[自检] 通过:镜像内的 Node、Chrome、构建产物都可用。');
}
console.log(`
下一步:
# 自检(不需要账号,只读)
docker run --rm ${primary} --check
# 正式刷课(凭据只走环境变量,别写进镜像)
docker run -d --name yun-xue-tang \\
-e YUN_XUE_TANG_USR='账号' -e YUN_XUE_TANG_PWD='密码' \\
-v "$PWD/.run-profile:/app/.run-profile" -v "$PWD/run-logs:/app/run-logs" \\
--shm-size=512m --restart on-failure:3 ${primary}
# 或用 compose(账号写在 .env 里):cp .env.example .env && docker compose up -d
`);
return 0;
}
process.exit(main());