navigation-stack 0.3.0 → 0.4.0

package/test/middleware/createNavigationBlockerMiddleware.test.js

@@ -1,471 +0,0 @@
-import delay from 'delay';
-import pDefer from 'p-defer';
-import { applyMiddleware, createStore } from 'redux';
-
-import Actions from '../../src/Actions';
-import addNavigationBlockerOriginal from '../../src/addNavigationBlocker';
-import createMiddlewares from '../../src/createMiddlewares';
-import locationReducer from '../../src/locationReducer';
-import MemorySession from '../../src/session/MemorySession';
-import { shouldWarn } from '../helpers';
-
-describe('createNavigationBlockerMiddleware', () => {
-  const sandbox = sinon.createSandbox();
-
-  let session;
-  let store;
-
-  function addNavigationBlocker(blocker) {
-    return addNavigationBlockerOriginal(session, blocker);
-  }
-
-  beforeEach(() => {
-    session = new MemorySession('/foo');
-
-    store = createStore(
-      locationReducer,
-      applyMiddleware(...createMiddlewares(session)),
-    );
-    store.dispatch(Actions.init());
-
-    sinon.spy(session, 'addBeforeDestroyListener');
-    // sinon.spy(session, '_removeBeforeDestroyListener');
-  });
-
-  afterEach(() => {
-    store.dispatch(Actions.dispose());
-
-    sandbox.restore();
-  });
-
-  describe('PUSH navigations', () => {
-    it('should block navigation when blocker returns `true`', () => {
-      const blocker = sinon.stub().returns(true);
-      addNavigationBlocker(blocker);
-
-      store.dispatch(Actions.push('/bar'));
-      expect(store.getState().pathname).to.equal('/foo');
-
-      expect(blocker).to.have.been.calledOnce();
-
-      expect(blocker.firstCall.args[0]).to.include({
-        action: 'PUSH',
-        pathname: '/bar',
-      });
-    });
-
-    it('should allow navigation when blocker returns `undefined`', () => {
-      addNavigationBlocker(() => undefined);
-
-      store.dispatch(Actions.push('/bar'));
-      expect(store.getState().pathname).to.equal('/bar');
-    });
-
-    it("should fall through when first blocker doesn't return `true`", () => {
-      const blocker1 = sinon.stub().returns(undefined);
-      const blocker2 = sinon.stub().returns(true);
-
-      addNavigationBlocker(blocker1);
-      addNavigationBlocker(blocker2);
-
-      store.dispatch(Actions.push('/bar'));
-      expect(store.getState().pathname).to.equal('/foo');
-
-      expect(blocker1).to.have.been.calledOnce();
-      expect(blocker2).to.have.been.calledOnce();
-    });
-
-    it('should not fall through when first blocker returns `true`', () => {
-      const blocker1 = sinon.stub().returns(true);
-      const blocker2 = sinon.stub().returns(undefined);
-
-      addNavigationBlocker(blocker1);
-      addNavigationBlocker(blocker2);
-
-      store.dispatch(Actions.push('/bar'));
-      expect(store.getState().pathname).to.equal('/foo');
-
-      expect(blocker1).to.have.been.calledOnce();
-      expect(blocker2).not.to.have.been.called();
-    });
-
-    it('should warn on and ignore blockers that throw', () => {
-      shouldWarn(
-        'Ignoring navigation blocker `syncblocker` that failed with `Error: foo`.',
-      );
-
-      const syncblocker = () => {
-        throw new Error('foo');
-      };
-
-      addNavigationBlocker(syncblocker);
-
-      store.dispatch(Actions.push('/bar'));
-      expect(store.getState().pathname).to.equal('/bar');
-    });
-
-    // it('should show a confirmation dialog and allow navigation on string', () => {
-    //   sandbox.stub(window, 'confirm').returns(true);
-    //
-    //   addNavigationBlocker(({ pathname }) => pathname);
-    //
-    //   store.dispatch(Actions.push('/bar'));
-    //   expect(store.getState().pathname).to.equal('/bar');
-    //
-    //   expect(window.confirm)
-    //     .to.have.been.calledOnce()
-    //     .and.to.have.been.called.with('/bar');
-    // });
-
-    // it('should show a confirmation dialog and block navigation on string', () => {
-    //   sandbox.stub(window, 'confirm').returns(false);
-    //
-    //   addNavigationBlocker(({ pathname }) => pathname);
-    //
-    //   store.dispatch(Actions.push('/bar'));
-    //   expect(store.getState().pathname).to.equal('/foo');
-    //
-    //   expect(window.confirm)
-    //     .to.have.been.calledOnce()
-    //     .and.to.have.been.called.with('/bar');
-    // });
-
-    it('should allow navigation when blocker returns `undefined` (async)', async () => {
-      const deferred = pDefer();
-      addNavigationBlocker(() => deferred.promise);
-
-      store.dispatch(Actions.push('/bar'));
-      expect(store.getState().pathname).to.equal('/foo');
-
-      deferred.resolve(undefined);
-      await delay(10);
-
-      expect(store.getState().pathname).to.equal('/bar');
-    });
-
-    it('should block navigation when blocker returns `true` (async)', async () => {
-      const deferred = pDefer();
-      addNavigationBlocker(() => deferred.promise);
-
-      store.dispatch(Actions.push('/bar'));
-      expect(store.getState().pathname).to.equal('/foo');
-
-      deferred.resolve(true);
-      await delay(10);
-
-      expect(store.getState().pathname).to.equal('/foo');
-    });
-
-    it('should allow chaining async blockers', async () => {
-      const deferred1 = pDefer();
-      const deferred2 = pDefer();
-
-      addNavigationBlocker(() => deferred1.promise);
-      addNavigationBlocker(() => deferred2.promise);
-
-      store.dispatch(Actions.push('/bar'));
-      expect(store.getState().pathname).to.equal('/foo');
-
-      deferred1.resolve(undefined);
-      await delay(10);
-
-      expect(store.getState().pathname).to.equal('/foo');
-
-      deferred2.resolve(undefined);
-      await delay(10);
-
-      expect(store.getState().pathname).to.equal('/bar');
-    });
-
-    it('should warn on and ignore async blockers that throw an error', async () => {
-      shouldWarn(
-        'Ignoring navigation blocker `asyncblocker` that failed with `Error: foo`.',
-      );
-
-      // eslint-disable-next-line require-await
-      const asyncblocker = async () => {
-        throw new Error('foo');
-      };
-
-      addNavigationBlocker(asyncblocker);
-
-      store.dispatch(Actions.push('/bar'));
-      expect(store.getState().pathname).to.equal('/foo');
-
-      await delay(10);
-
-      expect(store.getState().pathname).to.equal('/bar');
-    });
-
-    it('should allow removing blockers', () => {
-      const removeNavigationBlocker = addNavigationBlocker(() => true);
-
-      store.dispatch(Actions.push('/bar'));
-      expect(store.getState().pathname).to.equal('/foo');
-
-      removeNavigationBlocker();
-
-      store.dispatch(Actions.push('/bar'));
-      expect(store.getState().pathname).to.equal('/bar');
-    });
-  });
-
-  describe('SHIFT navigations', () => {
-    beforeEach(() => {
-      store.dispatch(Actions.push('/bar'));
-    });
-
-    it('should allow navigation when blocker returns `undefined`', () => {
-      const blocker = sinon.stub().returns(undefined);
-      addNavigationBlocker(blocker);
-
-      store.dispatch(Actions.shift(-1));
-      expect(store.getState().pathname).to.equal('/foo');
-
-      expect(blocker.firstCall.args[0]).to.include({
-        action: 'SHIFT',
-        pathname: '/foo',
-        delta: -1,
-      });
-    });
-
-    it('should block navigation when blocker returns `true`', () => {
-      addNavigationBlocker(() => true);
-
-      store.dispatch(Actions.shift(-1));
-      expect(store.getState().pathname).to.equal('/bar');
-    });
-
-    it('should allow navigation when blocker returns `undefined` (async)', async () => {
-      const deferred = pDefer();
-      addNavigationBlocker(() => deferred.promise);
-
-      store.dispatch(Actions.shift(-1));
-      expect(store.getState().pathname).to.equal('/bar');
-
-      deferred.resolve(undefined);
-      await delay(10);
-
-      expect(store.getState().pathname).to.equal('/foo');
-    });
-
-    it('should block navigation when blocker returns `true` (async)', async () => {
-      const deferred = pDefer();
-      addNavigationBlocker(() => deferred.promise);
-
-      store.dispatch(Actions.shift(-1));
-      expect(store.getState().pathname).to.equal('/bar');
-
-      deferred.resolve(true);
-      await delay(10);
-
-      expect(store.getState().pathname).to.equal('/bar');
-    });
-
-    // it('should show a confirmation dialog and allow navigation on string', () => {
-    //   sandbox.stub(window, 'confirm').returns(true);
-    //
-    //   addNavigationBlocker(({ pathname }) => pathname);
-    //
-    //   store.dispatch(Actions.shift(-1));
-    //   expect(store.getState().pathname).to.equal('/foo');
-    //
-    //   expect(window.confirm)
-    //     .to.have.been.calledOnce()
-    //     .and.to.have.been.called.with('/bar');
-    // });
-
-    it('should ignore the initial load when blocker returns `true`', () => {
-      // Get rid of the old store. We'll replace it with a new one.
-      store.dispatch(Actions.dispose());
-
-      store = createStore(
-        locationReducer,
-        applyMiddleware(...createMiddlewares(new MemorySession('/foo'))),
-      );
-      addNavigationBlocker(() => true);
-
-      expect(store.getState()).to.be.undefined();
-      store.dispatch(Actions.init());
-      expect(store.getState().pathname).to.equal('/foo');
-    });
-
-    it('should support async rewinding', async () => {
-      // eslint-disable-next-line no-underscore-dangle
-      const blocker = session.navigation._subscriptionListener;
-
-      let sessionDeferred;
-
-      // eslint-disable-next-line no-underscore-dangle
-      session.navigation._subscriptionListener = async (location) => {
-        sessionDeferred = pDefer();
-        await sessionDeferred.promise;
-
-        blocker(location);
-      };
-
-      const deferred = pDefer();
-      addNavigationBlocker(() => deferred.promise);
-
-      store.dispatch(Actions.shift(-1));
-
-      // session shifted, update to store blocked.
-      expect(session.navigation.init().pathname).to.equal('/foo');
-      expect(store.getState().pathname).to.equal('/bar');
-
-      sessionDeferred.resolve();
-      await delay(10);
-
-      // session rewinded.
-      expect(session.navigation.init().pathname).to.equal('/bar');
-      expect(store.getState().pathname).to.equal('/bar');
-
-      deferred.resolve(undefined);
-      await delay(10);
-
-      sessionDeferred.resolve();
-      await delay(10);
-
-      // session re-shifted (the rewind was undone), update to store delayed.
-      expect(session.navigation.init().pathname).to.equal('/foo');
-      expect(store.getState().pathname).to.equal('/foo');
-    });
-
-    it('should allow navigation without calling any blockers when `location.delta` is `null`', async () => {
-      const deferred = pDefer();
-      addNavigationBlocker(() => deferred.promise);
-
-      // Update location with a `SHIFT` action.
-      /* eslint-disable no-underscore-dangle */
-      session.navigation._index = 0;
-      session.navigation._subscriptionListener(session.navigation.init(null));
-      /* eslint-enable no-underscore-dangle */
-
-      deferred.resolve(undefined);
-      await delay(10);
-
-      // Without delta, we can't rewind on the session,
-      // so navigation is allowed without calling any blockers.
-      expect(session.navigation.init().pathname).to.equal('/foo');
-      expect(store.getState().pathname).to.equal('/foo');
-    });
-
-    // it('should allow navigation when blocker returns `undefined` and `location.delta` is `null`', async () => {
-    //   const deferred = pDefer();
-    //   addNavigationBlocker(() => deferred.promise);
-    //
-    //   // Update location with a `SHIFT` action.
-    //   /* eslint-disable no-underscore-dangle */
-    //   session.navigation._index = 0;
-    //   session.navigation._subscriptionListener(session.navigation.init(null));
-    //   /* eslint-enable no-underscore-dangle */
-    //
-    //   // Without delta, we can't rewind on the session.
-    //   expect(session.navigation.init().pathname).to.equal('/foo');
-    //   expect(store.getState().pathname).to.equal('/bar');
-    //
-    //   deferred.resolve(undefined);
-    //   await delay(10);
-    //
-    //   expect(session.navigation.init().pathname).to.equal('/foo');
-    //   expect(store.getState().pathname).to.equal('/foo');
-    // });
-
-    // it('should block store update when blocker returns `true` and `location.delta` is `null`', async () => {
-    //   const deferred = pDefer();
-    //   addNavigationBlocker(() => deferred.promise);
-    //
-    //   /* eslint-disable no-underscore-dangle */
-    //   session.navigation._index = 0;
-    //   session.navigation._subscriptionListener(session.navigation.init(null));
-    //   /* eslint-enable no-underscore-dangle */
-    //
-    //   expect(session.navigation.init().pathname).to.equal('/foo');
-    //   expect(store.getState().pathname).to.equal('/bar');
-    //
-    //   deferred.resolve(true);
-    //   await delay(10);
-    //
-    //   // These are out-of-sync now, but it's the best we can do.
-    //   expect(session.navigation.init().pathname).to.equal('/foo');
-    //   expect(store.getState().pathname).to.equal('/bar');
-    // });
-  });
-
-  describe('beforeUnload', () => {
-    beforeEach(() => {
-      // Get rid of the old store. We'll replace it with a new one.
-      store.dispatch(Actions.dispose());
-
-      sandbox.stub(window, 'addEventListener');
-      sandbox.stub(window, 'removeEventListener');
-
-      store = createStore(
-        () => null,
-        applyMiddleware(...createMiddlewares(session)),
-      );
-
-      store.dispatch(Actions.init());
-    });
-
-    it('should manage event blocker', () => {
-      expect(session.addBeforeDestroyListener).not.to.have.been.called();
-      // expect(window.addEventListener).not.to.have.been.called();
-
-      const removeNavigationBlocker1 = addNavigationBlocker(() => null, {
-        beforeUnload: true,
-      });
-      expect(session.addBeforeDestroyListener).to.have.been.calledOnce();
-      // expect(window.addEventListener)
-      //   .to.have.been.calledOnce()
-      //   .and.to.have.been.called.with('beforeunload');
-
-      const removeNavigationBlocker2 = addNavigationBlocker(() => null, {
-        beforeUnload: true,
-      });
-      expect(session.addBeforeDestroyListener).to.have.been.calledOnce();
-      // expect(window.addEventListener)
-      //   .to.have.been.calledOnce()
-      //   .and.to.have.been.called.with('beforeunload');
-
-      const removeBeforeDestroyListener = sinon.stub();
-      // eslint-disable-next-line no-underscore-dangle
-      session._removeBeforeDestroyListener = removeBeforeDestroyListener;
-
-      removeNavigationBlocker1();
-      // expect(window.removeEventListener).not.to.have.been.called();
-      expect(removeBeforeDestroyListener).not.to.have.been.called();
-
-      removeNavigationBlocker2();
-      // expect(window.removeEventListener)
-      //   .to.have.been.calledOnce()
-      //   .and.to.have.been.called.with('beforeunload');
-      expect(removeBeforeDestroyListener).to.have.been.calledOnce();
-    });
-
-    it('should remove event blocker on dispose', () => {
-      addNavigationBlocker(() => null, { beforeUnload: true });
-
-      const removeBeforeDestroyListener = sinon.stub();
-      // eslint-disable-next-line no-underscore-dangle
-      session._removeBeforeDestroyListener = removeBeforeDestroyListener;
-
-      // expect(window.removeEventListener).not.to.have.been.called();
-      expect(removeBeforeDestroyListener).not.to.have.been.called();
-
-      store.dispatch(Actions.dispose());
-      // expect(window.removeEventListener)
-      //   .to.have.been.calledOnce()
-      //   .and.to.have.been.called.with('beforeunload');
-      expect(removeBeforeDestroyListener).to.have.been.calledOnce();
-    });
-
-    // it('should not add a global "before destroy" listener when no `beforeDestroy` blocker has been added', () => {
-    //   const removeNavigationBlocker = addNavigationBlocker(() => null);
-    //   expect(window.addEventListener).not.to.have.been.called();
-    //
-    //   removeNavigationBlocker();
-    //   expect(window.removeEventListener).not.to.have.been.called();
-    // });
-  });
-});

package/test/middleware/createTransformLocationMiddleware.test.js

@@ -1,44 +0,0 @@
-import ActionTypes from '../../src/ActionTypes';
-import createTransformLocationMiddleware from '../../src/middleware/createTransformLocationMiddleware';
-
-describe('createTransformLocationMiddleware', () => {
-  const middleware = createTransformLocationMiddleware({
-    transformInputLocation: (locationInput) => ({ locationInput }),
-    transformSubscriptionLocation: (location) => ({ location }),
-  });
-
-  const dispatch = middleware()((action) => action.payload);
-
-  it('should handle location descriptors for NAVIGATE', () => {
-    expect(
-      dispatch({
-        type: ActionTypes.NAVIGATE,
-        payload: {},
-      }),
-    ).to.eql({
-      locationInput: {},
-    });
-  });
-
-  it('should handle locations for UPDATE', () => {
-    expect(
-      dispatch({
-        type: ActionTypes.UPDATE,
-        payload: {},
-      }),
-    ).to.eql({
-      location: {},
-    });
-  });
-
-  it('should ignore other actions', () => {
-    expect(
-      dispatch({
-        type: 'UNKNOWN',
-        payload: { unknown: {} },
-      }),
-    ).to.eql({
-      unknown: {},
-    });
-  });
-});

package/test/session/BrowserSession.test.js

@@ -1,182 +0,0 @@
-import delay from 'delay';
-
-import BrowserSession from '../../src/session/BrowserSession';
-
-describe('BrowserSession', () => {
-  beforeEach(() => {
-    window.history.replaceState(null, null, '/');
-  });
-
-  it('should parse the initial location', () => {
-    window.history.replaceState(null, null, '/foo?bar=baz#qux');
-    const session = new BrowserSession();
-
-    expect(session.navigation.init()).to.deep.include({
-      action: 'INIT',
-      pathname: '/foo',
-      search: '?bar=baz',
-      query: {
-        bar: 'baz',
-      },
-      hash: '#qux',
-      index: 0,
-      delta: 0,
-      state: undefined,
-    });
-  });
-
-  it('should require initialization', () => {
-    const session = new BrowserSession();
-
-    expect(() =>
-      session.navigation.navigate({
-        action: 'PUSH',
-        pathname: '/bar',
-        search: '?search',
-        hash: '#hash',
-        state: { the: 'state' },
-      }),
-    ).to.throw('Browser session must be initialized before navigation');
-  });
-
-  it('should support basic navigation', async () => {
-    window.history.replaceState(null, null, '/foo');
-    const session = new BrowserSession();
-
-    const listener = sinon.spy();
-    session.navigation.subscribe(listener);
-
-    session.navigation.init();
-
-    const barLocation = session.navigation.navigate({
-      action: 'PUSH',
-      pathname: '/bar',
-      search: '?search',
-      hash: '#hash',
-      state: { the: 'state' },
-    });
-
-    expect(window.location).to.include({
-      pathname: '/bar',
-      search: '?search',
-      hash: '#hash',
-    });
-    expect(barLocation).to.deep.include({
-      action: 'PUSH',
-      pathname: '/bar',
-      search: '?search',
-      hash: '#hash',
-      index: 1,
-      delta: 1,
-      state: { the: 'state' },
-    });
-    expect(barLocation.key).not.to.be.empty();
-
-    expect(
-      session.navigation.navigate({
-        action: 'PUSH',
-        pathname: '/baz',
-        search: '',
-        hash: '',
-      }),
-    ).to.include({
-      action: 'PUSH',
-      pathname: '/baz',
-      index: 2,
-      delta: 1,
-    });
-
-    expect(window.location.pathname).to.equal('/baz');
-
-    expect(
-      session.navigation.navigate({
-        action: 'REPLACE',
-        pathname: '/qux',
-        search: '',
-        hash: '',
-      }),
-    ).to.include({
-      action: 'REPLACE',
-      pathname: '/qux',
-      index: 2,
-      delta: 0,
-    });
-    await delay(20);
-
-    expect(window.location.pathname).to.equal('/qux');
-    expect(listener).not.to.have.been.called();
-
-    session.navigation.shift(-1);
-    await delay(20);
-
-    expect(window.location).to.include({
-      pathname: '/bar',
-      search: '?search',
-      hash: '#hash',
-    });
-    expect(listener).to.have.been.calledOnce();
-    expect(listener.firstCall.args[0]).to.deep.include({
-      action: 'SHIFT',
-      pathname: '/bar',
-      search: '?search',
-      hash: '#hash',
-      key: barLocation.key,
-      index: 1,
-      delta: -1,
-      state: { the: 'state' },
-    });
-    listener.resetHistory();
-
-    window.history.back();
-    await delay(20);
-
-    expect(window.location.pathname).to.equal('/foo');
-    expect(listener).to.have.been.calledOnce();
-    expect(listener.firstCall.args[0]).to.deep.include({
-      action: 'SHIFT',
-      pathname: '/foo',
-      index: 0,
-      delta: -1,
-      state: undefined,
-    });
-
-    listener.resetHistory();
-  });
-
-  it('should support subscribing and unsubscribing', async () => {
-    const session = new BrowserSession();
-    session.navigation.init();
-    session.navigation.navigate({
-      action: 'PUSH',
-      pathname: '/bar',
-      search: '',
-      hash: '',
-    });
-    session.navigation.navigate({
-      action: 'PUSH',
-      pathname: '/baz',
-      search: '',
-      hash: '',
-    });
-
-    const listener = sinon.spy();
-    const unsubscribe = session.navigation.subscribe(listener);
-
-    session.navigation.shift(-1);
-    await delay(20);
-
-    expect(listener).to.have.been.calledOnce();
-    expect(listener.firstCall.args[0]).to.include({
-      action: 'SHIFT',
-      pathname: '/bar',
-    });
-    listener.resetHistory();
-
-    unsubscribe();
-
-    session.navigation.shift(-1);
-    await delay(20);
-
-    expect(listener).not.to.have.been.called();
-  });
-});