whistle.mockbubu 1.0.0-dev.1

package/.editorconfig

@@ -0,0 +1,18 @@
+# http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 80
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = 0
+trim_trailing_whitespace = false
+
+[COMMIT_EDITMSG]
+max_line_length = 0

package/.gitignore

@@ -0,0 +1,63 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next
+/.history
+/dist

package/README.md

@@ -0,0 +1,80 @@
+# whistle.mockbubu
+
+whistle.mockbubu 是[whistle](https://github.com/avwo/whistle)的一个扩展脚本插件，包括以下功能
+
+- 实时生成捕获接口的 mock 文件
+- 管理 mock 文件
+
+# 安装
+
+$ w2 install whistle.mockbubu
+
+# 用法
+
+### 配置 [whistle 规则](https://avwo.github.io/whistle/rules/)
+
+> mode 有三种选项 pathname | href | pattern，默认是 pathname
+
+```text
+pattern mockbubu://[mode]
+```
+
+### 生成 mock 文件
+
+---
+
+#### pathname 模式：使用接口的 origin + pathname 作为文件名
+
+```text
+pattern mockbubu://  或者 pattern mockbubu://pathname
+```
+
+---
+
+#### href 模式：使用接口的 路径 作为文件名
+
+```text
+pattern mockbubu://href
+
+```
+
+---
+
+#### pattern 模式：使用 pattern 作为文件名
+
+```text
+pattern mockbubu://pattern
+```
+
+---
+
+### 开始 mock
+
+第一步：开启文件的 mock 开关，系统生成一条规则：
+
+```
+文件名 resBody:{文件内容}
+```
+
+第二步：在 Response 面板管理文件内容
+
+手动添加文件
+
+- 如果需要提前生成 mock 文件，可手动添加（通常不需要手动添加，通过实时捕获接口即可生成 mock 文件）
+
+编辑文件
+
+- 支持文件编辑
+
+多版本
+
+- 支持新增不同版本的文件内容
+- 其中 source 版本是默认生成的，是原始接口响应数据，支持修改
+
+切换 mock 文件
+
+- mock 返回内容使用当前选中的版本
+
+![alt text](step1.png)
+
+![alt text](step2.png)

package/index.js

@@ -0,0 +1,19 @@
+exports.uiServer = require('./lib/uiServer')
+// exports.rulesServer = require('./lib/rulesServer')
+// exports.tunnelRulesServer = require('./lib/tunnelRulesServer');
+exports.resRulesServer = require('./lib/resRulesServer')
+// exports.statsServer = require('./lib/statsServer')
+// exports.resStatsServer = require('./lib/resStatsServer')
+exports.server = require('./lib/server')
+// exports.reqRead = require('./lib/reqRead')
+// exports.reqWrite = require('./lib/reqWrite');
+// exports.resRead = require('./lib/resRead')
+// exports.resWrite = require('./lib/resWrite')
+// exports.wsReqRead = require('./lib/wsReqRead');
+// exports.wsReqWrite = require('./lib/wsReqWrite');
+// exports.wsResRead = require('./lib/wsResRead');
+// exports.wsResWrite = require('./lib/wsResWrite');
+// exports.tunnelReqRead = require('./lib/tunnelReqRead');
+// exports.tunnelReqWrite = require('./lib/tunnelReqWrite');
+// exports.tunnelResRead = require('./lib/tunnelResRead');
+// exports.tunnelResWrite = require('./lib/tunnelResWrite');

package/lib/const.js

@@ -0,0 +1,28 @@
+exports.RuleValueMap = {
+  href: 'href',
+  pathname: 'pathname',
+  pattern: 'pattern',
+}
+
+exports.RangeMap = {
+  MOCKING: 'mocking',
+  NOT_MOCKING: 'not-mocking',
+  LOCKED: 'locked',
+}
+
+exports.RangeFilterMap = {
+  'mocking': { key: 'mock', value: true, method: 'equal' },
+  'not-mocking': { key: 'mock', value: false, method: 'equal' },
+  'locked': { key: 'locked', value: true, method: 'equal' },
+}
+
+exports.RuleFilterMap = {
+  'href': { key: 'ruleValue', value: 'href', method: 'equal' },
+  'pathname': { key: 'ruleValue', value: 'pathname', method: 'equal' },
+  'pattern': { key: 'ruleValue', value: 'pattern', method: 'equal' },
+}
+
+exports.LockedFilterMap = {
+  'locked': { key: 'locked', value: true, method: 'equal' },
+  'unlocked': { key: 'locked', value: false, method: 'equal' },
+}

package/lib/resRulesServer.js

@@ -0,0 +1,9 @@
+module.exports = (server, options) => {
+  server.on('request', (req, res) => {
+    if (req.originalReq.headers['from-res-cache']) {
+      res.end('* style://color=red')
+      return
+    }
+    res.end()
+  })
+}

package/lib/server.js

@@ -0,0 +1,107 @@
+const {
+  getProperty,
+  setProperty,
+  getFilename,
+  getRule,
+  isJsonReq,
+  setApiListUpdated,
+  getVersionContent,
+  handleBuffer2String,
+  withTryCatch,
+} = require('./utils')
+const qs = require('qs')
+
+module.exports = (server, { storage }) => {
+  server.on('request', (req, res) => {
+    const { originalReq, method } = req
+    const { headers, ruleValue, url, pattern } = originalReq
+    const filename = getFilename(originalReq)
+    const rule = getRule(originalReq)
+
+    // 非json请求直接透传
+    if (!isJsonReq(headers)) return req.passThrough()
+
+    // 获取请求信息
+    let str = ''
+    req.on('data', (chunk) => {
+      str += chunk
+    })
+    req.on('end', () => {
+      setProperty(storage, filename, { payload: str })
+    })
+    setProperty(storage, filename, {
+      query: qs.parse(new URL(url).searchParams.toString()),
+    })
+
+    try {
+      const { mock, mockVersion } = getProperty(storage, filename) || {}
+      const sessionCache = storage.readFile(filename)
+
+      if (mock) {
+        if (sessionCache) {
+          const resCache = JSON.parse(sessionCache)?.res
+          const { statusCode, statusMessage, headers } = resCache
+
+          headers['from-res-cache'] = 'true'
+          delete headers['content-encoding']
+          delete headers['content-length']
+          res.writeHead(statusCode, statusMessage, headers)
+          if (mockVersion) {
+            const mockVersionContent = getVersionContent({ storage, filename, versionName: mockVersion })
+            res.end(JSON.stringify(mockVersionContent))
+          } else {
+            res.end(resCache.body)
+          }
+        }
+      } else {
+        // 已有缓存则直接透传
+        if (sessionCache) return req.passThrough()
+
+        // 命中插件规则，没有勾选mock的缓存最新的接口数据
+        const client = req.request((svrRes) => {
+          const encoding = svrRes.headers['content-encoding']
+          let body
+
+          svrRes.on('data', (data) => {
+            body = body ? Buffer.concat([body, data]) : data
+          })
+          svrRes.on('end', withTryCatch(async () => {
+            if (!body) return
+
+            const content = await handleBuffer2String({ body, encoding })
+            // 获取完整的抓包数据，要等待响应完成
+            req.getSession(async (session) => {
+              // 如果设置了 enable://hide 会获取到空数据
+              if (!session) {
+                return
+              }
+              setProperty(storage, filename, {
+                method,
+                rule,
+                status: session.res.statusCode,
+                pattern,
+                ruleValue: ruleValue || 'pathname',
+                url,
+                mock: false,
+                locked: false,
+                date: Date.now(),
+                mockTime: null,
+              })
+
+              const tempSession = JSON.parse(JSON.stringify(session))
+              tempSession.res.body = content
+              storage.writeFile(filename, JSON.stringify(tempSession))
+
+              setApiListUpdated(storage, true)
+            })
+          }))
+        })
+
+        req.pipe(client)
+        req.passThrough()
+      }
+    } catch (error) {
+      req.passThrough()
+    }
+  })
+}

package/lib/uiServer/index.js

@@ -0,0 +1,35 @@
+const Koa = require('koa')
+const bodyParser = require('koa-bodyparser')
+const onerror = require('koa-onerror')
+const serve = require('koa-static')
+const path = require('path')
+const router = require('koa-router')()
+const setupRouter = require('./router')
+const cors = require('koa2-cors')
+const MAX_AGE = 1000 * 60 * 5
+
+module.exports = (server, options) => {
+  const app = new Koa()
+
+  app.proxy = true
+  app.silent = true
+  onerror(app)
+  setupRouter(router, options)
+  app.use(
+    cors({
+      origin: '*',
+      maxAge: 10,
+      credentials: true,
+      allowMethods: ['GET', 'POST', 'PUT', 'DELETE', 'OPTIONS'],
+    }),
+  )
+  app.use(bodyParser({
+    jsonLimit: '10mb',
+    formLimit: '10mb',
+    textLimit: '10mb',
+  }))
+  app.use(router.routes())
+  app.use(router.allowedMethods())
+  app.use(serve(path.join(__dirname, '../../public'), { maxage: MAX_AGE }))
+  server.on('request', app.callback())
+}

package/lib/uiServer/router/index.js

@@ -0,0 +1,171 @@
+const {
+  updateFile,
+  removeFile,
+  writeFile,
+  readFile,
+  setProperty,
+  getProperty,
+  getApiListUpdated,
+  setApiListUpdated,
+} = require('../../utils')
+const {
+  createErrorResponse,
+  createSuccessResponse,
+  handleFilterList,
+  getFullDataList,
+} = require('../util')
+const versionRouter = require('./version-router')
+
+module.exports = (router) => {
+  // 文件版本路由
+  versionRouter(router)
+
+  // 获取列表数据接口
+  router.post('/cgi-bin/mockbubu/api-list', async (ctx) => {
+    try {
+      const { localStorage } = ctx.req
+
+      const filteredList = handleFilterList(
+        getFullDataList(localStorage),
+        ctx.request.body,
+      )
+
+      setApiListUpdated(localStorage, false)
+      ctx.body = createSuccessResponse(filteredList || [])
+    } catch (error) {
+      ctx.body = createErrorResponse(error.message)
+    }
+  })
+
+  // 检测接口是否更新
+  router.get('/cgi-bin/mockbubu/check-api-list', (ctx) => {
+    try {
+      const { localStorage } = ctx.req
+      const updated = getApiListUpdated(localStorage)
+      ctx.body = createSuccessResponse(updated)
+    } catch (error) {
+      ctx.body = createErrorResponse(error.message)
+    }
+  })
+
+  // 更新文件详情接口
+  router.post('/cgi-bin/mockbubu/update-api-data', (ctx) => {
+    try {
+      const { localStorage } = ctx.req
+      const { name, data } = ctx.request.body
+
+      updateFile(localStorage, name, data)
+      const file = readFile(localStorage, name)
+      const props = getProperty(localStorage, name) || {}
+
+      ctx.body = createSuccessResponse({
+        ...props,
+        name,
+        data: file,
+      })
+    } catch (error) {
+      ctx.body = createErrorResponse(error.message)
+    }
+  })
+
+  // 获取文件详情接口
+  router.post('/cgi-bin/mockbubu/get-api-data', (ctx) => {
+    try {
+      const { localStorage } = ctx.req
+      const { name } = ctx.request.body
+
+      const file = readFile(localStorage, name)
+      const props = getProperty(localStorage, name) || {}
+
+      ctx.body = createSuccessResponse({
+        ...props,
+        name,
+        data: file,
+      })
+    } catch (error) {
+      ctx.body = createErrorResponse(error.message)
+    }
+  })
+
+  // 新增mock接口
+  router.post('/cgi-bin/mockbubu/create-api-data', (ctx) => {
+    try {
+      const { localStorage } = ctx.req
+      const { name, content, ruleValue } = ctx.request.body
+
+      writeFile({
+        storage: localStorage,
+        filename: name,
+        body: content,
+        properties: { ruleValue, mock: true },
+      })
+
+      ctx.body = createSuccessResponse(null, '创建成功')
+    } catch (error) {
+      ctx.body = createErrorResponse(error.message)
+    }
+  })
+
+  // 修改接口mock开关
+  router.post('/cgi-bin/mockbubu/update-api-mock', (ctx) => {
+    try {
+      const { localStorage } = ctx.req
+      const { name, mock } = ctx.request.body
+
+      setProperty(localStorage, name, { mock })
+      ctx.body = createSuccessResponse(null, '更新成功')
+    } catch (error) {
+      ctx.body = createErrorResponse(error.message)
+    }
+  })
+
+  // 修改接口lock开关
+  router.post('/cgi-bin/mockbubu/update-api-lock', (ctx) => {
+    try {
+      const { localStorage } = ctx.req
+      const { name, locked } = ctx.request.body
+
+      setProperty(localStorage, name, { locked })
+      ctx.body = createSuccessResponse(null, '更新成功')
+    } catch (error) {
+      ctx.body = createErrorResponse(error.message)
+    }
+  })
+
+  // 删除接口数据
+  router.post('/cgi-bin/mockbubu/delete-api', (ctx) => {
+    try {
+      const { localStorage } = ctx.req
+      const { name } = ctx.request.body
+
+      removeFile(localStorage, name)
+      ctx.body = createSuccessResponse(null, '删除成功')
+    } catch (error) {
+      ctx.body = createErrorResponse(error.message)
+    }
+  })
+
+  // 批量删除接口
+  router.post('/cgi-bin/mockbubu/batch-delete-api', (ctx) => {
+    try {
+      const { localStorage } = ctx.req
+
+      const filteredList = handleFilterList(getFullDataList(localStorage), {
+        ...ctx.request.body,
+        locked: 'unlocked', // 锁定的文件不可批量删除
+      })
+      // 批量删除
+      filteredList.forEach((item) => {
+        try {
+          removeFile(localStorage, item.name)
+        } catch (error) {
+          console.error(`删除文件 ${item.name} 失败:`, error.message)
+        }
+      })
+
+      ctx.body = createSuccessResponse(null, '删除成功')
+    } catch (error) {
+      ctx.body = createErrorResponse(error.message)
+    }
+  })
+}

package/lib/uiServer/router/version-router.js

@@ -0,0 +1,127 @@
+const {
+  addNewVersion,
+  updateVersionContent,
+  deleteVersion,
+  updateVersionName,
+  getVersions,
+  setProperty,
+  getPropertyAttr,
+  removePropertyAttr,
+} = require('../../utils')
+const { createErrorResponse, createSuccessResponse } = require('../util')
+
+
+module.exports = (router) => {
+  // 新增版本
+  router.post('/cgi-bin/mockbubu/add-new-version', (ctx) => {
+    try {
+      const { localStorage } = ctx.req
+      const { versionName, content = {}, name } = ctx.request.body || {}
+
+      addNewVersion({
+        storage: localStorage,
+        filename: name,
+        versionName,
+        content,
+      })
+
+      ctx.body = createSuccessResponse({
+        filename: versionName,
+        content,
+      }, '版本创建成功')
+    } catch (error) {
+      ctx.body = createErrorResponse(error.message)
+    }
+  })
+
+  // 删除版本
+  router.post('/cgi-bin/mockbubu/delete-version', (ctx) => {
+    try {
+      const { localStorage } = ctx.req
+      const { versionName, name } = ctx.request.body || {}
+
+      const mockVersion = getPropertyAttr(localStorage, name, 'mockVersion')
+
+      // 如果删除的是当前mock版本，则清除mock版本设置
+      if (versionName === mockVersion) {
+        removePropertyAttr(localStorage, name, 'mockVersion')
+      }
+
+      deleteVersion({
+        storage: localStorage,
+        filename: name,
+        versionName,
+      })
+
+      ctx.body = createSuccessResponse(null, '版本删除成功')
+    } catch (error) {
+      ctx.body = createErrorResponse(error.message)
+    }
+  })
+
+  // 更新版本内容
+  router.post('/cgi-bin/mockbubu/update-version-content', (ctx) => {
+    try {
+      const { localStorage } = ctx.req
+      const { versionName, content, name } = ctx.request.body || {}
+
+      updateVersionContent({
+        storage: localStorage,
+        filename: name,
+        versionName,
+        content,
+      })
+
+      ctx.body = createSuccessResponse(null, '版本内容更新成功')
+    } catch (error) {
+      ctx.body = createErrorResponse(error.message)
+    }
+  })
+
+  // 更新版本名称
+  router.post('/cgi-bin/mockbubu/update-version-name', (ctx) => {
+    try {
+      const { localStorage } = ctx.req
+      const { versionName, name, newVersion } = ctx.request.body || {}
+
+      updateVersionName({
+        storage: localStorage,
+        filename: name,
+        versionName,
+        newVersion,
+      })
+
+      ctx.body = createSuccessResponse(null, '版本名称更新成功')
+    } catch (error) {
+      ctx.body = createErrorResponse(error.message)
+    }
+  })
+
+  // 获取版本列表
+  router.post('/cgi-bin/mockbubu/get-versions', (ctx) => {
+    try {
+      const { localStorage } = ctx.req
+      const { name } = ctx.request.body || {}
+
+      const list = getVersions({ storage: localStorage, filename: name }) || []
+
+      ctx.body = createSuccessResponse(list, '获取版本列表成功')
+    } catch (error) {
+      ctx.body = createErrorResponse(error.message)
+    }
+  })
+
+  // 设置mock的版本
+  router.post('/cgi-bin/mockbubu/set-mock-version', (ctx) => {
+    try {
+      const { localStorage } = ctx.req
+      const { name, versionName } = ctx.request.body || {}
+
+      setProperty(localStorage, name, { mockVersion: versionName })
+
+      ctx.body = createSuccessResponse(null, 'Mock版本设置成功')
+    } catch (error) {
+      ctx.body = createErrorResponse(error.message)
+    }
+  })
+}