Mailspring/spec/stores/contact-store-spec.coffee
Evan Morikawa d1c587a01c fix(spec): add support for async specs and disable misbehaving ones
More spec fixes

replace process.nextTick with setTimeout(fn, 0) for specs

Also added an unspy in the afterEach

Temporarily disable specs

fix(spec): start fixing specs

Summary:
This is the WIP fix to our spec runner.

Several tests have been completely commented out that will require
substantially more work to fix. These have been added to our sprint
backlog.

Other tests have been fixed to update to new APIs or to deal with genuine
bugs that were introduced without our knowing!

The most common non-trivial change relates to observing the `NylasAPI` and
`NylasAPIRequest`. We used to observe the arguments to `makeRequest`.
Unfortunately `NylasAPIRequest.run` is argumentless. Instead you can do:
`NylasAPIRequest.prototype.run.mostRecentCall.object.options` to get the
`options` passed into the object. the `.object` property grabs the context
of the spy when it was last called.

Fixing these tests uncovered several concerning issues with our test
runner. I spent a while tracking down why our participant-text-field-spec
was failling every so often. I chose that spec because it was the first
spec to likely fail, thereby requiring looking at the least number of
preceding files. I tried binary searching, turning on and off, several
files beforehand only to realize that the failure rate was not determined
by a particular preceding test, but rather the existing and quantity of
preceding tests, AND the number of console.log statements I had. There is
some processor-dependent race condition going on that needs further
investigation.

I also discovered an issue with the file-download-spec. We were getting
errors about it accessing a file, which was very suspicious given the code
stubs out all fs access. This was caused due to a spec that called an
async function outside ot a `waitsForPromise` block or a `waitsFor` block.
The test completed, the spies were cleaned up, but the downstream async
chain was still running. By the time the async chain finished the runner
was already working on the next spec and the spies had been restored
(causing the real fs access to run).

Juan had an idea to kill the specs once one fails to prevent cascading
failures. I'll implement this in the next diff update

Test Plan: npm test

Reviewers: juan, halla, jackie

Differential Revision: https://phab.nylas.com/D3501

Disable other specs

Disable more broken specs

All specs turned off till passing state

Use async-safe versions of spec functions

Add async test spec

Remove unused package code

Remove canary spec
2016-12-15 13:02:00 -05:00

167 lines
7.4 KiB
CoffeeScript

_ = require 'underscore'
Rx = require 'rx-lite'
{NylasTestUtils} = require 'nylas-exports'
Contact = require('../../src/flux/models/contact').default
NylasAPI = require('../../src/flux/nylas-api').default
NylasAPIRequest = require('../../src/flux/nylas-api-request').default
ContactStore = require '../../src/flux/stores/contact-store'
ContactRankingStore = require '../../src/flux/stores/contact-ranking-store'
DatabaseStore = require('../../src/flux/stores/database-store').default
AccountStore = require('../../src/flux/stores/account-store').default
{mockObservable} = NylasTestUtils
xdescribe "ContactStore", ->
beforeEach ->
spyOn(NylasEnv, "isMainWindow").andReturn true
@rankings = [
["evanA@nylas.com", 10]
["evanB@nylas.com", 1]
["evanC@nylas.com", 0.1]
]
spyOn(NylasAPIRequest.prototype, "run").andCallFake (options) =>
if options.path is "/contacts/rankings"
return Promise.resolve(@rankings)
else
throw new Error("Invalid request path!")
NylasEnv.testOrganizationUnit = "folder"
ContactStore._contactCache = []
ContactStore._fetchOffset = 0
ContactStore._accountId = null
ContactRankingStore.reset()
afterEach ->
NylasEnv.testOrganizationUnit = null
describe "ranking contacts", ->
beforeEach ->
@accountId = TEST_ACCOUNT_ID
@c1 = new Contact({name: "Evan A", email: "evanA@nylas.com", @accountId})
@c2 = new Contact({name: "Evan B", email: "evanB@nylas.com", @accountId})
@c3 = new Contact({name: "Evan C", email: "evanC@nylas.com", @accountId})
@c4 = new Contact({name: "Ben", email: "ben@nylas.com"})
@contacts = [@c3, @c1, @c2, @c4]
it "queries for, and sorts, contacts present in the rankings", ->
spyOn(ContactRankingStore, 'valuesForAllAccounts').andReturn
"evana@nylas.com": 10
"evanb@nylas.com": 1
"evanc@nylas.com": 0.1
spyOn(DatabaseStore, 'findAll').andCallFake =>
return {background: => Promise.resolve([@c3, @c1, @c2, @c4])}
waitsForPromise =>
ContactStore._updateRankedContactCache().then =>
expect(ContactStore._rankedContacts).toEqual [@c1, @c2, @c3, @c4]
describe "when ContactRankings change", ->
it "re-generates the ranked contact cache", ->
spyOn(ContactStore, "_updateRankedContactCache")
ContactRankingStore.trigger()
expect(ContactStore._updateRankedContactCache).toHaveBeenCalled()
describe "when searching for a contact", ->
beforeEach ->
@c1 = new Contact(name: "", email: "1test@nylas.com")
@c2 = new Contact(name: "First", email: "2test@nylas.com")
@c3 = new Contact(name: "First Last", email: "3test@nylas.com")
@c4 = new Contact(name: "Fit", email: "fit@nylas.com")
@c5 = new Contact(name: "Fins", email: "fins@nylas.com")
@c6 = new Contact(name: "Fill", email: "fill@nylas.com")
@c7 = new Contact(name: "Fin", email: "fin@nylas.com")
ContactStore._rankedContacts = [@c1,@c2,@c3,@c4,@c5,@c6,@c7]
it "can find by first name", ->
waitsForPromise =>
ContactStore.searchContacts("First").then (results) =>
expect(results.length).toBe 2
expect(results[0]).toBe @c2
expect(results[1]).toBe @c3
it "can find by last name", ->
waitsForPromise =>
ContactStore.searchContacts("Last").then (results) =>
expect(results.length).toBe 1
expect(results[0]).toBe @c3
it "can find by email", ->
waitsForPromise =>
ContactStore.searchContacts("1test").then (results) =>
expect(results.length).toBe 1
expect(results[0]).toBe @c1
it "is case insensitive", ->
waitsForPromise =>
ContactStore.searchContacts("FIrsT").then (results) =>
expect(results.length).toBe 2
expect(results[0]).toBe @c2
expect(results[1]).toBe @c3
it "only returns the number requested", ->
waitsForPromise =>
ContactStore.searchContacts("FIrsT", limit: 1).then (results) =>
expect(results.length).toBe 1
expect(results[0]).toBe @c2
it "returns no more than 5 by default", ->
waitsForPromise =>
ContactStore.searchContacts("fi").then (results) =>
expect(results.length).toBe 5
it "can return more than 5 if requested", ->
waitsForPromise =>
ContactStore.searchContacts("fi", limit: 6).then (results) =>
expect(results.length).toBe 6
describe 'isValidContact', ->
it "should call contact.isValid", ->
contact = new Contact()
spyOn(contact, 'isValid').andReturn(true)
expect(ContactStore.isValidContact(contact)).toBe(true)
it "should return false for non-Contact objects", ->
expect(ContactStore.isValidContact({name: 'Ben', email: 'ben@nylas.com'})).toBe(false)
it "returns false if we're not passed a contact", ->
expect(ContactStore.isValidContact()).toBe false
describe 'parseContactsInString', ->
testCases =
# Single contact test cases
"evan@nylas.com": [new Contact(name: "evan@nylas.com", email: "evan@nylas.com")]
"Evan Morikawa": []
"'evan@nylas.com'": [new Contact(name: "evan@nylas.com", email: "evan@nylas.com")]
"\"evan@nylas.com\"": [new Contact(name: "evan@nylas.com", email: "evan@nylas.com")]
"'evan@nylas.com": [new Contact(name: "'evan@nylas.com", email: "'evan@nylas.com")]
"Evan Morikawa <evan@nylas.com>": [new Contact(name: "Evan Morikawa", email: "evan@nylas.com")]
"Evan Morikawa (evan@nylas.com)": [new Contact(name: "Evan Morikawa", email: "evan@nylas.com")]
"spang (Christine Spang) <noreply+phabricator@nilas.com>": [new Contact(name: "spang (Christine Spang)", email: "noreply+phabricator@nilas.com")]
"spang 'Christine Spang' <noreply+phabricator@nilas.com>": [new Contact(name: "spang 'Christine Spang'", email: "noreply+phabricator@nilas.com")]
"spang \"Christine Spang\" <noreply+phabricator@nilas.com>": [new Contact(name: "spang \"Christine Spang\"", email: "noreply+phabricator@nilas.com")]
"Evan (evan@nylas.com)": [new Contact(name: "Evan", email: "evan@nylas.com")]
"\"Michael\" (mg@nylas.com)": [new Contact(name: "Michael", email: "mg@nylas.com")]
"announce-uc.1440659566.kankcagcmaacemjlnoma-security=nylas.com@lists.openwall.com": [new Contact(name: "announce-uc.1440659566.kankcagcmaacemjlnoma-security=nylas.com@lists.openwall.com", email: "announce-uc.1440659566.kankcagcmaacemjlnoma-security=nylas.com@lists.openwall.com")]
# Multiple contact test cases
"Evan Morikawa <evan@nylas.com>, Ben <ben@nylas.com>": [
new Contact(name: "Evan Morikawa", email: "evan@nylas.com")
new Contact(name: "Ben", email: "ben@nylas.com")
]
"mark@nylas.com\nGleb (gleb@nylas.com)\rEvan Morikawa <evan@nylas.com>, spang (Christine Spang) <noreply+phabricator@nilas.com>": [
new Contact(name: "", email: "mark@nylas.com")
new Contact(name: "Gleb", email: "gleb@nylas.com")
new Contact(name: "Evan Morikawa", email: "evan@nylas.com")
new Contact(name: "spang (Christine Spang)", email: "noreply+phabricator@nilas.com")
]
_.forEach testCases, (value, key) ->
it "works for #{key}", ->
waitsForPromise ->
ContactStore.parseContactsInString(key).then (contacts) ->
contacts = contacts.map (c) -> c.toString()
expectedContacts = value.map (c) -> c.toString()
expect(contacts).toEqual expectedContacts