@inboxsdk/core 0.2.27 → 0.2.28-alpha.1

package/src/platform-implementation-js/dom-driver/gmail/gmail-driver/show-custom-thread-list.test.js

@@ -0,0 +1,404 @@
+/* @flow */
+
+import showCustomThreadList from './show-custom-thread-list';
+
+import * as GSRP from '../gmail-sync-response-processor';
+
+import fs from 'fs';
+import once from 'lodash/once';
+import Kefir from 'kefir';
+import kefirBus from 'kefir-bus';
+
+const readFile = fs.promises.readFile;
+
+beforeAll(() => {
+  (document.body: any).innerHTML = `
+  <div>
+    <form role="search">
+      <input type="text">
+    </form>
+  </div>
+`;
+});
+
+class ShowCustomThreadListTester {
+  _ajaxInterceptStream = kefirBus();
+  _customListNewQueryBus = kefirBus();
+  _customListResultsBus = kefirBus();
+  _allowGmailThreadIdLookup = kefirBus();
+  _driver: any = {
+    isUsingSyncAPI: () => true,
+    getLogger: once(() => ({
+      error(e) {
+        // eslint-disable-next-line no-console
+        console.error(e);
+        throw e;
+      },
+    })),
+    getCustomListSearchStringsToRouteIds: once(() => new Map()),
+    getPageCommunicator: once(() => ({
+      ajaxInterceptStream: this._ajaxInterceptStream,
+      setupCustomListResultsQuery: jest.fn(),
+      setCustomListNewQuery: jest.fn((value) => {
+        this._customListNewQueryBus.value(value);
+      }),
+      setCustomListResults: jest.fn((value) => {
+        this._customListResultsBus.value(value);
+      }),
+    })),
+    signalCustomThreadListActivity: jest.fn(),
+    getRfcMessageIdForGmailThreadId: jest.fn(async (gmailThreadId: string) => {
+      if (!this._threadIdsToRfcIds.has(gmailThreadId)) {
+        throw new Error('Failed to find id');
+      }
+      return this._threadIdsToRfcIds.get(gmailThreadId);
+    }),
+    getGmailThreadIdForRfcMessageId: jest.fn(async (rfcId: string) => {
+      if (!this._rfcIdsToThreadIds.has(rfcId)) {
+        throw new Error('Failed to find id');
+      }
+      await this._allowGmailThreadIdLookup.take(1).toPromise();
+      return this._rfcIdsToThreadIds.get(rfcId);
+    }),
+  };
+
+  _customRouteID = 'tlbeep';
+  _routeParams = [];
+
+  _onActivate: Function;
+  _expectedSearchQuery: string;
+  _start: number;
+  _getOriginalSearchResponse: () => Promise<string>;
+  _threadIdsToRfcIds: Map<string, string>;
+  _rfcIdsToThreadIds: Map<string, string>;
+
+  _newQuery: string;
+
+  constructor(options: {|
+    onActivate: Function,
+    threadAndRfcIds: Array<[string, string]>,
+    expectedSearchQuery: string,
+    start: number,
+    getOriginalSearchResponse: () => Promise<string>,
+  |}) {
+    this._onActivate = options.onActivate;
+
+    this._threadIdsToRfcIds = new Map(options.threadAndRfcIds);
+    this._rfcIdsToThreadIds = new Map(
+      options.threadAndRfcIds.map(([threadId, rfcId]) => [rfcId, threadId])
+    );
+
+    this._expectedSearchQuery = options.expectedSearchQuery;
+    this._start = options.start;
+    this._getOriginalSearchResponse = options.getOriginalSearchResponse;
+  }
+
+  async runAndGetSetCustomListResults(): Promise<Object> {
+    showCustomThreadList(
+      this._driver,
+      this._customRouteID,
+      this._onActivate,
+      this._routeParams,
+      () => null
+    );
+
+    expect(
+      this._driver.getPageCommunicator().setupCustomListResultsQuery.mock.calls
+        .length
+    ).toBe(1);
+    this._newQuery =
+      this._driver.getPageCommunicator().setupCustomListResultsQuery.mock.calls[0][0];
+    expect(typeof this._newQuery).toBe('string');
+
+    expect(this._driver.getCustomListSearchStringsToRouteIds().size).toBe(1);
+    expect(
+      this._driver.getCustomListSearchStringsToRouteIds().get(this._newQuery)
+    ).toBe('tlbeep');
+
+    expect(this._driver.signalCustomThreadListActivity.mock.calls).toEqual([]);
+    expect(
+      this._driver.getPageCommunicator().setCustomListNewQuery.mock.calls
+    ).toEqual([]);
+    this._ajaxInterceptStream.value({
+      type: 'searchForReplacement',
+      query: this._newQuery,
+      start: this._start,
+    });
+    expect(this._driver.signalCustomThreadListActivity.mock.calls).toEqual([
+      [this._customRouteID],
+    ]);
+    await this._customListNewQueryBus.take(1).toPromise();
+    expect(
+      this._driver.getPageCommunicator().setCustomListNewQuery.mock.calls
+    ).toEqual([
+      [
+        {
+          newQuery: this._expectedSearchQuery,
+          newStart: 0,
+          query: this._newQuery,
+          start: this._start,
+        },
+      ],
+    ]);
+
+    const originalSearchResponse = await this._getOriginalSearchResponse();
+
+    this._ajaxInterceptStream.value({
+      type: 'searchResultsResponse',
+      query: this._newQuery,
+      start: this._start,
+      response: originalSearchResponse,
+    });
+
+    expect(
+      this._driver.getPageCommunicator().setCustomListResults.mock.calls.length
+    ).toBe(0);
+    this._allowGmailThreadIdLookup.value();
+    await this._customListResultsBus.take(1).toPromise();
+    expect(
+      this._driver.getPageCommunicator().setCustomListResults.mock.calls.length
+    ).toBe(1);
+
+    expect(
+      this._driver.getPageCommunicator().setCustomListResults.mock.calls[0][0]
+    ).toBe(this._newQuery);
+
+    return this._driver.getPageCommunicator().setCustomListResults.mock
+      .calls[0][1];
+  }
+}
+
+test('works', async () => {
+  const getOriginalSearchResponse = once(() =>
+    readFile(
+      __dirname + '/../../../../../test/data/2019-02-01 search results.json',
+      'utf8'
+    )
+  );
+
+  const tester = new ShowCustomThreadListTester({
+    onActivate() {
+      return {
+        hasMore: false,
+        threads: [
+          '168ab8987a3b61b3',
+          '<CAL_Ays8e-3FpHxkJ8qWNXKMHKnysR2XTeSakv_yvQNUjZsSSdw@mail.gmail.com>',
+        ],
+      };
+    },
+    threadAndRfcIds: [
+      [
+        '168ab8987a3b61b3',
+        '<CAL_Ays_RcwA0U8-43zY8JYPRsyQ5EOavXjrYZx7=EqVTx9Jz3g@mail.gmail.com>',
+      ],
+      [
+        '168a6018f86576ac',
+        '<CAL_Ays8e-3FpHxkJ8qWNXKMHKnysR2XTeSakv_yvQNUjZsSSdw@mail.gmail.com>',
+      ],
+    ],
+    expectedSearchQuery:
+      'rfc822msgid:<CAL_Ays_RcwA0U8-43zY8JYPRsyQ5EOavXjrYZx7=EqVTx9Jz3g@mail.gmail.com> OR rfc822msgid:<CAL_Ays8e-3FpHxkJ8qWNXKMHKnysR2XTeSakv_yvQNUjZsSSdw@mail.gmail.com>',
+    start: 0,
+    getOriginalSearchResponse,
+  });
+  const setCustomListResults = await tester.runAndGetSetCustomListResults();
+
+  function ignoreRawResponses(syncThreads: GSRP.SyncThread[]) {
+    return syncThreads.map((o) => ({
+      ...o,
+      rawResponse: 'ignored',
+    }));
+  }
+
+  expect(
+    ignoreRawResponses(
+      GSRP.extractThreadsFromSearchResponse(setCustomListResults)
+    )
+  ).toEqual(
+    ignoreRawResponses(
+      GSRP.extractThreadsFromSearchResponse(await getOriginalSearchResponse())
+    )
+  );
+});
+
+test('can reorder list', async () => {
+  const getOriginalSearchResponse = once(() =>
+    readFile(
+      __dirname + '/../../../../../test/data/2019-02-01 search results.json',
+      'utf8'
+    )
+  );
+
+  const tester = new ShowCustomThreadListTester({
+    onActivate() {
+      return {
+        hasMore: false,
+        threads: [
+          '<CAL_Ays8e-3FpHxkJ8qWNXKMHKnysR2XTeSakv_yvQNUjZsSSdw@mail.gmail.com>',
+          '168ab8987a3b61b3',
+        ],
+      };
+    },
+    threadAndRfcIds: [
+      [
+        '168ab8987a3b61b3',
+        '<CAL_Ays_RcwA0U8-43zY8JYPRsyQ5EOavXjrYZx7=EqVTx9Jz3g@mail.gmail.com>',
+      ],
+      [
+        '168a6018f86576ac',
+        '<CAL_Ays8e-3FpHxkJ8qWNXKMHKnysR2XTeSakv_yvQNUjZsSSdw@mail.gmail.com>',
+      ],
+    ],
+    expectedSearchQuery:
+      'rfc822msgid:<CAL_Ays8e-3FpHxkJ8qWNXKMHKnysR2XTeSakv_yvQNUjZsSSdw@mail.gmail.com> OR rfc822msgid:<CAL_Ays_RcwA0U8-43zY8JYPRsyQ5EOavXjrYZx7=EqVTx9Jz3g@mail.gmail.com>',
+    start: 0,
+    getOriginalSearchResponse,
+  });
+  const setCustomListResults = await tester.runAndGetSetCustomListResults();
+
+  function ignoreSomeFields(syncThreads: GSRP.SyncThread[]) {
+    return syncThreads.map((o) => ({
+      ...o,
+      rawResponse: 'ignored',
+      extraMetaData: {
+        ...o.extraMetaData,
+        syncMessageData: o.extraMetaData.syncMessageData.map((s) => ({
+          ...s,
+          date: 'ignored',
+        })),
+      },
+    }));
+  }
+
+  expect(
+    ignoreSomeFields(
+      GSRP.extractThreadsFromSearchResponse(setCustomListResults)
+    )
+  ).toEqual(
+    ignoreSomeFields(
+      GSRP.extractThreadsFromSearchResponse(await getOriginalSearchResponse())
+    ).reverse()
+  );
+});
+
+test('missing thread id', async () => {
+  const getOriginalSearchResponse = once(() =>
+    readFile(
+      __dirname + '/../../../../../test/data/2019-02-01 search results.json',
+      'utf8'
+    )
+  );
+
+  const tester = new ShowCustomThreadListTester({
+    onActivate() {
+      return {
+        hasMore: false,
+        threads: [
+          '<CAL_Ays8e-3FpHxkJ8qWNXKMHKnysR2XTeSakv_yvQNUjZsSSdw@mail.gmail.com>',
+          '168ab8987a3b61b3',
+          '1111111111111111',
+          '1111111111111112',
+          '<a@b.com>',
+        ],
+      };
+    },
+    threadAndRfcIds: [
+      [
+        '168ab8987a3b61b3',
+        '<CAL_Ays_RcwA0U8-43zY8JYPRsyQ5EOavXjrYZx7=EqVTx9Jz3g@mail.gmail.com>',
+      ],
+      [
+        '168a6018f86576ac',
+        '<CAL_Ays8e-3FpHxkJ8qWNXKMHKnysR2XTeSakv_yvQNUjZsSSdw@mail.gmail.com>',
+      ],
+    ],
+    expectedSearchQuery:
+      'rfc822msgid:<CAL_Ays8e-3FpHxkJ8qWNXKMHKnysR2XTeSakv_yvQNUjZsSSdw@mail.gmail.com> OR rfc822msgid:<CAL_Ays_RcwA0U8-43zY8JYPRsyQ5EOavXjrYZx7=EqVTx9Jz3g@mail.gmail.com> OR rfc822msgid:<a@b.com>',
+    start: 0,
+    getOriginalSearchResponse,
+  });
+  const setCustomListResults = await tester.runAndGetSetCustomListResults();
+
+  function ignoreSomeFields(syncThreads: GSRP.SyncThread[]) {
+    return syncThreads.map((o) => ({
+      ...o,
+      rawResponse: 'ignored',
+      extraMetaData: {
+        ...o.extraMetaData,
+        syncMessageData: o.extraMetaData.syncMessageData.map((s) => ({
+          ...s,
+          date: 'ignored',
+        })),
+      },
+    }));
+  }
+
+  expect(
+    ignoreSomeFields(
+      GSRP.extractThreadsFromSearchResponse(setCustomListResults)
+    )
+  ).toEqual(
+    ignoreSomeFields(
+      GSRP.extractThreadsFromSearchResponse(await getOriginalSearchResponse())
+    ).reverse()
+  );
+});
+
+test('missing threads in response', async () => {
+  const getOriginalSearchResponse = once(() =>
+    readFile(
+      __dirname + '/../../../../../test/data/2019-02-01 search results.json',
+      'utf8'
+    )
+  );
+
+  const tester = new ShowCustomThreadListTester({
+    onActivate() {
+      return {
+        hasMore: false,
+        threads: [
+          '168ab8987a3b61b3',
+          '<CAL_Ays8e-3FpHxkJ8qWNXKMHKnysR2XTeSakv_yvQNUjZsSSdw@mail.gmail.com>',
+          '1111111111111111',
+          '1111111111111112',
+          '<a@b.com>',
+        ],
+      };
+    },
+    threadAndRfcIds: [
+      [
+        '168ab8987a3b61b3',
+        '<CAL_Ays_RcwA0U8-43zY8JYPRsyQ5EOavXjrYZx7=EqVTx9Jz3g@mail.gmail.com>',
+      ],
+      [
+        '168a6018f86576ac',
+        '<CAL_Ays8e-3FpHxkJ8qWNXKMHKnysR2XTeSakv_yvQNUjZsSSdw@mail.gmail.com>',
+      ],
+      ['1111111111111111', '<ones@example.com>'],
+      ['1111111111111112', '<onesandatwo@example.com>'],
+      ['abab111111111111', '<a@b.com>'],
+    ],
+    expectedSearchQuery:
+      'rfc822msgid:<CAL_Ays_RcwA0U8-43zY8JYPRsyQ5EOavXjrYZx7=EqVTx9Jz3g@mail.gmail.com> OR rfc822msgid:<CAL_Ays8e-3FpHxkJ8qWNXKMHKnysR2XTeSakv_yvQNUjZsSSdw@mail.gmail.com> OR rfc822msgid:<ones@example.com> OR rfc822msgid:<onesandatwo@example.com> OR rfc822msgid:<a@b.com>',
+    start: 0,
+    getOriginalSearchResponse,
+  });
+  const setCustomListResults = await tester.runAndGetSetCustomListResults();
+
+  function ignoreRawResponses(syncThreads: GSRP.SyncThread[]) {
+    return syncThreads.map((o) => ({
+      ...o,
+      rawResponse: 'ignored',
+    }));
+  }
+
+  expect(
+    ignoreRawResponses(
+      GSRP.extractThreadsFromSearchResponse(setCustomListResults)
+    )
+  ).toEqual(
+    ignoreRawResponses(
+      GSRP.extractThreadsFromSearchResponse(await getOriginalSearchResponse())
+    )
+  );
+});

package/src/platform-implementation-js/dom-driver/gmail/gmail-driver/show-native-route-view.js

@@ -0,0 +1,33 @@
+/* @flow */
+
+import GmailElementGetter from '../gmail-element-getter';
+import fakeWindowResize from '../../../lib/fake-window-resize';
+
+export default function showNativeRouteView(gmailDriver: any) {
+  const contentSectionElement = GmailElementGetter.getContentSectionElement();
+  if (!contentSectionElement) {
+    return;
+  }
+
+  Array.prototype.forEach.call(
+    (contentSectionElement: any).children,
+    (child: HTMLElement) => {
+      child.style.display = '';
+    }
+  );
+
+  if (
+    ((document.body: any): HTMLElement).classList.contains(
+      'inboxsdk__custom_view_active'
+    )
+  ) {
+    ((document.body: any): HTMLElement).classList.remove(
+      'inboxsdk__custom_view_active'
+    );
+    // Work around issue where Gmail sometimes screws up its formatting until
+    // the user resizes their screen. Reproduction steps that sometimes work:
+    // use multiple inboxes lab, with multiple inboxes set below the inbox, go
+    // to a pipeline, resize the window slightly, and then go to inbox.
+    fakeWindowResize();
+  }
+}

package/src/platform-implementation-js/dom-driver/gmail/gmail-driver/suppressAddon.js

@@ -0,0 +1,50 @@
+/* @flow */
+
+import type GmailDriver from '../gmail-driver';
+import { simulateClick } from '../../../lib/dom/simulate-mouse-event';
+import makeElementChildStream from '../../../lib/dom/make-element-child-stream';
+import waitFor from '../../../lib/stream-wait-for';
+import GmailElementGetter from '../gmail-element-getter';
+
+export default function suppressAddon(driver: GmailDriver, addonTitle: string) {
+  waitFor(() => GmailElementGetter.getCompanionSidebarIconContainerElement())
+    .map((iconContainerElement) => {
+      // .J-KU-Jg is pre-2018-07-30 element?
+      const elementToWatch = iconContainerElement.querySelector(
+        '.J-KU-Jg, [role=tablist], .brC-bsf-aT5-aOt'
+      );
+      if (!elementToWatch) {
+        driver
+          .getLogger()
+          .error(
+            new Error('_waitForAddonTitleAndSuppress: elementToWatch not found')
+          );
+        return null;
+      }
+      return elementToWatch;
+    })
+    .filter()
+    .flatMap(makeElementChildStream)
+    .filter(
+      ({ el }) =>
+        el.getAttribute('role') === 'tab' &&
+        (el.getAttribute('data-tooltip') || el.getAttribute('aria-label')) ===
+          addonTitle
+    )
+    .takeUntilBy(driver.getStopper())
+    .onValue(({ el }) => {
+      if (
+        el.classList.contains('J-KU-KO') || // old pre-2018-07-30 classname?
+        el.classList.contains('bse-bvF-I-KO') || // old pre-2018-10-15 classname?
+        el.classList.contains('aT5-aOt-I-KO')
+      ) {
+        // it is currently open, so let's close
+        simulateClick(el);
+      }
+
+      el.style.display = 'none';
+    })
+    .onError((err) => {
+      driver.getLogger().error(err, 'error in suppressAddon');
+    });
+}

package/src/platform-implementation-js/dom-driver/gmail/gmail-driver/temporary-track-download-url-validity.js

@@ -0,0 +1,45 @@
+/* @flow */
+
+import type GmailDriver from '../gmail-driver';
+
+let isTrackingValidity = false;
+
+export default function temporaryTrackDownloadUrlValidity(driver: GmailDriver) {
+  if (
+    driver.getAppId() !== 'sdk_streak_21e9788951' ||
+    !global.fetch ||
+    isTrackingValidity
+  ) {
+    return;
+  }
+  isTrackingValidity = true;
+
+  driver
+    .getAttachmentCardViewDriverStream()
+    .filter((cardView) => cardView.getAttachmentType() === 'FILE')
+    .filter(() => Math.random() < 0.01)
+    .onValue(async (cardView) => {
+      const downloadLinkBefore = cardView._getDownloadLink();
+      let downloadUrl;
+      try {
+        downloadUrl = await cardView.getDownloadURL();
+      } catch (err) {
+        driver.getLogger().error(err, {
+          reason: 'problem getting download url',
+          downloadLinkBefore,
+          downloadLinkAfter: cardView._getDownloadLink(),
+        });
+        return;
+      }
+
+      if (!downloadUrl) {
+        driver.getLogger().error(new Error('no download url found'), {
+          downloadLinkBefore,
+          downloadLinkAfter: cardView._getDownloadLink(),
+        });
+        return;
+      }
+
+      driver.getLogger().eventSdkPassive('testing.getDownloadURL success');
+    });
+}

package/src/platform-implementation-js/dom-driver/gmail/gmail-driver/thread-row-identifier.js

@@ -0,0 +1,123 @@
+/* @flow */
+
+import { defn } from 'ud';
+import Kefir from 'kefir';
+
+import getSyncThreadFromSyncThreadId from './getSyncThreadFromSyncThreadId';
+
+import type GmailDriver from '../gmail-driver';
+import type GmailComposeView from '../views/gmail-compose-view';
+import type GmailThreadRowView from '../views/gmail-thread-row-view';
+
+// This object helps GmailThreadRowViews identify themselves if the normal
+// method (ask the injected script) fails to work. This object keeps track of
+// the open GmailComposeViews so it can
+class ThreadRowIdentifier {
+  _driver: GmailDriver;
+  _composeViews: Set<GmailComposeView>;
+
+  constructor(driver: GmailDriver) {
+    this._driver = driver;
+    this._composeViews = new Set();
+
+    this._driver
+      .getComposeViewDriverStream()
+      .onValue((gmailComposeView: Object) => {
+        this._composeViews.add(gmailComposeView);
+
+        gmailComposeView.getStopper().onValue(() => {
+          this._composeViews.delete(gmailComposeView);
+        });
+      });
+  }
+
+  getThreadIdForThreadRow(
+    gmailThreadRowView: GmailThreadRowView,
+    elements: HTMLElement[]
+  ): ?string {
+    {
+      const threadID = this._driver
+        .getPageCommunicator()
+        .getThreadIdForThreadRowByDatabase(elements[0]);
+      if (threadID) {
+        return threadID;
+      }
+    }
+
+    if (
+      gmailThreadRowView.getVisibleMessageCount() == 0 &&
+      gmailThreadRowView.getVisibleDraftCount() > 0
+    ) {
+      const composeView = this._findComposeForThreadRow(gmailThreadRowView);
+      if (composeView) {
+        return composeView.getMessageID();
+      }
+    }
+
+    // TODO fix or remove
+    // eslint-disable-next-line
+    if (false) {
+      // Try identifying the row by simulating a ctrl-click on it. Note that if
+      // the thread row corresponds to an open minimized draft, then we won't
+      // get a result, and the compose will be restored, so we counteract that
+      // here if we failed.
+      const minimizedComposes = [];
+      for (let composeView of this._composeViews) {
+        const minimized = composeView.isMinimized();
+        if (minimized) {
+          minimizedComposes.push(composeView);
+        }
+      }
+      const threadID = this._driver
+        .getPageCommunicator()
+        .getThreadIdForThreadRowByClick(elements[0]);
+      if (threadID) {
+        return threadID;
+      }
+      for (let composeView of minimizedComposes) {
+        composeView.setMinimized(true);
+      }
+    }
+
+    return null;
+  }
+
+  async getDraftIdForThreadRow(
+    gmailThreadRowView: GmailThreadRowView
+  ): Promise<?string> {
+    if (
+      gmailThreadRowView.getVisibleMessageCount() > 0 ||
+      gmailThreadRowView.getVisibleDraftCount() == 0
+    ) {
+      return Promise.resolve(null);
+    }
+
+    const composeView = this._findComposeForThreadRow(gmailThreadRowView);
+    if (composeView) {
+      return composeView.getDraftID();
+    }
+
+    const { draftID } = await this._driver.getDraftIDForMessageID(
+      gmailThreadRowView.getThreadID()
+    );
+    return draftID;
+  }
+
+  _findComposeForThreadRow(
+    gmailThreadRowView: GmailThreadRowView
+  ): ?GmailComposeView {
+    const candidates = [];
+    const subject = gmailThreadRowView.getSubject();
+    for (let gmailComposeView of this._composeViews) {
+      if (subject === gmailComposeView.getSubject()) {
+        candidates.push(gmailComposeView);
+      }
+    }
+    if (candidates.length == 1) {
+      return candidates[0];
+    }
+    return null;
+  }
+}
+
+export default defn(module, ThreadRowIdentifier);