mirror of
https://github.com/Foundry376/Mailspring.git
synced 2024-11-12 04:25:31 +08:00
d1c587a01c
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
180 lines
6.4 KiB
JavaScript
180 lines
6.4 KiB
JavaScript
import fs from 'fs';
|
|
import { remote } from 'electron';
|
|
import {Message, DraftStore} from 'nylas-exports';
|
|
import TemplateStore from '../lib/template-store';
|
|
|
|
const { shell } = remote;
|
|
|
|
const stubTemplatesDir = '~/.nylas/templates';
|
|
|
|
const stubTemplateFiles = {
|
|
'template1.html': '<p>bla1</p>',
|
|
'template2.html': '<p>bla2</p>',
|
|
};
|
|
|
|
const stubTemplates = [
|
|
{id: 'template1.html', name: 'template1', path: `${stubTemplatesDir}/template1.html`},
|
|
{id: 'template2.html', name: 'template2', path: `${stubTemplatesDir}/template2.html`},
|
|
];
|
|
|
|
xdescribe('TemplateStore', function templateStore() {
|
|
beforeEach(() => {
|
|
spyOn(fs, 'mkdir');
|
|
spyOn(shell, 'showItemInFolder').andCallFake(() => {});
|
|
spyOn(fs, 'writeFile').andCallFake((path, contents, callback) => {
|
|
callback(null);
|
|
});
|
|
spyOn(fs, 'readFile').andCallFake((path, callback) => {
|
|
const filename = path.split('/').pop();
|
|
callback(null, stubTemplateFiles[filename]);
|
|
});
|
|
});
|
|
|
|
it('should create the templates folder if it does not exist', () => {
|
|
spyOn(fs, 'exists').andCallFake((path, callback) => callback(false));
|
|
TemplateStore._init(stubTemplatesDir);
|
|
expect(fs.mkdir).toHaveBeenCalled();
|
|
});
|
|
|
|
it('should expose templates in the templates directory', () => {
|
|
let watchCallback;
|
|
spyOn(fs, 'exists').andCallFake((path, callback) => { callback(true); });
|
|
spyOn(fs, 'watch').andCallFake((path, callback) => { watchCallback = callback });
|
|
spyOn(fs, 'readdir').andCallFake((path, callback) => { callback(null, Object.keys(stubTemplateFiles)); });
|
|
TemplateStore._init(stubTemplatesDir);
|
|
watchCallback();
|
|
expect(TemplateStore.items()).toEqual(stubTemplates);
|
|
});
|
|
|
|
it('should watch the templates directory and reflect changes', () => {
|
|
let watchCallback = null;
|
|
let watchFired = false;
|
|
|
|
spyOn(fs, 'exists').andCallFake((path, callback) => callback(true));
|
|
spyOn(fs, 'watch').andCallFake((path, callback) => { watchCallback = callback });
|
|
spyOn(fs, 'readdir').andCallFake((path, callback) => {
|
|
if (watchFired) {
|
|
callback(null, Object.keys(stubTemplateFiles));
|
|
} else {
|
|
callback(null, []);
|
|
}
|
|
});
|
|
TemplateStore._init(stubTemplatesDir);
|
|
expect(TemplateStore.items()).toEqual([]);
|
|
|
|
watchFired = true;
|
|
watchCallback();
|
|
expect(TemplateStore.items()).toEqual(stubTemplates);
|
|
});
|
|
|
|
describe('insertTemplateId', () => {
|
|
xit('should insert the template with the given id into the draft with the given id', () => {
|
|
let watchCallback;
|
|
spyOn(fs, 'exists').andCallFake((path, callback) => { callback(true); });
|
|
spyOn(fs, 'watch').andCallFake((path, callback) => { watchCallback = callback });
|
|
spyOn(fs, 'readdir').andCallFake((path, callback) => { callback(null, Object.keys(stubTemplateFiles)); });
|
|
TemplateStore._init(stubTemplatesDir);
|
|
watchCallback();
|
|
const add = jasmine.createSpy('add');
|
|
spyOn(DraftStore, 'sessionForClientId').andCallFake(() => {
|
|
return Promise.resolve({changes: {add}});
|
|
});
|
|
|
|
runs(() => {
|
|
TemplateStore._onInsertTemplateId({
|
|
templateId: 'template1.html',
|
|
draftClientId: 'localid-draft',
|
|
});
|
|
});
|
|
waitsFor(() => add.calls.length > 0);
|
|
runs(() => {
|
|
expect(add).toHaveBeenCalledWith({
|
|
body: stubTemplateFiles['template1.html'],
|
|
});
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('onCreateTemplate', () => {
|
|
beforeEach(() => {
|
|
let d;
|
|
spyOn(DraftStore, 'sessionForClientId').andCallFake((draftClientId) => {
|
|
if (draftClientId === 'localid-nosubject') {
|
|
d = new Message({subject: '', body: '<p>Body</p>'});
|
|
} else {
|
|
d = new Message({subject: 'Subject', body: '<p>Body</p>'});
|
|
}
|
|
const session = {draft() { return d; }};
|
|
return Promise.resolve(session);
|
|
});
|
|
TemplateStore._init(stubTemplatesDir);
|
|
});
|
|
|
|
xit('should create a template with the given name and contents', () => {
|
|
const ref = TemplateStore.items();
|
|
TemplateStore._onCreateTemplate({name: '123', contents: 'bla'});
|
|
const item = (ref != null ? ref[0] : undefined);
|
|
expect(item.id).toBe('123.html');
|
|
expect(item.name).toBe('123');
|
|
expect(item.path.split('/').pop()).toBe('123.html');
|
|
});
|
|
|
|
xit('should display an error if no name is provided', () => {
|
|
spyOn(TemplateStore, '_displayError');
|
|
TemplateStore._onCreateTemplate({contents: 'bla'});
|
|
expect(TemplateStore._displayError).toHaveBeenCalled();
|
|
});
|
|
|
|
xit('should display an error if no content is provided', () => {
|
|
spyOn(TemplateStore, '_displayError');
|
|
TemplateStore._onCreateTemplate({name: 'bla'});
|
|
expect(TemplateStore._displayError).toHaveBeenCalled();
|
|
});
|
|
|
|
xit('should save the template file to the templates folder', () => {
|
|
TemplateStore._onCreateTemplate({name: '123', contents: 'bla'});
|
|
const path = `${stubTemplatesDir}/123.html`;
|
|
expect(fs.writeFile).toHaveBeenCalled();
|
|
expect(fs.writeFile.mostRecentCall.args[0]).toEqual(path);
|
|
expect(fs.writeFile.mostRecentCall.args[1]).toEqual('bla');
|
|
});
|
|
|
|
xit('should open the template so you can see it', () => {
|
|
TemplateStore._onCreateTemplate({name: '123', contents: 'bla'});
|
|
expect(shell.showItemInFolder).toHaveBeenCalled();
|
|
});
|
|
|
|
describe('when given a draft id', () => {
|
|
xit('should create a template from the name and contents of the given draft', () => {
|
|
spyOn(TemplateStore, 'trigger');
|
|
spyOn(TemplateStore, '_populate');
|
|
runs(() => {
|
|
TemplateStore._onCreateTemplate({draftClientId: 'localid-b'});
|
|
});
|
|
waitsFor(() => TemplateStore.trigger.callCount > 0);
|
|
runs(() => {
|
|
expect(TemplateStore.items().length).toEqual(1);
|
|
});
|
|
});
|
|
|
|
it('should display an error if the draft has no subject', () => {
|
|
spyOn(TemplateStore, '_displayError');
|
|
spyOn(fs, 'watch');
|
|
runs(() => {
|
|
TemplateStore._onCreateTemplate({draftClientId: 'localid-nosubject'});
|
|
});
|
|
waitsFor(() => TemplateStore._displayError.callCount > 0);
|
|
runs(() => {
|
|
expect(TemplateStore._displayError).toHaveBeenCalled();
|
|
});
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('onShowTemplates', () => {
|
|
xit('should open the templates folder in the Finder', () => {
|
|
TemplateStore._onShowTemplates();
|
|
expect(shell.showItemInFolder).toHaveBeenCalled();
|
|
});
|
|
});
|
|
});
|