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)
72 lines
1.8 KiB
JavaScript
72 lines
1.8 KiB
JavaScript
/**
|
||
* @typedef {object} Attribution
|
||
* @prop {string|null} [id]
|
||
* @prop {string|null} [url]
|
||
* @prop {string} [type]
|
||
*/
|
||
|
||
/**
|
||
* Convert a UrlHistory to an attribution object
|
||
*/
|
||
class AttributionBuilder {
|
||
/**
|
||
*/
|
||
constructor({urlTranslator}) {
|
||
this.urlTranslator = urlTranslator;
|
||
}
|
||
|
||
/**
|
||
* Last Post Algorithm™️
|
||
* @param {UrlHistory} history
|
||
* @returns {Attribution}
|
||
*/
|
||
getAttribution(history) {
|
||
if (history.length === 0) {
|
||
return {
|
||
id: null,
|
||
url: null,
|
||
type: null
|
||
};
|
||
}
|
||
|
||
// TODO: if something is wrong with the attribution script, and it isn't loading
|
||
// we might get out of date URLs
|
||
// so we need to check the time of each item and ignore items that are older than 24u here!
|
||
|
||
// Start at the end. Return the first post we find
|
||
for (const item of history) {
|
||
const typeId = this.urlTranslator.getTypeAndId(item.path);
|
||
|
||
if (typeId && typeId.type === 'post') {
|
||
return {
|
||
url: item.path,
|
||
...typeId
|
||
};
|
||
}
|
||
}
|
||
|
||
// No post found?
|
||
// Try page or tag or author
|
||
for (const item of history) {
|
||
const typeId = this.urlTranslator.getTypeAndId(item.path);
|
||
|
||
if (typeId) {
|
||
return {
|
||
url: item.path,
|
||
...typeId
|
||
};
|
||
}
|
||
}
|
||
|
||
// Default to last URL
|
||
// In the future we might decide to exclude certain URLs, that can happen here
|
||
return {
|
||
id: null,
|
||
url: history.last.path,
|
||
type: 'url'
|
||
};
|
||
}
|
||
}
|
||
|
||
module.exports = AttributionBuilder;
|