mirror of https://github.com/hansjone/netx.git synced 2026-10-09 06:40:45 +08:00

oliver 0eead0e662 Add industrial config sync separate from collection tasks.

Periodic vendor-aware CLI sync stores zlib snapshots in Postgres with dashboard, retry, and config viewer under Network Management.

Co-authored-by: Cursor <cursoragent@cursor.com>

2026-07-31 10:25:36 +08:00

5.1 KiB

Raw Blame History

NetX Web 前端规范

技术栈

React 19 + TypeScript + Vite
React Router（工作台 + 模块页）
TanStack Query（服务端状态）
自研 i18n（src/i18n/，无额外依赖）

目录结构

src/
  config/modules.ts      # 模块注册表（工作台卡片、路由、标题 i18n）
  constants/queryKeys.ts # React Query key
  components/            # 可复用 UI（无业务 API 调用）
  hooks/                 # 通用 hooks（Toast、窗口注册）
  i18n/                  # 文案 zh / en
  layout/                # AppLayout、ErrorBoundary
  pages/                 # 页面（按路由）
  services/api.ts        # HTTP 封装与 API 函数
  types.ts               # 与后端契约类型
  utils/
    tabChannel.ts        # 跨标签页聚焦（BroadcastChannel）
    workbench.ts         # 返回工作台
    moduleWindows.ts     # 打开/聚焦模块页签
    display.ts           # 纯展示辅助

路由与模块

路径	页面	moduleId
`/`	工作台	—
`/ume`	UME 同步	`ume`
`/network`	网络管理（左栏 + 子路由）	`network`
`/network/devices`	设备列表	`network`
`/network/topology`	拓扑信息	`network`
`/network/alarms`	告警信息	`network`
`/network/configs`	配置信息（同步快照）	`network`
`/network/webcrt`	WebCRT 终端	`network`
`/network/tasks/collect`	采集任务	`network`
`/network/tasks/config-sync`	配置同步	`network`
`/network/tasks/port-traffic`	端口流量（占位）	`network`
`/ne`	redirect → `/network/devices`	—
`/collect`	redirect → `/network/tasks/collect`	—
`/topology`	redirect → `/network/topology`	—
`/webcrt`	redirect → `/network/webcrt`（保留 query）	—

菜单树见 config/networkNav.ts。新增网络子页：

在 networkNav.ts 增加叶子项
在 App.tsx /network 下增加子 <Route>
补充 i18n network.*

新增工作台模块仍改 config/modules.ts：

在 MODULES 增加一项（moduleId、path、section、i18n key、iconTone）
在 App.tsx 增加 <Route path="..." element={...} />
在 i18n/zh.ts 与 en.ts 补充文案
工作台卡片由 modulesInSection 自动生成，点击走 openOrFocusModule

跨标签页导航

工作台 → 模块：openOrFocusModule（同 moduleId 仅一个标签，已打开则聚焦）
模块 → 工作台：顶栏四格图标，returnToWorkbench（聚焦原工作台标签；已关闭则新开）
实现：utils/tabChannel.ts + 命名窗口 netx-module-{id} / netx-workbench

i18n

所有面向用户的文案走 useI18n().t("dotted.key")
表头/字段名等技术列可保持英文
语言存在 localStorage（netx-locale），顶栏 ⋯ 切换

数据请求

API 仅写在 services/api.ts
Query key 集中在 constants/queryKeys.ts
失效缓存用 prefix key（如 queryKeys.umeSyncStatusAll）
顶栏连接状态：App 轮询 GET /v1/integrations/status（5s），展示 netx api 与 oclaw bridge（含延迟 / 错误类型）

网元管理（独立于 UME）

API：/v1/managed-ne/*（CRUD、导入、连通性测试）
环境变量：NETX_CREDENTIAL_SECRET_KEY（Fernet，用于加密存储 SSH 密码）
导入列：device_type,ip,username,password,port,protocol,name,vendor
连通性测试成功后会始终用探测到的设备名覆盖「名称」

批量采集

API：/v1/ne-collections/*（仅 connect_status=pass 的网元可参与）
采集日志目录：NETX_NE_COLLECTION_DATA_DIR（默认 data/ne_collections）
命令每行一条，# 为注释；输出格式与旧版 NetX 采集 .txt 一致

配置同步

API：/v1/config-sync/*（策略、看板、周期、快照）
存储：PostgreSQL ne_config_snapshot / ne_config_history（zlib BYTEA）
范围：ManagedNE + UME CLI 目标；厂商固定只读命令矩阵
调度：NETX_CONFIG_SYNC_SCHEDULER_ENABLED（默认开），周期天数策略可配（默认 3 天）
前端：/network/tasks/config-sync（看板）+ /network/configs（查看）

WebCRT

API：POST /v1/webcrt/sessions（ne_id 或 ume_ne_id）、WS /v1/webcrt/sessions/{id}/ws、DELETE /v1/webcrt/sessions/{id}
目标列表复用 /v1/cli/targets（托管 + UME，搜索分页；source=all|managed|ume）
凭据：托管走网元自身账号；UME 走 CLI 连接模板（resolve_cli_target）
前端：CRT 风格左右分栏（会话管理 + 多标签终端）
审计：NETX_WEBCRT_DATA_DIR（默认 data/webcrt/audit.jsonl）
限流：NETX_WEBCRT_MAX_SESSIONS、NETX_WEBCRT_IDLE_TIMEOUT_SEC

Toast

使用 ToastProvider（main.tsx）+ useToast()
禁止页面内单独维护一套 toast 状态

样式

全局样式：index.css（工作台浅色主题）
不使用 CSS Modules；类名 BEM 风格：app-brand__logo、wb-card

构建

cd web && npm run build

开发：npm run dev（需后端 API 或 Vite proxy 配置）

5.1 KiB Raw Blame History Unescape Escape