Automerge库中toJS方法返回值异常问题分析

问题背景

在使用Automerge这一用于构建协同应用程序的JavaScript库时，开发者发现了一个关于toJS方法的行为异常。该问题出现在对文档进行修改后，toJS方法未能正确返回修改前的文档状态，而是返回了修改后的最新快照。

问题重现

通过以下代码可以重现该问题：

import * as A from '@automerge/automerge/next';
import _ from 'lodash';

const doc = A.from({
    x: 1
});

const doc1 = A.change(doc, doc => {
    doc.a = 123;
    doc.b = 456;
});

const diff = A.diff(doc1, A.getHeads(doc), A.getHeads(doc1)); // 存在差异
const before = A.toJS(doc); // 预期返回{x:1}，实际返回{x:1,a:123,b:456}
const after = A.toJS(doc1);
console.log(_.isEqual(before, after), before); // 预期false，实际true

问题分析

1. 预期行为：toJS方法应该返回文档在特定状态下的JavaScript对象表示。在上述例子中，对原始文档doc调用toJS应该返回修改前的状态{x:1}。

2. 实际行为：toJS方法返回了修改后的最新状态{x:1,a:123,b:456}，这与文档doc1的状态相同。

3. 根本原因：Automerge库在内部实现上可能存在引用共享问题，导致修改后的文档影响了原始文档的状态表示。

临时解决方案

在官方修复此问题前，开发者可以采用以下两种临时解决方案：

方案一：使用文档克隆

const doc1 = A.change(A.clone(doc), doc => {
    doc.a = 123;
    doc.b = 456;
});

通过显式克隆原始文档，可以确保修改操作不会影响原始文档的状态。

方案二：使用JSON.stringify替代

console.log(JSON.stringify(doc)); // {"x":1}
console.log(JSON.stringify(doc1)); // {"x":1,"a":123,"b":456}

直接使用JSON.stringify方法可以正确序列化文档在不同状态下的内容。

技术影响

这个问题会影响以下场景：

1. 需要获取文档修改前状态的应用程序
2. 依赖toJS方法进行状态比较的功能
3. 需要精确控制文档版本差异的场景

最佳实践建议

1. 在对文档进行修改前，考虑是否需要保留原始状态
2. 对于关键操作，使用文档克隆确保状态隔离
3. 在比较文档状态时，考虑使用JSON.stringify作为替代方案
4. 关注Automerge库的更新，及时应用修复版本

总结

Automerge库中的toJS方法在当前版本存在返回值异常的问题，开发者需要注意这一行为差异。通过使用文档克隆或JSON序列化等替代方案，可以暂时规避此问题。理解这一问题的本质有助于开发者更好地使用Automerge库构建可靠的协同应用程序。