@fluidframework/test-client-utils

中文文档
1.4.0发布于 2024/04/10MITTypeScriptESM + CJS近 30 天下载 2.4万

流体客户端开发和测试公用事业

中文使用文档
文档目录5 节
  1. 不安全的托肯保护者
  2. 利用当地微小实例促进发展
  3. 使用Azure Fluid中继服务促进发展
  4. 生成测试用户
  5. 使用量

@ fluidframework/test-client-utils (英语)

在开发和测试使用特定服务客户(即:. AzureClient, (中文(简体) ), TinyliciousClient由流体框架提供.

不安全的托肯保护者

这个 InsecureTokenProvider 为本地生成的 JWT 令牌提供类,使用租户密钥签名,可以发送到流体服务. 这些令牌将用来认证和识别哪个用户正在从客户端发送操作.

它需要两个参数:

  • tenantKey - 用来签名 与符号使用 tenantId 我们试图连接到服务
  • user - 用来在目前编辑容器的观众中充斥当前用户的细节

这个 AzureClient从 @fluidframework/azure-client 软件包,以 tokenProvider 参数作为其构建器的一部分。 此参数可通过使用 InsecureTokenProvider 此处导出。 然而,建议它只用于开发或测试目的,因为它有可能暴露您的Azure Fluid Relay服务租户在客户端代码上的密钥.

利用当地微小实例促进发展

使用时 AzureClient,您可以配置它来对抗本地的微小实例。 请看客户的 关于地方发展的文件 关于如何这样做的更多信息。 在这种情况下 InsecureTokenProvider 将取任何值 tenantKey 参数,因为我们正在工作 一个本地的微小实例 不需要任何认证。 因此,我们可以创建这样的例子:

const tokenProvider = new InsecureTokenProvider("fooBar", { id: "123", name: "Test User" });

使用Azure Fluid中继服务促进发展

这个 AzureClient 也可以配置到所部署的 Azure Fluid 中继服务实例,如描述 这里。现在,配置正在使用真实的 tenantId 编辑 InsecureTokenProvider 需要匹配 tenantKey 服务期间提供的服务.

const tokenProvider = new InsecureTokenProvider("YOUR-TENANT-KEY-HERE", { id: "123", name: "Test User" });

同样,这只应用于本地开发,因为客户端代码中包含租户密钥有可能导致恶意用户从客户端的捆绑中嗅出. 请考虑使用 AzureFunction Token 创建器 或实现 ITokenProvider 接口作为生产情景的替代品.

生成测试用户

生成测试用户的简单函数 。 用于与 InsecureTokenProvider。响应对象将是 { id: string, name: string}。 。 。 . id 将是一个uid和 name 将是一个随机生成的友好的先名和由空格分隔的后名.

使用量

const tokenProvider = new InsecureTokenProvider("YOUR-TENANT-KEY-HERE", generateTestUser());

版本与发布记录

@fluidframework/test-client-utils 共发布 247 个版本,首次发布于 2021/09/21;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.4.0latest2024/04/102 年前
2.0.0-internal.4.3.2canary2023/09/123 年前
1.3.72023/09/013 年前
2.0.0-internal.5.4.22023/08/203 年前
2.0.0-internal.5.3.42023/08/083 年前
2.0.0-internal.5.4.02023/08/043 年前

其他发布通道:next → 2.0.0-dev.5.2.0.169897,canary → 2.0.0-internal.4.3.2。

关于 @fluidframework/test-client-utils 的常见问题

@fluidframework/test-client-utils 是什么?

流体客户端开发和测试公用事业

如何安装 @fluidframework/test-client-utils?

在项目目录运行 npm install @fluidframework/test-client-utils,或使用 pnpm add / yarn add / bun add。

@fluidframework/test-client-utils 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@fluidframework/test-client-utils 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@fluidframework/test-client-utils 可以商用吗?

@fluidframework/test-client-utils 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@fluidframework/test-client-utils 的下载量有多少?

根据 npm 官方下载统计,@fluidframework/test-client-utils 在 2026/10/15 – 2026/11/13 这 30 天内被下载 24,492 次,日均约 816 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@fluidframework/test-client-utils 还在维护吗?

最新版本 1.4.0 发布于 2024/04/10(2 年前);至今共发布 247 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/09/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。