Fast-Check 从 3.x 升级到 4.x 迁移指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00260/article/details/148524419

Fast-Check 从 3.x 升级到 4.x 迁移指南

fast-check Property based testing framework for JavaScript (like QuickCheck) written in TypeScript 项目地址: https://gitcode.com/gh_mirrors/fa/fast-check

前言

Fast-Check 是一个强大的基于属性的测试库，它通过生成随机输入来验证代码的正确性。随着 4.x 版本的发布，Fast-Check 引入了一些重大变更，本文将详细介绍如何从 3.x 版本平滑迁移到 4.x 版本。

环境要求变更

在升级到 Fast-Check 4.x 之前，请确保你的开发环境满足以下新要求：

| 名称 | 新要求 | 旧要求 | |--------------------------|--------------|--------| | Node.js | ≥12.17.0 | ≥8 | | ECMAScript 规范 | ES2020 | ES2017 | | TypeScript (可选) | ≥5.0 | ≥4.1 |

这些变更意味着 Fast-Check 4.x 不再支持较旧的 JavaScript 运行时环境，并利用了更新的 ECMAScript 特性。

迁移策略

建议采用两步迁移法：

首先升级到 3.x 的最新版本，处理所有弃用警告
然后再升级到 4.x 版本

这种方法可以最小化升级过程中的破坏性变更影响。

3.x 版本中的主要变更点

1. Date 生成器变更

在 4.x 版本中，date() 生成器默认会生成包括无效日期在内的所有 Date 实例。如果你的代码不能处理无效日期，需要显式配置：

// 旧版本
fc.date();

// 新版本 - 排除无效日期
fc.date({ noInvalidDate: true });

2. Dictionary 和 Record 生成器变更

4.x 版本中，dictionary 和 record 生成器默认可能生成原型为 null 的对象。如果需要保持旧行为：

// 保持对象有正常的原型链
fc.dictionary(fc.string(), fc.string(), {
  noNullPrototype: true
});

fc.record(recordModel, {
  noNullPrototype: true
});

此外，record 生成器的 withDeletedKeys 选项已被移除，改用 requiredKeys：

// 旧版本
fc.record(recordModel, { withDeletedKeys: true });

// 新版本
fc.record(recordModel, { requiredKeys: [] });

3. UUID 生成器增强

4.x 版本支持更多 UUID 版本：

// 旧版本 - 仅支持版本1-5
fc.uuid();

// 新版本 - 显式指定版本范围
fc.uuid({ version: [1, 2, 3, 4, 5] });

4. 字符串生成器重构

4.x 版本对字符串生成器进行了重大重构：

移除了单字符生成器（如 char()），统一使用 string()
合并了 ASCII 和 Unicode 字符串生成器
提供了更灵活的配置方式

迁移示例：

// 旧版本
fc.asciiString();
fc.fullUnicodeString();

// 新版本
fc.string({ unit: 'binary-ascii' });
fc.string({ unit: 'binary' });

5. 方法重构

一些方法被重构为独立的函数：

// 旧版本
myArbitrary.noBias();
myArbitrary.noShrink();

// 新版本
fc.noBias(myArbitrary);
fc.noShrink(myArbitrary);

6. BigInt 生成器简化

移除了专门的 bigInt 生成器，统一使用 bigInt()：

// 旧版本
fc.bigUintN(64);

// 新版本
fc.bigInt({ min: 0n, max: (1n << 64n) - 1n });

4.x 版本的新特性

1. 改进的类型推断

类型推断更加智能：

// 3.x 版本
fc.constant('a');  // Arbitrary<string>
fc.constant<'a'>('a');  // Arbitrary<'a'>

// 4.x 版本
fc.constant('a');  // 自动推断为 Arbitrary<'a'>

2. 更清晰的错误报告

利用错误链改进错误报告：

try {
  await fc.assert(fc.asyncProperty(fc.string(), async (s) => {
    if (s.length > 10) throw new Error('Too long');
  }));
} catch (error) {
  // 4.x 版本中原始错误作为 cause 属性附加
  console.log(error.cause);  // Error: Too long
}

3. 更可靠的调度器

调度器 (scheduler) 实现更加可靠：

const s = fc.scheduler();
s.schedule(Promise.resolve(1)).then(async () => {
  await someOperation();
  s.schedule(Promise.resolve(2));  // 在4.x中更可预测
});
await s.waitAll();  // 行为更加一致