mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-20 01:03:23 +03:00
da24d13601
refs https://github.com/TryGhost/Team/issues/1808 refs https://github.com/TryGhost/Team/issues/1809 refs https://github.com/TryGhost/Team/issues/1820 refs https://github.com/TryGhost/Team/issues/1814 ### Changes in `member-events` package - Added MemberCreatedEvent (event, not model) - Added SubscriptionCreatedEvent (event, not model) ### Added `member-attribution` package (new) - Added the AttributionBuilder class which is able to convert a url history to an attribution object (exposed as getAttribution on the service itself, which handles the dependencies) ``` [{ "path": "/", "time": 123 }] ``` to ``` { "url": "/", "id": null, "type": "url" } ``` - event handler listens for MemberCreatedEvent and SubscriptionCreatedEvent and creates the corresponding models in the database. ### Changes in `members-api` package - Added urlHistory to `sendMagicLink` endpoint body + convert the urlHistory to an attribution object that is stored in the tokenData of the magic link (sent by Portal in this PR: https://github.com/TryGhost/Portal/pull/256). - Added urlHistory to `createCheckoutSession` endpoint + convert the urlHistory to attribution keys that are saved in the Stripe Session metadata (sent by Portal in this PR: https://github.com/TryGhost/Portal/pull/256). - Added attribution data property to member repository's create method (when a member is created) - Dispatch MemberCreatedEvent with attribution ### Changes in `members-stripe-service` package (`ghost/stripe`) - Dispatch SubscriptionCreatedEvent in WebhookController on subscription checkout (with attribution from session metadata)
224 lines
8.8 KiB
JavaScript
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 MemberAttributionEventHandler = require('../lib/event-handler');
|
|
|
|
describe('MemberAttributionEventHandler', function () {
|
|
describe('Constructor', function () {
|
|
it('doesn\'t throw', function () {
|
|
new MemberAttributionEventHandler({});
|
|
});
|
|
});
|
|
|
|
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 MemberAttributionEventHandler({
|
|
DomainEvents,
|
|
MemberCreatedEvent: MemberCreatedEventModel,
|
|
labsService
|
|
});
|
|
eventHandler.subscribe();
|
|
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 MemberAttributionEventHandler({
|
|
DomainEvents,
|
|
MemberCreatedEvent: MemberCreatedEventModel,
|
|
labsService
|
|
});
|
|
eventHandler.subscribe();
|
|
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 MemberAttributionEventHandler({
|
|
DomainEvents,
|
|
MemberCreatedEvent: MemberCreatedEventModel,
|
|
labsService
|
|
});
|
|
eventHandler.subscribe();
|
|
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 MemberAttributionEventHandler({
|
|
DomainEvents,
|
|
SubscriptionCreatedEvent: SubscriptionCreatedEventModel,
|
|
labsService
|
|
});
|
|
eventHandler.subscribe();
|
|
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 MemberAttributionEventHandler({
|
|
DomainEvents,
|
|
SubscriptionCreatedEvent: SubscriptionCreatedEventModel,
|
|
labsService
|
|
});
|
|
eventHandler.subscribe();
|
|
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 MemberAttributionEventHandler({
|
|
DomainEvents,
|
|
SubscriptionCreatedEvent: SubscriptionCreatedEventModel,
|
|
labsService
|
|
});
|
|
eventHandler.subscribe();
|
|
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);
|
|
});
|
|
});
|
|
});
|