RavenDb：在单元测试时强制索引等到不陈旧

Question

在使用 RavenDb 进行单元测试时，通常会检索或以其他方式处理新添加的数据。这可能导致“过时索引”异常，例如

Bulk operation cancelled because the index is stale and allowStale is false

根据一些答案

• How should stale indexes be handled during testing?
• WaitForNonStaleResults per DocumentStore
• RavenDb : Update a Denormalized Reference property value

在处理查询或批处理操作之前强制数据库（IDocumentStore 实例）等到其索引不陈旧的方法是在IDocumentStore 初始化期间使用DefaultQueryingConsistency = ConsistencyOptions.QueryYourWrites，如下所示：

public class InMemoryRavenSessionProvider : IRavenSessionProvider
{
    private static IDocumentStore documentStore;

    public static IDocumentStore DocumentStore
    {
        get { return (documentStore ?? (documentStore = CreateDocumentStore())); }
    }

    private static IDocumentStore CreateDocumentStore()
    {
        var store = new EmbeddableDocumentStore
        {
            RunInMemory = true,
            Conventions = new DocumentConvention
            {
                DefaultQueryingConsistency = ConsistencyOptions.QueryYourWrites,
                IdentityPartsSeparator = "-"
            }
        };
        store.Initialize();
        IndexCreation.CreateIndexes(typeof (RavenIndexes).Assembly, store);
        return store;
    }

    public IDocumentSession GetSession()
    {
        return DocumentStore.OpenSession();
    }
}

很遗憾，上面的代码不起作用。我仍然收到有关过时索引的例外情况。这些可以通过放入包含.Customize(x => x.WaitForNonStaleResultsAsOfLastWrite()) 的虚拟查询来解决。

这很好，只要这些可以包含在单元测试中，但是如果它们不能包含呢？我发现这些 WaitForNonStaleResults* 调用正在悄悄进入生产代码，这样我就可以让单元测试通过。

那么，有没有一种可靠的方法，使用最新版本的 RavenDb，在允许处理命令之前强制索引更新 - 仅用于单元测试的目的？

编辑 1

这是基于下面给出的答案的解决方案，该解决方案强制等待索引不陈旧。为了单元测试的方便，我把它写成一个扩展方法；

public static class IDocumentSessionExt
{
    public static void ClearStaleIndexes(this IDocumentSession db)
    {
        while (db.Advanced.DatabaseCommands.GetStatistics().StaleIndexes.Length != 0)
        {
            Thread.Sleep(10);
        }
    }
}

这是一个单元测试，它使用了详细的WaitForNonStaleResultsAsOfLastWrite 技术，但现在使用了更简洁的扩展方法。

[Fact]
public void Should_return_list_of_Relationships_for_given_mentor()
{
    using (var db = Fake.Db())
    {
        var mentorId = Fake.Mentor(db).Id;
        Fake.Relationship(db, mentorId, Fake.Mentee(db).Id);
        Fake.Relationship(db, mentorId, Fake.Mentee(db).Id);
        Fake.Relationship(db, Fake.Mentor(db).Id, Fake.Mentee(db).Id);

        //db.Query<Relationship>()
        //  .Customize(x => x.WaitForNonStaleResultsAsOfLastWrite())
        //  .Count()
        //  .ShouldBe(3);

        db.ClearStaleIndexes();
        db.Query<Relationship>().Count().ShouldBe(3);
        MentorService.GetRelationships(db, mentorId).Count.ShouldBe(2);
    }
}

Answer 1

如果您有 Map/Reduce 索引，DefaultQueryingConsistency = ConsistencyOptions.QueryYourWrites 将不起作用。您需要使用其他方法。

在您的单元测试中，在您插入任何数据后立即调用这样的代码，这将强制 所有 索引在您执行任何其他操作之前更新：

while (documentStore.DatabaseCommands.GetStatistics().StaleIndexes.Length != 0)
{
    Thread.Sleep(10);
}

更新如果您愿意，当然可以将其放入扩展方法中：

public static class IDocumentSessionExt
{
    public static void ClearStaleIndexes(this IDocumentSession db)
    {
        while (db.Advanced.DatabaseCommands.GetStatistics().StaleIndexes.Length != 0)
        {
            Thread.Sleep(10);
        }
    }
}

那么你可以说：

db.ClearStaleIndexes();

Answer 2

您实际上可以在 DocumentStore 上添加一个查询侦听器来等待非陈旧的结果。这可以仅用于单元测试，因为它在文档存储中，而不是每个操作。

// Initialise the Store.
var documentStore = new EmbeddableDocumentStore
                {
                    RunInMemory = true
                };
documentStore.Initialize();

// Force queries to wait for indexes to catch up. Unit Testing only :P
documentStore.RegisterListener(new NoStaleQueriesListener());

....


#region Nested type: NoStaleQueriesListener

public class NoStaleQueriesListener : IDocumentQueryListener
{
    #region Implementation of IDocumentQueryListener

    public void BeforeQueryExecuted(IDocumentQueryCustomization queryCustomization)
    {
        queryCustomization.WaitForNonStaleResults();
    }

    #endregion
}

#endregion

（无耻从RavenDB how to flush?盗取）

Answer 3

请注意，StaleIndexes 还包括废弃和禁用的索引 - 它们永远不会更新。

所以为了避免无限等待，请改用这个属性：

 var staleIndices = store.DatabaseCommands.GetStatistics().CountOfStaleIndexesExcludingDisabledAndAbandoned;