@inboxsdk/core 0.2.28-alpha.4 → 0.2.28-alpha.5

package/src/platform-implementation-js/dom-driver/gmail/gmail-driver/setup-route-view-driver-stream.js

@@ -1,189 +1,173 @@
-/* @flow */
-
-import Kefir from 'kefir';
-import get from '../../../../common/get-or-fail';
-
-import type GmailDriver from '../gmail-driver';
-import type GmailRouteProcessor from '../views/gmail-route-view/gmail-route-processor';
-import GmailElementGetter from '../gmail-element-getter';
-import GmailRouteView from '../views/gmail-route-view/gmail-route-view';
-import getURLObject from './get-url-object';
-
-import routeIDmatchesHash from '../../../lib/routeIDmatchesHash';
-
-export default function setupRouteViewDriverStream(
-  gmailRouteProcessor: GmailRouteProcessor,
-  driver: GmailDriver
-): Kefir.Observable<GmailRouteView> {
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = setupRouteViewDriverStream;
+var _kefir = _interopRequireDefault(require("kefir"));
+var _getOrFail = _interopRequireDefault(require("../../../../common/get-or-fail"));
+var _gmailElementGetter = _interopRequireDefault(require("../gmail-element-getter"));
+var _gmailRouteView = _interopRequireDefault(require("../views/gmail-route-view/gmail-route-view"));
+var _getUrlObject = _interopRequireDefault(require("./get-url-object"));
+var _routeIDmatchesHash = _interopRequireDefault(require("../../../lib/routeIDmatchesHash"));
+function setupRouteViewDriverStream(gmailRouteProcessor, driver) {
   const customRouteIDs = driver.getCustomRouteIDs();
   const customListRouteIDs = driver.getCustomListRouteIDs();
-  const customListSearchStringsToRouteIds =
-    driver.getCustomListSearchStringsToRouteIds();
-
-  let lastNativeHash = getURLObject(document.location.href).hash;
+  const customListSearchStringsToRouteIds = driver.getCustomListSearchStringsToRouteIds();
+  let lastNativeHash = (0, _getUrlObject.default)(document.location.href).hash;
   let latestGmailRouteView = null;
-
   driver.getStopper().onValue(() => {
     if (latestGmailRouteView) {
       latestGmailRouteView.destroy();
     }
   });
-
   let lastHash = lastNativeHash;
-
   let sameRouteData = {};
-
-  const eligibleHashChanges = Kefir.fromEvents(window, 'hashchange')
-    .filter((event) => !event.oldURL.match(/#inboxsdk-fake-no-vc$/))
-    .map((event) => ({
-      new: getURLObject(event.newURL),
-      old: getURLObject(event.oldURL),
-    }))
-    .filter((event) => event.new.hash !== event.old.hash)
-    .map((event) => event.new)
-    .map((urlObject) => {
-      const { hash, name } = urlObject;
-      for (let routeIDs of customRouteIDs) {
-        let routeID = routeIDmatchesHash(routeIDs, hash);
-        if (routeID) {
-          return { urlObject, type: 'CUSTOM', routeID };
-        }
-      }
-      for (let [routeIDs] of customListRouteIDs) {
-        let routeID = routeIDmatchesHash(routeIDs, name);
-        if (routeID) {
-          return { urlObject, type: 'CUSTOM_LIST_TRIGGER', routeID };
-        }
+  const eligibleHashChanges = _kefir.default.fromEvents(window, 'hashchange').filter(event => !event.oldURL.match(/#inboxsdk-fake-no-vc$/)).map(event => ({
+    new: (0, _getUrlObject.default)(event.newURL),
+    old: (0, _getUrlObject.default)(event.oldURL)
+  })).filter(event => event.new.hash !== event.old.hash).map(event => event.new).map(urlObject => {
+    const {
+      hash,
+      name
+    } = urlObject;
+    for (let routeIDs of customRouteIDs) {
+      let routeID = (0, _routeIDmatchesHash.default)(routeIDs, hash);
+      if (routeID) {
+        return {
+          urlObject,
+          type: 'CUSTOM',
+          routeID
+        };
       }
-      if (gmailRouteProcessor.isNativeRoute(urlObject.name)) {
-        return { urlObject, type: 'NATIVE' };
+    }
+    for (let [routeIDs] of customListRouteIDs) {
+      let routeID = (0, _routeIDmatchesHash.default)(routeIDs, name);
+      if (routeID) {
+        return {
+          urlObject,
+          type: 'CUSTOM_LIST_TRIGGER',
+          routeID
+        };
       }
-      return { urlObject, type: 'OTHER_APP_CUSTOM' };
-    });
-
-  const customAndCustomListRouteHashChanges = eligibleHashChanges.filter(
-    ({ type }) => type !== 'NATIVE'
-  );
+    }
+    if (gmailRouteProcessor.isNativeRoute(urlObject.name)) {
+      return {
+        urlObject,
+        type: 'NATIVE'
+      };
+    }
+    return {
+      urlObject,
+      type: 'OTHER_APP_CUSTOM'
+    };
+  });
+  const customAndCustomListRouteHashChanges = eligibleHashChanges.filter(_ref => {
+    let {
+      type
+    } = _ref;
+    return type !== 'NATIVE';
+  });
 
   // If a user goes from a native route to a custom route, and then back to the
   // same native route, we need to make a new GmailRouteView because
   // getMainContentElementChangedStream() won't be firing, except when going from thread->custom->thread
-  const revertNativeHashChanges = eligibleHashChanges
-    .filter(({ type }) => type === 'NATIVE')
-    .filter(({ urlObject }) => {
-      const tmp = lastNativeHash;
-      lastNativeHash = urlObject.hash;
-      return tmp === urlObject.hash;
-    })
-    .filter(({ urlObject }) => {
-      return urlObject.hash !== lastHash;
-    });
+  const revertNativeHashChanges = eligibleHashChanges.filter(_ref2 => {
+    let {
+      type
+    } = _ref2;
+    return type === 'NATIVE';
+  }).filter(_ref3 => {
+    let {
+      urlObject
+    } = _ref3;
+    const tmp = lastNativeHash;
+    lastNativeHash = urlObject.hash;
+    return tmp === urlObject.hash;
+  }).filter(_ref4 => {
+    let {
+      urlObject
+    } = _ref4;
+    return urlObject.hash !== lastHash;
+  });
 
   // Merge everything that can trigger a new RouteView
-  return Kefir.merge([
-    customAndCustomListRouteHashChanges,
-    revertNativeHashChanges,
-
-    // when native gmail changes main view there's a div that takes on role=main.
-    // getMainContentElementChangedStream doesn't respect custom views so filter
-    // out events from it. This filter is needed if the user is already at a custom
-    // view of another InboxSDK instance while this starts up.
-    GmailElementGetter.getMainContentElementChangedStream()
-      .map((event) => ({
-        urlObject: getURLObject(document.location.href),
-        type: 'NATIVE',
-      }))
-      .filter((options) =>
-        gmailRouteProcessor.isNativeRoute(options.urlObject.name)
-      ),
-  ])
-    .map((options) => {
-      const { type, urlObject } = options;
-      if (type === 'NATIVE' && urlObject.name === 'search') {
-        const customListRouteId = customListSearchStringsToRouteIds.get(
-          urlObject.params[0]
-        );
-        if (customListRouteId) {
-          const searchInput = GmailElementGetter.getSearchInput();
-          if (!searchInput) throw new Error('Should not happen');
-          searchInput.value = '';
-
-          // Only rewrite the url if it's a search query with no further
-          // parameters or it has a page parameter. Don't write URLs with thread
-          // id parameters because currently other parts of the code depend on
-          // being able to parse the URL as a normal thread URL.
-
-          // Additionally, we don't want to treat threads as the CUSTOM_LIST type
-          // since they're not lists.
-          if (
-            urlObject.params.length === 1 ||
-            (urlObject.params.length === 2 && urlObject.params[1][0] === 'p')
-          ) {
-            driver.hashChangeNoViewChange(
-              '#' +
-                customListRouteId +
-                (urlObject.params[1] ? '/' + urlObject.params[1] : '')
-            );
-            return {
-              type: 'CUSTOM_LIST',
-              urlObject,
-              routeID: customListRouteId,
-            };
-          }
+  return _kefir.default.merge([customAndCustomListRouteHashChanges, revertNativeHashChanges,
+  // when native gmail changes main view there's a div that takes on role=main.
+  // getMainContentElementChangedStream doesn't respect custom views so filter
+  // out events from it. This filter is needed if the user is already at a custom
+  // view of another InboxSDK instance while this starts up.
+  _gmailElementGetter.default.getMainContentElementChangedStream().map(event => ({
+    urlObject: (0, _getUrlObject.default)(document.location.href),
+    type: 'NATIVE'
+  })).filter(options => gmailRouteProcessor.isNativeRoute(options.urlObject.name))]).map(options => {
+    const {
+      type,
+      urlObject
+    } = options;
+    if (type === 'NATIVE' && urlObject.name === 'search') {
+      const customListRouteId = customListSearchStringsToRouteIds.get(urlObject.params[0]);
+      if (customListRouteId) {
+        const searchInput = _gmailElementGetter.default.getSearchInput();
+        if (!searchInput) throw new Error('Should not happen');
+        searchInput.value = '';
+
+        // Only rewrite the url if it's a search query with no further
+        // parameters or it has a page parameter. Don't write URLs with thread
+        // id parameters because currently other parts of the code depend on
+        // being able to parse the URL as a normal thread URL.
+
+        // Additionally, we don't want to treat threads as the CUSTOM_LIST type
+        // since they're not lists.
+        if (urlObject.params.length === 1 || urlObject.params.length === 2 && urlObject.params[1][0] === 'p') {
+          driver.hashChangeNoViewChange('#' + customListRouteId + (urlObject.params[1] ? '/' + urlObject.params[1] : ''));
+          return {
+            type: 'CUSTOM_LIST',
+            urlObject,
+            routeID: customListRouteId
+          };
         }
       }
-      return options;
-    })
-    .map((options) => {
-      const MAX_KEY_CACHE = 50;
-      const { urlObject } = options;
-
-      if (!sameRouteData[urlObject.hash]) {
-        sameRouteData[urlObject.hash] = {
-          data: {},
-        };
-      }
-      sameRouteData[urlObject.hash].lastUsedTimestamp = Date.now();
-
-      if (Object.keys(sameRouteData).length > MAX_KEY_CACHE) {
-        sameRouteData = Object.keys(sameRouteData)
-          .sort(
-            (a, b) =>
-              sameRouteData[b].lastUsedTimestamp -
-              sameRouteData[a].lastUsedTimestamp
-          )
-          .slice(0, MAX_KEY_CACHE / 2)
-          .reduce((acc, hash) => ({ ...acc, [hash]: sameRouteData[hash] }), {});
-      }
-
-      return {
-        ...options,
-        cachedRouteData: sameRouteData[urlObject.hash].data,
+    }
+    return options;
+  }).map(options => {
+    const MAX_KEY_CACHE = 50;
+    const {
+      urlObject
+    } = options;
+    if (!sameRouteData[urlObject.hash]) {
+      sameRouteData[urlObject.hash] = {
+        data: {}
       };
-    })
-    .map((options) => {
-      if (options.type === 'NATIVE' || options.type === 'CUSTOM_LIST') {
-        driver.showNativeRouteView();
-      } else if (options.type === 'CUSTOM_LIST_TRIGGER') {
-        driver.showCustomThreadList(
-          options.routeID,
-          get(customListRouteIDs, options.routeID),
-          options.urlObject.params
-        );
-        return;
-      }
-      return new GmailRouteView(options, gmailRouteProcessor, driver);
-    })
-    .filter(Boolean)
-    .map((gmailRouteView) => {
-      if (latestGmailRouteView) {
-        latestGmailRouteView.destroy();
-      }
-      latestGmailRouteView = gmailRouteView;
-      lastHash = getURLObject(document.location.href).hash;
-
-      return gmailRouteView;
-    });
+    }
+    sameRouteData[urlObject.hash].lastUsedTimestamp = Date.now();
+    if (Object.keys(sameRouteData).length > MAX_KEY_CACHE) {
+      sameRouteData = Object.keys(sameRouteData).sort((a, b) => sameRouteData[b].lastUsedTimestamp - sameRouteData[a].lastUsedTimestamp).slice(0, MAX_KEY_CACHE / 2).reduce((acc, hash) => ({
+        ...acc,
+        [hash]: sameRouteData[hash]
+      }), {});
+    }
+    return {
+      ...options,
+      cachedRouteData: sameRouteData[urlObject.hash].data
+    };
+  }).map(options => {
+    if (options.type === 'NATIVE' || options.type === 'CUSTOM_LIST') {
+      driver.showNativeRouteView();
+    } else if (options.type === 'CUSTOM_LIST_TRIGGER') {
+      driver.showCustomThreadList(options.routeID, (0, _getOrFail.default)(customListRouteIDs, options.routeID), options.urlObject.params);
+      return;
+    }
+    return new _gmailRouteView.default(options, gmailRouteProcessor, driver);
+  }).filter(Boolean).map(gmailRouteView => {
+    if (latestGmailRouteView) {
+      latestGmailRouteView.destroy();
+    }
+    latestGmailRouteView = gmailRouteView;
+    lastHash = (0, _getUrlObject.default)(document.location.href).hash;
+    return gmailRouteView;
+  });
 }
 
 /*
@@ -191,4 +175,4 @@ export default function setupRouteViewDriverStream(
  *
  * SDK only cares about hash change when the hash goes to a route that the app registered as custom.
  * Otherwise it only responds to route changes when the role=main div changes.
- */
+ */

package/src/platform-implementation-js/dom-driver/gmail/gmail-driver/setup-route-view-driver-stream.test.js

@@ -1,21 +1,17 @@
-/* @flow */
-
-jest.mock('../views/gmail-route-view/gmail-route-view', () =>
-  jest.fn(() => ({ destroy() {} }))
-);
-
-import _ from 'lodash';
-import kefirBus from 'kefir-bus';
-import delay from 'pdelay';
-
-import setupRouteViewDriverStream from './setup-route-view-driver-stream';
-
-import GmailRouteProcessor from '../views/gmail-route-view/gmail-route-processor';
-import makeMutationEventInjector from '../../../../../test/lib/makeElementIntoEventEmitter';
-import MockMutationObserver from '../../../../../test/lib/mock-mutation-observer';
-
-global.MutationObserver = MockMutationObserver;
-
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _lodash = _interopRequireDefault(require("lodash"));
+var _kefirBus = _interopRequireDefault(require("kefir-bus"));
+var _pdelay = _interopRequireDefault(require("pdelay"));
+var _setupRouteViewDriverStream = _interopRequireDefault(require("./setup-route-view-driver-stream"));
+var _gmailRouteProcessor = _interopRequireDefault(require("../views/gmail-route-view/gmail-route-processor"));
+var _makeElementIntoEventEmitter = _interopRequireDefault(require("../../../../../test/lib/makeElementIntoEventEmitter"));
+var _mockMutationObserver = _interopRequireDefault(require("../../../../../test/lib/mock-mutation-observer"));
+jest.mock('../views/gmail-route-view/gmail-route-view', () => jest.fn(() => ({
+  destroy() {}
+})));
+global.MutationObserver = _mockMutationObserver.default;
 if (!document.body) throw new Error('should not happen');
 document.body.innerHTML = `
   <div class="aeF">
@@ -28,164 +24,128 @@ document.body.innerHTML = `
 const main = document.getElementById('main');
 const main2 = document.getElementById('main2');
 if (!main || !main2) throw new Error();
-const mainEmitter = makeMutationEventInjector(main);
-const main2Emitter = makeMutationEventInjector(main2);
-
-const stopper = kefirBus();
+const mainEmitter = (0, _makeElementIntoEventEmitter.default)(main);
+const main2Emitter = (0, _makeElementIntoEventEmitter.default)(main2);
+const stopper = (0, _kefirBus.default)();
 afterEach(() => {
   stopper.emit(null);
 });
-
-function makeMockDriver(): Object {
+function makeMockDriver() {
   return {
-    getStopper: _.constant(stopper),
-    getCustomRouteIDs: _.constant(new Set()),
-    getCustomListRouteIDs: _.constant(new Map()),
-    getCustomListSearchStringsToRouteIds: _.constant(new Map()),
+    getStopper: _lodash.default.constant(stopper),
+    getCustomRouteIDs: _lodash.default.constant(new Set()),
+    getCustomListRouteIDs: _lodash.default.constant(new Map()),
+    getCustomListSearchStringsToRouteIds: _lodash.default.constant(new Map()),
     hashChangeNoViewChange: jest.fn(),
     showNativeRouteView: jest.fn(),
-    showCustomThreadList: jest.fn(),
+    showCustomThreadList: jest.fn()
   };
 }
-
 test('role=main changes are seen', async () => {
   const items = [];
   window.location.hash = '#inbox';
-
-  setupRouteViewDriverStream(new GmailRouteProcessor(), makeMockDriver())
-    .takeUntilBy(stopper)
-    .onValue((item) => {
-      items.push(item);
-    });
-
-  await delay(1);
+  (0, _setupRouteViewDriverStream.default)(new _gmailRouteProcessor.default(), makeMockDriver()).takeUntilBy(stopper).onValue(item => {
+    items.push(item);
+  });
+  await (0, _pdelay.default)(1);
   expect(items.length).toBe(1);
-
   main.style.display = 'none';
   main2.style.display = '';
-  mainEmitter({ attributeName: 'style' });
-  main2Emitter({ attributeName: 'style' });
-
-  await delay(1);
+  mainEmitter({
+    attributeName: 'style'
+  });
+  main2Emitter({
+    attributeName: 'style'
+  });
+  await (0, _pdelay.default)(1);
   expect(items.length).toBe(2);
-
   main.style.display = '';
   main2.style.display = 'none';
-  mainEmitter({ attributeName: 'style' });
-  main2Emitter({ attributeName: 'style' });
-
-  await delay(1);
+  mainEmitter({
+    attributeName: 'style'
+  });
+  main2Emitter({
+    attributeName: 'style'
+  });
+  await (0, _pdelay.default)(1);
   expect(items.length).toBe(3);
 });
-
 test('custom view hashchanges are seen', async () => {
   const items = [];
   const driver = makeMockDriver();
   driver.getCustomRouteIDs().add('foo');
   driver.getCustomRouteIDs().add('bar');
   window.location.hash = '#inbox';
-
-  setupRouteViewDriverStream(new GmailRouteProcessor(), driver)
-    .takeUntilBy(stopper)
-    .onValue((item) => {
-      items.push(item);
-    });
-
-  await delay(1);
+  (0, _setupRouteViewDriverStream.default)(new _gmailRouteProcessor.default(), driver).takeUntilBy(stopper).onValue(item => {
+    items.push(item);
+  });
+  await (0, _pdelay.default)(1);
   expect(items.length).toBe(1);
   expect(driver.showNativeRouteView).toHaveBeenCalledTimes(1);
-
   window.location.hash = '#foo';
-
-  await delay(1);
+  await (0, _pdelay.default)(1);
   expect(items.length).toBe(2);
   expect(driver.showNativeRouteView).toHaveBeenCalledTimes(1);
-
   window.location.hash = '#foo/123';
-
-  await delay(1);
+  await (0, _pdelay.default)(1);
   expect(items.length).toBe(3);
   expect(driver.showNativeRouteView).toHaveBeenCalledTimes(1);
 
   // Setting to the same hash should NOT make a new routeview.
   window.location.hash = '#foo/123?compose=123';
-
-  await delay(1);
+  await (0, _pdelay.default)(1);
   expect(items.length).toBe(3);
   expect(driver.showNativeRouteView).toHaveBeenCalledTimes(1);
-
   window.location.hash = '#bar';
-
-  await delay(1);
+  await (0, _pdelay.default)(1);
   expect(items.length).toBe(4);
   expect(driver.showNativeRouteView).toHaveBeenCalledTimes(1);
 });
-
 test('native hash changes are ignored', async () => {
   // We don't pay attention to native hash changes usually. We settle for
   // watching a new [role=main] element become displayed.
   const items = [];
   const driver = makeMockDriver();
   window.location.hash = '#inbox';
-
-  setupRouteViewDriverStream(new GmailRouteProcessor(), driver)
-    .takeUntilBy(stopper)
-    .onValue((item) => {
-      items.push(item);
-    });
-
-  await delay(1);
+  (0, _setupRouteViewDriverStream.default)(new _gmailRouteProcessor.default(), driver).takeUntilBy(stopper).onValue(item => {
+    items.push(item);
+  });
+  await (0, _pdelay.default)(1);
   expect(items.length).toBe(1);
   expect(driver.showNativeRouteView).toHaveBeenCalledTimes(1);
-
   window.location.hash = '#starred';
-
-  await delay(1);
+  await (0, _pdelay.default)(1);
   expect(items.length).toBe(1);
   expect(driver.showNativeRouteView).toHaveBeenCalledTimes(1);
 });
-
 test('revertNativeHashChanges works', async () => {
   const items = [];
   const driver = makeMockDriver();
   driver.getCustomRouteIDs().add('foo');
   window.location.hash = '#inbox';
-
-  setupRouteViewDriverStream(new GmailRouteProcessor(), driver)
-    .takeUntilBy(stopper)
-    .onValue((item) => {
-      items.push(item);
-    });
-
-  await delay(1);
+  (0, _setupRouteViewDriverStream.default)(new _gmailRouteProcessor.default(), driver).takeUntilBy(stopper).onValue(item => {
+    items.push(item);
+  });
+  await (0, _pdelay.default)(1);
   expect(items.length).toBe(1);
   expect(driver.showNativeRouteView).toHaveBeenCalledTimes(1);
-
   window.location.hash = '#foo';
-
-  await delay(1);
+  await (0, _pdelay.default)(1);
   expect(items.length).toBe(2);
   expect(driver.showNativeRouteView).toHaveBeenCalledTimes(1);
-
   window.location.hash = '#inbox';
-
-  await delay(1);
+  await (0, _pdelay.default)(1);
   expect(items.length).toBe(3);
   expect(driver.showNativeRouteView).toHaveBeenCalledTimes(2);
-
   window.location.hash = '#foo';
-
-  await delay(1);
+  await (0, _pdelay.default)(1);
   expect(items.length).toBe(4);
   expect(driver.showNativeRouteView).toHaveBeenCalledTimes(2);
-
   window.location.hash = '#inbox';
-
-  await delay(1);
+  await (0, _pdelay.default)(1);
   expect(items.length).toBe(5);
   expect(driver.showNativeRouteView).toHaveBeenCalledTimes(3);
 });
-
 test('revertNativeHashChanges and ?compose parameter play nicely together', async () => {
   // If you make a draft while at a native route view, Gmail adds ?compose=ID
   // to the hash. If you edit the draft, Gmail updates the ID in the hash. If
@@ -201,33 +161,23 @@ test('revertNativeHashChanges and ?compose parameter play nicely together', asyn
   const driver = makeMockDriver();
   driver.getCustomRouteIDs().add('foo');
   window.location.hash = '#inbox';
-
-  setupRouteViewDriverStream(new GmailRouteProcessor(), driver)
-    .takeUntilBy(stopper)
-    .onValue((item) => {
-      items.push(item);
-    });
-
-  await delay(1);
+  (0, _setupRouteViewDriverStream.default)(new _gmailRouteProcessor.default(), driver).takeUntilBy(stopper).onValue(item => {
+    items.push(item);
+  });
+  await (0, _pdelay.default)(1);
   expect(items.length).toBe(1);
   expect(driver.showNativeRouteView).toHaveBeenCalledTimes(1);
-
   window.location.hash = '#inbox?compose=A';
-
-  await delay(1);
+  await (0, _pdelay.default)(1);
   expect(items.length).toBe(1);
   expect(driver.showNativeRouteView).toHaveBeenCalledTimes(1);
-
   window.location.hash = '#foo';
-
-  await delay(1);
+  await (0, _pdelay.default)(1);
   expect(items.length).toBe(2);
   expect(driver.showNativeRouteView).toHaveBeenCalledTimes(1);
-
   window.location.hash = '#inbox?compose=A';
   window.location.hash = '#inbox?compose=B';
-
-  await delay(1);
+  await (0, _pdelay.default)(1);
   expect(items.length).toBe(3);
   expect(driver.showNativeRouteView).toHaveBeenCalledTimes(2);
-});
+});