mirror of
https://github.com/Shu-Ying/noname-shuying.git
synced 2026-10-13 18:46:17 +08:00
feat # 新增日志功能
This commit is contained in:
@@ -0,0 +1,59 @@
|
||||
# 术樱包自动诊断日志
|
||||
|
||||
扩展加载后自动记录本扩展的关键业务步骤,发生错误时自动生成独立报告。
|
||||
无需开启控制台或手动开始录制;不上传任何数据。
|
||||
|
||||
## 文件位置
|
||||
|
||||
PC 和安卓客户端均写入游戏目录下的 `extension/术樱包/logs/`。
|
||||
|
||||
- `runtime-*.jsonl`:按行保存时间、模块、步骤、关联 ID 和上下文。
|
||||
- `report-*.json`:错误报告,包含首次/最近异常、错误栈、cause、内部异常、
|
||||
运行版本、错误前操作、当前结算阶段和存档状态。
|
||||
|
||||
同一异常在存档层、结算层等多个入口被观察时,共用报告编号并更新修订号;
|
||||
occurrences 表示被捕获的次数,不表示奖励发放次数。最近报告不会因普通日志
|
||||
轮转被删除。保存回执绑定对应修订和真实通道,旧版本写入成功不会误标新版本。
|
||||
|
||||
扩展设置中的“诊断日志位置”显示实际位置和最近报告保存状态。
|
||||
只需要保留相应报告和附近的 runtime 文件;如何发送由用户自行处理。
|
||||
|
||||
## 采集范围
|
||||
|
||||
- 主动记录术樱包加载、更新、梦三战斗、结算、存档、手牌、地图及菜单错误。
|
||||
- 全局错误仅接收来源文件或异常栈属于本扩展的情况,包含编码后的中文路径。
|
||||
- 不因为当前开启梦三就收集所有错误,也不根据错误消息包含“术樱包”归因。
|
||||
- 原引擎错误处理仍会执行;不替换引擎事件、Promise 或 console 的原型。
|
||||
|
||||
## 存档诊断
|
||||
|
||||
报告分别记录 storageStatus、memoryPublished 和 commitReceipt:
|
||||
|
||||
- storageStatus=committed 表示存档事务完成,或 localStorage 写入已返回。
|
||||
- memoryPublished=true 表示运行内存已发布成功存档。
|
||||
- commitReceipt=true 表示结算协调器收到了提交成功结果。
|
||||
|
||||
资源清理、技能释放或地图展示随后失败时,不能据此判断存档失败。
|
||||
重试沿用现有去重和奖励提交规则,日志不参与存档事务,也不触发自动重试。
|
||||
|
||||
## 容量与兼容
|
||||
|
||||
默认每秒批量保存普通日志;错误报告立即排入写入队列。运行日志按约
|
||||
256 KiB 分段;内存保留最近约 512 KiB / 400 条记录。日志目录自动清理
|
||||
系统自己生成的旧文件,保留总量约 5 MiB、最多 64 个文件。报告包含截断和
|
||||
丢弃计数;“完整诊断”指受限的错误链与现场记录,不是无限保留整个游戏过程。
|
||||
|
||||
PC 使用异步文件操作,安卓使用 Cordova 目录和 FileWriter 回调,写入前截断旧
|
||||
内容,使用 UTF-8 Blob。单次保存操作设置 5 秒观察超时;超时后停止使用该
|
||||
文件通道,避免迟到写入与后续写入重叠。写入异常不会中断游戏业务。
|
||||
|
||||
原生文件不可用时,降级到独立的 `shuying-diagnostics` IndexedDB;它不与
|
||||
游戏存档共用数据库。若两种持久化方式都不可用,仅保留本次运行的内存
|
||||
记录,菜单会明确显示未持久化,不能宣称文件已生成。
|
||||
|
||||
切入后台或页面隐藏时尝试保存缓冲;被系统强制杀死或断电时,最后尚未完成的
|
||||
异步写入可能丢失。结算内部等待超过 15 秒会记录观察日志,选择奖励、地图节点
|
||||
和剧情等待不会被当作超时错误;观察器不会结束业务事件。
|
||||
|
||||
字段过滤会隐藏凭据字段、常见 URL 凭据参数和 Bearer 内容。报告不会复制完整
|
||||
玩家对象、DOM、引擎状态或整个存档。日志文件不进入发布清单和 Git。
|
||||
@@ -0,0 +1,327 @@
|
||||
import {
|
||||
byteLength, cleanText, extensionError, extensionSource, serializeError, snapshot,
|
||||
} from "./serialize.js";
|
||||
import { createDiagnosticStorage, isDiagnosticFile, LOG_DIRECTORY } from "./storage.js";
|
||||
|
||||
const noop = () => null;
|
||||
const inactive = Object.freeze({
|
||||
info: noop, warn: noop, error: noop, scope: () => inactive,
|
||||
registerContext: () => noop, flush: async () => {},
|
||||
step: async (_event, action) => action(),
|
||||
status: () => ({ enabled: false }), dispose: noop,
|
||||
});
|
||||
let current = inactive;
|
||||
|
||||
export function getDiagnostics() { return current; }
|
||||
|
||||
export function createDiagnostics(options = {}) {
|
||||
const env = options.env || {};
|
||||
const now = options.now || Date.now;
|
||||
const monotonic = () => {
|
||||
try { return env.performance?.now?.() ?? now(); } catch { return now(); }
|
||||
};
|
||||
const launchId = `${now().toString(36)}-${Math.random().toString(36).slice(2, 10)}`;
|
||||
const maxMemoryBytes = options.maxMemoryBytes ?? 512 * 1024;
|
||||
const maxJournalBytes = options.maxJournalBytes ?? 256 * 1024;
|
||||
const maxReportBytes = options.maxReportBytes ?? 512 * 1024;
|
||||
const maxDiskBytes = options.maxDiskBytes ?? 5 * 1024 * 1024;
|
||||
const maxFiles = options.maxFiles ?? 64;
|
||||
const maxPending = options.maxPending ?? 12;
|
||||
const flushMs = options.flushMs ?? 1000;
|
||||
const recent = [], contexts = new Map(), pending = new Map();
|
||||
const errors = new WeakMap(), fingerprints = new Map(), listeners = [];
|
||||
let sequence = 0, reportSequence = 0, segment = 0, memoryBytes = 0;
|
||||
let journal = [], journalBytes = 0, revision = 0, queuedRevision = -1;
|
||||
let flushTimer = null, worker = null, stopped = false, unavailable = false;
|
||||
let latestReport = null, droppedRecords = 0, droppedWrites = 0;
|
||||
let inventory = null, inventoryKind = null;
|
||||
const metadata = snapshot({
|
||||
extension: "术樱包", extensionVersion: options.version || "unknown",
|
||||
engineVersion: env.lib?.version || "unknown", launchId,
|
||||
platform: env.lib?.node ? "pc" : env.lib?.device ? "android" : "browser",
|
||||
userAgent: env.window?.navigator?.userAgent || "unknown",
|
||||
modules: { mengsan: env.lib?.config?.shuYing_mengsan_installed_version || null },
|
||||
});
|
||||
const roots = [];
|
||||
try {
|
||||
const root = new URL("../", import.meta.url);
|
||||
if (["file:", "http:", "https:"].includes(root.protocol)) roots.push(root.href);
|
||||
} catch {}
|
||||
if (options.extensionRoot) {
|
||||
try {
|
||||
roots.push(new URL(options.extensionRoot.replace(/\/?$/, "/"),
|
||||
env.document?.baseURI || env.window?.location?.href).href);
|
||||
} catch {}
|
||||
}
|
||||
const storage = options.storage || createDiagnosticStorage(env, {
|
||||
timeoutMs: options.storageTimeoutMs,
|
||||
onFailure(error, phase) {
|
||||
record("WARN", "diagnostics.storage.failure", { phase }, error, "diagnostics");
|
||||
},
|
||||
});
|
||||
const storageStatus = () => storage.status?.() || { kind: "file", location: LOG_DIRECTORY };
|
||||
const runtimeName = () => `runtime-${launchId}-${segment}.jsonl`;
|
||||
|
||||
function contextFor(extra) {
|
||||
const values = {};
|
||||
for (const [name, provider] of contexts) {
|
||||
try { values[name] = snapshot(provider()); }
|
||||
catch { values[name] = { diagnosticContextUnavailable: true }; }
|
||||
}
|
||||
return { ...values, ...snapshot(extra || {}) };
|
||||
}
|
||||
|
||||
function schedule() {
|
||||
if (flushTimer || stopped || unavailable) return;
|
||||
flushTimer = setTimeout(() => { flushTimer = null; void flush(); }, flushMs);
|
||||
flushTimer?.unref?.();
|
||||
}
|
||||
|
||||
function record(level, event, extra, error, module = "extension") {
|
||||
if (stopped) return null;
|
||||
try {
|
||||
const entry = {
|
||||
schemaVersion: 1, sequence: ++sequence, time: new Date(now()).toISOString(),
|
||||
launchId, level, module: cleanText(module, 128), event: cleanText(event, 256),
|
||||
context: contextFor(extra),
|
||||
};
|
||||
if (error !== undefined) entry.error = serializeError(error);
|
||||
const item = { entry, bytes: 0 };
|
||||
recent.push(item);
|
||||
if (level === "ERROR") createReport(entry, error);
|
||||
const text = JSON.stringify(entry) + "\n";
|
||||
const bytes = byteLength(text);
|
||||
item.bytes = bytes; memoryBytes += bytes;
|
||||
if (journalBytes + bytes > maxJournalBytes && journal.length) {
|
||||
enqueue(runtimeName(), journal.join(""));
|
||||
segment++; journal = []; journalBytes = 0; queuedRevision = -1;
|
||||
}
|
||||
journal.push(text); journalBytes += bytes; revision++;
|
||||
while (recent.length > 400 || memoryBytes > maxMemoryBytes) {
|
||||
memoryBytes -= recent.shift().bytes; droppedRecords++;
|
||||
}
|
||||
schedule();
|
||||
if (level === "ERROR") void flush();
|
||||
return entry;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
function createReport(entry, rawError) {
|
||||
let known;
|
||||
if (rawError && typeof rawError === "object") known = errors.get(rawError);
|
||||
const fingerprint = `${entry.module}:${entry.event}:${entry.error?.name}:${entry.error?.message}`;
|
||||
if (!known) {
|
||||
const prior = fingerprints.get(fingerprint);
|
||||
if (prior && now() - prior.time < 5000) known = prior;
|
||||
}
|
||||
if (!known) known = { id: `${launchId}-${++reportSequence}`, count: 0,
|
||||
first: entry.time, time: now(), firstFailure: entry };
|
||||
known.count++; known.time = now();
|
||||
if (rawError && typeof rawError === "object") errors.set(rawError, known);
|
||||
fingerprints.set(fingerprint, known);
|
||||
while (fingerprints.size > 64) fingerprints.delete(fingerprints.keys().next().value);
|
||||
entry.reportId = known.id;
|
||||
const file = `report-${known.id}.json`;
|
||||
const report = {
|
||||
schemaVersion: 1, reportId: known.id, firstSeen: known.first,
|
||||
lastSeen: entry.time, occurrences: known.count, environment: metadata,
|
||||
storageAtCapture: snapshot(storageStatus()), firstFailure: known.firstFailure,
|
||||
failure: entry, records: recent.map(item => item.entry),
|
||||
droppedRecords, droppedWrites,
|
||||
};
|
||||
let text = JSON.stringify(report, null, 2);
|
||||
while (byteLength(text) > maxReportBytes && report.records.length > 1) {
|
||||
report.records.shift(); report.droppedRecords++;
|
||||
text = JSON.stringify(report, null, 2);
|
||||
}
|
||||
latestReport = { id: known.id, file, revision: known.count,
|
||||
persisted: false, event: entry.event };
|
||||
enqueue(file, text, true, known.count);
|
||||
}
|
||||
|
||||
function enqueue(name, text, priority = false, reportRevision = null) {
|
||||
if (unavailable || stopped) return;
|
||||
if (!pending.has(name) && pending.size >= maxPending) {
|
||||
const victim = [...pending].find(([, item]) => !item.priority)?.[0];
|
||||
if (!victim) { droppedWrites++; return; }
|
||||
pending.delete(victim); droppedWrites++;
|
||||
}
|
||||
pending.set(name, { text, priority, reportRevision });
|
||||
startWorker();
|
||||
}
|
||||
|
||||
async function prune(protect, text) {
|
||||
const kind = storageStatus().kind;
|
||||
if (!inventory || inventoryKind !== kind) {
|
||||
inventory = new Map((await storage.list()).filter(file =>
|
||||
isDiagnosticFile(file.name)).map(file => [file.name, file]));
|
||||
inventoryKind = kind;
|
||||
}
|
||||
inventory.set(protect, { name: protect, bytes: byteLength(text), time: now() });
|
||||
const files = [...inventory.values()];
|
||||
files.sort((a, b) => (a.time || 0) - (b.time || 0));
|
||||
let bytes = files.reduce((sum, file) => sum + (file.bytes || 0), 0);
|
||||
let count = files.length;
|
||||
for (const file of files) {
|
||||
if (bytes <= maxDiskBytes && count <= maxFiles) break;
|
||||
if (file.name === protect || file.name === runtimeName()
|
||||
|| file.name === latestReport?.file) continue;
|
||||
await storage.remove(file.name);
|
||||
inventory.delete(file.name);
|
||||
bytes -= file.bytes || 0; count--;
|
||||
}
|
||||
}
|
||||
|
||||
function startWorker() {
|
||||
if (worker || !pending.size) return;
|
||||
worker = Promise.resolve().then(async () => {
|
||||
while (pending.size && !unavailable) {
|
||||
const name = [...pending].find(([, item]) => item.priority)?.[0]
|
||||
|| pending.keys().next().value;
|
||||
const item = pending.get(name);
|
||||
pending.delete(name);
|
||||
try {
|
||||
await storage.write(name, item.text);
|
||||
if (latestReport?.file === name && latestReport.revision === item.reportRevision) {
|
||||
latestReport.persisted = true;
|
||||
latestReport.savedStorage = snapshot(storageStatus());
|
||||
}
|
||||
try { await prune(name, item.text); } catch { inventory = null; }
|
||||
} catch {
|
||||
unavailable = true; pending.clear();
|
||||
}
|
||||
}
|
||||
}).catch(() => { unavailable = true; pending.clear(); }).finally(() => {
|
||||
worker = null;
|
||||
if (pending.size && !unavailable) startWorker();
|
||||
});
|
||||
}
|
||||
|
||||
async function flush() {
|
||||
try {
|
||||
clearTimeout(flushTimer); flushTimer = null;
|
||||
if (journal.length && queuedRevision !== revision) {
|
||||
queuedRevision = revision;
|
||||
enqueue(runtimeName(), journal.join(""));
|
||||
}
|
||||
while (worker) await worker;
|
||||
} catch {}
|
||||
}
|
||||
|
||||
function scope(module, provider = () => ({})) {
|
||||
const details = extra => {
|
||||
try {
|
||||
const context = typeof provider === "function" ? provider() : provider;
|
||||
return { ...snapshot(context), ...snapshot(extra || {}) };
|
||||
} catch { return { diagnosticContextUnavailable: true }; }
|
||||
};
|
||||
return Object.freeze({
|
||||
info: (event, extra) => record("INFO", event, details(extra), undefined, module),
|
||||
warn: (event, extra, error) => record("WARN", event, details(extra), error, module),
|
||||
error: (event, error, extra) => record("ERROR", event, details(extra), error, module),
|
||||
async step(event, action, extra = {}, options = {}) {
|
||||
const started = monotonic();
|
||||
record("INFO", `${event}.start`, details(extra), undefined, module);
|
||||
let timer;
|
||||
if (options.observeWait !== false) {
|
||||
timer = setTimeout(() => {
|
||||
if (env.document?.hidden) return;
|
||||
record("WARN", `${event}.waiting`, details({ ...extra,
|
||||
elapsedMs: monotonic() - started }), undefined, module);
|
||||
}, options.waitMs ?? 15000);
|
||||
timer?.unref?.();
|
||||
}
|
||||
try {
|
||||
const result = await action();
|
||||
record("INFO", `${event}.complete`, details({ ...extra,
|
||||
elapsedMs: monotonic() - started }), undefined, module);
|
||||
return result;
|
||||
} catch (error) {
|
||||
record("ERROR", `${event}.failed`, details({ ...extra,
|
||||
elapsedMs: monotonic() - started }), error, module);
|
||||
throw error;
|
||||
} finally { clearTimeout(timer); }
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
function listen(target, event, handler, capture = false) {
|
||||
if (typeof target?.addEventListener !== "function") return;
|
||||
target.addEventListener(event, handler, capture);
|
||||
listeners.push(() => target.removeEventListener(event, handler, capture));
|
||||
}
|
||||
const globalLogger = scope("extension.global");
|
||||
const globalSeen = new WeakMap();
|
||||
function captureGlobal(error, source, extra = {}) {
|
||||
if (!extensionSource(source, roots) && !extensionError(error, roots)) return;
|
||||
if (error && typeof error === "object") {
|
||||
const last = globalSeen.get(error);
|
||||
if (last !== undefined && now() - last < 20) return;
|
||||
globalSeen.set(error, now());
|
||||
}
|
||||
globalLogger.error("uncaught", error, { source, ...extra });
|
||||
}
|
||||
listen(env.window, "error", event => {
|
||||
try {
|
||||
if (extensionSource(event.filename, roots) || extensionError(event.error, roots)) {
|
||||
captureGlobal(event.error || event.message, event.filename,
|
||||
{ line: event.lineno, column: event.colno });
|
||||
} else {
|
||||
const source = event.target?.src || event.target?.href;
|
||||
if (extensionSource(source, roots)) globalLogger.error("resource.load",
|
||||
new Error("术樱包资源加载失败"), { source });
|
||||
}
|
||||
} catch {}
|
||||
}, true);
|
||||
listen(env.window, "unhandledrejection", event => {
|
||||
try {
|
||||
if (extensionError(event.reason, roots)) captureGlobal(event.reason, "",
|
||||
{ origin: "unhandledrejection" });
|
||||
} catch {}
|
||||
});
|
||||
if (env.window) {
|
||||
const previous = env.window.onerror;
|
||||
const chained = function(message, source, line, column, error) {
|
||||
try { captureGlobal(error || message, source, { line, column }); } catch {}
|
||||
return typeof previous === "function" ? previous.apply(this, arguments) : undefined;
|
||||
};
|
||||
env.window.onerror = chained;
|
||||
listeners.push(() => {
|
||||
if (env.window.onerror === chained) env.window.onerror = previous;
|
||||
});
|
||||
}
|
||||
listen(env.document, "visibilitychange", () => {
|
||||
if (env.document.hidden) void flush();
|
||||
});
|
||||
listen(env.window, "pagehide", () => { void flush(); });
|
||||
const api = Object.freeze({
|
||||
...scope("extension"), scope,
|
||||
registerContext(name, provider) {
|
||||
contexts.set(name, provider);
|
||||
return () => contexts.delete(name);
|
||||
},
|
||||
flush,
|
||||
status: () => snapshot({ enabled: true, ...storageStatus(),
|
||||
unavailable, latestReport, droppedRecords, droppedWrites,
|
||||
runtimeFile: runtimeName(), launchId }),
|
||||
dispose() {
|
||||
void flush(); stopped = true; clearTimeout(flushTimer);
|
||||
for (const remove of listeners) remove();
|
||||
if (current === api) current = inactive;
|
||||
},
|
||||
});
|
||||
api.info("diagnostics.started", { environment: metadata });
|
||||
return api;
|
||||
}
|
||||
|
||||
export function configureDiagnostics({ lib, game, window, document, version, extensionRoot }) {
|
||||
if (current !== inactive) return current;
|
||||
try {
|
||||
current = createDiagnostics({ version, extensionRoot,
|
||||
env: { lib, game, window, document, performance: window?.performance,
|
||||
localStorage: window?.localStorage, indexedDB: window?.indexedDB } });
|
||||
} catch {}
|
||||
return current;
|
||||
}
|
||||
@@ -0,0 +1,127 @@
|
||||
const secretKey = /password|passwd|secret|token|cookie|authorization|api[_-]?key|credential/i;
|
||||
|
||||
export function cleanText(value, limit = 8192) {
|
||||
let text;
|
||||
try { text = String(value); } catch { return "[unreadable]"; }
|
||||
const truncated = text.length > limit;
|
||||
text = text.slice(0, limit);
|
||||
text = text.replace(/([?&](?:token|key|api[_-]?key|access_token|password|secret|auth)[a-z0-9_-]*=)[^&#\s]*/gi,
|
||||
"$1[redacted]");
|
||||
text = text.replace(/((?:Bearer|Basic)\s+)[\w.+\/=-]+/gi, "$1[redacted]");
|
||||
text = text.replace(/\b(?:https?|ftp):\/\/[^\s/?#]*/gi, (url, offset, source) => {
|
||||
const schemeEnd = url.indexOf("://") + 3;
|
||||
const at = url.lastIndexOf("@");
|
||||
if (at >= schemeEnd) return url.slice(0, schemeEnd) + "[redacted]@" + url.slice(at + 1);
|
||||
if (truncated && offset + url.length === source.length
|
||||
&& url.slice(schemeEnd).includes(":")) return url.slice(0, schemeEnd) + "[redacted]";
|
||||
return url;
|
||||
});
|
||||
return !truncated && text.length <= limit ? text : text.slice(0, limit) + "[truncated]";
|
||||
}
|
||||
|
||||
function read(object, key) {
|
||||
try { return object[key]; } catch { return "[unreadable]"; }
|
||||
}
|
||||
|
||||
export function snapshot(value, depth = 0, seen = new WeakSet()) {
|
||||
if (value === null || value === undefined) return value ?? null;
|
||||
if (typeof value === "string") return cleanText(value, 2048);
|
||||
if (typeof value === "boolean") return value;
|
||||
if (typeof value === "number") return Number.isFinite(value) ? value : String(value);
|
||||
if (typeof value !== "object") return cleanText(value, 256);
|
||||
if (seen.has(value)) return "[circular]";
|
||||
if (depth >= 5) return "[depth limit]";
|
||||
seen.add(value);
|
||||
if (Array.isArray(value)) {
|
||||
const result = value.slice(0, 32).map(item => snapshot(item, depth + 1, seen));
|
||||
if (value.length > 32) result.push(`[${value.length - 32} more items]`);
|
||||
return result;
|
||||
}
|
||||
let keys;
|
||||
try { keys = Object.keys(value); } catch { return "[unreadable]"; }
|
||||
const result = {};
|
||||
for (const key of keys.slice(0, 40)) {
|
||||
if (key === "__proto__" || key === "constructor") continue;
|
||||
result[key] = secretKey.test(key) ? "[redacted]"
|
||||
: snapshot(read(value, key), depth + 1, seen);
|
||||
}
|
||||
if (keys.length > 40) result.truncatedKeys = keys.length - 40;
|
||||
return result;
|
||||
}
|
||||
|
||||
export function serializeError(error, depth = 0, seen = new WeakSet(),
|
||||
budget = { nodes: 0, characters: 32768 }) {
|
||||
if (++budget.nodes > 32 || budget.characters <= 0) {
|
||||
return { name: "TruncatedError", message: "[error size limit]" };
|
||||
}
|
||||
const text = (value, limit = 8192) => {
|
||||
const result = cleanText(value, Math.max(0, Math.min(limit, budget.characters)));
|
||||
budget.characters -= result.length;
|
||||
return result;
|
||||
};
|
||||
if (!error || typeof error !== "object") {
|
||||
return { name: "ThrownValue", message: text(error) };
|
||||
}
|
||||
if (seen.has(error)) return { name: "CircularError", message: "[circular]" };
|
||||
if (depth >= 5) return { name: "TruncatedError", message: "[depth limit]" };
|
||||
seen.add(error);
|
||||
const result = {
|
||||
name: text(read(error, "name") || "Error", 128),
|
||||
message: text(read(error, "message") || error),
|
||||
stack: text(read(error, "stack") || "", 16384),
|
||||
};
|
||||
for (const key of ["code", "operationUncertain"]) {
|
||||
const value = read(error, key);
|
||||
if (value !== undefined) result[key] = snapshot(value);
|
||||
}
|
||||
const cause = read(error, "cause");
|
||||
if (cause !== undefined) result.cause = serializeError(cause, depth + 1, seen, budget);
|
||||
const errors = read(error, "errors");
|
||||
if (Array.isArray(errors)) {
|
||||
result.errors = errors.slice(0, 16).map(item =>
|
||||
serializeError(item, depth + 1, seen, budget));
|
||||
if (errors.length > 16) result.truncatedErrors = errors.length - 16;
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
function decode(value) {
|
||||
let text = cleanText(value, 32768).replace(/\\/g, "/");
|
||||
for (let count = 0; count < 2; count++) {
|
||||
try { text = decodeURIComponent(text); } catch { break; }
|
||||
}
|
||||
return text;
|
||||
}
|
||||
|
||||
export function extensionSource(value, roots = []) {
|
||||
if (typeof value !== "string" || !value) return false;
|
||||
const source = cleanText(value, 32768).replace(/\\/g, "/").trim();
|
||||
const url = source.match(/(?:file|https?):\/\/[^\n]+/i)?.[0];
|
||||
const native = source.match(/[a-z]:\/[^\n]+/i)?.[0];
|
||||
const candidate = decode((url || native || source)
|
||||
.replace(/\)\s*$/, "").split(/[?#]/, 1)[0]);
|
||||
if (roots.some(root => {
|
||||
const base = decode(root).split(/[?#]/, 1)[0];
|
||||
return base && (candidate.startsWith(base)
|
||||
|| (base.startsWith("file:") && candidate.startsWith(base.replace(/^file:\/+/, ""))));
|
||||
})) return true;
|
||||
if (/^(?:\.?\/)?extension\/术樱包\//.test(candidate)) return true;
|
||||
return !roots.length && /\/extension\/术樱包\//.test(candidate);
|
||||
}
|
||||
|
||||
export function extensionError(error, roots = [], depth = 0) {
|
||||
if (!error || typeof error !== "object" || depth >= 5) return false;
|
||||
const stack = read(error, "stack");
|
||||
if (typeof stack === "string" && stack.split("\n").slice(1).some(line =>
|
||||
/(?:\bat\s|@)/.test(line) && extensionSource(line, roots))) return true;
|
||||
if (extensionSource(read(error, "fileName"), roots)) return true;
|
||||
if (extensionError(read(error, "cause"), roots, depth + 1)) return true;
|
||||
const errors = read(error, "errors");
|
||||
return Array.isArray(errors) && errors.slice(0, 16).some(item =>
|
||||
extensionError(item, roots, depth + 1));
|
||||
}
|
||||
|
||||
export function byteLength(text) {
|
||||
if (typeof TextEncoder === "function") return new TextEncoder().encode(text).length;
|
||||
return new Blob([text]).size;
|
||||
}
|
||||
@@ -0,0 +1,206 @@
|
||||
import { byteLength } from "./serialize.js";
|
||||
|
||||
export const LOG_DIRECTORY = "extension/术樱包/logs";
|
||||
const ownedName = /^(?:runtime|report)-[a-zA-Z0-9-]+\.(?:jsonl|json)$/;
|
||||
|
||||
export function isDiagnosticFile(name) {
|
||||
return typeof name === "string" && ownedName.test(name);
|
||||
}
|
||||
|
||||
function checkedName(name) {
|
||||
if (!isDiagnosticFile(name)) throw new Error("Invalid diagnostic filename");
|
||||
return name;
|
||||
}
|
||||
|
||||
function callback(start) {
|
||||
return new Promise((resolve, reject) => {
|
||||
try { start(resolve, reject); } catch (error) { reject(error); }
|
||||
});
|
||||
}
|
||||
|
||||
function nodeStorage(env) {
|
||||
const fs = env.lib?.node?.fs;
|
||||
const root = env.window?.__dirname;
|
||||
if (!fs || typeof root !== "string" || !root) return null;
|
||||
const directory = `${root.replace(/[\\/]$/, "")}/${LOG_DIRECTORY}`;
|
||||
const invoke = (method, ...args) => callback((resolve, reject) => {
|
||||
fs[method](...args, (error, value) => error ? reject(error) : resolve(value));
|
||||
});
|
||||
const ready = () => invoke("mkdir", directory, { recursive: true });
|
||||
return {
|
||||
kind: "file", location: directory,
|
||||
async write(name, text) {
|
||||
await ready();
|
||||
await invoke("writeFile", `${directory}/${checkedName(name)}`, text, "utf8");
|
||||
},
|
||||
async list() {
|
||||
await ready();
|
||||
const names = (await invoke("readdir", directory)).filter(isDiagnosticFile);
|
||||
const entries = [];
|
||||
for (const name of names) {
|
||||
const stat = await invoke("lstat", `${directory}/${name}`);
|
||||
if (stat.isFile()) entries.push({ name, bytes: stat.size, time: stat.mtimeMs });
|
||||
}
|
||||
return entries;
|
||||
},
|
||||
remove: name => invoke("unlink", `${directory}/${checkedName(name)}`),
|
||||
};
|
||||
}
|
||||
|
||||
function cordovaStorage(env) {
|
||||
const host = env.window;
|
||||
if (typeof host?.resolveLocalFileSystemURL !== "function") return null;
|
||||
const root = env.localStorage?.getItem("noname_inited");
|
||||
if (!root) return null;
|
||||
let directoryPromise;
|
||||
const directory = () => {
|
||||
if (!directoryPromise) directoryPromise = callback((resolve, reject) => {
|
||||
host.resolveLocalFileSystemURL(root, resolve, reject);
|
||||
}).then(async entry => {
|
||||
for (const part of LOG_DIRECTORY.split("/")) {
|
||||
entry = await callback((resolve, reject) =>
|
||||
entry.getDirectory(part, { create: true }, resolve, reject));
|
||||
}
|
||||
return entry;
|
||||
});
|
||||
return directoryPromise;
|
||||
};
|
||||
const file = async name => {
|
||||
const entry = await directory();
|
||||
return callback((resolve, reject) =>
|
||||
entry.getFile(checkedName(name), { create: true }, resolve, reject));
|
||||
};
|
||||
return {
|
||||
kind: "file", location: `${root.replace(/\/$/, "")}/${LOG_DIRECTORY}`,
|
||||
async write(name, text) {
|
||||
const entry = await file(name);
|
||||
await callback((resolve, reject) => entry.createWriter(writer => {
|
||||
let truncated = false;
|
||||
writer.onerror = () => reject(writer.error || new Error("Diagnostic write failed"));
|
||||
writer.onwriteend = () => {
|
||||
if (writer.error) { reject(writer.error); return; }
|
||||
if (truncated) { resolve(); return; }
|
||||
truncated = true;
|
||||
try { writer.write(new Blob([text], { type: "text/plain;charset=utf-8" })); }
|
||||
catch (error) { reject(error); }
|
||||
};
|
||||
try { writer.truncate(0); } catch (error) { reject(error); }
|
||||
}, reject));
|
||||
},
|
||||
async list() {
|
||||
const entry = await directory();
|
||||
const reader = entry.createReader();
|
||||
const entries = [];
|
||||
while (true) {
|
||||
const batch = await callback((resolve, reject) =>
|
||||
reader.readEntries(resolve, reject));
|
||||
if (!batch.length) break;
|
||||
for (const item of batch) {
|
||||
if (!item.isFile || !isDiagnosticFile(item.name)) continue;
|
||||
const metadata = await callback((resolve, reject) =>
|
||||
item.getMetadata(resolve, reject));
|
||||
entries.push({ name: item.name, bytes: metadata.size,
|
||||
time: new Date(metadata.modificationTime).getTime() });
|
||||
}
|
||||
}
|
||||
return entries;
|
||||
},
|
||||
async remove(name) {
|
||||
const entry = await file(name);
|
||||
return callback((resolve, reject) => entry.remove(resolve, reject));
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
function databaseStorage(env) {
|
||||
const indexedDB = env.indexedDB;
|
||||
if (!indexedDB) return null;
|
||||
let database;
|
||||
const open = () => database ||= callback((resolve, reject) => {
|
||||
const request = indexedDB.open("shuying-diagnostics", 1);
|
||||
let failed = false;
|
||||
request.onupgradeneeded = () => {
|
||||
const db = request.result;
|
||||
if (!db.objectStoreNames.contains("files")) db.createObjectStore("files", { keyPath: "name" });
|
||||
};
|
||||
request.onsuccess = () => {
|
||||
if (failed) { request.result.close(); return; }
|
||||
request.result.onversionchange = () => request.result.close();
|
||||
resolve(request.result);
|
||||
};
|
||||
request.onerror = () => { failed = true; reject(request.error); };
|
||||
request.onblocked = () => { failed = true; reject(new Error("Diagnostic database blocked")); };
|
||||
});
|
||||
const transaction = async action => {
|
||||
const db = await open();
|
||||
return callback((resolve, reject) => {
|
||||
const tx = db.transaction(["files"], "readwrite");
|
||||
let value, failure;
|
||||
tx.oncomplete = () => resolve(value);
|
||||
tx.onerror = event => { failure = event.target?.error; };
|
||||
tx.onabort = () => reject(tx.error || failure || new Error("Diagnostic transaction aborted"));
|
||||
try { action(tx.objectStore("files"), result => { value = result; }); }
|
||||
catch (error) { try { tx.abort(); } catch {} reject(error); }
|
||||
});
|
||||
};
|
||||
return {
|
||||
kind: "indexeddb", location: "本机独立诊断数据库",
|
||||
write(name, text) {
|
||||
return transaction(store => store.put({ name: checkedName(name), text,
|
||||
bytes: byteLength(text), time: Date.now() }));
|
||||
},
|
||||
list() {
|
||||
return transaction((store, done) => {
|
||||
const entries = [];
|
||||
const cursor = store.openCursor();
|
||||
cursor.onsuccess = () => {
|
||||
const item = cursor.result;
|
||||
if (!item) { done(entries); return; }
|
||||
if (isDiagnosticFile(item.value.name)) entries.push({
|
||||
name: item.value.name, bytes: item.value.bytes, time: item.value.time,
|
||||
});
|
||||
item.continue();
|
||||
};
|
||||
});
|
||||
},
|
||||
remove: name => transaction(store => store.delete(checkedName(name))),
|
||||
};
|
||||
}
|
||||
|
||||
export function createDiagnosticStorage(env, options = {}) {
|
||||
const timeoutMs = options.timeoutMs ?? 5000;
|
||||
const onFailure = options.onFailure || (() => {});
|
||||
const candidates = [];
|
||||
try {
|
||||
const native = nodeStorage(env) || cordovaStorage(env);
|
||||
if (native) candidates.push(native);
|
||||
} catch (error) { onFailure(error, "file.init"); }
|
||||
try {
|
||||
const database = databaseStorage(env);
|
||||
if (database) candidates.push(database);
|
||||
} catch (error) { onFailure(error, "database.init"); }
|
||||
let index = 0;
|
||||
const timed = action => new Promise((resolve, reject) => {
|
||||
const timer = setTimeout(() => reject(new Error("Diagnostic storage timed out")), timeoutMs);
|
||||
Promise.resolve().then(action).then(resolve, reject).finally(() => clearTimeout(timer));
|
||||
});
|
||||
const execute = async (method, ...args) => {
|
||||
while (index < candidates.length) {
|
||||
const backend = candidates[index];
|
||||
try { return await timed(() => backend[method](...args)); }
|
||||
catch (error) {
|
||||
try { onFailure(error, `${backend.kind}.${method}`); } catch {}
|
||||
if (method !== "write") throw error;
|
||||
index++;
|
||||
}
|
||||
}
|
||||
throw new Error("Diagnostic persistence unavailable; records kept in memory");
|
||||
};
|
||||
return {
|
||||
write: (name, text) => execute("write", name, text),
|
||||
list: () => execute("list"),
|
||||
remove: name => execute("remove", name),
|
||||
status: () => ({ kind: candidates[index]?.kind || "memory",
|
||||
location: candidates[index]?.location || "仅当前运行内存,未能持久化" }),
|
||||
};
|
||||
}
|
||||
Reference in New Issue
Block a user