Ghost/ghost/members-events-service/test/event-storage.test.js
Fabien "egg" O'Carroll 104f84f252 Added eslint rule for file naming convention
As discussed with the product team we want to enforce kebab-case file names for
all files, with the exception of files which export a single class, in which
case they should be PascalCase and reflect the class which they export.

This will help find classes faster, and should push better naming for them too.

Some files and packages have been excluded from this linting, specifically when
a library or framework depends on the naming of a file for the functionality
e.g. Ember, knex-migrator, adapter-manager
2023-05-09 12:34:34 -04:00

224 lines
8.8 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/EventStorage');
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: '123',
attribution_type: 'post',
attribution_url: 'url',
source: 'test',
referrer_source: null,
referrer_medium: null,
referrer_url: null
});
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('works with flag 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: '123',
attribution_type: 'post',
attribution_url: 'url',
referrer_source: null,
referrer_medium: null,
referrer_url: null
});
sinon.assert.calledTwice(subscribeSpy);
});
});
});