mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-24 11:22:19 +03:00
Added email event storage unit tests
refs https://github.com/TryGhost/Team/issues/2339
This commit is contained in:
Simon Backx
parent
a8a879ef53
commit
53b5c152d9
351
ghost/email-service/test/email-event-storage.test.js
Normal file
351
ghost/email-service/test/email-event-storage.test.js
Normal file
@ -0,0 +1,351 @@
|
||||
const EmailEventStorage = require('../lib/email-event-storage');
|
||||
const {EmailDeliveredEvent, EmailOpenedEvent, EmailBouncedEvent, EmailTemporaryBouncedEvent, EmailUnsubscribedEvent, SpamComplaintEvent} = require('@tryghost/email-events');
|
||||
const sinon = require('sinon');
|
||||
const assert = require('assert');
|
||||
|
||||
function stubDb() {
|
||||
const db = {
|
||||
knex: function () {
|
||||
return this;
|
||||
},
|
||||
where: function () {
|
||||
return this;
|
||||
},
|
||||
whereNull: function () {
|
||||
return this;
|
||||
},
|
||||
update: sinon.stub().resolves()
|
||||
};
|
||||
db.knex.raw = function () {
|
||||
return this;
|
||||
};
|
||||
return db;
|
||||
}
|
||||
|
||||
describe('Email event storage', function () {
|
||||
describe('Constructor', function () {
|
||||
it('doesn\'t throw', function () {
|
||||
new EmailEventStorage({});
|
||||
});
|
||||
});
|
||||
|
||||
it('Handles email delivered events', async function () {
|
||||
const DomainEvents = {
|
||||
subscribe: async (type, handler) => {
|
||||
if (type === EmailDeliveredEvent) {
|
||||
handler(EmailDeliveredEvent.create({
|
||||
email: 'example@example.com',
|
||||
memberId: '123',
|
||||
emailId: '456',
|
||||
emailRecipientId: '789'
|
||||
}, new Date(0)));
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
const subscribeSpy = sinon.spy(DomainEvents, 'subscribe');
|
||||
const db = stubDb();
|
||||
const eventHandler = new EmailEventStorage({db});
|
||||
eventHandler.listen(DomainEvents);
|
||||
sinon.assert.callCount(subscribeSpy, 6);
|
||||
sinon.assert.calledOnce(db.update);
|
||||
assert(!!db.update.firstCall.args[0].delivered_at);
|
||||
});
|
||||
|
||||
it('Handles email opened events', async function () {
|
||||
const DomainEvents = {
|
||||
subscribe: async (type, handler) => {
|
||||
if (type === EmailOpenedEvent) {
|
||||
handler(EmailOpenedEvent.create({
|
||||
email: 'example@example.com',
|
||||
memberId: '123',
|
||||
emailId: '456',
|
||||
emailRecipientId: '789'
|
||||
}, new Date(0)));
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
const subscribeSpy = sinon.spy(DomainEvents, 'subscribe');
|
||||
const db = stubDb();
|
||||
const eventHandler = new EmailEventStorage({db});
|
||||
eventHandler.listen(DomainEvents);
|
||||
sinon.assert.callCount(subscribeSpy, 6);
|
||||
sinon.assert.calledOnce(db.update);
|
||||
assert(!!db.update.firstCall.args[0].opened_at);
|
||||
});
|
||||
|
||||
it('Handles email permanent bounce events with update', async function () {
|
||||
let waitPromise;
|
||||
|
||||
const DomainEvents = {
|
||||
subscribe: async (type, handler) => {
|
||||
if (type === EmailBouncedEvent) {
|
||||
waitPromise = handler(EmailBouncedEvent.create({
|
||||
email: 'example@example.com',
|
||||
memberId: '123',
|
||||
emailId: '456',
|
||||
emailRecipientId: '789',
|
||||
error: {
|
||||
message: 'test',
|
||||
code: 500,
|
||||
enhancedCode: '5.5.5'
|
||||
}
|
||||
}, new Date(0)));
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
const subscribeSpy = sinon.spy(DomainEvents, 'subscribe');
|
||||
const db = stubDb();
|
||||
const existing = {
|
||||
id: 1,
|
||||
get: (key) => {
|
||||
if (key === 'severity') {
|
||||
return 'temporary';
|
||||
}
|
||||
if (key === 'failed_at') {
|
||||
return new Date(-5);
|
||||
}
|
||||
},
|
||||
save: sinon.stub().resolves()
|
||||
};
|
||||
const EmailRecipientFailure = {
|
||||
transaction: async function (callback) {
|
||||
return await callback(1);
|
||||
},
|
||||
findOne: sinon.stub().resolves(existing)
|
||||
};
|
||||
|
||||
const eventHandler = new EmailEventStorage({
|
||||
db,
|
||||
models: {
|
||||
EmailRecipientFailure
|
||||
}
|
||||
});
|
||||
eventHandler.listen(DomainEvents);
|
||||
sinon.assert.callCount(subscribeSpy, 6);
|
||||
await waitPromise;
|
||||
sinon.assert.calledOnce(db.update);
|
||||
assert(!!db.update.firstCall.args[0].failed_at);
|
||||
assert(db.update.firstCall.args[0].delivered_at === null);
|
||||
assert(existing.save.calledOnce);
|
||||
});
|
||||
|
||||
it('Handles email permanent bounce events with insert', async function () {
|
||||
let waitPromise;
|
||||
|
||||
const DomainEvents = {
|
||||
subscribe: async (type, handler) => {
|
||||
if (type === EmailBouncedEvent) {
|
||||
waitPromise = handler(EmailBouncedEvent.create({
|
||||
email: 'example@example.com',
|
||||
memberId: '123',
|
||||
emailId: '456',
|
||||
emailRecipientId: '789',
|
||||
error: {
|
||||
message: 'test',
|
||||
code: 500,
|
||||
enhancedCode: '5.5.5'
|
||||
}
|
||||
}, new Date(0)));
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
const subscribeSpy = sinon.spy(DomainEvents, 'subscribe');
|
||||
const db = stubDb();
|
||||
const EmailRecipientFailure = {
|
||||
transaction: async function (callback) {
|
||||
return await callback(1);
|
||||
},
|
||||
findOne: sinon.stub().resolves(undefined),
|
||||
add: sinon.stub().resolves()
|
||||
};
|
||||
|
||||
const eventHandler = new EmailEventStorage({
|
||||
db,
|
||||
models: {
|
||||
EmailRecipientFailure
|
||||
}
|
||||
});
|
||||
eventHandler.listen(DomainEvents);
|
||||
sinon.assert.callCount(subscribeSpy, 6);
|
||||
await waitPromise;
|
||||
sinon.assert.calledOnce(db.update);
|
||||
assert(!!db.update.firstCall.args[0].failed_at);
|
||||
assert(db.update.firstCall.args[0].delivered_at === null);
|
||||
assert(EmailRecipientFailure.add.calledOnce);
|
||||
});
|
||||
|
||||
it('Handles email permanent bounce events with skipped update', async function () {
|
||||
let waitPromise;
|
||||
|
||||
const DomainEvents = {
|
||||
subscribe: async (type, handler) => {
|
||||
if (type === EmailBouncedEvent) {
|
||||
waitPromise = handler(EmailBouncedEvent.create({
|
||||
email: 'example@example.com',
|
||||
memberId: '123',
|
||||
emailId: '456',
|
||||
emailRecipientId: '789',
|
||||
error: {
|
||||
message: 'test',
|
||||
code: 500,
|
||||
enhancedCode: '5.5.5'
|
||||
}
|
||||
}, new Date(0)));
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
const subscribeSpy = sinon.spy(DomainEvents, 'subscribe');
|
||||
const db = stubDb();
|
||||
const existing = {
|
||||
id: 1,
|
||||
get: (key) => {
|
||||
if (key === 'severity') {
|
||||
return 'permanent';
|
||||
}
|
||||
if (key === 'failed_at') {
|
||||
return new Date(-5);
|
||||
}
|
||||
},
|
||||
save: sinon.stub().resolves()
|
||||
};
|
||||
const EmailRecipientFailure = {
|
||||
transaction: async function (callback) {
|
||||
return await callback(1);
|
||||
},
|
||||
findOne: sinon.stub().resolves(existing)
|
||||
};
|
||||
|
||||
const eventHandler = new EmailEventStorage({
|
||||
db,
|
||||
models: {
|
||||
EmailRecipientFailure
|
||||
}
|
||||
});
|
||||
eventHandler.listen(DomainEvents);
|
||||
sinon.assert.callCount(subscribeSpy, 6);
|
||||
await waitPromise;
|
||||
sinon.assert.calledOnce(db.update);
|
||||
assert(!!db.update.firstCall.args[0].failed_at);
|
||||
assert(db.update.firstCall.args[0].delivered_at === null);
|
||||
assert(EmailRecipientFailure.findOne.called);
|
||||
assert(!existing.save.called);
|
||||
});
|
||||
|
||||
it('Handles email temporary bounce events with update', async function () {
|
||||
let waitPromise;
|
||||
|
||||
const DomainEvents = {
|
||||
subscribe: async (type, handler) => {
|
||||
if (type === EmailTemporaryBouncedEvent) {
|
||||
waitPromise = handler(EmailTemporaryBouncedEvent.create({
|
||||
email: 'example@example.com',
|
||||
memberId: '123',
|
||||
emailId: '456',
|
||||
emailRecipientId: '789',
|
||||
error: {
|
||||
message: 'test',
|
||||
code: 500,
|
||||
enhancedCode: '5.5.5'
|
||||
}
|
||||
}, new Date(0)));
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
const subscribeSpy = sinon.spy(DomainEvents, 'subscribe');
|
||||
const existing = {
|
||||
id: 1,
|
||||
get: (key) => {
|
||||
if (key === 'severity') {
|
||||
return 'temporary';
|
||||
}
|
||||
if (key === 'failed_at') {
|
||||
return new Date(-5);
|
||||
}
|
||||
},
|
||||
save: sinon.stub().resolves()
|
||||
};
|
||||
const EmailRecipientFailure = {
|
||||
transaction: async function (callback) {
|
||||
return await callback(1);
|
||||
},
|
||||
findOne: sinon.stub().resolves(existing)
|
||||
};
|
||||
|
||||
const eventHandler = new EmailEventStorage({
|
||||
models: {
|
||||
EmailRecipientFailure
|
||||
}
|
||||
});
|
||||
eventHandler.listen(DomainEvents);
|
||||
sinon.assert.callCount(subscribeSpy, 6);
|
||||
await waitPromise;
|
||||
assert(existing.save.calledOnce);
|
||||
});
|
||||
|
||||
it('Handles unsubscribe', async function () {
|
||||
let waitPromise;
|
||||
|
||||
const DomainEvents = {
|
||||
subscribe: async (type, handler) => {
|
||||
if (type === EmailUnsubscribedEvent) {
|
||||
waitPromise = handler(EmailUnsubscribedEvent.create({
|
||||
email: 'example@example.com',
|
||||
memberId: '123',
|
||||
emailId: '456'
|
||||
}, new Date(0)));
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
const subscribeSpy = sinon.spy(DomainEvents, 'subscribe');
|
||||
const update = sinon.stub().resolves();
|
||||
|
||||
const eventHandler = new EmailEventStorage({
|
||||
membersRepository: {
|
||||
update
|
||||
}
|
||||
});
|
||||
eventHandler.listen(DomainEvents);
|
||||
sinon.assert.callCount(subscribeSpy, 6);
|
||||
await waitPromise;
|
||||
assert(update.calledOnce);
|
||||
assert(update.firstCall.args[0].newsletters.length === 0);
|
||||
});
|
||||
|
||||
it('Handles complaints', async function () {
|
||||
let waitPromise;
|
||||
|
||||
const DomainEvents = {
|
||||
subscribe: async (type, handler) => {
|
||||
if (type === SpamComplaintEvent) {
|
||||
waitPromise = handler(SpamComplaintEvent.create({
|
||||
email: 'example@example.com',
|
||||
memberId: '123',
|
||||
emailId: '456'
|
||||
}, new Date(0)));
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
const subscribeSpy = sinon.spy(DomainEvents, 'subscribe');
|
||||
const EmailSpamComplaintEvent = {
|
||||
add: sinon.stub().resolves()
|
||||
};
|
||||
|
||||
const eventHandler = new EmailEventStorage({
|
||||
models: {
|
||||
EmailSpamComplaintEvent
|
||||
}
|
||||
});
|
||||
eventHandler.listen(DomainEvents);
|
||||
sinon.assert.callCount(subscribeSpy, 6);
|
||||
await waitPromise;
|
||||
assert(EmailSpamComplaintEvent.add.calledOnce);
|
||||
});
|
||||
});
|
||||
Loading…
Reference in New Issue
Block a user