Проблемы с отложенной итерацией возврата доходности

На самом деле это не ответ... скорее предложение альтернативной реализации, исключающей рекурсию. Слишком долго, чтобы опубликовать в качестве комментария.

    public IEnumerable<IPageNode> ancestorsOf(IPageNode pageNode) {
        if(pageNode == null) throw new ArgumentNullException(("pageNode"));
        Stack<IPageNode> stack = new Stack<IPageNode>();
        stack.Push(pageNode);
        while(stack.Any())
        {
            IPageNode n=stack.Pop();
            if (n.url != pageNodeService.rootUrl) {
                yield return n;
                if(n.parent != null)
                {
                    stack.Push(n.parent);
                }
            }
        }
    }

Подумав об этом, вы могли бы вообще удалить стек:

public IEnumerable<IPageNode> ancestorsOf(IPageNode pageNode) {
    if(pageNode == null) throw new ArgumentNullException(("pageNode"));
    IPageNode n = pageNode;
    while(n != null && n.url != pageNodeService.rootUrl)
    {
        yield return n;
        n = n.parent;
    }
}

Я не знаю, где ваша ошибка, и StackOverflow — это не сервис для отладки вашего кода; Я бы решил вашу проблему, запустив ее в отладчике и найдя ошибку.

Однако я воспользуюсь этой возможностью, чтобы указать, что это:

public IEnumerable<IPageNode> AncestorsOf(IPageNode pageNode) {
    if(pageNode == null) throw new ArgumentNullException(("pageNode"));
    // Do stuff that yields 

немного проблематичен, потому что ни один код в блоке не запускается, пока MoveNext не будет вызван в первый раз. Другими словами, если вы делаете:

var seq = AncestorsOf(null); // Not thrown here!
using (var enumtor = seq.GetEnumerator())
{
    bool more = enumtor.MoveNext(); // Exception is thrown here!

что очень удивляет людей. Вместо этого напишите свой код следующим образом:

public IEnumerable<IPageNode> AncestorsOf(IPageNode pageNode) {
    if(pageNode == null) throw new ArgumentNullException(("pageNode"));
    return AncestorsOfIterator(pageNode);
}
private IEnumerable<IPageNode> AncestorsOfIterator(IPageNode pageNode)
{
    Debug.Assert(pageNode != null);
    // Do stuff that yields 
}

Имеет ли вообще смысл использовать yield в этом месте, поскольку при вызове Reverse все вещи должны быть все равно буферизуется, так что вместо этого вы можете просто вернуть полный список предков.

Добавьте начальный узел вне этого итератора, если вам это нужно.

public class PageNodeIterator {
    //properties and constructor left out for brevity

    public IEnumerable<IPageNode> ancestorsOf(IPageNode pageNode) {
        if(pageNode == null) throw new ArgumentNullException(("pageNode"));

        if (pageNode.url != pageNodeService.rootUrl)
        {
            if (pageNode.parent != null ) 
            {
                yield return pageNode.parent;
                yield return ancestorsOf(pageNode.parent);
            }
        }
    }
}