Jsdom: Browser history pushState/onpopstate/window.location not well managed

Created on 17 Jul 2016 · 4Comments · Source: jsdom/jsdom

Hello,

I would say history management is not complete.
This test on my side fails with jsdom version 9.4.1:

    describe('jsdom history management', () => {
        before(() => {
        // Init DOM with a fake document
        // <base> and uri (initial uri) allow to do pushState in jsdom
            jsdom.env({
                html: `
                 <html>
                     <head>
                         <base href="http://localhost:8080/"></base>
                     </head>
                  </html>
                `,
                url: 'http://localhost:8080/',
                done(err, window) {
                    global.window = window;
                    global.document = window.document;
                    window.console = global.console;
                }
            });
        });

        it('location not updated', () => {
            window.history.pushState({}, 'route1', '/route1');
            assert(window.location.pathname === '/route1'); // this test is OK
            window.history.back();
            assert(window.location.pathname === '/'); // this test fails pathname still with value '/route1'
        });

        it('onpopstate not called', () => {
            window.onpopstate = () => { };
            const spy_onpopstate = sinon.spy(window, 'onpopstate');
            window.history.pushState({}, 'route1', '/route1');
            window.history.back();
            window.history.forward();
            assert(spy_onpopstate.called);// this test fails as well
        });
    });

Source

camelaissani

👍9

Most helpful comment

A work around, for anyone who finds this post and looking to get tests working, is using Sinon spy and mocking the history.pushState or history.replaceState methods.

crobinson42 on 28 Apr 2017

👍7

All 4 comments

Yes. jsdom does not in general support navigation yet, since that involves creating an entirely new window object. This is a hard long-term problem we haven't begun to think about addressing.

domenic on 17 Jul 2016

A work around, for anyone who finds this post and looking to get tests working, is using Sinon spy and mocking the history.pushState or history.replaceState methods.

crobinson42 on 28 Apr 2017

👍7

@crobinson42 not sure if i get you, but would mocking help with the window.onpopstate as well ?

gaurav5430 on 18 Dec 2017

Here is the workaround I use (TypeScript):

function firePopstateOnRoute(window: DOMWindow): void {
  const { history } = window;
  const originalBack = history.back;
  const originalForwards = history.forward;

  (history as unknown as {__proto__: History})['__proto__'].back = function patchedBack(this: History, ...args: Parameters<History['back']>): void {
    originalBack.apply(this, args);

    window.dispatchEvent(new PopStateEvent('popstate'));
  };

  (history as unknown as {__proto__: History}).__proto__.forward = function patchedForward(this: History, ...args: Parameters<History['forward']>): void {
    originalForwards.apply(this, args);

    window.dispatchEvent(new PopStateEvent('popstate'));
  };
}

export function mockBrowser(): void {
  const jsdom = new JSDOM('');
  const { window } = jsdom;

  firePopstateOnRoute(window);
}