Merge pull request #16 from cjcenizal/implement/storeStateInLocalstor…

…age/refactor-pure-functions

Refactor state-hashing files into state_hashing and state_storage subdirectories.

src/ui/public/chrome/directives/kbn_chrome.js

@@ -2,7 +2,10 @@ import $ from 'jquery';
 
 import './kbn_chrome.less';
 import UiModules from 'ui/modules';
-import { UnhashStatesProvider } from 'ui/state_management/unhash_states';
+import {
+  getUnhashableStatesProvider,
+  unhashUrl,
+} from 'ui/state_management/state_hashing';
 
 export default function (chrome, internals) {
 
@@ -28,15 +31,16 @@ export default function (chrome, internals) {
 
       controllerAs: 'chrome',
       controller($scope, $rootScope, $location, $http, Private) {
-        const unhashStates = Private(UnhashStatesProvider);
+        const getUnhashableStates = Private(getUnhashableStatesProvider);
 
         // are we showing the embedded version of the chrome?
         internals.setVisibleDefault(!$location.search().embed);
 
         // listen for route changes, propogate to tabs
         const onRouteChange = function () {
-          let { href } = window.location;
-          internals.trackPossibleSubUrl(unhashStates.inAbsUrl(href));
+          const urlWithHashes = window.location.href;
+          const urlWithStates = unhashUrl(urlWithHashes, getUnhashableStates());
+          internals.trackPossibleSubUrl(urlWithStates);
         };
 
         $rootScope.$on('$routeChangeSuccess', onRouteChange);

src/ui/public/share/directives/share_object_url.js

@@ -4,7 +4,10 @@ import '../styles/index.less';
 import LibUrlShortenerProvider from '../lib/url_shortener';
 import uiModules from 'ui/modules';
 import shareObjectUrlTemplate from 'ui/share/views/share_object_url.html';
-import { UnhashStatesProvider } from 'ui/state_management/unhash_states';
+import {
+  getUnhashableStatesProvider,
+  unhashUrl,
+} from 'ui/state_management/state_hashing';
 import { memoize } from 'lodash';
 
 app.directive('shareObjectUrl', function (Private, Notifier) {
@@ -71,12 +74,15 @@ app.directive('shareObjectUrl', function (Private, Notifier) {
       };
 
       // since getUrl() is called within a watcher we cache the unhashing step
-      const unhashStatesInAbsUrl = memoize((absUrl) => {
-        return Private(UnhashStatesProvider).inAbsUrl(absUrl);
+      const unhashAndCacheUrl = memoize((urlWithHashes, unhashableStates) => {
+        const urlWithStates = unhashUrl(urlWithHashes, unhashableStates);
+        return urlWithStates;
       });
 
       $scope.getUrl = function () {
-        let url = unhashStatesInAbsUrl($location.absUrl());
+        const urlWithHashes = $location.absUrl();
+        const getUnhashableStates = Private(getUnhashableStatesProvider);
+        let url = unhashAndCacheUrl(urlWithHashes, getUnhashableStates());
 
         if ($scope.shareAsEmbed) {
           url = url.replace('?', '?embed=true&');

src/ui/public/state_management/__tests__/state.js

@@ -7,8 +7,8 @@ import { encode as encodeRison } from 'rison-node';
 import 'ui/private';
 import Notifier from 'ui/notify/notifier';
 import StateManagementStateProvider from 'ui/state_management/state';
-import { UnhashStatesProvider } from 'ui/state_management/unhash_states';
-import { HashingStore } from 'ui/state_management/hashing_store';
+import { unhashQueryString } from 'ui/state_management/state_hashing';
+import { HashingStore } from 'ui/state_management/state_storage';
 import StubBrowserStorage from 'test_utils/stub_browser_storage';
 import EventsProvider from 'ui/events';
 
@@ -35,9 +35,8 @@ describe('State Management', function () {
       const hashingStore = new HashingStore({ store });
       const state = new State(param, initial, { hashingStore, notify });
 
-      const getUnhashedSearch = (state) => {
-        const unhashStates = Private(UnhashStatesProvider);
-        return unhashStates.inParsedQueryString($location.search(), [ state ]);
+      const getUnhashedSearch = state => {
+        return unhashQueryString($location.search(), [ state ]);
       };
 
       return { notify, store, hashingStore, state, getUnhashedSearch };

src/ui/public/state_management/state.js

@@ -7,8 +7,10 @@ import EventsProvider from 'ui/events';
 import Notifier from 'ui/notify/notifier';
 import KbnUrlProvider from 'ui/url';
 
-import { HashingStore } from './hashing_store';
-import { LazyLruStore } from './lazy_lru_store';
+import {
+  HashingStore,
+  LazyLruStore,
+} from './state_storage';
 
 const MAX_BROWSER_HISTORY = 50;
 

src/ui/public/state_management/state_hashing/__tests__/unhash_url.js

@@ -0,0 +1,73 @@
+import expect from 'expect.js';
+import ngMock from 'ng_mock';
+import sinon from 'auto-release-sinon';
+
+import StateProvider from 'ui/state_management/state';
+import { unhashUrl } from 'ui/state_management/state_hashing';
+
+describe('unhashUrl', () => {
+  let unhashableStates;
+
+  beforeEach(ngMock.module('kibana'));
+
+  beforeEach(ngMock.inject(Private => {
+    const State = Private(StateProvider);
+    const unhashableState = new State('testParam');
+    sinon.stub(unhashableState, 'translateHashToRison').withArgs('hash').returns('replacement');
+    unhashableStates = [unhashableState];
+  }));
+
+  describe('does nothing', () => {
+    it('if missing input', () => {
+      expect(() => {
+        unhashUrl();
+      }).to.not.throwError();
+    });
+
+    it('if just a host and port', () => {
+      const url = 'https://localhost:5601';
+      expect(unhashUrl(url, unhashableStates)).to.be(url);
+    });
+
+    it('if just a path', () => {
+      const url = 'https://localhost:5601/app/kibana';
+      expect(unhashUrl(url, unhashableStates)).to.be(url);
+    });
+
+    it('if just a path and query', () => {
+      const url = 'https://localhost:5601/app/kibana?foo=bar';
+      expect(unhashUrl(url, unhashableStates)).to.be(url);
+    });
+
+    it('if empty hash with query', () => {
+      const url = 'https://localhost:5601/app/kibana?foo=bar#';
+      expect(unhashUrl(url, unhashableStates)).to.be(url);
+    });
+
+    it('if empty hash without query', () => {
+      const url = 'https://localhost:5601/app/kibana#';
+      expect(unhashUrl(url, unhashableStates)).to.be(url);
+    });
+
+    it('if empty hash without query', () => {
+      const url = 'https://localhost:5601/app/kibana#';
+      expect(unhashUrl(url, unhashableStates)).to.be(url);
+    });
+
+    it('if hash is just a path', () => {
+      const url = 'https://localhost:5601/app/kibana#/discover';
+      expect(unhashUrl(url, unhashableStates)).to.be(url);
+    });
+
+    it('if hash does not have matching query string vals', () => {
+      const url = 'https://localhost:5601/app/kibana#/discover?foo=bar';
+      expect(unhashUrl(url, unhashableStates)).to.be(url);
+    });
+  });
+
+  it('replaces query string vals in hash for matching states with output of state.toRISON()', () => {
+    const urlWithHashes = 'https://localhost:5601/#/?foo=bar&testParam=hash';
+    const exp = 'https://localhost:5601/#/?foo=bar&testParam=replacement';
+    expect(unhashUrl(urlWithHashes, unhashableStates)).to.be(exp);
+  });
+});

src/ui/public/state_management/state_hashing/get_unhashable_states_provider.js

@@ -0,0 +1,5 @@
+export default function getUnhashableStatesProvider(getAppState, globalState) {
+  return function getUnhashableStates() {
+    return [getAppState(), globalState].filter(Boolean);
+  };
+}

src/ui/public/state_management/state_hashing/index.js

@@ -0,0 +1,11 @@
+export {
+  default as getUnhashableStatesProvider,
+} from './get_unhashable_states_provider';
+
+export {
+  default as unhashQueryString,
+} from './unhash_query_string';
+
+export {
+  default as unhashUrl,
+} from './unhash_url';

src/ui/public/state_management/state_hashing/unhash_query_string.js

@@ -0,0 +1,8 @@
+import { mapValues } from 'lodash';
+
+export default function unhashQueryString(parsedQueryString, states) {
+  return mapValues(parsedQueryString, (val, key) => {
+    const state = states.find(s => key === s.getQueryParamName());
+    return state ? state.translateHashToRison(val) : val;
+  });
+}

src/ui/public/state_management/state_hashing/unhash_url.js

@@ -0,0 +1,36 @@
+import {
+  parse as parseUrl,
+  format as formatUrl,
+} from 'url';
+
+import unhashQueryString from './unhash_query_string';
+
+export default function unhashUrl(urlWithHashes, states) {
+  if (!urlWithHashes) return urlWithHashes;
+
+  const urlWithHashesParsed = parseUrl(urlWithHashes, true);
+  if (!urlWithHashesParsed.hostname) {
+    // passing a url like "localhost:5601" or "/app/kibana" should be prevented
+    throw new TypeError(
+      'Only absolute urls should be passed to `unhashUrl()`. ' +
+      'Unable to detect url hostname.'
+    );
+  }
+
+  if (!urlWithHashesParsed.hash) return urlWithHashes;
+
+  const appUrl = urlWithHashesParsed.hash.slice(1); // trim the #
+  if (!appUrl) return urlWithHashes;
+
+  const appUrlParsed = parseUrl(urlWithHashesParsed.hash.slice(1), true);
+  if (!appUrlParsed.query) return urlWithHashes;
+
+  const appQueryWithoutHashes = unhashQueryString(appUrlParsed.query || {}, states);
+  return formatUrl({
+    ...urlWithHashesParsed,
+    hash: formatUrl({
+      pathname: appUrlParsed.pathname,
+      query: appQueryWithoutHashes,
+    })
+  });
+}

src/ui/public/state_management/__tests__/hashing_store.js → src/ui/public/state_management/state_storage/_tests__/hashing_store.js

@@ -3,7 +3,7 @@ import sinon from 'sinon';
 import { encode as encodeRison } from 'rison-node';
 
 import StubBrowserStorage from 'test_utils/stub_browser_storage';
-import { HashingStore } from 'ui/state_management/hashing_store';
+import { HashingStore } from 'ui/state_management/state_storage';
 
 const setup = ({ createHash } = {}) => {
   const store = new StubBrowserStorage();

src/ui/public/state_management/__tests__/lazy_lru_store.js → src/ui/public/state_management/state_storage/_tests__/lazy_lru_store.js

@@ -3,7 +3,7 @@ import sinon from 'sinon';
 import { times, sum, padLeft } from 'lodash';
 
 import StubBrowserStorage from 'test_utils/stub_browser_storage';
-import { LazyLruStore } from '../lazy_lru_store';
+import { LazyLruStore } from '..';
 
 const setup = (opts = {}) => {
   const {

src/ui/public/state_management/hashing_store.js → src/ui/public/state_management/state_storage/hashing_store.js

@@ -13,7 +13,7 @@ const TAG = 'h@';
  *  hash. This hash is then returned so that the item can be received
  *  at a later time.
  */
-export class HashingStore {
+export default class HashingStore {
   constructor({ store, createHash, maxItems } = {}) {
     this._store = store || window.sessionStorage;
     if (createHash) this._createHash = createHash;

src/ui/public/state_management/state_storage/index.js

@@ -0,0 +1,7 @@
+export {
+  default as HashingStore,
+} from './hashing_store';
+
+export {
+  default as LazyLruStore,
+} from './lazy_lru_store';

src/ui/public/state_management/lazy_lru_store.js → src/ui/public/state_management/state_storage/lazy_lru_store.js

@@ -31,7 +31,7 @@ const DEFAULT_IDEAL_CLEAR_RATIO = 100;
  */
 const DEFAULT_MAX_IDEAL_CLEAR_PERCENT = 0.3;
 
-export class LazyLruStore {
+export default class LazyLruStore {
   constructor(opts = {}) {
     const {
       id,