Skip to content

Circular 引用 in Snapshot

错误信息

                TypeError: Converting circular 结构到 JSON in snapshot
              

快速摘要

对象通过到 toMatchSnapshot() 有 circular 引用 (对象那个引用它自己), 哪个能't 是 serialized.

为什么发生

  • 对象属性点 后面到 对象它自己 or parent.

  • DOM 节点使用 parent/child 引用是 是 snapshotted.

  • 类实例使用 circular 内部引用.

  • React 组件实例使用 fiber 节点引用.

最小示例

✗ 错误代码
test('snapshot', () => {
  const obj = { a: 1 };
  obj.self = obj; // circular reference
  expect(obj).toMatchSnapshot(); // fails — circular
});
✓ 修复代码
test('snapshot', () => {
  const obj = { a: 1 };
  obj.self = obj;
  const { a } = obj; // extract serializable part
  expect({ a }).toMatchSnapshot(); // works
});

Extract 仅 serializable 部分的 对象之前 snapshotting.

如何诊断

  • 检查如果对象是 snapshotted 有 circular 引用.

  • Use console.log(util.inspect(obj, { 深度: 空 })) 到 see 结构.

  • 检查如果你're snapshotting DOM 节点 or React 实例相反的 serializable 数据.

如何修复

  • Snapshot 仅 serializable 部分: expect(obj.serializablePart).toMatchSnapshot().

  • Use JSON.stringify 使用 replacer 函数到 break circular 引用.

  • For DOM 组件, snapshot 容器.innerHTML 相反的 容器对象.

  • 移除 or break circular 引用之前 snapshotting.

如何预防

  • 仅 snapshot serializable 数据 (plain 对象, 数组, 字符串).

  • Avoid snapshotting DOM 节点, 类实例, or 对象使用 circular refs.

  • Extract relevant 数据到 plain 对象之前 snapshotting.

相关资源

相关术语

相关课程

← 返回语言