@huaqiu/dsh-analytics 0.4.7

package/lib/index.d.mts

@@ -0,0 +1,48 @@
+import { Context } from "@deepseek-ai/cordis";
+import { IncomingMessage, ServerResponse } from "node:http";
+//#region src/tool-events.d.ts
+interface AnalyticsEvent {
+  event: string;
+  properties?: Record<string, unknown>;
+}
+declare function isTrackedTool(name: string): boolean;
+interface ToolExecutionLike {
+  callId: string | {
+    toString(): string;
+  };
+  name: string;
+  arguments?: unknown;
+}
+interface ToolResultLike {
+  isError: boolean;
+  error?: {
+    message?: unknown;
+  };
+  content?: ReadonlyArray<unknown>;
+}
+declare function toToolAnalyticsEvent(exec: ToolExecutionLike, result: ToolResultLike, responseTime: number): AnalyticsEvent;
+declare class AnalyticsEventQueue {
+  private pending;
+  push(event: AnalyticsEvent): void;
+  drain(): AnalyticsEvent[];
+}
+//#endregion
+//#region src/routes.d.ts
+declare const ANALYTICS_ROUTE_PREFIX = "/api/v1/huaqiu/analytics";
+type AnalyticsHandler = (req: IncomingMessage, res: ServerResponse) => void;
+declare function createAnalyticsHandler(queue: AnalyticsEventQueue): AnalyticsHandler;
+//#endregion
+//#region src/index.d.ts
+declare const name = "@huaqiu/dsh-analytics";
+declare const inject: readonly ["webServer", "tools"];
+interface HuaqiuAnalyticsService {
+  track(event: string, properties?: Record<string, unknown>): void;
+}
+declare module '@deepseek-ai/cordis' {
+  interface Context {
+    huaqiuAnalytics: HuaqiuAnalyticsService;
+  }
+}
+declare function apply(ctx: Context): void;
+//#endregion
+export { ANALYTICS_ROUTE_PREFIX, type AnalyticsEvent, AnalyticsEventQueue, HuaqiuAnalyticsService, apply, createAnalyticsHandler, inject, isTrackedTool, name, toToolAnalyticsEvent };

package/lib/index.mjs

@@ -0,0 +1,106 @@
+import { getLogger } from "@huaqiu/dsh-plugin-log";
+//#region src/routes.ts
+const ANALYTICS_ROUTE_PREFIX = "/api/v1/huaqiu/analytics";
+function createAnalyticsHandler(queue) {
+	return (req, res) => {
+		const pathname = new URL(req.url ?? "/", "http://localhost").pathname;
+		res.setHeader("content-type", "application/json; charset=utf-8");
+		res.setHeader("cache-control", "no-store");
+		if (req.method === "GET" && pathname === `/api/v1/huaqiu/analytics/events`) {
+			res.statusCode = 200;
+			res.end(JSON.stringify({ events: queue.drain() }));
+			return;
+		}
+		res.statusCode = 404;
+		res.end(JSON.stringify({ error: "not_found" }));
+	};
+}
+//#endregion
+//#region src/tool-events.ts
+const TRACKED_TOOLS = /* @__PURE__ */ new Set([
+	"generate_symbol_from_image",
+	"generate_footprint_from_image",
+	"generate_footprint_from_dimensions",
+	"generate_schematic_from_description",
+	"generate_system_module_graph",
+	"search_hqsch_parts",
+	"get_hqsch_part",
+	"get_hqsch_part_models",
+	"get_hqsch_supply_chain",
+	"pcb_preview",
+	"get_project_netlist",
+	"get_selection_netlist",
+	"get_active_page_netlist",
+	"get_eda_host_info",
+	"get_pcb_selection",
+	"get_pcb_board",
+	"get_eda_host_capabilities",
+	"kicad_ipc_diagnose",
+	"kicad_ipc_verify_live",
+	"kicad_pcb_create_track",
+	"kicad_pcb_create_via",
+	"kicad_pcb_create_copper_zone",
+	"kicad_pcb_add_footprint_from_template",
+	"kicad_pcb_move_rotate_footprint",
+	"kicad_pcb_update_selected_track_width",
+	"kicad_pcb_refill_zones",
+	"kicad_pcb_remove_selected_items"
+]);
+function isTrackedTool(name) {
+	return TRACKED_TOOLS.has(name);
+}
+function toToolAnalyticsEvent(exec, result, responseTime) {
+	return {
+		event: "tool_call",
+		properties: {
+			tool_name: exec.name,
+			success: !result.isError,
+			response_time: responseTime,
+			err_msg: result.isError ? String(result.error?.message ?? "") : ""
+		}
+	};
+}
+var AnalyticsEventQueue = class {
+	pending = [];
+	push(event) {
+		this.pending.push(event);
+	}
+	drain() {
+		return this.pending.splice(0);
+	}
+};
+//#endregion
+//#region src/index.ts
+const name = "@huaqiu/dsh-analytics";
+const inject = ["webServer", "tools"];
+function apply(ctx) {
+	const log = getLogger("dsh-analytics");
+	const queue = new AnalyticsEventQueue();
+	const toolStartTimes = /* @__PURE__ */ new WeakMap();
+	const service = { track(event, properties) {
+		queue.push({
+			event,
+			properties
+		});
+	} };
+	ctx.effect(() => ctx.provide("huaqiuAnalytics", service));
+	ctx.effect(() => ctx.webServer.register({
+		kind: "prefix",
+		path: ANALYTICS_ROUTE_PREFIX,
+		handler: createAnalyticsHandler(queue)
+	}));
+	ctx.on("tools/pre-execute", async (exec, next) => {
+		if (isTrackedTool(exec.name)) toolStartTimes.set(exec, Date.now());
+		return next();
+	});
+	ctx.on("tools/result", (exec, result) => {
+		if (!isTrackedTool(exec.name)) return;
+		const startedAt = toolStartTimes.get(exec);
+		toolStartTimes.delete(exec);
+		const event = toToolAnalyticsEvent(exec, result, startedAt === void 0 ? 0 : Date.now() - startedAt);
+		queue.push(event);
+	});
+	log.info("analytics ready", { route: ANALYTICS_ROUTE_PREFIX });
+}
+//#endregion
+export { ANALYTICS_ROUTE_PREFIX, AnalyticsEventQueue, apply, createAnalyticsHandler, inject, isTrackedTool, name, toToolAnalyticsEvent };

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@huaqiu/dsh-analytics",
+  "version": "0.4.7",
+  "description": "Huaqiu Sensors Analytics integration for DeepSeek Harness",
+  "type": "module",
+  "main": "./lib/index.mjs",
+  "types": "./lib/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.mts",
+      "default": "./lib/index.mjs"
+    },
+    "./client": {
+      "default": "./lib/client.js"
+    },
+    "./cordis.patch.yml": "./cordis.patch.yml",
+    "./package.json": "./package.json"
+  },
+  "dsh": {
+    "bundle": {
+      "patch": "./cordis.patch.yml"
+    },
+    "client": {
+      "platform": "web",
+      "inject": [
+        "@deepseek-ai/dsh-client-runtime",
+        "@huaqiu/dsh-auth"
+      ]
+    }
+  },
+  "peerDependencies": {
+    "@deepseek-ai/cordis": "^4.0.1",
+    "@deepseek-ai/dsh-host-webserver": "^0.1.0-rc.0",
+    "@deepseek-ai/dsh-tools": "^0.1.0-rc.0"
+  },
+  "dependencies": {
+    "sa-sdk-javascript": "1.16.16",
+    "@huaqiu/dsh-auth": "0.4.7",
+    "@huaqiu/dsh-plugin-log": "0.4.7"
+  },
+  "files": [
+    "lib",
+    "src",
+    "cordis.patch.yml"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "build": "tsdown",
+    "test": "vitest run"
+  }
+}

package/src/client/analytics.ts

@@ -0,0 +1,57 @@
+export const SENSORS_SERVER_URL = 'https://sensorsapi.hqchip.com/sa?project=eda'
+
+export type ReqSource = 'website' | 'kicad' | 'huaqiu_eda_desktop'
+export type AnalyticsProperties = Record<string, unknown>
+
+export interface SensorsClient {
+  init(options: {
+    server_url: string
+    heatmap: { scroll_notice_map: 'not_collect' }
+    use_client_time: true
+    send_type: 'beacon'
+    show_log?: boolean
+  }): void
+  register(properties: AnalyticsProperties): void
+  quick(name: string, properties?: AnalyticsProperties): void
+  track(name: string, properties?: AnalyticsProperties): void
+  login(id: string): void
+}
+
+export interface HuaqiuAnalytics {
+  track(event: string, properties?: AnalyticsProperties): void
+  login(userId: string): void
+}
+
+export function trackLogin(analytics: HuaqiuAnalytics, uid: string): void {
+  analytics.login(uid)
+  analytics.track('login', { uid })
+}
+
+export function resolveReqSource(hostMode: boolean, targetHost: string): ReqSource {
+  if (!hostMode) return 'website'
+  return targetHost === 'hq-eda' ? 'huaqiu_eda_desktop' : 'kicad'
+}
+
+export function createAnalytics(
+  sensors: SensorsClient,
+  host: { hostMode: boolean; targetHost: string },
+): HuaqiuAnalytics {
+  sensors.init({
+    server_url: SENSORS_SERVER_URL,
+    heatmap: { scroll_notice_map: 'not_collect' },
+    use_client_time: true,
+    send_type: 'beacon',
+    show_log: true,
+  })
+  sensors.register({
+    env: 'prod',
+    project: 'dsh_copilot',
+    req_source: resolveReqSource(host.hostMode, host.targetHost),
+  })
+  sensors.quick('autoTrack')
+
+  return {
+    track: (event, properties) => { sensors.track(event, properties) },
+    login: userId => { sensors.login(userId) },
+  }
+}

package/src/client/index.ts

@@ -0,0 +1,103 @@
+import sensors from 'sa-sdk-javascript'
+import {
+  createAnalytics,
+  trackLogin,
+  type HuaqiuAnalytics,
+  type SensorsClient,
+} from './analytics.js'
+import type { AnalyticsEvent } from '../tool-events.js'
+
+export const inject: string[] = []
+
+interface AuthInfo {
+  id?: string
+  userId?: string
+}
+
+interface AuthApi {
+  isAuthenticated(): boolean
+  getUserInfo(): Promise<AuthInfo | null>
+  onAuthStateChanged(listener: (info: AuthInfo | null) => void): () => void
+}
+
+interface HqEdgeService {
+  context?: { getTargetHost?(): string }
+}
+
+interface ClientContext {
+  provide?(name: string, value: unknown): () => void
+  get?<T>(name: string): T | undefined
+}
+
+const POLL_INTERVAL_MS = 1000
+
+async function resolveHostMode(): Promise<boolean> {
+  try {
+    const response = await fetch('/api/v1/huaqiu/auth/config', {
+      headers: { accept: 'application/json' },
+    })
+    if (!response.ok) return false
+    const body = await response.json() as { hostMode?: unknown }
+    return body.hostMode === true
+  } catch {
+    return false
+  }
+}
+
+async function drainNodeEvents(analytics: HuaqiuAnalytics): Promise<void> {
+  try {
+    const response = await fetch('/api/v1/huaqiu/analytics/events', {
+      headers: { accept: 'application/json' },
+    })
+    if (!response.ok) return
+    const body = await response.json() as { events?: AnalyticsEvent[] }
+    for (const item of body.events ?? []) {
+      if (typeof item?.event === 'string' && item.event.length > 0) {
+        analytics.track(item.event, item.properties)
+      }
+    }
+  } catch {
+    // Analytics must never affect the host application.
+  }
+}
+
+export function apply(ctx: ClientContext): () => void {
+  const disposers: Array<() => void> = []
+  let disposed = false
+
+  void resolveHostMode().then((hostMode) => {
+    if (disposed) return
+    const targetHost = ctx.get?.<HqEdgeService>('hqEdge')?.context?.getTargetHost?.() ?? ''
+    const analytics = createAnalytics(sensors as unknown as SensorsClient, { hostMode, targetHost })
+
+    const disposeProvide = ctx.provide?.('huaqiuAnalytics', analytics)
+    if (disposeProvide) disposers.push(disposeProvide)
+
+    const auth = ctx.get?.<{ auth?: AuthApi }>('huaqiuAuth')?.auth
+    if (auth) {
+      let wasAuthenticated = auth.isAuthenticated()
+      void auth.getUserInfo().then((info) => {
+        const userId = info?.id ?? info?.userId
+        if (userId) analytics.login(userId)
+      }).catch(() => undefined)
+      disposers.push(auth.onAuthStateChanged((info) => {
+        const authenticated = info !== null
+        const userId = info?.id ?? info?.userId
+        if (userId && !wasAuthenticated && authenticated) trackLogin(analytics, userId)
+        else if (userId) analytics.login(userId)
+        wasAuthenticated = authenticated
+      }))
+    }
+
+    void drainNodeEvents(analytics)
+    const timer = window.setInterval(() => { void drainNodeEvents(analytics) }, POLL_INTERVAL_MS)
+    disposers.push(() => { window.clearInterval(timer) })
+  })
+
+  return () => {
+    disposed = true
+    for (const dispose of disposers.reverse()) dispose()
+  }
+}
+
+export { createAnalytics, resolveReqSource, trackLogin, type HuaqiuAnalytics } from './analytics.js'

package/src/index.ts

@@ -0,0 +1,55 @@
+import type { Context } from '@deepseek-ai/cordis'
+import type {} from '@deepseek-ai/dsh-host-webserver'
+import type {} from '@deepseek-ai/dsh-tools'
+import { getLogger } from '@huaqiu/dsh-plugin-log'
+import { ANALYTICS_ROUTE_PREFIX, createAnalyticsHandler } from './routes.js'
+import { AnalyticsEventQueue, isTrackedTool, toToolAnalyticsEvent, type AnalyticsEvent } from './tool-events.js'
+
+export const name = '@huaqiu/dsh-analytics'
+export const inject = ['webServer', 'tools'] as const
+
+export interface HuaqiuAnalyticsService {
+  track(event: string, properties?: Record<string, unknown>): void
+}
+
+declare module '@deepseek-ai/cordis' {
+  interface Context {
+    huaqiuAnalytics: HuaqiuAnalyticsService
+  }
+}
+
+export function apply(ctx: Context): void {
+  const log = getLogger('dsh-analytics')
+  const queue = new AnalyticsEventQueue()
+  const toolStartTimes = new WeakMap<object, number>()
+  const service: HuaqiuAnalyticsService = {
+    track(event, properties) {
+      queue.push({ event, properties })
+    },
+  }
+
+  ctx.effect(() => ctx.provide('huaqiuAnalytics', service))
+  ctx.effect(() => ctx.webServer.register({
+    kind: 'prefix',
+    path: ANALYTICS_ROUTE_PREFIX,
+    handler: createAnalyticsHandler(queue),
+  }))
+  ctx.on('tools/pre-execute', async (exec, next) => {
+    const tracked = isTrackedTool(exec.name)
+    if (tracked) toolStartTimes.set(exec, Date.now())
+    return next()
+  })
+  ctx.on('tools/result', (exec, result) => {
+    const tracked = isTrackedTool(exec.name)
+    if (!tracked) return
+    const startedAt = toolStartTimes.get(exec)
+    toolStartTimes.delete(exec)
+    const event = toToolAnalyticsEvent(exec, result, startedAt === undefined ? 0 : Date.now() - startedAt)
+    queue.push(event)
+  })
+
+  log.info('analytics ready', { route: ANALYTICS_ROUTE_PREFIX })
+}
+
+export { ANALYTICS_ROUTE_PREFIX, createAnalyticsHandler } from './routes.js'
+export { AnalyticsEventQueue, isTrackedTool, toToolAnalyticsEvent, type AnalyticsEvent } from './tool-events.js'

package/src/routes.ts

@@ -0,0 +1,23 @@
+import type { IncomingMessage, ServerResponse } from 'node:http'
+import type { AnalyticsEventQueue } from './tool-events.js'
+
+export const ANALYTICS_ROUTE_PREFIX = '/api/v1/huaqiu/analytics'
+
+export type AnalyticsHandler = (req: IncomingMessage, res: ServerResponse) => void
+
+export function createAnalyticsHandler(queue: AnalyticsEventQueue): AnalyticsHandler {
+  return (req, res) => {
+    const pathname = new URL(req.url ?? '/', 'http://localhost').pathname
+    res.setHeader('content-type', 'application/json; charset=utf-8')
+    res.setHeader('cache-control', 'no-store')
+
+    if (req.method === 'GET' && pathname === `${ANALYTICS_ROUTE_PREFIX}/events`) {
+      res.statusCode = 200
+      res.end(JSON.stringify({ events: queue.drain() }))
+      return
+    }
+
+    res.statusCode = 404
+    res.end(JSON.stringify({ error: 'not_found' }))
+  }
+}

package/src/tool-events.ts

@@ -0,0 +1,79 @@
+export interface AnalyticsEvent {
+  event: string
+  properties?: Record<string, unknown>
+}
+
+// 埋点工具白名单
+const TRACKED_TOOLS = new Set([
+  'generate_symbol_from_image',
+  'generate_footprint_from_image',
+  'generate_footprint_from_dimensions',
+  'generate_schematic_from_description',
+  'generate_system_module_graph',
+  'search_hqsch_parts',
+  'get_hqsch_part',
+  'get_hqsch_part_models',
+  'get_hqsch_supply_chain',
+  'pcb_preview',
+  'get_project_netlist',
+  'get_selection_netlist',
+  'get_active_page_netlist',
+  'get_eda_host_info',
+  'get_pcb_selection',
+  'get_pcb_board',
+  'get_eda_host_capabilities',
+  'kicad_ipc_diagnose',
+  'kicad_ipc_verify_live',
+  'kicad_pcb_create_track',
+  'kicad_pcb_create_via',
+  'kicad_pcb_create_copper_zone',
+  'kicad_pcb_add_footprint_from_template',
+  'kicad_pcb_move_rotate_footprint',
+  'kicad_pcb_update_selected_track_width',
+  'kicad_pcb_refill_zones',
+  'kicad_pcb_remove_selected_items',
+])
+
+export function isTrackedTool(name: string): boolean {
+  return TRACKED_TOOLS.has(name)
+}
+
+interface ToolExecutionLike {
+  callId: string | { toString(): string }
+  name: string
+  arguments?: unknown
+}
+
+interface ToolResultLike {
+  isError: boolean
+  error?: { message?: unknown }
+  content?: ReadonlyArray<unknown>
+}
+
+export function toToolAnalyticsEvent(
+  exec: ToolExecutionLike,
+  result: ToolResultLike,
+  responseTime: number,
+): AnalyticsEvent {
+  return {
+    event: 'tool_call',
+    properties: {
+      tool_name: exec.name,
+      success: !result.isError,
+      response_time: responseTime,
+      err_msg: result.isError ? String(result.error?.message ?? '') : '',
+    },
+  }
+}
+
+export class AnalyticsEventQueue {
+  private pending: AnalyticsEvent[] = []
+
+  push(event: AnalyticsEvent): void {
+    this.pending.push(event)
+  }
+
+  drain(): AnalyticsEvent[] {
+    return this.pending.splice(0)
+  }
+}