Ghost/ghost/members-events-service/test/event-storage.test.js
Simon Backx 74ecde73db
Moved attribution event handler to events service (#15379)
fixes https://github.com/TryGhost/Team/issues/1821

This change moves all the event storage logic to one new place: the event storage class in the MembersEventsService, which is initialised in a new members events service wrapper.

Apart from this, this includes some improvements:
- Removed DomainEvents from the constructor arguments to the subscribe method (to make it more clear where to subscribe to and decrease dependencies)
- LastSeenAtUpdater doesn't subscribe in the constructor any longer (removes unclear side effect)
- Moved LastSeenAtUpdater initialisation to new members events service wrapper
- Added missing tests to LastSeenAtUpdater to assure that the MembersEventsService package has 100% coverage.
2022-09-07 16:41:59 +02:00

218 lines
8.6 KiB
JavaScript

// Switch these lines once there are useful utils
// const testUtils = require('./utils');
require('./utils');
const {MemberCreatedEvent, SubscriptionCreatedEvent} = require('@tryghost/member-events');
const EventStorage = require('../lib/event-storage');
describe('EventStorage', function () {
describe('Constructor', function () {
it('doesn\'t throw', function () {
new EventStorage({});
});
});
describe('MemberCreatedEvent handling', function () {
it('defaults to external for missing attributions', function () {
const DomainEvents = {
subscribe: (type, handler) => {
if (type === MemberCreatedEvent) {
handler(MemberCreatedEvent.create({
memberId: '123',
source: 'test'
}, new Date(0)));
}
}
};
const MemberCreatedEventModel = {add: sinon.stub()};
const labsService = {isSet: sinon.stub().returns(true)};
const subscribeSpy = sinon.spy(DomainEvents, 'subscribe');
const eventHandler = new EventStorage({
models: {MemberCreatedEvent: MemberCreatedEventModel},
labsService
});
eventHandler.subscribe(DomainEvents);
sinon.assert.calledOnceWithMatch(MemberCreatedEventModel.add, {
member_id: '123',
created_at: new Date(0),
source: 'test'
});
sinon.assert.calledTwice(subscribeSpy);
});
it('passes custom attributions', function () {
const DomainEvents = {
subscribe: (type, handler) => {
if (type === MemberCreatedEvent) {
handler(MemberCreatedEvent.create({
memberId: '123',
source: 'test',
attribution: {
id: '123',
type: 'post',
url: 'url'
}
}, new Date(0)));
}
}
};
const MemberCreatedEventModel = {add: sinon.stub()};
const labsService = {isSet: sinon.stub().returns(true)};
const subscribeSpy = sinon.spy(DomainEvents, 'subscribe');
const eventHandler = new EventStorage({
models: {MemberCreatedEvent: MemberCreatedEventModel},
labsService
});
eventHandler.subscribe(DomainEvents);
sinon.assert.calledOnceWithMatch(MemberCreatedEventModel.add, {
member_id: '123',
created_at: new Date(0),
attribution_id: '123',
attribution_type: 'post',
attribution_url: 'url',
source: 'test'
});
sinon.assert.calledTwice(subscribeSpy);
});
it('filters if disabled', function () {
const DomainEvents = {
subscribe: (type, handler) => {
if (type === MemberCreatedEvent) {
handler(MemberCreatedEvent.create({
memberId: '123',
source: 'test',
attribution: {
id: '123',
type: 'post',
url: 'url'
}
}, new Date(0)));
}
}
};
const MemberCreatedEventModel = {add: sinon.stub()};
const labsService = {isSet: sinon.stub().returns(false)};
const subscribeSpy = sinon.spy(DomainEvents, 'subscribe');
const eventHandler = new EventStorage({
models: {MemberCreatedEvent: MemberCreatedEventModel},
labsService
});
eventHandler.subscribe(DomainEvents);
sinon.assert.calledOnceWithMatch(MemberCreatedEventModel.add, {
member_id: '123',
created_at: new Date(0),
attribution_id: null,
attribution_type: null,
attribution_url: null,
source: 'test'
});
sinon.assert.calledTwice(subscribeSpy);
});
});
describe('SubscriptionCreatedEvent handling', function () {
it('defaults to external for missing attributions', function () {
const DomainEvents = {
subscribe: (type, handler) => {
if (type === SubscriptionCreatedEvent) {
handler(SubscriptionCreatedEvent.create({
memberId: '123',
subscriptionId: '456'
}, new Date(0)));
}
}
};
const SubscriptionCreatedEventModel = {add: sinon.stub()};
const labsService = {isSet: sinon.stub().returns(true)};
const subscribeSpy = sinon.spy(DomainEvents, 'subscribe');
const eventHandler = new EventStorage({
models: {SubscriptionCreatedEvent: SubscriptionCreatedEventModel},
labsService
});
eventHandler.subscribe(DomainEvents);
sinon.assert.calledOnceWithMatch(SubscriptionCreatedEventModel.add, {
member_id: '123',
subscription_id: '456',
created_at: new Date(0)
});
sinon.assert.calledTwice(subscribeSpy);
});
it('passes custom attributions', function () {
const DomainEvents = {
subscribe: (type, handler) => {
if (type === SubscriptionCreatedEvent) {
handler(SubscriptionCreatedEvent.create({
memberId: '123',
subscriptionId: '456',
attribution: {
id: '123',
type: 'post',
url: 'url'
}
}, new Date(0)));
}
}
};
const SubscriptionCreatedEventModel = {add: sinon.stub()};
const labsService = {isSet: sinon.stub().returns(true)};
const subscribeSpy = sinon.spy(DomainEvents, 'subscribe');
const eventHandler = new EventStorage({
models: {SubscriptionCreatedEvent: SubscriptionCreatedEventModel},
labsService
});
eventHandler.subscribe(DomainEvents);
sinon.assert.calledOnceWithMatch(SubscriptionCreatedEventModel.add, {
member_id: '123',
subscription_id: '456',
created_at: new Date(0),
attribution_id: '123',
attribution_type: 'post',
attribution_url: 'url'
});
sinon.assert.calledTwice(subscribeSpy);
});
it('filters if disabled', function () {
const DomainEvents = {
subscribe: (type, handler) => {
if (type === SubscriptionCreatedEvent) {
handler(SubscriptionCreatedEvent.create({
memberId: '123',
subscriptionId: '456',
attribution: {
id: '123',
type: 'post',
url: 'url'
}
}, new Date(0)));
}
}
};
const SubscriptionCreatedEventModel = {add: sinon.stub()};
const labsService = {isSet: sinon.stub().returns(false)};
const subscribeSpy = sinon.spy(DomainEvents, 'subscribe');
const eventHandler = new EventStorage({
models: {SubscriptionCreatedEvent: SubscriptionCreatedEventModel},
labsService
});
eventHandler.subscribe(DomainEvents);
sinon.assert.calledOnceWithMatch(SubscriptionCreatedEventModel.add, {
member_id: '123',
subscription_id: '456',
created_at: new Date(0),
attribution_id: null,
attribution_type: null,
attribution_url: null
});
sinon.assert.calledTwice(subscribeSpy);
});
});
});