@wuyoumaster/opencode-telemetry-panel 0.0.7

package/README.md

@@ -0,0 +1,72 @@
+# OpenCode Telemetry Panel
+
+OpenCode telemetry plugin plus a Tauri floating panel.
+
+中文文档: [README_CN.md](./README_CN.md)
+
+## What it does
+
+- Captures request telemetry from OpenCode events.
+- Stores telemetry in `~/.opencode-telemetry/telemetry.jsonl`.
+- Launches a native floating panel from the plugin.
+- Downloads the matching executable automatically during `postinstall`.
+
+## Package Layout
+
+- `plugin/opencode-telemetry-panel.ts` OpenCode plugin entry.
+- `src/` Solid panel UI.
+- `src-tauri/` Tauri backend.
+- `scripts/postinstall.mjs` binary downloader.
+
+## Install
+
+```bash
+bun add @opencode-ai/telemetry-panel
+```
+
+or
+
+```bash
+npm i @opencode-ai/telemetry-panel
+```
+
+The install step runs `postinstall` and downloads the matching binary into `~/.opencode-telemetry/`.
+
+## Environment Variables
+
+- `OPENCODE_TELEMETRY_PANEL_REPO` overrides the GitHub repo slug used for binary downloads.
+- `OPENCODE_TELEMETRY_PANEL_BIN` forces a custom binary path.
+- `OPENCODE_TELEMETRY_PANEL_SKIP_DOWNLOAD=1` disables binary download during CI installs.
+
+## Supported Platforms
+
+- Windows x64
+- macOS x64
+- macOS arm64
+
+Linux is intentionally not supported for release artifacts yet.
+
+## Development
+
+```bash
+bun install
+bun run tauri dev
+```
+
+## Build Executable
+
+```bash
+bun run build:exe
+```
+
+This outputs the executable only, not an installer.
+
+## Release
+
+- Push a `v*` tag to publish npm and GitHub Release artifacts.
+- GitHub Releases contain the platform-specific executables.
+
+## Notes
+
+- The plugin reads the binary from `~/.opencode-telemetry/OpenCodeTelemetryPanel(.exe)` by default.
+- On Windows, the binary is `OpenCodeTelemetryPanel.exe`.

package/README_CN.md

@@ -0,0 +1,72 @@
+# OpenCode Telemetry Panel
+
+OpenCode 监控插件 + Tauri 浮窗面板。
+
+English: [README.md](./README.md)
+
+## 功能
+
+- 监听 OpenCode 事件并记录请求指标。
+- 将 telemetry 保存到 `~/.opencode-telemetry/telemetry.jsonl`。
+- 由插件拉起本地浮窗面板。
+- 安装时通过 `postinstall` 自动下载匹配平台的可执行文件。
+
+## 仓库结构
+
+- `plugin/opencode-telemetry-panel.ts` OpenCode 插件入口。
+- `src/` Solid 前端界面。
+- `src-tauri/` Tauri 后端。
+- `scripts/postinstall.mjs` 二进制下载脚本。
+
+## 安装
+
+```bash
+bun add @opencode-ai/telemetry-panel
+```
+
+或者
+
+```bash
+npm i @opencode-ai/telemetry-panel
+```
+
+安装时会执行 `postinstall`，把对应平台的可执行文件下载到 `~/.opencode-telemetry/`。
+
+## 环境变量
+
+- `OPENCODE_TELEMETRY_PANEL_REPO` 覆盖下载二进制时使用的 GitHub 仓库地址。
+- `OPENCODE_TELEMETRY_PANEL_BIN` 手动指定可执行文件路径。
+- `OPENCODE_TELEMETRY_PANEL_SKIP_DOWNLOAD=1` 可在 CI 安装时跳过二进制下载。
+
+## 支持平台
+
+- Windows x64
+- macOS x64
+- macOS arm64
+
+暂时不发布 Linux 构建产物。
+
+## 开发
+
+```bash
+bun install
+bun run tauri dev
+```
+
+## 构建可执行文件
+
+```bash
+bun run build:exe
+```
+
+这里只输出可执行文件，不生成安装包。
+
+## 发布
+
+- 推送 `v*` tag 会同时触发 npm 发布和 GitHub Release。
+- GitHub Release 会附带各平台的可执行文件。
+
+## 说明
+
+- 插件默认从 `~/.opencode-telemetry/OpenCodeTelemetryPanel(.exe)` 读取可执行文件。
+- Windows 下文件名是 `OpenCodeTelemetryPanel.exe`。

package/package.json

@@ -0,0 +1,53 @@
+{
+  "$schema": "https://json.schemastore.org/package.json",
+  "name": "@wuyoumaster/opencode-telemetry-panel",
+  "private": false,
+  "description": "OpenCode telemetry panel plugin with a companion Tauri binary",
+  "version": "0.0.7",
+  "type": "module",
+  "packageManager": "bun@1.3.11",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wuyouMaster/opencode-telemetry-panel.git"
+  },
+  "homepage": "https://github.com/wuyouMaster/opencode-telemetry-panel",
+  "bugs": {
+    "url": "https://github.com/wuyouMaster/opencode-telemetry-panel/issues"
+  },
+  "main": "./plugin/opencode-telemetry-panel.ts",
+  "exports": {
+    ".": "./plugin/opencode-telemetry-panel.ts",
+    "./server": "./plugin/opencode-telemetry-panel.ts"
+  },
+  "files": [
+    "plugin/opencode-telemetry-panel.ts",
+    "scripts/postinstall.mjs",
+    "README.md",
+    "README_CN.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "build:exe": "tauri build --no-bundle",
+    "postinstall": "node ./scripts/postinstall.mjs",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "tauri": "tauri"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "@tauri-apps/api": "^2",
+    "solid-js": "1.9.10"
+  },
+  "devDependencies": {
+    "@tauri-apps/cli": "^2",
+    "@types/bun": "1.3.11",
+    "typescript": "5.8.2",
+    "vite": "7.1.4",
+    "vite-plugin-solid": "2.11.10"
+  }
+}

package/plugin/opencode-telemetry-panel.ts

@@ -0,0 +1,214 @@
+import { appendFile, mkdir } from "node:fs/promises"
+import { existsSync } from "node:fs"
+import { dirname, join } from "node:path"
+import { homedir } from "node:os"
+
+type SessionStatusEvent = {
+  type: "session.status"
+  properties: {
+    sessionID: string
+    status: {
+      type: string
+    }
+  }
+}
+
+type MessagePartDeltaEvent = {
+  type: "message.part.delta"
+  properties: {
+    sessionID: string
+    messageID: string
+  }
+}
+
+type MessageUpdatedEvent = {
+  type: "message.updated"
+  properties: {
+    sessionID: string
+    info: {
+      role: string
+      id: string
+      providerID: string
+      modelID: string
+      time: {
+        created: number
+        completed?: number | null
+        error?: unknown
+      }
+    }
+  }
+}
+
+type SessionErrorEvent = {
+  type: "session.error"
+  properties: {
+    sessionID?: string | null
+    error: unknown
+  }
+}
+
+type TelemetryEvent = SessionStatusEvent | MessagePartDeltaEvent | MessageUpdatedEvent | SessionErrorEvent
+
+type Plugin = () => Promise<{
+  event: (input: { event: TelemetryEvent }) => Promise<void>
+}>
+
+type PendingRequest = {
+  sessionId: string
+  messageId: string
+  providerId: string
+  modelId: string
+  startedAt: number
+  firstTokenAt?: number
+  retries: number
+}
+
+const root = join(homedir(), ".opencode-telemetry")
+const file = join(root, "telemetry.jsonl")
+const executablePath = join(
+  root,
+  process.platform === "win32" ? "OpenCodeTelemetryPanel.exe" : "OpenCodeTelemetryPanel",
+)
+const pending = new Map<string, PendingRequest>()
+const firstTokenAt = new Map<string, number>()
+let panelLaunched = false
+
+function key(sessionId: string, messageId: string) {
+  return `${sessionId}:${messageId}`
+}
+
+function compactError(error: unknown) {
+  if (!error) return "session error"
+  if (typeof error !== "object") return String(error)
+  if ("data" in error && error.data && typeof error.data === "object" && "message" in error.data) {
+    return String((error.data as { message?: unknown }).message ?? (error as { message?: unknown }).message ?? "")
+  }
+  return String((error as { message?: unknown }).message ?? error)
+}
+
+async function append(record: Record<string, unknown>) {
+  await mkdir(dirname(file), { recursive: true })
+  await appendFile(file, `${JSON.stringify(record)}\n`)
+}
+
+function launchPanel() {
+  if (panelLaunched) return
+
+  const executable = [process.env.OPENCODE_TELEMETRY_PANEL_BIN, executablePath]
+    .filter((value): value is string => typeof value === "string")
+    .find((value) => existsSync(value))
+
+  if (!executable) return
+
+  const child = Bun.spawn([executable], {
+    detached: true,
+    stdio: ["ignore", "ignore", "ignore"],
+  })
+
+  child.unref()
+  panelLaunched = true
+}
+
+function recordFromPending(pendingRequest: PendingRequest, finishedAt: number, success: boolean, error?: string) {
+  const firstTokenAt = pendingRequest.firstTokenAt ?? finishedAt
+  return {
+    kind: "request",
+    sessionId: pendingRequest.sessionId,
+    messageId: pendingRequest.messageId,
+    providerId: pendingRequest.providerId,
+    modelId: pendingRequest.modelId,
+    startedAt: pendingRequest.startedAt,
+    firstTokenAt,
+    completedAt: finishedAt,
+    success,
+    error: error ?? null,
+    retries: pendingRequest.retries,
+  }
+}
+
+export const TelemetryPanelPlugin: Plugin = async () => {
+  launchPanel()
+
+  return {
+    event: async ({ event }) => {
+      if (event.type === "session.status") {
+        if (event.properties.status.type === "idle") {
+          for (const [requestKey, request] of pending.entries()) {
+            if (request.sessionId !== event.properties.sessionID) continue
+            pending.delete(requestKey)
+            firstTokenAt.delete(requestKey)
+          }
+          return
+        }
+
+        if (event.properties.status.type === "retry") {
+          for (const request of pending.values()) {
+            if (request.sessionId === event.properties.sessionID) request.retries += 1
+          }
+        }
+
+        return
+      }
+
+      if (event.type === "message.part.delta") {
+        const requestKey = key(event.properties.sessionID, event.properties.messageID)
+        if (!firstTokenAt.has(requestKey)) firstTokenAt.set(requestKey, Date.now())
+
+        const request = pending.get(requestKey)
+        if (request && request.firstTokenAt === undefined) request.firstTokenAt = firstTokenAt.get(requestKey)
+        return
+      }
+
+      if (event.type === "message.updated") {
+        if (event.properties.info.role !== "assistant") return
+
+        const requestKey = key(event.properties.sessionID, event.properties.info.id)
+        const existing = pending.get(requestKey)
+        const next =
+          existing ??
+          ({
+            sessionId: event.properties.sessionID,
+            messageId: event.properties.info.id,
+            providerId: event.properties.info.providerID,
+            modelId: event.properties.info.modelID,
+            startedAt: event.properties.info.time.created,
+            retries: 0,
+          } satisfies PendingRequest)
+
+        if (next.firstTokenAt === undefined) next.firstTokenAt = firstTokenAt.get(requestKey)
+
+        if (!existing) pending.set(requestKey, next)
+
+        if (!event.properties.info.time.completed) return
+
+        await append(
+          recordFromPending(
+            next,
+            event.properties.info.time.completed,
+            !event.properties.info.time.error,
+            event.properties.info.time.error ? compactError(event.properties.info.time.error) : undefined,
+          ),
+        ).catch(() => undefined)
+        pending.delete(requestKey)
+        firstTokenAt.delete(requestKey)
+        return
+      }
+
+      if (event.type === "session.error") {
+        const sessionId = event.properties.sessionID
+        if (!sessionId) return
+
+        const requests = [...pending.values()].filter((request) => request.sessionId === sessionId)
+        const request = requests.sort((left, right) => right.startedAt - left.startedAt)[0]
+        if (!request) return
+
+        await append(recordFromPending(request, Date.now(), false, compactError(event.properties.error))).catch(
+          () => undefined,
+        )
+        const requestKey = key(request.sessionId, request.messageId)
+        pending.delete(requestKey)
+        firstTokenAt.delete(requestKey)
+      }
+    },
+  }
+}

package/scripts/postinstall.mjs

@@ -0,0 +1,73 @@
+import { chmod, mkdir, readFile, rename, rm, writeFile } from "node:fs/promises"
+import { existsSync } from "node:fs"
+import { homedir } from "node:os"
+import { join } from "node:path"
+
+const packageJson = JSON.parse(await readFile(new URL("../package.json", import.meta.url), "utf8"))
+const root = join(homedir(), ".opencode-telemetry")
+const binaryName = process.platform === "win32" ? "OpenCodeTelemetryPanel.exe" : "OpenCodeTelemetryPanel"
+const binaryPath = join(root, binaryName)
+const version = packageJson.version
+const repo = resolveRepo(packageJson)
+const asset = resolveAsset()
+
+if (process.env.OPENCODE_TELEMETRY_PANEL_SKIP_DOWNLOAD === "1") {
+  process.exit(0)
+}
+
+if (!asset) {
+  console.warn("[opencode-telemetry-panel] skipping binary download on unsupported platform")
+  process.exit(0)
+}
+
+if (!repo) {
+  console.warn("[opencode-telemetry-panel] skipping binary download because repository is not configured")
+  process.exit(0)
+}
+
+await mkdir(root, { recursive: true })
+
+const url = `https://github.com/${repo}/releases/download/v${version}/${asset}`
+const response = await fetch(url)
+
+if (!response.ok) {
+  if (response.status === 404) {
+    console.warn(`[opencode-telemetry-panel] binary not found at ${url}; skipping download`)
+    process.exit(0)
+  }
+
+  throw new Error(`failed to download telemetry panel binary from ${url}: ${response.status} ${response.statusText}`)
+}
+
+const tempPath = `${binaryPath}.download`
+await writeFile(tempPath, Buffer.from(await response.arrayBuffer()))
+
+if (process.platform !== "win32") await chmod(tempPath, 0o755)
+
+if (existsSync(binaryPath)) await rm(binaryPath, { force: true })
+await rename(tempPath, binaryPath)
+
+function resolveRepo(pkg) {
+  const override = process.env.OPENCODE_TELEMETRY_PANEL_REPO?.trim()
+  if (override) return parseRepo(override) ?? override.replace(/^https?:\/\/github\.com\//, "").replace(/\.git$/, "")
+
+  const value = pkg.repository
+  if (typeof value === "string") return parseRepo(value)
+  if (value && typeof value.url === "string") return parseRepo(value.url)
+}
+
+function parseRepo(value) {
+  const text = value.trim()
+  if (!text) return
+  const https = text.match(/github\.com[:/](.+?)(?:\.git)?$/)
+  if (https) return https[1]
+
+  const git = text.match(/^git@github\.com:(.+?)(?:\.git)?$/)
+  if (git) return git[1]
+}
+
+function resolveAsset() {
+  if (process.platform === "win32" && process.arch === "x64") return "opencode-telemetry-panel-windows-x64.exe"
+  if (process.platform === "darwin" && process.arch === "arm64") return "opencode-telemetry-panel-macos-arm64"
+  if (process.platform === "darwin" && process.arch === "x64") return "opencode-telemetry-panel-macos-x64"
+}