2029年选举：解决不可能的异常错误

在写完上一篇文章后不久，一位同事联系我，说她找到了问题所在——至少在最直接的层面上，也就是异常本身。排序代码没有问题——只是异常消息太容易被误读了。她说得完全正确，我为此感到懊恼。

以下是异常消息：

1

Incorrect ordering for PredictionSets: mic-01 should occur before focaldata-01

以及创建该异常的代码：

1
2
3
4
5
6
7


string currentText = selector(current);
string nextText = selector(next);
if (StringComparer.Ordinal.Compare(currentText, nextText) >= 0)
{
    throw new InvalidOperationException(
        $"Incorrect ordering for {message}: {currentText} should occur before {nextText}");
}

在我之前的文章中，我声称：

异常消息暗示在异常发生时，currentText 的值是 “focaldata-01”，而 nextText 的值是 “mic-01”。

不，并非如此！它暗示的恰恰相反，即 currentText 的值是 “mic-01”，而 nextText 的值是 “focaldata-01”……换句话说，数据确实有问题。

唉。即使我不断想着“当我的代码行为不当时，几乎总是我的错”，我仍然没能真正退后一步，适当地仔细检查我的逻辑。

但这很奇怪，对吧？因为之前无效的数据（20:15:57）后来神奇地“变成”了有效（20:26:22），对吧？这是我在上一篇文章中声称的。我应该更仔细地查看日志……在 20:22:58 启动了一个新实例。这个新实例正确加载了数据，因此重新加载已经有效的数据是没问题的。

真正的问题是什么？

我在实际修复代码之前就开始写这篇文章，但我现在确信问题在于“部分”重新加载——向数据库添加一个新的预测集，然后从存储系统中重新加载数据，而该系统的缓存中已有现有数据。这应该相对容易测试——

首先，值得修复那条消息。与其谈论“应该出现”什么，不如说明实际情况，并指出集合中出错位置的索引：

1
2
3
4
5
6
7
8
9


foreach (var (index, (current, next)) in source.Zip(source.Skip(1)).Index())
{
    string currentText = selector(current);
    string nextText = selector(next);
    if (StringComparer.Ordinal.Compare(currentText, nextText) >= 0)
    {
        throw new InvalidOperationException($"Incorrect ordering: {message}[{index}]={currentText}; {message}[{index + 1}]={nextText}");
    }
}

接下来，让我们在上传新数据时添加另一层检查：除了从干净状态重新加载两次外，让我们添加一个“前后”重新加载。这方面的代码并不有趣（尽管由于依赖注入的原因，它很繁琐）。然后只需测试添加一个 ID 为 “aaaa” 的“绝对首位”预测集……

太好了，我重现了问题！

1

Incorrect ordering: PredictionSets[4]=name-length; PredictionSets[5]=aaaa

之后，我花了不太长的时间（通过添加更多日志）找到了问题。一旦找到问题，修复起来就非常容易。无需过多不必要的细节，我在合并新旧映射时破坏了我从“哈希到完整数据”的内部映射。

1
2
3


var predictionSetsByHash = newHashes.Concat(currentHashes)
    .Zip(currentPredictionSets.Concat(newPredictionSets))
    .ToOrdinalDictionary(pair => pair.First, pair => pair.Second);

应该改为：

1
2
3


var predictionSetsByHash = newHashes.Concat(currentHashes)
    .Zip(newPredictionSets.Concat(currentPredictionSets))
    .ToOrdinalDictionary(pair => pair.First, pair => pair.Second);

这只有在加载带有新预测集的上下文，并且我们之前已有预测集时才会成为问题。

这就是我的选举网站缺乏许多自动化测试（这些可能必须是集成测试而不是单元测试）的不足之处……尽管公平地说，这是少数几次出现这种情况。

可能是时候开始编写更多测试了——尤其是在这种情况下，这是一个在凌晨重写的完整上下文存储系统。

结论

因此，学到了一些教训：

是的，当我的代码行为不当时，几乎总是我的错。即使我盯着它看，并认为我 somehow 发现了真正奇怪的东西。
我应该编写更多测试。
使异常消息尽可能明确是非常重要的。
我应该总是听 Amanda 的。