ChangeLog

2017-02-11  Simon Fraser  <simon.fraser@apple.com>

        Add support for history.scrollRestoration

        https://bugs.webkit.org/show_bug.cgi?id=147782

        rdar://problem/22614568

        Reviewed by NOBODY (OOPS!).

        Add Mac support for history.scrollRestoration, per spec:

        <https://html.spec.whatwg.org/multipage/browsers.html#dom-history-scroll-restoration>

        This is a new attribute on the History interface. On setting, sets the "shouldRestoreScrollPosition"

        state on the current history item, and the getter returns that state. pushState() inherits the

        state from the current item.

        HistoryController::restoreScrollPositionAndViewState() consults this state, and if set to "manual"

        ("don't restore) it just uses the current scroll position (we need something to pass to

        setPageScaleFactor() so can't just avoid the restoration).

        FrameLoader::scrollToFragmentWithParentBoundary() also needs to consult the historyItem

        to know if it's OK to scroll to a fragment, on back/forward same-document loads.

        Tests: fast/history/history-scroll-restoration-attribute.html

               fast/history/history-scroll-restoration.html

        * history/HistoryItem.cpp:

        (WebCore::HistoryItem::HistoryItem):

        (WebCore::HistoryItem::shouldRestoreScrollPosition):

        (WebCore::HistoryItem::setShouldRestoreScrollPosition):

        * history/HistoryItem.h:

        * loader/FrameLoader.cpp:

        (WebCore::FrameLoader::loadInSameDocument):

        (WebCore::itemAllowsScrollRestoration):

        (WebCore::isNavigationOtherThanBackForward):

        (WebCore::FrameLoader::scrollToFragmentWithParentBoundary):

        (WebCore::FrameLoader::continueLoadAfterNavigationPolicy):

        * loader/FrameLoader.h:

        * loader/HistoryController.cpp:

        (WebCore::HistoryController::restoreScrollPositionAndViewState):

        (WebCore::HistoryController::pushState):

        (WebCore::HistoryController::replaceState):

        * page/History.cpp:

        (WebCore::History::scrollRestoration):

        (WebCore::History::setScrollRestoration):

        * page/History.h:

        * page/History.idl:

2017-02-11  Olivier Blin  <olivier.blin@softathome.com>

        [GStreamer][MSE][EME] Fix decryptor assignment

Source/WebCore/history/HistoryItem.cpp

@@static void defaultNotifyHistoryItemChanged(HistoryItem*)

WEBCORE_EXPORT void (*notifyHistoryItemChanged)(HistoryItem*) = defaultNotifyHistoryItemChanged;

HistoryItem::HistoryItem()

    : m_pageScaleFactor(0)

    , m_lastVisitWasFailure(false)

    , m_isTargetItem(false)

    , m_itemSequenceNumber(generateSequenceNumber())

59 : m_itemSequenceNumber(generateSequenceNumber())

    , m_documentSequenceNumber(generateSequenceNumber())

    , m_pruningReason(PruningReason::None)

{

@@HistoryItem::HistoryItem(const String& urlString, const String& title)

    : m_urlString(urlString)

    , m_originalURLString(urlString)

    , m_title(title)

    , m_pageScaleFactor(0)

    , m_lastVisitWasFailure(false)

    , m_isTargetItem(false)

    , m_itemSequenceNumber(generateSequenceNumber())

    , m_documentSequenceNumber(generateSequenceNumber())

    , m_pruningReason(PruningReason::None)

@@HistoryItem::HistoryItem(const String& urlString, const String& title, const Str

    , m_title(title)

    , m_displayTitle(alternateTitle)

    , m_pageScaleFactor(0)

88 , m_lastVisitWasFailure(false)

89 , m_isTargetItem(false)

    , m_itemSequenceNumber(generateSequenceNumber())

    , m_documentSequenceNumber(generateSequenceNumber())

    , m_pruningReason(PruningReason::None)

@@void HistoryItem::clearScrollPosition()

    m_scrollPosition = IntPoint();

}

bool HistoryItem::shouldRestoreScrollPosition() const

{

    return m_shouldRestoreScrollPosition;

}

void HistoryItem::setShouldRestoreScrollPosition(bool shouldRestore)

{

    m_shouldRestoreScrollPosition = shouldRestore;

}

float HistoryItem::pageScaleFactor() const

{

    return m_pageScaleFactor;

Source/WebCore/history/HistoryItem.h

@@public:

    WEBCORE_EXPORT const IntPoint& scrollPosition() const;

    WEBCORE_EXPORT void setScrollPosition(const IntPoint&);

    void clearScrollPosition();

    WEBCORE_EXPORT bool shouldRestoreScrollPosition() const;

    WEBCORE_EXPORT void setShouldRestoreScrollPosition(bool);

    
    WEBCORE_EXPORT float pageScaleFactor() const;

    WEBCORE_EXPORT void setPageScaleFactor(float);

@@private:

    String m_displayTitle;

    IntPoint m_scrollPosition;

218 float m_pageScaleFactor;

221 float m_pageScaleFactor { 0 }; // 0 indicates "unset".

    Vector<String> m_documentState;

    ShouldOpenExternalURLsPolicy m_shouldOpenExternalURLsPolicy { ShouldOpenExternalURLsPolicy::ShouldNotAllow };

    Vector<Ref<HistoryItem>> m_children;

225 bool m_lastVisitWasFailure;

226 bool m_isTargetItem;

228 bool m_lastVisitWasFailure { false };

229 bool m_isTargetItem { false };

227230 bool m_wasRestoredFromSession { false };

231 bool m_shouldRestoreScrollPosition { true };

    // If two HistoryItems have the same item sequence number, then they are

    // clones of one another.  Traversing history from one such HistoryItem to

Source/WebCore/loader/FrameLoader.cpp

@@void FrameLoader::loadInSameDocument(const URL& url, SerializedScriptValue* stat

    // We need to scroll to the fragment whether or not a hash change occurred, since

    // the user might have scrolled since the previous navigation.

1054 scrollToFragmentWithParentBoundary(url);

1054 scrollToFragmentWithParentBoundary(url, isNewNavigation);

    
    m_isComplete = false;

    checkCompleted();

@@bool FrameLoader::shouldPerformFragmentNavigation(bool isFormSubmission, const S

        && !m_frame.document()->isFrameSet();

}

2862 void FrameLoader::scrollToFragmentWithParentBoundary(const URL& url)

static bool itemAllowsScrollRestoration(HistoryItem *historyItem)

{

    return historyItem && historyItem->shouldRestoreScrollPosition();

}

static bool isNavigationOtherThanBackForward(bool isNewNavigation, FrameLoadType loadType)

{

    return isNewNavigation || !isBackForwardLoadType(loadType);

}

void FrameLoader::scrollToFragmentWithParentBoundary(const URL& url, bool isNewNavigation)

{

    FrameView* view = m_frame.view();

    if (!view)

@@void FrameLoader::scrollToFragmentWithParentBoundary(const URL& url)

    if (boundaryFrame)

        boundaryFrame->view()->setSafeToPropagateScrollToParent(false);

2874 view->scrollToFragment(url);

2884 if (isNavigationOtherThanBackForward(isNewNavigation, m_loadType) || itemAllowsScrollRestoration(m_frame.mainFrame().loader().history().currentItem()))

2885 view->scrollToFragment(url);

    if (boundaryFrame)

        boundaryFrame->view()->setSafeToPropagateScrollToParent(true);

@@void FrameLoader::continueLoadAfterNavigationPolicy(const ResourceRequest& reque

        setPolicyDocumentLoader(nullptr);

        // If the navigation request came from the back/forward menu, and we punt on it, we have the

3065 // problem that we have optimistically moved the b/f cursor already, so move it back. For sanity,

3076 // problem that we have optimistically moved the b/f cursor already, so move it back. For sanity,

        // we only do this when punting a navigation for the target frame or top-level frame.  

        if ((isTargetItem || m_frame.isMainFrame()) && isBackForwardLoadType(policyChecker().loadType())) {

            if (Page* page = m_frame.page()) {

Source/WebCore/loader/FrameLoader.h

@@private:

    void continueFragmentScrollAfterNavigationPolicy(const ResourceRequest&, bool shouldContinue);

    bool shouldPerformFragmentNavigation(bool isFormSubmission, const String& httpMethod, FrameLoadType, const URL&);

337 void scrollToFragmentWithParentBoundary(const URL&);

337 void scrollToFragmentWithParentBoundary(const URL&, bool isNewNavigation = true);

    void checkLoadCompleteForThisFrame();

Source/WebCore/loader/HistoryController.cpp

@@void HistoryController::restoreScrollPositionAndViewState()

    // Don't restore scroll point on iOS as FrameLoaderClient::restoreViewState() does that.

    if (view && !view->wasScrolledByUser()) {

        Page* page = m_frame.page();

161 auto desiredScrollPosition = m_currentItem->scrollPosition();

162

161 auto desiredScrollPosition = m_currentItem->shouldRestoreScrollPosition() ? m_currentItem->scrollPosition() : view->scrollPosition();

        if (page && m_frame.isMainFrame() && m_currentItem->pageScaleFactor())

            page->setPageScaleFactor(m_currentItem->pageScaleFactor() * page->viewScaleFactor(), desiredScrollPosition);

        else

@@void HistoryController::pushState(RefPtr<SerializedScriptValue>&& stateObject, c

    Page* page = m_frame.page();

    ASSERT(page);

855 bool shouldRestoreScrollPosition = m_currentItem->shouldRestoreScrollPosition();

856

    // Get a HistoryItem tree for the current frame tree.

    Ref<HistoryItem> topItem = m_frame.mainFrame().loader().history().createItemTree(m_frame, false);

@@void HistoryController::pushState(RefPtr<SerializedScriptValue>&& stateObject, c

    m_currentItem->setTitle(title);

    m_currentItem->setStateObject(WTFMove(stateObject));

    m_currentItem->setURLString(urlString);

865 m_currentItem->setShouldRestoreScrollPosition(shouldRestoreScrollPosition);

864866

865 LOG(History, "HistoryController %p pushState: Adding top item %p, setting url of current item %p to %s", this, topItem.ptr(), m_currentItem.get(), urlString.ascii().data());

867 LOG(History, "HistoryController %p pushState: Adding top item %p, setting url of current item %p to %s, scrollRestoration is %s", this, topItem.ptr(), m_currentItem.get(), urlString.ascii().data(), topItem->shouldRestoreScrollPosition() ? "auto" : "manual");

    page->backForward().addItem(WTFMove(topItem));

@@void HistoryController::replaceState(RefPtr<SerializedScriptValue>&& stateObject

    if (!m_currentItem)

        return;

881 LOG(History, "HistoryController %p replaceState: Setting url of current item %p to %s", this, m_currentItem.get(), urlString.ascii().data());

883 LOG(History, "HistoryController %p replaceState: Setting url of current item %p to %s scrollRestoration %s", this, m_currentItem.get(), urlString.ascii().data(), m_currentItem->shouldRestoreScrollPosition() ? "auto" : "manual");

    if (!urlString.isEmpty())

        m_currentItem->setURLString(urlString);

Source/WebCore/page/History.cpp

@@unsigned History::length() const

    return page->backForward().count();

}

ExceptionOr<History::ScrollRestoration> History::scrollRestoration() const

{

    auto* historyItem = m_frame->loader().history().currentItem();

    if (!historyItem)

        return ScrollRestoration::Auto;

    return historyItem->shouldRestoreScrollPosition() ? ScrollRestoration::Auto : ScrollRestoration::Manual;

}

ExceptionOr<void> History::setScrollRestoration(ScrollRestoration scrollRestoration)

{

    auto* historyItem = m_frame->loader().history().currentItem();

    if (historyItem)

        historyItem->setShouldRestoreScrollPosition(scrollRestoration == ScrollRestoration::Auto);

    return { };

}

SerializedScriptValue* History::state()

{

    m_lastStateObjectRequested = stateInternal();

Source/WebCore/page/History.h

@@public:

    static Ref<History> create(Frame& frame) { return adoptRef(*new History(frame)); }

    unsigned length() const;

    
    enum class ScrollRestoration {

        Auto,

        Manual

    };

    ExceptionOr<ScrollRestoration> scrollRestoration() const;

    ExceptionOr<void> setScrollRestoration(ScrollRestoration);

    SerializedScriptValue* state();

    void back();

    void forward();

Source/WebCore/page/History.idl

    GenerateIsReachable=ImplFrame,

] interface History {

    readonly attribute unsigned long length;

30 [SetterMayThrowException, GetterMayThrowException] attribute ScrollRestoration scrollRestoration;

    [CachedAttribute, Custom] readonly attribute SerializedScriptValue state;

    [CallWith=Document, ForwardDeclareInHeader] void back();

    [Custom, MayThrowException] void pushState(any data, DOMString title, optional USVString? url = null);

    [Custom, MayThrowException] void replaceState(any data, DOMString title, optional USVString? url = null);

};

40

41enum ScrollRestoration { "auto", "manual" };

LayoutTests/ChangeLog

2017-02-11  Simon Fraser  <simon.fraser@apple.com>

        Add support for history.scrollRestoration

        https://bugs.webkit.org/show_bug.cgi?id=147782

        rdar://problem/22614568

        Reviewed by NOBODY (OOPS!).

        * fast/dom/Window/window-appendages-cleared-expected.txt:

        * fast/history/history-scroll-restoration-attribute-expected.txt: Added.

        * fast/history/history-scroll-restoration-attribute.html: Added.

        * fast/history/history-scroll-restoration-expected.txt: Added.

        * fast/history/history-scroll-restoration.html: Added.

2017-02-11  Andreas Kling  <akling@apple.com>

        LayoutTest fast/scrolling/page-cache-back-overflow-scroll-restore.html is a flaky failure

LayoutTests/imported/w3c/ChangeLog

2017-02-11  Simon Fraser  <simon.fraser@apple.com>

        Add support for history.scrollRestoration

        https://bugs.webkit.org/show_bug.cgi?id=147782

        rdar://problem/22614568

        Reviewed by NOBODY (OOPS!).

        New passing baselines.

        * web-platform-tests/html/browsers/browsing-the-web/history-traversal/persisted-user-state-restoration/scroll-restoration-basic-expected.txt:

        * web-platform-tests/html/browsers/browsing-the-web/history-traversal/persisted-user-state-restoration/scroll-restoration-fragment-scrolling-cross-origin-expected.txt:

        * web-platform-tests/html/browsers/browsing-the-web/history-traversal/persisted-user-state-restoration/scroll-restoration-navigation-cross-origin-expected.txt:

        * web-platform-tests/html/browsers/browsing-the-web/history-traversal/persisted-user-state-restoration/scroll-restoration-navigation-samedoc-expected.txt:

2017-02-11  Chris Dumez  <cdumez@apple.com>

        Implement URL's toJSON()

LayoutTests/fast/dom/Window/window-appendages-cleared-expected.txt

@@PASS history.go == "LEFTOVER" is false

PASS history.length == "LEFTOVER" is false

PASS history.pushState == "LEFTOVER" is false

PASS history.replaceState == "LEFTOVER" is false

7PASS history.scrollRestoration == "LEFTOVER" is false

PASS history.state == "LEFTOVER" is false

PASS location.ancestorOrigins == "LEFTOVER" is false

PASS location.assign == "LEFTOVER" is false

LayoutTests/fast/history/history-scroll-restoration-attribute-expected.txt

Tests the history.scrollRestoration attribute

On success, you will see a series of "PASS" messages, followed by "TEST COMPLETE".

PASS 'scrollRestoration' in history is true

PASS history.scrollRestoration is "auto"

PASS history.scrollRestoration is "manual"

PASS history.scrollRestoration is "manual"

PASS history.scrollRestoration is "auto"

PASS successfullyParsed is true

TEST COMPLETE

LayoutTests/fast/history/history-scroll-restoration-attribute.html

<html>

<head>

<script src="../../resources/js-test-pre.js"></script>

</head>

<body>

<script>

    description("Tests the history.scrollRestoration attribute");

    if (window.testRunner)

        testRunner.clearBackForwardList();

    shouldBeTrue("'scrollRestoration' in history");

    history.scrollRestoration = 'auto';

    shouldBeEqualToString('history.scrollRestoration', 'auto');

    history.scrollRestoration = 'manual';

    shouldBeEqualToString('history.scrollRestoration', 'manual');

    history.scrollRestoration = 'bananas';

    shouldBeEqualToString('history.scrollRestoration', 'manual');

    history.scrollRestoration = 'auto';

    shouldBeEqualToString('history.scrollRestoration', 'auto');

</script>

<script src="../../resources/js-test-post.js"></script>

</body>

</html>

LayoutTests/fast/history/history-scroll-restoration-expected.txt

Tests that history.scrollRestoration works for same-document navigations

On success, you will see a series of "PASS" messages, followed by "TEST COMPLETE".

PASS 'scrollRestoration' in history is true

PASS history.scrollRestoration is "auto"

PASS window.scrollX is 123

PASS window.scrollY is 456

PASS history.scrollRestoration is "manual"

PASS window.scrollX is 333

PASS window.scrollY is 555

PASS successfullyParsed is true

TEST COMPLETE

LayoutTests/fast/history/history-scroll-restoration.html

<html>

<head>

<script src="../../resources/js-test-pre.js"></script>

<style>

    body {

        height: 2000px;

        width: 2000px;

    }

</style>

</head>

<body>

<script>

    var jsTestIsAsync = true;

    description("Tests that history.scrollRestoration works for same-document navigations");

    if (window.testRunner)

        testRunner.clearBackForwardList();

    shouldBeTrue("'scrollRestoration' in history");

    // Can't create history entries inside the onload handler.

    window.setTimeout(testAutoScrollRestoration, 0);

    function testAutoScrollRestoration()

    {

        history.scrollRestoration = 'auto';

        shouldBeEqualToString('history.scrollRestoration', 'auto');

        window.scrollTo(123, 456);

        history.pushState(null, '', '#1');

        window.scrollTo(0, 0);

        history.back();

        window.setTimeout(function() {

            shouldBe('window.scrollX', '123');

            shouldBe('window.scrollY', '456');

            testManualScrollRestoration();

        }, 0);

    }

    function testManualScrollRestoration()

    {

        history.scrollRestoration = 'manual';

        shouldBeEqualToString('history.scrollRestoration', 'manual');

        window.scrollTo(123, 456);

        history.pushState(null, '', '#2');

        window.scrollTo(333, 555);

        history.back();

        window.setTimeout(function() {

            shouldBe('window.scrollX', '333');

            shouldBe('window.scrollY', '555');

            window.scrollTo(0, 0);

            finishJSTest();

        }, 0);

    }

</script>

<script src="../../resources/js-test-post.js"></script>

</body>

</html>

LayoutTests/imported/w3c/web-platform-tests/html/browsers/browsing-the-web/history-traversal/persisted-user-state-restoration/scroll-restoration-basic-expected.txt

11

2 F~~AIL~~ Default value is "auto" ~~assert_equals: expected (string) "auto" but got (undefined) undefined~~

2PASS Default value is "auto"

33PASS It is writable

4 F~~AIL~~ Invalid values are ignored ~~assert_equals: setting to invalid value (3.1415) should be ignored expected (string) "auto" but got (number) 3.1415~~

4PASS Invalid values are ignored

55

LayoutTests/imported/w3c/web-platform-tests/html/browsers/browsing-the-web/history-traversal/persisted-user-state-restoration/scroll-restoration-fragment-scrolling-cross-origin-expected.txt

11Blocked access to external URL http://www.localhost:8800/html/browsers/browsing-the-web/history-traversal/persisted-user-state-restoration/resources/blank1.html

2 CONSOLE MESSAGE: line 2451: Error: assert_equals: navigating back should retain scrollRestoration value expected (string) "manual" but got (undefined) undefined

32

43

Harness Error (TIMEOUT), message = null

TIMEOUT Manual scroll restoration should take precedent over scrolling to fragment in cross origin navigation Test timed out

4PASS Manual scroll restoration should take precedent over scrolling to fragment in cross origin navigation

85

LayoutTests/imported/w3c/web-platform-tests/html/browsers/browsing-the-web/history-traversal/persisted-user-state-restoration/scroll-restoration-navigation-cross-origin-expected.txt

11

22

3 F~~AIL~~ Navigating to new page should reset to "auto" and navigating back should restore and respect scroll restoration mode ~~assert_equals: new page loads should set scrollRestoration to "auto" expected (string) "auto" but got (undefined) undefined~~

3PASS Navigating to new page should reset to "auto" and navigating back should restore and respect scroll restoration mode

44

LayoutTests/imported/w3c/web-platform-tests/html/browsers/browsing-the-web/history-traversal/persisted-user-state-restoration/scroll-restoration-navigation-samedoc-expected.txt

11

2 F~~AIL~~ history.{push,replace}State retain scroll restoration mode and navigation in the same document respects it ~~assert_equals: scrollX is correct for #4 expected 555 but got 200~~

2PASS history.{push,replace}State retain scroll restoration mode and navigation in the same document respects it

33