@cloudflare/旗舰

打开形状- 符合要求的供应商SDK 旗舰, Cloudflare 全球分布,低纬度地物地标旗平台.

服务器侧(Node.js, Cloudflare Workers)和客户端侧(浏览器)通过孤立的子路径导出支持. 可树摇动-导入 @cloudflare/flagship/server 从不装载 @openfeature/web-sdk 而反之亦然.

安装

服务器侧 (节点.js, Cloudflare工人):

npm install @cloudflare/flagship @openfeature/server-sdk

客户端 (浏览器):

npm install @cloudflare/flagship @openfeature/web-sdk

快速启动 — 服务器

import { OpenFeature } from '@openfeature/server-sdk';
import { FlagshipServerProvider } from '@cloudflare/flagship/server';

await OpenFeature.setProviderAndWait(
  new FlagshipServerProvider({ appId: 'your-app-id', accountId: 'your-account-id', authToken: 'your-token' }),
);

const client = OpenFeature.getClient();
const enabled = await client.getBooleanValue('dark-mode', false, { userId: 'user-123' });

快速启动——云浮工人

建议对Cloudflare工人采取的办法。 使用扳手绑定——不需要HTTP上架,不需要认证符.

配置在 wrangler.json数字 :

{
  "flagship": [{ "binding": "FLAGS", "app_id": "<your-app-id>" }]
}

import { OpenFeature } from '@openfeature/server-sdk';
import { FlagshipServerProvider } from '@cloudflare/flagship/server';
import type { FlagshipBinding } from '@cloudflare/flagship/server';

export default {
  async fetch(request: Request, env: { FLAGS: FlagshipBinding }): Promise<Response> {
    await OpenFeature.setProviderAndWait(new FlagshipServerProvider({ binding: env.FLAGS }));

    const client = OpenFeature.getClient();
    const darkMode = await client.getBooleanValue('dark-mode', false, {
      targetingKey: new URL(request.url).searchParams.get('userId') ?? 'anonymous',
    });

    return Response.json({ darkMode });
  },
};

快速启动 — HTTP

对于没有旗舰绑定或非工人服务器环境的工人:

import { OpenFeature } from '@openfeature/server-sdk';
import { FlagshipServerProvider } from '@cloudflare/flagship/server';

let initialized = false;

export default {
  async fetch(request: Request): Promise<Response> {
    if (!initialized) {
      await OpenFeature.setProviderAndWait(
        new FlagshipServerProvider({ appId: 'your-app-id', accountId: 'your-account-id', authToken: 'your-token' }),
      );
      initialized = true;
    }

    const client = OpenFeature.getClient();
    const darkMode = await client.getBooleanValue('dark-mode', false, {
      userId: new URL(request.url).searchParams.get('userId') ?? 'anonymous',
    });

    return Response.json({ darkMode });
  },
};

结构化评价背景

绑定和 HTTP 模式支持嵌入对象、阵列和 null 在评价方面。 日期被递归转换为ISO-8601字符串.

const checkout = await client.getStringValue('checkout-flow', 'control', {
  targetingKey: 'user-123',
  profile: { account: { plan: 'enterprise' } },
  tags: ['beta', 'internal'],
});

原始的仅HTTP上下文继续使用GET查询参数. 结构化背景,包括 null,使用 JSON POST 端点;在浏览器中此选项添加了 CORS 飞行前请求。 只有弦,数字,布尔斯, null、日期、数组和平面对象均得到支持。 其他任何东西,包括循环值,都与 INVALID_CONTEXT 无需装订或HTTP呼叫.

缓存

服务器提供商可以缓存评价来避免网络回行(HTTP模式)或对重复的旗/上线对的绑定调用(绑定模式). 缓存是 默认关闭 通过设置 cacheTtl数字 :

new FlagshipServerProvider({
  appId: 'your-app-id',
  accountId: 'your-account-id',
  cacheTtl: 30_000, // ms — enables caching; values may be up to this stale
  cacheMaxSize: 1000, // max cached entries, LRU-evicted (default: 1000)
});

每个条目按旗下键键、类型和 全面评价背景,所以不同的情况 从来没有共享一个价值。 缓存点击解析 reason: 'CACHED'。禁用旗帜和错误永远不会被缓存。 由于新鲜度以TTL为主,在条目到期后,Flagship的一面国旗更名生效.

地方评价

服务器提供者可以一次下载旗下定义,并在过程中评价旗下,每次评价没有网络呼叫. 定义在背景中轻而易举地更新(在评价时更新).

await OpenFeature.setProviderAndWait(
  new FlagshipServerProvider({
    appId: 'your-app-id',
    accountId: 'your-account-id', // required — used as the rollout hash seed
    authToken: 'your-read-token', // needs app **read** permission, not evaluate
    localEvaluation: true,
    refreshInterval: 30_000, // ms between background refreshes (default 30s)
  }),
);

注释:

• 与 binding 模式和模式 cacheTtl (没有什么可缓存的).
• accountId 总是需要本地模式,包括何时 endpoint 已使用.
• 与 endpoint, URL 路径必须结束于 /evaluate 这样 /definitions 可导出.
• 地方评价 没有 出现在服务器侧分析中.
• 见 examples/server-local.ts。 。 。 .

快速启动 — 浏览器

import { OpenFeature } from '@openfeature/web-sdk';
import { FlagshipClientProvider } from '@cloudflare/flagship/web';

await OpenFeature.setProviderAndWait(
  new FlagshipClientProvider({
    appId: 'your-app-id',
    accountId: 'your-account-id',
    authToken: 'your-token',
  }),
);

await OpenFeature.setContext({ userId: 'user-123', plan: 'premium' });

const client = OpenFeature.getClient();
const darkMode = client.getBooleanValue('dark-mode', false);

特征

软件包

文档

• API 参考
• OpenFeature 规格
• 实例

发展

pnpm install         # install dependencies
pnpm run dev         # watch mode
pnpm run test        # run tests
pnpm run build       # build for distribution

捐款

欢迎捐款。 请先开出一个问题来讨论你想要改变什么. 见 仓库 更多细节.

许可证

阿帕奇 - 2.0