unleashorg/unleash-proxy

Unleash Proxy

Unleash Proxy 简化了前端和原生应用在特定用户上下文中与 Unleash API 的集成。该代理位于代理 SDK 和 Unleash API 之间，确保内部功能开关配置不会暴露给外部。

代理提供以下特性：

• 高性能 - 单个代理实例可处理数千请求/秒，并支持水平扩展。
• 终端用户隐私保护 - 终端用户不会直接访问 Unleash API，代理由您托管，确保用户数据（如 userId、IP 等）不会被共享。
• 安全性 - 由您完全控制并托管在自有域名下，且不会向用户共享功能开关配置，仅返回评估后的开关状态。

您可以在 官方文档 中了解更多关于代理的信息。

运行 Unleash Proxy

Unleash Proxy 是一个小型无状态 HTTP 应用，运行时仅需能够与 Unleash API（无论是 Unleash OSS 还是 Unleash Hosted）通信。

使用 Docker 运行

运行 Unleash 最简单的方式是通过 Docker。我们已在 Docker Hub 上发布了 https://hub.docker.com/r/unleashorg/unleash-proxy/%E3%80%82

步骤 1：拉取镜像

bash
docker pull unleashorg/unleash-proxy

步骤 2：启动容器

bash
docker run \
   -e UNLEASH_PROXY_SECRETS=some-secret \
   -e UNLEASH_URL=https://app.unleash-hosted.com/demo/api/ \
   -e UNLEASH_API_TOKEN=56907a2fa53c1d16101d509a10b78e36190b0f918d9f122d \
   -p 3000:3000 \
   unleashorg/unleash-proxy

启动成功后，您将看到以下输出：

bash
Unleash-proxy is listening on port 3000!

步骤 3：验证运行状态

您可以使用 curl 验证代理是否正常工作，预期会返回评估后的功能开关结果：

bash
curl http://localhost:3000/proxy -H "Authorization: some-secret"

预期输出示例：

json
{
	"toggles": [{
		"name": "demo",
		"enabled": true,
		"variant": {
			"name": "disabled",
			"enabled": false
		}
	}, {
		"name": "demoApp.step1",
		"enabled": true,
		"variant": {
			"name": "disabled",
			"enabled": false
		}
	}]
}

健康检查端点

代理启动时会尝试与 Unleash API 同步，同步成功前所有请求将返回 HTTP 503 - Not Ready。您可通过健康检查端点验证代理是否就绪：

bash
curl http://localhost:3000/proxy/health -I

预期响应：

bash
HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: ETag
Content-Type: text/html; charset=utf-8
Content-Length: 2
ETag: W/"2-eoX0dku9ba8cNUXvu/DyeabcC+s"
Date: Fri, 04 Jun 2021 10:38:27 GMT
Connection: keep-alive
Keep-Alive: timeout=5

可用选项

使用 Node.js 运行

步骤 1：安装依赖

bash
npm install @unleash/proxy

步骤 2：在代码中使用

javascript
const port = 3000;

const { createApp } = require('@unleash/proxy');

const app = createApp({
    unleashUrl: 'https://app.unleash-hosted.com/demo/api/',
    unleashApiToken: '56907a2fa53c1d16101d509a10b78e36190b0f918d9f122d',
    proxySecrets: ['proxy-secret', 'another-proxy-secret', 's1'],
    refreshInterval: 1000,
    // logLevel: 'info',
    // projectName: 'order-team',
    // environment: 'development',
});

app.listen(port, () =>
    // eslint-disable-next-line no-console
    console.log(`Unleash Proxy 监听在 http://localhost:${port}/proxy`),
);

代理客户端

为简化集成，我们开发了多种代理客户端 SDK，您可在 官方文档 中查看完整列表：

• https://github.com/unleash-hosted/unleash-proxy-client-js
• https://github.com/Unleash/unleash-android-proxy-sdk
• https://github.com/Unleash/unleash-proxy-client-swift