whistle.sse-mock 1.0.0

package/README.md

@@ -0,0 +1,185 @@
+# whistle.sse-mock
+
+一个用于模拟 SSE (Server-Sent Events) 流数据的 Whistle 插件。
+
+## 功能特点
+
+- 🎯 **自定义 SSE 数据**：支持配置多条 SSE 消息，每条消息可设置延迟时间
+- 🔄 **多配置管理**：支持创建多个配置，通过规则指定使用哪个配置
+- 💻 **可视化界面**：提供友好的 Web UI 来管理 SSE 配置
+- ⚡ **实时预览**：在界面中直接测试 SSE 输出效果
+- 🔁 **循环播放**：支持消息循环播放模式
+- 📝 **完整 SSE 支持**：支持 event、id、data 等 SSE 字段
+
+## 安装
+
+### 方式一：使用 lack 脚手架（官方推荐）
+
+```bash
+# 全局安装 lack
+npm i -g lack
+
+# 进入插件目录
+cd whistle.sse-mock
+
+# 开发模式运行（自动挂载到 Whistle）
+lack watch
+```
+
+> 参考：[Whistle 插件开发指南](https://wproxy.org/docs/extensions/dev.html)
+
+### 方式二：本地安装
+
+```bash
+# 进入插件目录
+cd whistle.sse-mock
+
+# 使用 whistle 安装插件（在插件目录执行）
+w2 i
+```
+
+### 方式三：npm link
+
+```bash
+# 进入插件目录
+cd whistle.sse-mock
+
+# 链接到全局
+npm link
+
+# 重启 whistle
+w2 restart
+```
+
+## 使用方法
+
+### 1. 配置 SSE 数据
+
+安装插件后，在 Whistle 界面的 Plugins 标签页中，点击 `sse-mock` 打开配置界面。
+
+在界面中可以：
+- 创建/编辑/删除 SSE 配置
+- 为每条消息设置数据内容和延迟时间
+- 设置是否循环播放
+- 实时预览 SSE 输出效果
+
+### 2. 添加 Whistle 规则
+
+在 Whistle Rules 中添加规则，格式为：
+
+```
+# 使用默认配置
+api.example.com/sse/stream sse-mock://
+
+# 使用指定配置
+api.example.com/chat/stream sse-mock://chatgpt
+
+# 正则匹配
+/api\/.*\/stream/ sse-mock://default
+```
+
+### 3. 访问接口
+
+现在访问匹配的接口时，Whistle 会返回你配置的 SSE 流数据：
+
+```bash
+curl -N http://api.example.com/sse/stream
+```
+
+## 配置示例
+
+### 基础配置
+
+```json
+{
+  "name": "default",
+  "description": "默认 SSE 配置",
+  "messages": [
+    { "data": "Hello SSE!", "delay": 1000 },
+    { "data": "This is mock data", "delay": 1000 },
+    { "data": "[DONE]", "delay": 0 }
+  ],
+  "loop": false
+}
+```
+
+### ChatGPT 风格配置
+
+```json
+{
+  "name": "chatgpt",
+  "description": "ChatGPT 风格 SSE 响应",
+  "messages": [
+    { "data": "{\"choices\":[{\"delta\":{\"content\":\"你\"}}]}", "delay": 100 },
+    { "data": "{\"choices\":[{\"delta\":{\"content\":\"好\"}}]}", "delay": 100 },
+    { "data": "{\"choices\":[{\"delta\":{\"content\":\"！\"}}]}", "delay": 100 },
+    { "data": "[DONE]", "delay": 0 }
+  ],
+  "loop": false
+}
+```
+
+### 带事件类型的配置
+
+```json
+{
+  "name": "with-events",
+  "messages": [
+    { "event": "start", "data": "开始", "delay": 0 },
+    { "event": "message", "data": "消息内容", "delay": 500 },
+    { "event": "end", "data": "结束", "delay": 500 }
+  ],
+  "loop": false
+}
+```
+
+## 消息字段说明
+
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| data | string | 是 | SSE 数据内容，可以是普通字符串或 JSON 字符串 |
+| delay | number | 否 | 发送前的延迟时间（毫秒），默认 100 |
+| event | string | 否 | SSE 事件类型，对应 `event:` 字段 |
+| id | string | 否 | SSE 消息 ID，对应 `id:` 字段 |
+
+## 目录结构
+
+```
+whistle.sse-mock/
+├── package.json        # 包配置
+├── index.js           # 插件入口
+├── lib/
+│   ├── server.js      # SSE 服务器（处理代理请求）
+│   ├── uiServer.js    # UI 服务器（提供配置界面 API）
+│   └── storage.js     # 存储模块（管理配置数据）
+├── public/
+│   └── index.html     # 配置界面
+├── data/
+│   └── config.json    # 配置数据（自动生成）
+└── README.md          # 说明文档
+```
+
+## 常见问题
+
+### Q: 插件安装后在 Whistle 中看不到？
+
+A: 确保：
+1. 插件名称以 `whistle.` 开头
+2. 已执行 `npm install` 安装依赖
+3. 重启 Whistle：`w2 restart`
+
+### Q: 规则配置正确但没有生效？
+
+A: 检查：
+1. 规则格式是否正确（注意 `://` 符号）
+2. URL 匹配是否正确
+3. 查看 Whistle Network 面板确认请求是否被匹配
+
+### Q: 如何查看原始 SSE 响应？
+
+A: 在浏览器开发者工具的 Network 面板中，找到对应请求，切换到 EventStream 标签页查看。
+
+## License
+
+MIT
+

package/data/.gitkeep

@@ -0,0 +1,2 @@
+# 此目录用于存储配置数据
+

package/index.js

@@ -0,0 +1,11 @@
+/**
+ * Whistle SSE Mock 插件
+ * 用于模拟 SSE 流数据，支持自定义数据输入和流式输出
+ */
+
+// 导出 server 模块 - 处理代理请求
+exports.server = require('./lib/server');
+
+// 导出 uiServer 模块 - 提供配置 UI
+exports.uiServer = require('./lib/uiServer');
+

package/lib/server.js

@@ -0,0 +1,152 @@
+/**
+ * SSE 服务器处理模块
+ * 处理代理请求，返回 SSE 流数据（支持分片延时）
+ * 
+ * 使用方式：在 Whistle Rules 中配置
+ *   pattern sse-mock://configName
+ *   pattern whistle.sse-mock://configName
+ */
+
+const storage = require('./storage');
+
+// 延时函数
+const sleep = (ms) => new Promise(resolve => setTimeout(resolve, ms));
+
+// 格式化 SSE 消息
+function formatSSEMessage(message) {
+  let output = '';
+  
+  if (message.event) {
+    output += `event: ${message.event}\n`;
+  }
+  
+  if (message.id) {
+    output += `id: ${message.id}\n`;
+  }
+  
+  const data = message.data !== undefined ? message.data : message;
+  if (typeof data === 'object') {
+    output += `data: ${JSON.stringify(data)}\n\n`;
+  } else {
+    output += `data: ${data}\n\n`;
+  }
+  
+  return output;
+}
+
+module.exports = (server, options) => {
+  server.on('request', async (req, res) => {
+    const originalReq = req.originalReq || {};
+    const ruleValue = originalReq.ruleValue || '';
+    
+    // 获取请求的 Origin（用于 CORS）
+    const origin = req.headers?.origin || req.headers?.Origin || '*';
+    
+    // 完整的 CORS 响应头
+    const corsHeaders = {
+      'Access-Control-Allow-Origin': origin,
+      'Access-Control-Allow-Methods': 'GET, POST, PUT, DELETE, OPTIONS, HEAD, PATCH',
+      'Access-Control-Allow-Headers': 'Content-Type, Authorization, X-Requested-With, Accept, Origin, Cache-Control, Pragma, User-Agent, Referer, DNT, ddmc-longitude, ddmc-build-version, ddmc-channel, ddmc-device-id, ddmc-app-client-id, ddmc-ip, ddmc-api-version, ddmc-city-number, ddmc-latitude, ddmc-station-id, *',
+      'Access-Control-Allow-Credentials': 'true',
+      'Access-Control-Expose-Headers': 'Content-Type, Content-Length',
+      'Access-Control-Max-Age': '86400'
+    };
+    
+    // 处理 OPTIONS 预检请求
+    if (req.method === 'OPTIONS') {
+      res.writeHead(204, corsHeaders);
+      res.end();
+      return;
+    }
+    
+    // 消费 POST body（如果有）
+    if (req.method === 'POST' || req.method === 'PUT' || req.method === 'PATCH') {
+      await new Promise((resolve) => {
+        req.on('data', () => {});
+        req.on('end', resolve);
+        req.on('error', resolve);
+      });
+    }
+    
+    const config = storage.getConfig();
+    
+    let configName = 'default';
+    if (ruleValue && ruleValue.trim()) {
+      configName = ruleValue.trim();
+    }
+    
+    const sseConfig = config.configs?.[configName] || config.configs?.['default'] || {
+      messages: [
+        { data: 'Hello SSE!', delay: 100 },
+        { data: 'This is mock data', delay: 100 },
+        { data: '[DONE]', delay: 0 }
+      ],
+      loop: false
+    };
+    
+    const messages = sseConfig.messages || [];
+    
+    // 合并 CORS 头和 SSE 响应头
+    const responseHeaders = {
+      ...corsHeaders,
+      'Content-Type': 'text/event-stream; charset=utf-8',
+      'Cache-Control': 'no-cache, no-store, must-revalidate',
+      'Pragma': 'no-cache',
+      'Expires': '0',
+      'Connection': 'keep-alive',
+      'Transfer-Encoding': 'chunked',
+      'X-Accel-Buffering': 'no'
+    };
+    
+    res.writeHead(200, responseHeaders);
+    
+    // 标记连接是否已关闭
+    let closed = false;
+    req.on('close', () => { closed = true; });
+    req.on('error', () => { closed = true; });
+    res.on('close', () => { closed = true; });
+    res.on('error', () => { closed = true; });
+    
+    // 流式发送消息（带延时）
+    const sendMessages = async () => {
+      for (let i = 0; i < messages.length; i++) {
+        if (closed) break;
+        
+        const message = messages[i];
+        const delay = message.delay !== undefined ? message.delay : 100;
+        
+        // 先等待延时
+        if (delay > 0) {
+          await sleep(delay);
+        }
+        
+        if (closed) break;
+        
+        // 发送消息
+        const sseData = formatSSEMessage(message);
+        
+        try {
+          res.write(sseData);
+          
+          // 尝试 flush
+          if (typeof res.flush === 'function') {
+            res.flush();
+          }
+        } catch (err) {
+          break;
+        }
+      }
+      
+      // 循环模式
+      if (!closed && sseConfig.loop) {
+        await sendMessages();
+      } else {
+        res.end();
+      }
+    };
+    
+    // 开始发送
+    await sendMessages();
+  });
+};
+

package/lib/storage.js

@@ -0,0 +1,120 @@
+/**
+ * 存储模块
+ * 用于管理 SSE 配置数据
+ */
+
+const fs = require('fs');
+const path = require('path');
+
+// 配置文件路径
+const CONFIG_FILE = path.join(__dirname, '../data/config.json');
+
+// 默认配置
+const defaultConfig = {
+  configs: {
+    default: {
+      name: 'default',
+      description: '默认 SSE 配置',
+      messages: [
+        { data: 'Hello SSE!', delay: 1000 },
+        { data: 'This is mock data from whistle.sse-mock', delay: 1000 },
+        { data: JSON.stringify({ type: 'message', content: 'JSON 数据示例' }), delay: 1000 },
+        { data: '[DONE]', delay: 0 }
+      ],
+      loop: false
+    },
+    chatgpt: {
+      name: 'chatgpt',
+      description: 'ChatGPT 风格 SSE 响应',
+      messages: [
+        { data: JSON.stringify({ choices: [{ delta: { content: '你' } }] }), delay: 100 },
+        { data: JSON.stringify({ choices: [{ delta: { content: '好' } }] }), delay: 100 },
+        { data: JSON.stringify({ choices: [{ delta: { content: '！' } }] }), delay: 100 },
+        { data: JSON.stringify({ choices: [{ delta: { content: '我' } }] }), delay: 100 },
+        { data: JSON.stringify({ choices: [{ delta: { content: '是' } }] }), delay: 100 },
+        { data: JSON.stringify({ choices: [{ delta: { content: 'AI' } }] }), delay: 100 },
+        { data: JSON.stringify({ choices: [{ delta: { content: '助' } }] }), delay: 100 },
+        { data: JSON.stringify({ choices: [{ delta: { content: '手' } }] }), delay: 100 },
+        { data: '[DONE]', delay: 0 }
+      ],
+      loop: false
+    }
+  }
+};
+
+// 确保数据目录存在
+function ensureDataDir() {
+  const dataDir = path.join(__dirname, '../data');
+  if (!fs.existsSync(dataDir)) {
+    fs.mkdirSync(dataDir, { recursive: true });
+  }
+}
+
+// 获取配置
+function getConfig() {
+  try {
+    ensureDataDir();
+    if (fs.existsSync(CONFIG_FILE)) {
+      const content = fs.readFileSync(CONFIG_FILE, 'utf8');
+      return JSON.parse(content);
+    }
+  } catch (error) {
+    console.error('读取配置文件失败:', error);
+  }
+  return defaultConfig;
+}
+
+// 保存配置
+function saveConfig(config) {
+  try {
+    ensureDataDir();
+    fs.writeFileSync(CONFIG_FILE, JSON.stringify(config, null, 2), 'utf8');
+    return true;
+  } catch (error) {
+    console.error('保存配置文件失败:', error);
+    return false;
+  }
+}
+
+// 获取单个配置
+function getConfigByName(name) {
+  const config = getConfig();
+  return config.configs?.[name] || null;
+}
+
+// 保存单个配置
+function saveConfigByName(name, sseConfig) {
+  const config = getConfig();
+  if (!config.configs) {
+    config.configs = {};
+  }
+  config.configs[name] = { ...sseConfig, name };
+  return saveConfig(config);
+}
+
+// 删除配置
+function deleteConfigByName(name) {
+  const config = getConfig();
+  if (config.configs && config.configs[name]) {
+    delete config.configs[name];
+    return saveConfig(config);
+  }
+  return false;
+}
+
+// 获取所有配置名称
+function getConfigNames() {
+  const config = getConfig();
+  return Object.keys(config.configs || {});
+}
+
+module.exports = {
+  getConfig,
+  saveConfig,
+  getConfigByName,
+  saveConfigByName,
+  deleteConfigByName,
+  getConfigNames,
+  defaultConfig
+};
+

package/lib/uiServer.js

@@ -0,0 +1,167 @@
+/**
+ * UI 服务器模块
+ * 提供配置界面 API
+ */
+
+const path = require('path');
+const fs = require('fs');
+const storage = require('./storage');
+
+module.exports = (server, options) => {
+  // 解析 JSON body
+  const parseBody = (req) => {
+    return new Promise((resolve, reject) => {
+      let body = '';
+      req.on('data', chunk => {
+        body += chunk.toString();
+      });
+      req.on('end', () => {
+        try {
+          resolve(body ? JSON.parse(body) : {});
+        } catch (e) {
+          resolve({});
+        }
+      });
+      req.on('error', reject);
+    });
+  };
+
+  // 发送 JSON 响应
+  const sendJson = (res, data, status = 200) => {
+    res.writeHead(status, { 'Content-Type': 'application/json; charset=utf-8' });
+    res.end(JSON.stringify(data));
+  };
+
+  // 发送 HTML 响应
+  const sendHtml = (res, html) => {
+    res.writeHead(200, { 'Content-Type': 'text/html; charset=utf-8' });
+    res.end(html);
+  };
+
+  server.on('request', async (req, res) => {
+    const url = new URL(req.url, `http://${req.headers.host}`);
+    const pathname = url.pathname;
+
+    try {
+      // 首页 - 返回配置界面
+      if (pathname === '/' || pathname === '/index.html') {
+        const htmlPath = path.join(__dirname, '../public/index.html');
+        const html = fs.readFileSync(htmlPath, 'utf8');
+        sendHtml(res, html);
+        return;
+      }
+
+      // API: 获取所有配置
+      if (pathname === '/api/configs' && req.method === 'GET') {
+        const config = storage.getConfig();
+        sendJson(res, { success: true, data: config.configs || {} });
+        return;
+      }
+
+      // API: 获取配置名称列表
+      if (pathname === '/api/config-names' && req.method === 'GET') {
+        const names = storage.getConfigNames();
+        sendJson(res, { success: true, data: names });
+        return;
+      }
+
+      // API: 获取单个配置
+      if (pathname.startsWith('/api/config/') && req.method === 'GET') {
+        const name = pathname.replace('/api/config/', '');
+        const config = storage.getConfigByName(decodeURIComponent(name));
+        if (config) {
+          sendJson(res, { success: true, data: config });
+        } else {
+          sendJson(res, { success: false, error: '配置不存在' }, 404);
+        }
+        return;
+      }
+
+      // API: 保存配置
+      if (pathname === '/api/config' && req.method === 'POST') {
+        const body = await parseBody(req);
+        const { name, ...configData } = body;
+        if (!name) {
+          sendJson(res, { success: false, error: '配置名称不能为空' }, 400);
+          return;
+        }
+        const success = storage.saveConfigByName(name, configData);
+        sendJson(res, { success, message: success ? '保存成功' : '保存失败' });
+        return;
+      }
+
+      // API: 删除配置
+      if (pathname.startsWith('/api/config/') && req.method === 'DELETE') {
+        const name = pathname.replace('/api/config/', '');
+        const success = storage.deleteConfigByName(decodeURIComponent(name));
+        sendJson(res, { success, message: success ? '删除成功' : '删除失败' });
+        return;
+      }
+
+      // API: 测试 SSE 流
+      if (pathname === '/api/test-sse' && req.method === 'GET') {
+        const configName = url.searchParams.get('config') || 'default';
+        const sseConfig = storage.getConfigByName(configName);
+        
+        if (!sseConfig) {
+          sendJson(res, { success: false, error: '配置不存在' }, 404);
+          return;
+        }
+
+        // 设置 SSE 响应头
+        res.writeHead(200, {
+          'Content-Type': 'text/event-stream',
+          'Cache-Control': 'no-cache',
+          'Connection': 'keep-alive'
+        });
+
+        let closed = false;
+        let currentIndex = 0;
+        let timer = null;
+
+        req.on('close', () => {
+          closed = true;
+          if (timer) clearTimeout(timer);
+        });
+
+        const sendNext = () => {
+          if (closed) return;
+          
+          const messages = sseConfig.messages || [];
+          if (currentIndex >= messages.length) {
+            res.end();
+            return;
+          }
+          
+          const message = messages[currentIndex];
+          const delay = message.delay !== undefined ? message.delay : 100;
+          
+          timer = setTimeout(() => {
+            if (closed) return;
+            
+            let output = '';
+            if (message.event) output += `event: ${message.event}\n`;
+            if (message.id) output += `id: ${message.id}\n`;
+            const data = message.data || message;
+            output += `data: ${typeof data === 'object' ? JSON.stringify(data) : data}\n\n`;
+            
+            res.write(output);
+            currentIndex++;
+            sendNext();
+          }, delay);
+        };
+
+        sendNext();
+        return;
+      }
+
+      // 404
+      sendJson(res, { success: false, error: 'Not Found' }, 404);
+
+    } catch (error) {
+      console.error('UI Server Error:', error);
+      sendJson(res, { success: false, error: error.message }, 500);
+    }
+  });
+};
+

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "whistle.sse-mock",
+  "version": "1.0.0",
+  "description": "Whistle 插件 - 模拟 SSE (Server-Sent Events) 流数据，支持可视化配置、批量导入、分片延时输出",
+  "main": "index.js",
+  "keywords": [
+    "whistle",
+    "whistle-plugin",
+    "plugin",
+    "sse",
+    "server-sent-events",
+    "mock",
+    "stream",
+    "proxy",
+    "chatgpt",
+    "ai"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zjians/whistle.sse-mock"
+  },
+  "homepage": "https://github.com/zjians/whistle.sse-mock",
+  "bugs": {
+    "url": "https://github.com/zjians/whistle.sse-mock/issues"
+  },
+  "files": [
+    "index.js",
+    "lib/",
+    "public/",
+    "data/.gitkeep",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "whistleConfig": {
+    "priority": 0,
+    "hintList": [
+      "sse-mock://default",
+      "sse-mock://chatgpt",
+      "sse-mock://{configName}"
+    ]
+  }
+}
+