# whistle.fastest

whistle.fastest 为 [whistle](https://github.com/avwo/whistle) 的一个插件，主要用于 fastest 项目。

## 特性

whistle.fastest 主要功能点如下：

- 从远程服务器中获取相关配置，并动态设置到 whistle 规则中，实现转发
- 将请求的结果在返回之前进行二次处理，以便实现静态资源、CGI 等的替换
- 支持权限控制


## 安装使用

whistle 的插件需要安装到全局（详见[whistle插件开发文档](https://wproxy.org/whistle/plugins.html) ），安装命令如下：

```bash
$ npm install whistle.fastest -g
```

安装成功之后，可以在 whistle 的管理端页面 `Plugins` tab 页看到安装的插件。

在规则中需要如下配置。将所有的请求都经过它来处理，注意需要传入 fastest 管理端接口的 IP 地址：

```bash
whistle.fastest://10.20.30.40 *
```


## 开发调试

### 安装插件

在开发的时候，可以使用下面命令将本地的包软链到全局。

```bash
npm link
```

### 构建

源代码在 `src` 目录下，我们引入了 babel 来处理，使用如下命令来构建发布版本：

```bash
npm run build
```

也可使用下面的命令，当 `src` 目录下的文件有变化时会自动构建

```bash
npm run watch
```

### 调试插件

开启 whistle 的调试模式，这样可以在控制台看到插件console输出的日志及错误。

```bash
w2 stop
w2 run
```

> 如果需要自定义端口，则可以使用 `w2 run -p 8080`

修改插件代码后，需要触发插件项目的 package.json 修改才会重新加载该插件，比如添加或删除一个空格。

### 测试用例

我们为主要的操作增加了测试用例，运行下面命令可以执行测试用例：

```bash
npm test
```

### 备注

本扩展插件是在 [whistle.script文档](https://github.com/whistle-plugins/whistle.script) 的基础上的简化定制版本。

> 一开始我们想直接使用 whistle.script ，但是发现请求量大的时候可能会导致 whistle 崩溃，原因未知，可能与其实现上过于复杂导致。

## 参考文档

- [whistle插件开发文档](https://wproxy.org/whistle/plugins.html)
- [whistle.script文档](https://github.com/whistle-plugins/whistle.script)