Files
ipass-plugin-cache/www/assets/cache.js
T
ssw 43718bd0c4 iPass cache gateway 源码
容量管理: zones.rs 直读 nginx file_cache 共享内存记账(双轴: 磁盘 + keys_zone 索引内存), ?scan=1 扫盘上限 20 万文件; POST /api/admin/cache/purge 整区清理(只删文件不删目录, 根治 [crit] mkdir failed); POST /api/admin/cache/invalidate 按制品精准失效(预览->确认两步式, glob/子串, 删除上限 5000/扫描上限 20 万); GET /api/admin/cache 新增 capacity 块; 前端容量面板 + 按制品失效工具条; 测试 test-cache-capacity.sh 48/48(容量 27 + 精准失效 21, 含 EXPECT_MIN 护栏与前端静态契约); docs 容量管理章节
2026-09-21 09:25:11 +08:00

489 lines
23 KiB
JavaScript
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
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.
/* ============================================================================
制品缓存管理页(cache.html)
数据源单一:`GET /api/admin/cache` 一次返回「上游表 + 是否生效 + 下游接入
命令 + 命中计数 + 变量契约」。UI 不做任何拼接——下游命令文案由后端
`config::CLIENT_HINTS` 下发(前缀与路由强耦合,写在前端必然漂移)。
交互:编辑(弹窗)/ 测试连通性 / 删除 / 一键复制接入命令。
========================================================================== */
(function () {
"use strict";
var D = null; // 最近一次快照(/api/admin/cache 的 data)
var loading = false;
function load(scan) {
if (loading) return Promise.resolve();
loading = true;
// scan=1 → 顺带盘点磁盘(秒级,大 zone 慎点);默认只读 nginx 记账(O(1))
return IP.api("GET", "/api/admin/cache" + (scan ? "?scan=1" : ""))
.then(function (r) { D = r.data; render(); })
.catch(function (e) { IP.toast(e.message, true); })
.finally(function () { loading = false; });
}
// ---------------- 渲染 ----------------
function render() {
if (!D) return;
var items = IP.arr(D.items);
IP.$("cacheEntry").innerHTML =
"网关入口:<code>" + IP.esc(D.entry) + "</code> · " +
"已配置 <b>" + D.configured + "</b> / " + D.count + " 个路由 · " +
"生效中 <b>" + D.active + "</b> · " +
"连通性探针:<code>" + IP.esc(D.probe_prefix) + "&lt;route&gt;</code>(仅内网可达)";
IP.$("cacheBody").innerHTML = items.map(row).join("");
renderCapacity();
renderStats();
renderVars();
}
function row(it) {
var status;
if (it.active) {
status = '<span class="badge b-ok">生效中</span>';
} else if (!it.configured) {
status = '<span class="badge b-gray">未配置</span>';
} else if (!it.enabled) {
status = '<span class="badge b-gray">已停用</span>';
} else {
status = '<span class="badge b-warn">未生效</span>';
}
// 「一键复制」只给主路由(route == eco)显示:cargo-dl / pypi-files 属于
// cargo / pypi 生态,客户端配置同一条,重复给按钮只会让人以为要配两遍。
var isPrimary = it.route === it.eco;
var down;
if (isPrimary && it.client) {
down =
'<div><code>' + IP.esc(D.entry + it.uri) + '</code></div>' +
'<button class="btn-sm" data-copy="' + IP.esc(it.route) + '">复制接入命令</button>';
} else if (isPrimary) {
down = '<div><code>' + IP.esc(D.entry + it.uri) + '</code></div>';
} else {
down =
'<div><code>' + IP.esc(D.entry + it.uri) + '</code></div>' +
'<span class="desc">计入 <b>' + IP.esc(it.eco) + '</b> 生态</span>';
}
var keyCell = it.key_set
? '<code>' + IP.esc(it.key_masked) + '</code>'
: '<span class="desc">无(不注入鉴权头)</span>';
var ops =
'<button class="btn-sm" data-edit="' + IP.esc(it.route) + '">编辑</button> ' +
(it.active
? '<button class="btn-sm" data-test="' + IP.esc(it.route) + '">测试</button> '
: "") +
(it.configured
? '<button class="btn-sm btn-danger" data-del="' + IP.esc(it.route) + '">删除</button>'
: "");
return "<tr>" +
"<td><b>" + IP.esc(it.eco) + "</b>" + (isPrimary ? "" : "<br><span class=\"desc\">" + IP.esc(it.route) + "</span>") + "</td>" +
"<td><code>" + IP.esc(it.uri) + "</code><br>" + down + "</td>" +
"<td>" + (it.base ? "<code>" + IP.esc(it.base) + "</code>" : '<span class="desc">未配置</span>') +
(it.base && it.base !== it.default_base ? '<br><span class="desc">官方源:' + IP.esc(it.default_base) + "</span>" : "") + "</td>" +
"<td>" + keyCell + "</td>" +
"<td>" + status + "</td>" +
"<td>" + ops + "</td>" +
"</tr>";
}
// ---------------- 容量与淘汰 ----------------
/// 字节人类可读。保留一位小数——「50 GB 与 49.8 GB」这种差别要看得出来。
function fmtBytes(n) {
n = Number(n) || 0;
if (n < 1024) return n + " B";
var u = ["KB", "MB", "GB", "TB", "PB"], i = -1;
do { n /= 1024; i++; } while (n >= 1024 && i < u.length - 1);
return (Math.round(n * 10) / 10) + " " + u[i];
}
function fmtSecs(s) {
s = Number(s) || 0;
if (s >= 86400) return Math.round(s / 86400) + " 天";
if (s >= 3600) return Math.round(s / 3600) + " 小时";
return s + " 秒";
}
/// 水位条。颜色只看后端下发的 `level`——若在这里再比一遍阈值,
/// 总览页与这页迟早会出现「一个绿一个红」,而数据是同一份。
function capBar(pct, level) {
var color = level === "crit" ? "#dc2626" : (level === "warn" ? "#f59e0b" : "#16a34a");
var w = Math.max(0, Math.min(100, Number(pct) || 0));
return '<div class="bar-track" style="height:14px">' +
'<div class="bar-fill" style="width:' + w + '%;background:' + color + '"></div></div>';
}
function renderCapacity() {
var c = D.capacity || {};
var zones = IP.arr(c.zones);
var body = IP.$("capBody");
if (!c.available) {
IP.$("capSummary").innerHTML =
'<span style="color:var(--err-fg)">容量读数不可用</span>:' + IP.esc(c.reason || "");
body.innerHTML = '<tr><td colspan="7" class="empty">读不到 proxy_cache 区</td></tr>';
return;
}
var t = c.totals || {};
var diskTxt = (t.disk_bytes === null || t.disk_bytes === undefined)
? ""
: " · 磁盘实测 <b>" + fmtBytes(t.disk_bytes) + "</b>";
IP.$("capSummary").innerHTML =
"共 <b>" + zones.length + "</b> 个缓存区 · nginx 记账占用 <b>" + fmtBytes(t.used_bytes) + "</b> / " +
fmtBytes(t.limit_bytes) + "(<b>" + t.pct + "%</b>)" + diskTxt +
" · 条目 <b>" + t.entries + "</b> · 偏高 <b>" + (t.warn || 0) + "</b> · 严重 <b>" + (t.crit || 0) +
"</b> · " + (c.scanned
? '<span class="muted">已含磁盘实测:两者差额 = nginx 尚未回收的条目(手工清过缓存时会滞后,见下)</span>'
: '<span class="muted">超上限按 LRU 自动淘汰;改容量需改 conf 的 max_size 后 reload</span>');
body.innerHTML = zones.map(capRow).join("");
// 「按制品失效」的下拉跟容量表同源:不硬编码生态列表,
// 免得加了 zone 之后这里少一项、只能靠「全部」兜着。
var sel = IP.$("capZone");
var keep = sel.value || "all";
sel.innerHTML = '<option value="all">全部缓存区</option>' +
zones.map(function (z) {
return '<option value="' + IP.esc(z.zone) + '">' + IP.esc(z.eco || z.zone) + "</option>";
}).join("");
sel.value = IP.arr(zones).some(function (z) { return z.zone === keep; }) ? keep : "all";
}
function capRow(z) {
var lv = z.level;
var badge, note = "";
if (!z.dir_exists) {
badge = '<span class="badge b-err">目录缺失</span>';
note = '<br><span class="desc">磁盘目录不存在。nginx 只在<b>启动时</b>创建这些目录、运行期不自愈,' +
'此后每次写缓存都会失败并断开客户端 —— 需 <b>restart</b>(reload 不够)</span>';
} else if (z.index_pressure) {
badge = '<span class="badge b-err">索引吃紧</span>';
note = '<br><span class="desc">keys_zone 曾被打满,nginx 已改按<b>条目数</b>强制回收 —— 建议扩大 keys_zone</span>';
} else if (z.cold || z.loading) {
badge = '<span class="badge b-blue">装载中</span>';
note = '<br><span class="desc">正在从磁盘重建索引(条目数会一路上涨,属正常)</span>';
} else if (lv === "crit") {
badge = '<span class="badge b-err">接近上限</span>';
} else if (lv === "warn") {
badge = '<span class="badge b-warn">占用偏高</span>';
} else {
badge = '<span class="badge b-ok">正常</span>';
}
var routes = IP.arr(z.routes);
var routeNote = routes.length > 1
? '<br><span class="desc">' + IP.esc(routes.join(" / ")) + " 共用本区</span>"
: "";
var zoneNote = z.eco && z.eco !== z.zone
? '<br><span class="desc">zone ' + IP.esc(z.zone) + "</span>"
: "";
// 磁盘实测(点了「盘点磁盘」才有)。差额 = nginx 还没回收的条目:
// 手工清过缓存文件时它会明显偏大(节点要等再被访问或到期才释放),
// 所以这个差**如实显示**,而不是替用户抹平。
var diskLine = "";
if (z.disk_bytes !== null && z.disk_bytes !== undefined) {
var lag = z.used_bytes - z.disk_bytes;
var lagPct = z.used_bytes > 0 ? Math.abs(lag) / z.used_bytes : 0;
var lagTxt = lagPct > 0.02
? ' <span style="color:var(--warn-fg)">账比盘多 ' + fmtBytes(lag) + "</span>"
: "";
diskLine = '<div class="desc" style="margin:2px 0 0">磁盘实测 <b>' + fmtBytes(z.disk_bytes) +
"</b> / " + z.disk_files + " 文件" + (z.disk_truncated ? "(已截断)" : "") + lagTxt + "</div>";
}
return "<tr>" +
"<td><b>" + IP.esc(z.eco || z.zone) + "</b>" + routeNote + zoneNote + "</td>" +
"<td><code>" + IP.esc(z.dir) + "</code>" +
'<br><span class="desc">块 ' + fmtBytes(z.bsize) + " · inactive " + fmtSecs(z.inactive_secs) + "</span></td>" +
"<td>" + capBar(z.pct, lv) +
'<div class="desc" style="margin:2px 0 0">nginx 记账 <b>' + fmtBytes(z.used_bytes) + "</b> / " +
fmtBytes(z.limit_bytes) + " <b>" + z.pct + "%</b></div>" + diskLine + "</td>" +
"<td>" + z.entries + "</td>" +
"<td>" + fmtBytes(z.keys_zone_bytes) +
'<br><span class="desc">上限约 ' + (z.entries_cap_est || "-") + " 条</span></td>" +
"<td>" + badge + note + "</td>" +
'<td><button class="btn-sm btn-danger" data-purge="' + IP.esc(z.zone) + '">清空</button></td>' +
"</tr>";
}
/// 清空一个缓存区(`all` = 全部)。
///
/// 删除必须由后端做——**只删文件、不删目录**。手工 `rm -rf cache/<eco>` 会让
/// 该路由此后每次写缓存都 [crit] mkdir 失败并断开客户端(直到 restart),
/// 这个坑在脚本里踩过一次。
function purge(zone) {
var z = IP.arr((D.capacity || {}).zones).filter(function (x) { return x.zone === zone; })[0];
var what = zone === "all" ? "全部缓存区" : ("「" + ((z && (z.eco || z.zone)) || zone) + "」");
var detail = z ? "\n将删除 " + z.entries + " 个条目(约占 " + fmtBytes(z.used_bytes) + ")" : "";
if (!window.confirm("确定清空 " + what + " 的磁盘缓存?" + detail + "。\n" +
"目录本身保留;清空后下次请求重新回源,不影响正确性。\n" +
"(nginx 的容量记账要等下一轮 cache manager 才回落,刚清完可能仍显示旧值)")) return;
IP.api("POST", "/api/admin/cache/purge", { zone: zone }).then(function (r) {
var t = r.data.total || {};
IP.toast(r.msg + " 释放 " + fmtBytes(t.bytes));
load();
}).catch(function (e) { IP.toast(e.message, true); });
}
// ---------------- 按制品失效(两步:预览 → 确认) ----------------
var lastPreview = null; // 上一次预览的结果,用于「确认失效」时复述删什么
/// 把缓存的命中结果渲染出来。命中为空也要明说 —— 最常见的情况其实是
/// 「关键字拼错了 / 记错了 key 形态」,沉默会让人以为功能坏了。
function showInval(r, applied) {
var sum = IP.$("capInvalResult");
var box = IP.$("capInvalKeys");
var d = (r && r.data) || {};
var t = d.total || {};
var lines = [];
if (!t.matched) {
box.style.display = "none";
box.textContent = "";
sum.innerHTML = '<span style="color:var(--warn-fg)">没有命中任何条目</span>' +
' · 请确认关键字;cache key 形如 <code>&lt;路由&gt;:&lt;URI&gt;&lt;方法&gt;&lt;Accept&gt;</code>' +
',例如 <code>npm:/npm/lodashGET*/*</code>(可先填 <code>*</code> 预览一遍看全部形态)';
return;
}
IP.arr(d.items).forEach(function (it) {
if (!it.matched) return;
lines.push("# " + it.zone + ":" +
(applied ? ("已删除 " + it.deleted + " 个") : (it.matched + " 个命中")) +
" " + fmtBytes(it.bytes));
IP.arr(it.keys).forEach(function (k) { lines.push(" → " + k); });
if (it.matched > IP.arr(it.keys).length) {
lines.push(" …另有 " + (it.matched - IP.arr(it.keys).length) + " 个同类条目");
}
});
sum.innerHTML = (applied
? '<span class="badge b-ok">已失效</span> '
: '<span class="badge b-blue">预览(未删除)</span> ') +
"共 <b>" + t.matched + "</b> 个 / " + fmtBytes(t.bytes) +
(d.truncated
? ' <span style="color:var(--warn-fg)">⚠️ 已达单次上限,数字是下界' +
(applied ? "" : ";请把关键字写窄一些再执行") + "</span>"
: "");
box.textContent = lines.join("\n");
box.style.display = "";
}
function invalidate(apply) {
var pat = (IP.$("capMatch").value || "").trim();
if (!pat) { IP.toast("先填要失效的制品关键字", true); return Promise.resolve(); }
var zone = IP.$("capZone").value || "all";
if (apply) {
var t = (lastPreview && lastPreview.total) || {};
// 二次确认:把「删什么、删多少」复述清楚,而不是一句「确定吗」
if (!window.confirm("确定失效「" + pat + "」?\n" +
"范围:" + (zone === "all" ? "全部缓存区" : zone) + "\n" +
"将删除 " + (t.matched || "?") + " 个条目(约 " + fmtBytes(t.bytes || 0) + ")\n" +
"目录本身保留;删掉的只是磁盘副本,下次请求重新回源,不影响正确性。")) {
return Promise.resolve();
}
}
IP.$("capApply").disabled = true;
return IP.api("POST", "/api/admin/cache/invalidate",
{ zone: zone, match: pat, apply: apply ? 1 : 0 })
.then(function (r) {
if (apply) {
lastPreview = null;
IP.toast(r.msg);
load();
} else {
lastPreview = r.data;
// 只有真的命中了才允许进入「确认」——否则按钮会诱人误点
IP.$("capApply").disabled = !((r.data.total || {}).matched > 0);
}
showInval(r, apply);
})
.catch(function (e) {
IP.toast(e.message, true);
IP.$("capApply").disabled = true;
});
}
function renderStats() {
var s = (D.stats && D.stats.by_ecosystem) || {};
var order = ["go", "cargo", "pypi", "npm", "maven", "docker", "global"];
IP.$("statsBody").innerHTML = order.map(function (eco) {
var m = s[eco];
if (!m) return "";
var hit = m.HIT || 0;
var miss = m.MISS || 0;
var denom = hit + miss;
var rate = denom ? Math.round((hit / denom) * 1000) / 10 + "%" : "-";
var cls = eco === "global" ? ' style="font-weight:600"' : "";
return "<tr" + cls + ">" +
"<td>" + IP.esc(eco) + "</td>" +
"<td>" + hit + "</td><td>" + miss + "</td>" +
"<td>" + (m.BYPASS || 0) + "</td><td>" + (m.EXPIRED || 0) + "</td>" +
"<td>" + (m.REVALIDATED || 0) + "</td><td>" + (m.UPDATING || 0) + "</td>" +
"<td>" + (m.STALE || 0) + "</td>" +
"<td>" + rate + "</td></tr>";
}).join("");
}
function renderVars() {
IP.$("varBody").innerHTML = IP.arr(D.variables).map(function (v) {
return "<tr><td><code>" + IP.esc(v.name) + "</code></td><td>" + IP.esc(v.desc) + "</td></tr>";
}).join("");
}
// ---------------- 编辑弹窗 ----------------
/// 凭据字段刻意用「勾选才提交」:JSON body 里 key 字段**不出现** = 保留原值,
/// 出现空串 = 清空。若默认提交空串,打开弹窗改个备注就会把上游凭据抹掉。
function edit(route) {
var it = (D.items || []).filter(function (x) { return x.route === route; })[0] || {};
IP.modal({
title: "上游配置 · " + route,
wide: true,
submitText: "保存",
html:
'<form id="cacheForm" autocomplete="off">' +
'<div class="field"><label>路由</label>' +
'<input name="route" value="' + IP.esc(route) + '" readonly></div>' +
'<div class="field"><label>上游地址(base)</label>' +
'<input name="base" value="' + IP.esc(it.base || "") + '" placeholder="https://proxy.golang.org" required>' +
'<button type="button" class="btn-sm" id="fillDefault" style="margin-left:6px">填入官方源</button>' +
'<div class="desc">必须带 http:// 或 https://,不要带尾斜杠。转发的目标 = 本地址 + location 前缀之后的路径。</div></div>' +
'<div class="field"><label>上游凭据</label>' +
'<label class="desc"><input type="checkbox" id="setKey"' + (it.key_set ? "" : "") + '> 修改凭据</label>' +
'<input name="key" type="password" placeholder="' +
IP.esc(it.key_set ? "当前:" + it.key_masked + "(留空 = 清空)" : "留空 = 透传客户端自带的 Authorization") + '" disabled>' +
'<div class="desc">填<b>完整的 Authorization 头值</b>(如 <code>Bearer xxx</code> / <code>Basic yyy</code>),不是只填 token —— 换成上游就换一套,模块不去猜 scheme。' +
'留空则透传客户端自带的 Authorization(Docker Hub 的短期 Bearer token 走这条);' +
'无论哪种,<b>本网关自己的 sk_ 都会被剔除,不会传给上游</b>。</div></div>' +
'<div class="field"><label>展示名</label>' +
'<input name="name" value="' + IP.esc(it.name || "") + '"></div>' +
'<div class="field"><label>说明</label>' +
'<input name="desc" value="' + IP.esc(it.desc || "") + '"></div>' +
'<div class="field"><label>备注</label>' +
'<input name="note" value="' + IP.esc(it.note || "") + '"></div>' +
'<div class="field"><label>状态</label>' +
'<label class="desc"><input type="checkbox" id="enabled"' + (it.enabled === false ? "" : " checked") + '> 启用(停用后该路由返回 503)</label></div>' +
"</form>",
onMount: function (card, close) {
var setKey = card.querySelector("#setKey");
var keyInput = card.querySelector('input[name="key"]');
setKey.addEventListener("change", function () {
keyInput.disabled = !setKey.checked;
if (setKey.checked) keyInput.focus();
});
card.querySelector("#fillDefault").addEventListener("click", function () {
card.querySelector('input[name="base"]').value = it.default_base || "";
});
card.querySelector("form").addEventListener("submit", function (e) {
e.preventDefault();
var f = e.target;
var body = {
route: route,
base: f.base.value.trim(),
name: f.name.value.trim(),
desc: f.desc.value.trim(),
note: f.note.value.trim(),
enabled: card.querySelector("#enabled").checked
};
// 只有勾了「修改凭据」才带 key 字段(空串 = 清空)
if (setKey.checked) body.key = keyInput.value;
IP.api("POST", "/api/admin/cache/save", body).then(function (r) {
close();
IP.toast("已保存:" + r.data.route + (r.data.active ? "(生效中)" : "(未生效)"));
load();
}).catch(function (err) { IP.toast(err.message, true); });
});
}
});
}
// ---------------- 连通性测试 ----------------
/// 走 `/_cache_test/<route>`:与真实转发同一套「拼目标 + 换凭据」逻辑,
/// 所以这里通了 = 真实请求能到上游。上游响应原样返回,故用原生 fetch 读文本
/// (不能走 IP.api:它假定响应是 ipass 的 JSON 信封)。
function test(route) {
IP.toast("正在测试 " + route + " …");
fetch("/api/admin/cache/test?route=" + encodeURIComponent(route), {
method: "POST",
credentials: "same-origin",
headers: { "Content-Type": "application/json" },
body: "{}"
}).then(function (res) {
return res.text().then(function (t) {
var brief = t.replace(/\s+/g, " ").slice(0, 200);
IP.toast(route + " → HTTP " + res.status + " " + brief, !res.ok);
});
}).catch(function (e) { IP.toast(route + " 测试失败:" + e.message, true); });
}
// ---------------- 删除 ----------------
function del(route) {
if (!window.confirm("确定删除路由 " + route + " 的上游配置?\n删除后该生态立即返回 503,已缓存的制品在磁盘上仍可命中。")) return;
IP.api("POST", "/api/admin/cache/delete", { route: route }).then(function () {
IP.toast("已删除 " + route);
load();
}).catch(function (e) { IP.toast(e.message, true); });
}
// ---------------- 事件委托 ----------------
document.addEventListener("click", function (e) {
var t = e.target;
if (!t || !t.getAttribute) return;
var copy = t.getAttribute("data-copy");
var edit_ = t.getAttribute("data-edit");
var test_ = t.getAttribute("data-test");
var del_ = t.getAttribute("data-del");
var purge_ = t.getAttribute("data-purge");
if (copy) {
var it = (D.items || []).filter(function (x) { return x.route === copy; })[0];
var cmd = it && it.client && it.client.command;
if (cmd) IP.copyText(cmd, "「" + copy + "」接入命令");
else IP.toast("该路由没有独立的客户端配置", true);
return;
}
if (edit_) return edit(edit_);
if (test_) return test(test_);
if (del_) return del(del_);
if (purge_) return purge(purge_);
});
IP.$("cRefresh").addEventListener("click", function () {
load().then(function () { IP.toast("已刷新"); });
});
IP.$("capRefresh").addEventListener("click", function () {
load().then(function () { IP.toast("容量读数已刷新"); });
});
IP.$("capScan").addEventListener("click", function () {
IP.toast("正在盘点磁盘…");
load(true).then(function () { IP.toast("磁盘盘点完成"); });
});
IP.$("capPurgeAll").addEventListener("click", function () { purge("all"); });
IP.$("capPreview").addEventListener("click", function () { invalidate(false); });
IP.$("capApply").addEventListener("click", function () { invalidate(true); });
// 改了关键字就把上一次的预览作废 —— 否则「确认失效」会拿着旧结果去删
IP.$("capMatch").addEventListener("input", function () {
lastPreview = null;
IP.$("capApply").disabled = true;
IP.$("capInvalResult").innerHTML = "";
IP.$("capInvalKeys").style.display = "none";
IP.$("capInvalKeys").textContent = "";
});
IP.$("capMatch").addEventListener("keydown", function (e) {
if (e.key === "Enter") invalidate(false);
});
// 页面入口:boot 会先确认管理会话、装外壳,再调本回调
IP.boot("cache", function () { load(); });
})();