opencode-metrics-plugin 0.2.0 → 0.3.0

package/dist/metrics/upload/workspaceResolver.js

@@ -0,0 +1,275 @@
+import * as fs from "node:fs";
+import * as path from "node:path";
+import { DEFAULT_DIR_MARKERS, DEFAULT_FILE_MARKERS, MAX_PROBE_DEPTH, MAX_ROOTS, sanitizeNameSegment, } from "./types.js";
+/**
+ * 会话证据收集器：旁路记录 write/edit 的文件路径与 bash 的工作目录、命令路径线索。
+ * 触发上传时用这些路径推断产物根。
+ */
+export class EvidenceCollector {
+    filePaths = new Set();
+    directories = new Set();
+    /**
+     * 记录一次文件写入/编辑。
+     *
+     * @param filePath 被写入文件的绝对路径
+     */
+    recordFileEdit(filePath) {
+        if (!filePath)
+            return;
+        this.filePaths.add(path.resolve(filePath));
+    }
+    /**
+     * 记录一次 bash 调用：登记工作目录，并从命令行提取路径线索
+     * （cd <path>、git -C <path>、出现 hvigorw 时登记工作目录本身）。
+     *
+     * @param workdir 命令执行目录（可能为空）
+     * @param command 完整命令行
+     */
+    recordBash(workdir, command) {
+        const base = workdir ? path.resolve(workdir) : process.cwd();
+        this.directories.add(base);
+        if (!command)
+            return;
+        // cd <path>（含引号形式），相对路径基于工作目录
+        const cdRegex = /(?:^|[\s;&(])cd\s+(?:"([^"&;]+)"|'([^'&;]+)'|([^\s;&|]+))/g;
+        let match;
+        while ((match = cdRegex.exec(command)) !== null) {
+            const target = match[1] ?? match[2] ?? match[3];
+            if (target)
+                this.directories.add(this.resolveAgainst(target, base));
+        }
+        // git -C <path>
+        const gitCRegex = /\bgit\s+(?:-\w+\s+)*-C\s+(?:"([^"&;]+)"|([^\s;&|]+))/g;
+        while ((match = gitCRegex.exec(command)) !== null) {
+            const target = match[1] ?? match[2];
+            if (target)
+                this.directories.add(this.resolveAgainst(target, base));
+        }
+        // hvigorw 出现即认为工作目录是构建现场
+        if (/hvigorw/.test(command)) {
+            this.directories.add(base);
+        }
+    }
+    /** 全部证据路径（文件 + 目录），供根推断使用 */
+    seeds() {
+        return [...this.filePaths, ...this.directories];
+    }
+    resolveAgainst(target, base) {
+        if (path.isAbsolute(target))
+            return path.resolve(target);
+        return path.resolve(base, target);
+    }
+}
+/**
+ * 判断目录是否为安卓工程：统计 gradle 构建信号（settings.gradle、gradlew、
+ * app/build.gradle、根 build.gradle+app/、AndroidManifest+src/），
+ * 命中 2 个及以上即判定，避免单文件误判。
+ *
+ * @param directory 待判定目录
+ * @returns          是安卓工程返回 true
+ */
+export function looksLikeAndroidProject(directory) {
+    const exists = (name) => fs.existsSync(path.join(directory, name));
+    let signals = 0;
+    if (exists("settings.gradle") || exists("settings.gradle.kts"))
+        signals++;
+    if (exists("gradlew") || exists("gradlew.bat"))
+        signals++;
+    if (exists("app/build.gradle") || exists("app/build.gradle.kts"))
+        signals++;
+    if ((exists("build.gradle") || exists("build.gradle.kts")) && exists("app"))
+        signals++;
+    if (exists("AndroidManifest.xml") && exists("src"))
+        signals++;
+    return signals >= 2;
+}
+/** 判断目录是否含鸿蒙工程标记（oh-package.json5 / build-profile.json5 / hvigorfile.ts / AppScope） */
+function hasHarmonyProjectMarkers(directory) {
+    return ["oh-package.json5", "build-profile.json5", "hvigorfile.ts", "AppScope"].some((marker) => fs.existsSync(path.join(directory, marker)));
+}
+/**
+ * 从证据路径推断产物根：自每条证据所在目录向上逐级探测标记（最多 5 层），
+ * 目录内存在任一标记即记为根；安卓工程根（自身无鸿蒙工程标记）先剔除，
+ * 嵌套根归并到最外层，去重后最多 3 个。
+ *
+ * @param seeds   证据路径（文件或目录的绝对路径）
+ * @param options 追加标记与安卓剔除开关（来自 appendArtifacts 配置）
+ * @returns        产物根绝对路径数组；无命中返回空数组
+ */
+export function resolveWorkspaceRoots(seeds, options) {
+    const dirMarkers = [...DEFAULT_DIR_MARKERS, ...(options?.extraDirMarkers ?? [])];
+    const fileMarkers = [...DEFAULT_FILE_MARKERS, ...(options?.extraFileMarkers ?? [])];
+    const markers = [...dirMarkers, ...fileMarkers];
+    const found = [];
+    for (const seed of seeds) {
+        const startDirectory = directoryOf(seed);
+        if (!startDirectory)
+            continue;
+        let current = startDirectory;
+        // 起始目录自身 + 向上最多 5 层祖先
+        for (let depth = 0; depth <= MAX_PROBE_DEPTH; depth++) {
+            if (markers.some((marker) => fs.existsSync(path.join(current, marker)))) {
+                found.push(current);
+            }
+            const parent = path.dirname(current);
+            if (parent === current)
+                break;
+            current = parent;
+        }
+    }
+    let candidates = dedupeRoots(found);
+    if (options?.excludeAndroidProjects !== false) {
+        candidates = candidates.filter((root) => !looksLikeAndroidProject(root) || hasHarmonyProjectMarkers(root));
+    }
+    return limitRoots(mergeNestedRoots(candidates));
+}
+/** 取路径所在目录：目录返回自身，文件返回父目录，不存在返回 null */
+function directoryOf(target) {
+    try {
+        const resolved = path.resolve(target);
+        const stat = fs.statSync(resolved);
+        return stat.isDirectory() ? resolved : path.dirname(resolved);
+    }
+    catch {
+        return null;
+    }
+}
+function normalizeKey(target) {
+    const resolved = path.resolve(target);
+    return process.platform === "win32" ? resolved.toLowerCase() : resolved;
+}
+function dedupeRoots(roots) {
+    const seen = new Set();
+    const result = [];
+    for (const root of roots) {
+        const key = normalizeKey(root);
+        if (!seen.has(key)) {
+            seen.add(key);
+            result.push(root);
+        }
+    }
+    return result;
+}
+/** 嵌套根归并：位于其他根内部的根丢弃，只保留最外层 */
+function mergeNestedRoots(roots) {
+    return roots.filter((root) => {
+        const rootKey = normalizeKey(root);
+        return !roots.some((other) => {
+            const otherKey = normalizeKey(other);
+            if (otherKey === rootKey)
+                return false;
+            return rootKey.startsWith(otherKey + path.sep);
+        });
+    });
+}
+/** 根数量上限：按路径排序后截取前 MAX_ROOTS 个 */
+function limitRoots(roots) {
+    const sorted = [...roots].sort();
+    return sorted.slice(0, MAX_ROOTS);
+}
+/**
+ * 判断证据路径是否位于配置路径之下（追加产物 "session-activity" 命中判定，
+ * Windows 下大小写不敏感）。
+ *
+ * @param evidencePath 证据路径
+ * @param configPath   配置的产物路径
+ * @returns            命中返回 true
+ */
+export function isPathInside(evidencePath, configPath) {
+    const evidenceKey = normalizeKey(path.resolve(evidencePath));
+    const configKey = normalizeKey(path.resolve(configPath));
+    return evidenceKey === configKey || evidenceKey.startsWith(configKey + path.sep);
+}
+// ─── 安卓项目名推断 ───────────────────────────────────────────────────────────
+/** 包名候选文件：相对证据目录的已知位置（祖先目录同样尝试） */
+const ANDROID_PACKAGE_CANDIDATES = [
+    "app/build.gradle",
+    "app/build.gradle.kts",
+    "build.gradle",
+    "build.gradle.kts",
+    "app/src/main/AndroidManifest.xml",
+    "src/main/AndroidManifest.xml",
+];
+/** 定位候选文件时自证据目录向上查找的祖先层数 */
+const ANDROID_ANCESTOR_DEPTH = 3;
+/**
+ * 从会话证据推断安卓项目名：在证据目录及其祖先（≤3 层）定位
+ * build.gradle / AndroidManifest.xml，按 applicationId > manifest package > namespace
+ * 的优先级提取包名；探测不到时回退目录名，仍无则返回 null。
+ *
+ * @param seeds   证据路径（文件或目录的绝对路径）
+ * @param options fallbackDirectory 提供目录兜底
+ * @returns        包名 / 兜底目录名（经名称清洗）；无可返回 null
+ */
+export function resolveAndroidProjectName(seeds, options) {
+    const candidateFiles = locateAndroidFiles(seeds);
+    // groovy 语法 applicationId "x" 无等号，kts 语法 applicationId = "x" 有等号，[=:]? 兼容两者
+    const packageId = extractByPattern(candidateFiles.gradle, /applicationId\s*[=:]?\s*["']([^"']+)["']/);
+    if (packageId)
+        return sanitizeNameSegment(packageId);
+    const manifestPackage = extractByPattern(candidateFiles.manifest, /\bpackage\s*=\s*"([^"]+)"/);
+    if (manifestPackage)
+        return sanitizeNameSegment(manifestPackage);
+    const namespace = extractByPattern(candidateFiles.gradle, /namespace\s*[=:]?\s*["']([^"']+)["']/);
+    if (namespace)
+        return sanitizeNameSegment(namespace);
+    if (options?.fallbackDirectory) {
+        return sanitizeNameSegment(path.basename(path.resolve(options.fallbackDirectory)));
+    }
+    return null;
+}
+/** 在证据目录及其祖先中定位全部存在的候选文件，按路径由浅到深分组返回 */
+function locateAndroidFiles(seeds) {
+    const gradle = [];
+    const manifest = [];
+    const seen = new Set();
+    for (const seed of seeds) {
+        const startDirectory = directoryOf(seed);
+        if (!startDirectory)
+            continue;
+        let current = startDirectory;
+        for (let depth = 0; depth <= ANDROID_ANCESTOR_DEPTH; depth++) {
+            for (const candidate of ANDROID_PACKAGE_CANDIDATES) {
+                const filePath = path.join(current, candidate);
+                const key = normalizeKey(filePath);
+                if (seen.has(key))
+                    continue;
+                try {
+                    fs.statSync(filePath);
+                    seen.add(key);
+                    if (filePath.endsWith(".gradle") || filePath.endsWith(".gradle.kts")) {
+                        gradle.push(filePath);
+                    }
+                    else {
+                        manifest.push(filePath);
+                    }
+                }
+                catch {
+                    // 不存在，跳过
+                }
+            }
+            const parent = path.dirname(current);
+            if (parent === current)
+                break;
+            current = parent;
+        }
+    }
+    // 浅层优先：多工程场景取最外层命中
+    const byDepth = (a, b) => a.split(path.sep).length - b.split(path.sep).length;
+    return { gradle: gradle.sort(byDepth), manifest: manifest.sort(byDepth) };
+}
+/** 逐文件读取并按正则提取第一个捕获组（只读文件头部，包名声明都在前部） */
+function extractByPattern(files, pattern) {
+    for (const file of files) {
+        try {
+            const content = fs.readFileSync(file, "utf-8").slice(0, 64 * 1024);
+            const match = content.match(pattern);
+            if (match)
+                return match[1];
+        }
+        catch {
+            // 读取失败，尝试下一个
+        }
+    }
+    return null;
+}

package/dist/plugin.d.ts

@@ -1,8 +1,10 @@
 import type { Plugin } from "@opencode-ai/plugin";
 import type { MetricsRuntimeOptions } from "./metrics/runtime.js";
 /**
- * opencode.json 插件配置项（["opencode-metrics-plugin", { ... }] 的第二参）。
- * 与 MetricsRuntimeOptions 一致：enabled / eventLogging / dirs / onFlush。
+ * opencode 插件配置项来源（优先级从高到低）：
+ * ① 项目 .opencode/opencode-metrics.json(.jsonc)（存在则完全接管，支持注释）；
+ * ② opencode.json 插件内联第二参（本类型，向后兼容）。
+ * 字段同 MetricsRuntimeOptions：enabled / eventLogging / checkpointFlushIntervalMs / dirs / upload。
  */
 export type MetricsPluginOptions = MetricsRuntimeOptions;
 /**
@@ -11,12 +13,13 @@ export type MetricsPluginOptions = MetricsRuntimeOptions;
  * ```jsonc
  * // opencode.json
  * { "plugin": ["opencode-metrics-plugin"] }
- * // 带配置：
- * { "plugin": [["opencode-metrics-plugin", { "enabled": true, "eventLogging": true }]] }
+ * // 带配置（内联，或移入项目根 opencode-metrics.json）：
+ * { "plugin": [["opencode-metrics-plugin", { "enabled": true, "upload": { "enabled": true } }]] }
  * ```
  *
  * 挂上后自动记录全部会话：每轮 session.idle 落盘快照 JSON，
- * dispose 时兜底 flush 未落盘会话。@opencode-ai/plugin 仅作类型依赖（零运行时依赖）。
+ * dispose 时兜底 flush 未落盘会话并排空上传队列。
+ * @opencode-ai/plugin 仅作类型依赖（零运行时依赖）。
  */
 export declare const MetricsPlugin: Plugin;
 export default MetricsPlugin;

package/dist/plugin.js

@@ -1,4 +1,5 @@
 import { createMetricsRuntime } from "./metrics/runtime.js";
+import { resolvePluginConfig } from "./metrics/configLoader.js";
 import { log } from "./shared/log.js";
 /**
  * opencode 插件入口。
@@ -6,20 +7,23 @@ import { log } from "./shared/log.js";
  * ```jsonc
  * // opencode.json
  * { "plugin": ["opencode-metrics-plugin"] }
- * // 带配置：
- * { "plugin": [["opencode-metrics-plugin", { "enabled": true, "eventLogging": true }]] }
+ * // 带配置（内联，或移入项目根 opencode-metrics.json）：
+ * { "plugin": [["opencode-metrics-plugin", { "enabled": true, "upload": { "enabled": true } }]] }
  * ```
  *
  * 挂上后自动记录全部会话：每轮 session.idle 落盘快照 JSON，
- * dispose 时兜底 flush 未落盘会话。@opencode-ai/plugin 仅作类型依赖（零运行时依赖）。
+ * dispose 时兜底 flush 未落盘会话并排空上传队列。
+ * @opencode-ai/plugin 仅作类型依赖（零运行时依赖）。
  */
-export const MetricsPlugin = async (_input, options) => {
-    const opts = (options ?? {});
-    const runtime = createMetricsRuntime(opts);
+export const MetricsPlugin = async (input, options) => {
+    const { config, source } = resolvePluginConfig(input.directory, (options ?? {}));
+    const runtime = createMetricsRuntime(config);
     log.info("[MetricsPlugin] started", {
         metricsDir: runtime.dirs.metricsDir,
         eventsDir: runtime.dirs.eventsDir,
-        enabled: opts.enabled !== false,
+        enabled: config.enabled !== false,
+        upload: Boolean(runtime.uploadManager),
+        configSource: source,
     });
     const hooks = {
         event: async ({ event }) => {
@@ -41,6 +45,7 @@ export const MetricsPlugin = async (_input, options) => {
         dispose: async () => {
             runtime.eventLogger?.dispose();
             runtime.engine.dispose();
+            await runtime.uploadManager?.dispose();
             log.info("[MetricsPlugin] disposed");
         },
     };

package/dist/shared/log.d.ts

@@ -1,6 +1,5 @@
 export type LogLevel = 'debug' | 'info' | 'warn' | 'error';
 export declare function setLogLevel(level: LogLevel): void;
-export declare function getLogLevel(): LogLevel;
 /** 设置运行日志落盘文件；传 null 关闭文件输出（仅 console）。 */
 export declare function setLogFile(file: string | null): void;
 export declare function flushLogs(): void;

package/dist/shared/log.js

@@ -6,9 +6,6 @@ let minOrder = LEVEL_ORDER.info;
 export function setLogLevel(level) {
     minOrder = LEVEL_ORDER[level];
 }
-export function getLogLevel() {
-    return Object.keys(LEVEL_ORDER).find((k) => LEVEL_ORDER[k] === minOrder) ?? 'info';
-}
 const DEFAULT_LOG_FILE = path.join(envPaths('opencode-metrics-plugin', { suffix: '' }).log, 'plugin.log');
 let logFile = DEFAULT_LOG_FILE;
 /** 设置运行日志落盘文件；传 null 关闭文件输出（仅 console）。 */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencode-metrics-plugin",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "opencode plugin: auto-records every session's metrics (tokens/rounds/steps/sub-agents/hvigor builds) to snapshot JSON. Zero DB, zero config. Pair with session-viewer for visualization.",
   "type": "module",
   "license": "MIT",
@@ -17,11 +17,17 @@
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
+    },
+    "./api": {
+      "types": "./dist/api.d.ts",
+      "import": "./dist/api.js"
     }
   },
   "files": [
     "dist",
-    "README.md"
+    "assets",
+    "README.md",
+    "CHANGELOG.md"
   ],
   "scripts": {
     "build": "node -e \"fs.rmSync('dist', { recursive: true, force: true })\" && tsc",